Download and enable the plugin to be able to use it in the Unreal Editor. You can either use the binary or build the plugin from source.
📄️ Getting Started - First Conference
The following steps present how to create a sample game which uses the plugin and connects to a demo conference. It is based on the Unreal Engine 5 First Person game template.
📄️ Common Tutorial Setup
This tutorial explains how to initialize the plugin and connect to a conference, which is a common prerequisite for other tutorials.
📄️ Camera Preview
This tutorial explains how to render a preview of your camera feed.
📄️ Rendering Remote Video
This tutorial explains how to render camera video coming from other participants.
📄️ Screen Share Preview
This tutorial explains how to render a preview of your screen share feed.
📄️ Rendering Remote Screen Share
This tutorial explains how to render screen share feeds coming from remote participants.
📄️ Device Management
This tutorial explains how to set up audio device management with a simple user interface.
📄️ Game Instance Usage
This tutorial explains how to use the plugin when working from within a game instance.
📄️ Using the Plugin with C++
After enabling the plugin, you need to use the UDolbyIOSubsystem class to be able to use the available features in C++. We will show an example using Unreal Engine 5's First Person C++ game template. For simplicity, we assume that the project is named "Foo".
📄️ Launching multiple games
If multiple games call Set Token at the same time, which is likely to happen when using "Number of Players" with a value of more than 1 in the editor, then it is likely that one of these calls will trigger an error. We recommend handling the error by retrying this function after a short delay. Usually, one tick is enough, but if you have time, we recommend setting a longer delay:
📄️ macOS Permissions
📄️ Targetting Android
This tutorial explains how to set up the plugin to target Android devices.