The new github repository address is https://github.com/AgoraIO-Extensions/Agora-Unreal-RTC-SDK, if you want to use it, please click.
The Agora Video Call is a demo app that will help you integrate Real Time Engagement 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:
- C++ based.
- Blueprints based.
Windows 64-bit
Mac
iOS
Agora plugin is implemented as separate module. Download the plugin .zip file here and add the AgoraPlugin folder to the "Plugins" folder inside your Unreal project.
You can simply unzip and drop the entire AgoraPlugin folder inside of Plugins, and you're good to go! The folder structure should like like /Plugins/AgoraPlugin/
Open AgoraVideoCall.uproject with Unreal Editor 4.23-4.25. To test Agora functionality, you have to package the project and run as a standalone build, or if testing on iOS use Unreal's "Launch" feature.
To package the project:
File->Package Project->Windows->Windows(64-bit) then select a folder where you want to package and wait for result.
File -> Package Project -> Mac
- Right click .app file - select "Show Package Contents"
- Go to "Contents->Info.plist"
- Click the plus next to "Information Property List" and add:
Privacy - Camera Usage Description
Privacy - Microphone Usage Description
- Package the project from Unreal
- From inside the Plugins folder of the project, copy the file: AgoraRtcKit.framework from Plugins/AgoraPlugin/Source/ThirdParty/Agora/Mac/Release to
- Paste file into your newly built project folder (Packaged project dir)/MacNoEditor/[project_name]/Contents/MacOS/
To package the project for iOS, you need to have a Signing Certificate and Provisioning Profile and add it to your project. I would highly recommend going to Project Settings > Platforms > iOS > Build > and check "Automatic Signing" - this saves me a lot of headache.
If you don't have one: follow the instructions from UE4 documentation: iOS Provisioning Go to the Edit->Project Settings->Platforms: iOS, then select the certificate and provisioning profile you created.
If you don't see one of them in the table, click Import Certificate or Import Provision, chose the right file in Finder and click Open.
Then enter a Bundle Identifier: it must be the Bundle Id you used during certificate creation.
To test your Agora project on your iOS device:
- Connect your phone to your computer via USB
- Make sure your signing certificates are all up to date and working
- In the Unreal "Toolbar" (Save, Compile, Source Control, etc.) click the "Launch" button (to the right of Play) with your device selected in the dropdown
In the iOS you also need the following permissions:
Privacy - Camera Usage Description
Privacy - Microphone Usage Description
To add them in the info.plist go to the Edit->Project Settings->Platforms: iOS and enter the following line to Additional Plist Data:
<key>NSCameraUsageDescription</key><string>AgoraVideoCall</string> <key>NSMicrophoneUsageDescription</key><string>AgoraVideoCall</string>
Now you are ready to package your project for iOS or launch it on iOS device.
- Copy the plugin to [your_project]/Plugins
- Add plugin dependency into [your_project]/Source/[project_name]/[project_name].Build.cs, Private Dependencies section
PrivateDependencyModuleNames.AddRange(new string[] { "AgoraPlugin", "AgoraBlueprintable" });
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;
- Open Unreal Project, go to Edit->Plugins. Find category Project->Other and make sure plugin is enabled.
- You can find full API document at Document Center
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent