Skip to content
This repository has been archived by the owner on Sep 9, 2024. It is now read-only.

Commit

Permalink
Merge pull request #84 from DolbyIO/develop
Browse files Browse the repository at this point in the history
Merge develop into main
  • Loading branch information
Adam1-3 authored Feb 10, 2023
2 parents 318e5f8 + aafdb88 commit 6c9c6ae
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 26 deletions.
20 changes: 1 addition & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```
<key>NSMicrophoneUsageDescription</key>
<string>Dolby.io Virtual World</string>
<key>NSCameraUsageDescription</key>
<string>Dolby.io Virtual World</string>
```

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.
7 changes: 3 additions & 4 deletions docs/docs/blueprints/Events/on-video-track-added.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
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.
Triggered when a video track is added. Provides the participant ID in its argument.
6 changes: 3 additions & 3 deletions docs/docs/blueprints/Events/on-video-track-removed.md
Original file line number Diff line number Diff line change
@@ -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.
Triggered when a video track is added. Provides the participant ID in its argument.

0 comments on commit 6c9c6ae

Please sign in to comment.