How do I add the permissions needed for real-time interaction to my Unreal Engine project?

In order to implement real-time interactive features on different target platforms, you need to add camera, microphone, and other permissions to your Unreal Engine project. Depending on the target platform, you can refer to this article for steps and configurations to get these permissions.

If the target platform is iOS, in the Unreal Editor, click Edit > Project Settings > Platforms > iOS to package the project and paste the following code into the Additional Plist Data input box to add the camera and microphone permissions required for real-time interaction:

_1

<key>NSCameraUsageDescription</key><string>AgoraVideoCall</string><key>NSMicrophoneUsageDescription</key><string>AgoraVideoCall</string>

If the target platform is macOS, refer to the following steps to add the camera and microphone permissions required for real-time interaction to your Unreal Engine project:

For Unreal Engine 4, you can directly modify the Info.plist file generated after the project is packaged to add the required permissions to your project. If you are using Unreal Engine 5, Agora suggests that you modify the Info.plist template that comes with the engine to ensure that the required permissions have been added to the file that is generated during packaging.

In the Unreal Editor, click Edit > Project Settings > Platforms > Mac Package Project. Right-click on the compiled application file (.app) and select Show Package Contents to display the package contents, which includes the files generated by the package Info.plist.

Open ./Epic Games/<Unreal Engine version path>/Engine/Source/Runtime/Launch/Resources/Mac which is the local path where the Info.plist template is located.

Add the following camera and microphone privacy permissions to the Information Property List in the Info.plist file:

• Privacy - Camera Usage Description: Camera usage permissions.
• Privacy - Microphone Usage Description: Microphone usage privileges.

Double-click to open the Info.plist file in Xcode and add the camera and microphone privacy permissions under Information Property List:

Open the Info.plist file with a text editor and add the following XML fragment:

_4

<key>NSCameraUsageDescription</key>

_4

<string>Use camera</string>

_4

<key>NSMicrophoneUsageDescription</key>

_4

<string>Use mic</string>

If the target platform is Android, refer to the following steps to add the following permissions required for real-time interaction to your Unreal Engine project:

• android.permission.RECORD_AUDIO: Recording permission.
• android.permission.CAMERA: Camera permission.
• android.permission.READ_PHONE_STATE: Read phone state permission.
• android.permission.WRITE_EXTERNAL_STORAGE: Write to external storage permission.

1. Add the following include code to the Project/Source/Project/AgoraWidget.h file:

   
   

   _3

   #if PLATFORM_ANDROID

   _3

   #include "AndroidPermission/Classes/AndroidPermissionFunctionLibrary.h"

   _3

   #endif

   
   

2. Add the AndroidPermission library to the Project/Source/Project/Project.Build.cs file:

   
   

   _4

   if (Target.Platform == UnrealTargetPlatform.Android)

   _4

   {

   _4

   PrivateDependencyModuleNames.AddRange(new string[] { "AndroidPermission" });

   _4

   }

   
   

3. Check if Android permissions have been obtained. Add the NativeConstruct and CheckAndroidPermission methods and implementations to the AgoraWidget.h and AgoraWidget.cpp files and call the CheckAndroidPermission method in NativeConstruct to check if the required Android permissions have been obtained. The sample code is as follows:

   
   

   _4

   // AgoraWidget.h

   _4

   private:

   _4

   // Get Android Permissions

   _4

   void CheckAndroidPermission();

   
   
   
   

   _27

   // AgoraWidget.cpp

   _27

   // Add the following code after #include "AgoraWidget.h"

   _27

   void UAgoraWidget::CheckAndroidPermission()

   _27

   {

   _27

   #if PLATFORM_ANDROID

   _27

   FString pathfromName = UGameplayStatics::GetPlatformName();

   _27

   if (pathfromName == "Android")

   _27

   {

   _27

   TArray<FString> AndroidPermission;

   _27

   AndroidPermission.Add(FString("android.permission.CAMERA"));

   _27

   AndroidPermission.Add(FString("android.permission.RECORD_AUDIO"));

   _27

   AndroidPermission.Add(FString("android.permission.READ_PHONE_STATE"));

   _27

   AndroidPermission.Add(FString("android.permission.WRITE_EXTERNAL_STORAGE"));

   _27

   AndroidPermission.Add(FString("android.permission.ACCESS_WIFI_STATE"));

   _27

   AndroidPermission.Add(FString("android.permission.ACCESS_NETWORK_STATE"));

   _27

   UAndroidPermissionFunctionLibrary::AcquirePermissions(AndroidPermission);

   _27

   }

   _27

   #endif

   _27

   }

   _27

   _27

   void UAgoraWidget::NativeConstruct()

   _27

   {

   _27

   Super::NativeConstruct();

   _27

   #if PLATFORM_ANDROID

   _27

   CheckAndroidPermission()

   _27

   #endif

   _27

   }

   
   

Before initializing the RTC engine, you need to check whether you have acquired the Android system permissions required to implement real-time interaction. You can refer to the following figure to create nodes to add permissions such as access to the microphone and camera in the Android system: