AgoraVideoCall

The Agora Video Call is a demo app that will help you get video chat integrated directly into your Unreal Engine applications using the AgoraPlugin, that wraps Agora Video SDK.

With this sample app, you can:

• Join / leave channel
• Mute / unmute audio
• Enable / disable video
• Switch camera
• Setup resolution and frame rate

Developed with Unreal Engine 4.23

There are two implementations of Agora Video Call demo application:

1. C++ based.
2. Blueprints based.

See [C++ Guide](C++\ Approach/GUIDE.md) and [Blueprints Guide](Blueprints\ Approach/GUIDE.md) for more info.

Agora plugin is implemented as separate module. Download the project with command git clone --recursive todo::link_to_the_repo, or download the plugin here and add it's contents to Plugins/AgoraPlugin for each project.

Building and running the App

Open AgoraVideoCall.uproject with Unreal Editor( version no less than 4.23 ).

To package the project:

1. File->Package Project->Windows->Windows(64-bit) then select a folder where you want to package and wait for result.

2. Now need to package the plugin.

For MacOS you don't need to do that. Just skip this step.

Edit->Plugins-> Skip Built-In plugins and scroll down to "Project", click on "Other" to find "AgoraPlugin", then "Package", and select the folder inside the packaged project: (Packaged project dir)/WindowsNoEditor/AgoraVideoCall/Plugins/AgoraPlugin/.

3. Now you can find executable file of the demo App in the folder selected on step (1) and run the App.

Supported platforms

Windows 64-bit

Mac

Use the plugin in your project

1. Copy the plugin to [your_project]/Plugins
2. Add plugin dependency into [your_project]/Source/[project_name]/[project_name].Build.cs, Private Dependencies section

PrivateDependencyModuleNames.AddRange(new string[] { "AgoraPlugin", "AgoraBlueprintable" });

3. Open Unreal Project, go to Edit->Plugins. Find category Project->Other and make sure plugin is enabled.

4. If the version of your Unreal Editor is 4.24 or higher add the following into [your_project]/Source/[project_name]Editor.Target.cs

DefaultBuildSettings = BuildSettingsVersion.V2;

Connect Us

• You can find full API document at Document Center

Mac

Permissions

Add the following permissions in the info.plist file for device access:

Privacy - Camera Usage Description

Privacy - Microphone Usage Description

Framework

After packaging the project copy AgoraRtcKit.framework from Plugins/AgoraPlugin/Source/ThirdParty/Agora/Mac/Release to (Packaged project dir)/MacNoEditor/[project_name]/Contents/MacOS/