From ac62ac07d2f269d2aa579206ac9fc8df224a9766 Mon Sep 17 00:00:00 2001 From: Adam Allaf Date: Tue, 7 Feb 2023 16:01:50 +0100 Subject: [PATCH 1/4] Update on-video-track-added.md --- docs/docs/blueprints/Events/on-video-track-added.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/blueprints/Events/on-video-track-added.md b/docs/docs/blueprints/Events/on-video-track-added.md index 51ec1344..7de4315b 100644 --- a/docs/docs/blueprints/Events/on-video-track-added.md +++ b/docs/docs/blueprints/Events/on-video-track-added.md @@ -1,6 +1,6 @@ --- -sidebar_label: On Track Added -title: On Track Added +sidebar_label: On Video Track Added +title: On Video Track Added --- -Triggered when a video track is added. Provides the participant ID in its argument. \ No newline at end of file +Triggered when a video track is added. Provides the participant ID in its argument. From 202566ab70511c2d3916e0ee1c1aa9989ec20fc5 Mon Sep 17 00:00:00 2001 From: Adam Allaf Date: Tue, 7 Feb 2023 16:03:32 +0100 Subject: [PATCH 2/4] Update on-video-track-removed.md --- docs/docs/blueprints/Events/on-video-track-removed.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/blueprints/Events/on-video-track-removed.md b/docs/docs/blueprints/Events/on-video-track-removed.md index c704f136..3dffb746 100644 --- a/docs/docs/blueprints/Events/on-video-track-removed.md +++ b/docs/docs/blueprints/Events/on-video-track-removed.md @@ -1,5 +1,5 @@ --- -sidebar_label: On Track Removed -title: On Track Removed +sidebar_label: On Video Track Removed +title: On Video Track Removed --- -Triggered when a video track is added. Provides the participant ID in its argument. \ No newline at end of file +Triggered when a video track is added. Provides the participant ID in its argument. From 509be82cd58eb5355333c96050e1c1e50d9c6560 Mon Sep 17 00:00:00 2001 From: Jakub Audykowicz Date: Wed, 8 Feb 2023 11:48:06 +0100 Subject: [PATCH 3/4] Remove macOS permissions readme section --- README.md | 20 +------------------- 1 file changed, 1 insertion(+), 19 deletions(-) diff --git a/README.md b/README.md index d04c0617..e2f1dea2 100644 --- a/README.md +++ b/README.md @@ -22,26 +22,8 @@ Before you start, make sure that you have: - A [Dolby.io](https://dolby.io) account. If you do not have an account, [sign up](https://dolby.io/signup) for free. - A client access token or an app key and an app secret copied from the Communications & Media [Dolby.io Dashboard](https://dashboard.dolby.io/). -## Install the plugin +## Installation 1. Make sure that your project contains a `Plugins` folder in the root of your game folder. If you do not have this folder, create it. 2. Download the latest plugin [release](https://github.com/DolbyIO/comms-sdk-unreal/releases) for your platform and unpack the plugin to the `Plugins` folder. 3. Launch your project using the Unreal Editor and select `Edit > Plugins` from the menu to enable the plugin manually. This step requires restarting the editor. - -## macOS permissions - -Using the plugin in the Unreal Editor requires the editor to obtain microphone and camera permissions. However, on macOS the editor never asks for permissions, so you need to forcefully provide them to your application. To do so, you can use the [tccutil](https://github.com/DocSystem/tccutil) permissions manager and the following commands: -- Epic Games Launcher: `sudo python tccutil.py -e -id com.epicgames.EpicGamesLauncher --microphone --camera` -- Unreal Engine 4: `sudo python tccutil.py -e -id com.epicgames.UE4Editor --microphone --camera` -- Unreal Engine 5: `sudo python tccutil.py -e -id com.epicgames.UnrealEditor --microphone --camera` - -The mentioned permissions manager is not endorsed by Dolby in any way and may be dangerous as it needs root permissions to access sensitive system files and requires you to grant full disk access to the terminal. If you do not wish to use it, you need to find another way to provide the required permissions to the Unreal Editor. Otherwise, you need to package the game to use the plugin and cannot test it in the editor. In order to package games using the plugin with the data required to request the necessary permissions, you need to add the following lines to your game's `Info.plist` file, or, if you want to automatically add these lines to all your packaged games, to the `{UnrealEngineRoot}/Engine/Source/Runtime/Launch/Resources/Mac/Info.plist` file: - -``` -NSMicrophoneUsageDescription -Dolby.io Virtual World -NSCameraUsageDescription -Dolby.io Virtual World -``` - -We recommend the latter solution if it does not conflict with your setup because the `Info.plist` file is overwritten each time the game is packaged. From 7432cc5e9146478ef2dc6f242681d085cdf35479 Mon Sep 17 00:00:00 2001 From: Adam Allaf Date: Wed, 8 Feb 2023 21:06:27 +0100 Subject: [PATCH 4/4] Update on-video-track-added.md --- docs/docs/blueprints/Events/on-video-track-added.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/blueprints/Events/on-video-track-added.md b/docs/docs/blueprints/Events/on-video-track-added.md index 7de4315b..121fddd9 100644 --- a/docs/docs/blueprints/Events/on-video-track-added.md +++ b/docs/docs/blueprints/Events/on-video-track-added.md @@ -2,5 +2,4 @@ sidebar_label: On Video Track Added title: On Video Track Added --- - Triggered when a video track is added. Provides the participant ID in its argument.