Video SDK v3.7.1 API Reference for Unity
Public Member Functions | Properties | List of all members
agora_gaming_rtc.RtcEngineConfig Struct Reference

Public Member Functions

 RtcEngineConfig (string mAppId, LogConfig config, AREA_CODE mAreaCode=AREA_CODE.AREA_CODE_GLOB)


string appId [get, set]
AREA_CODE areaCode [get, set]
LogConfig logConfig [get, set]

Detailed Description

Configurations for the IRtcEngine instance.

Constructor & Destructor Documentation

◆ RtcEngineConfig()

agora_gaming_rtc.RtcEngineConfig.RtcEngineConfig ( string  mAppId,
LogConfig  config,

Configurations for the IRtcEngine instance.

Property Documentation

◆ appId

string agora_gaming_rtc.RtcEngineConfig.appId

The App ID issued to you by Agora. See How to get the App ID. Only users in apps with the same App ID can join the same channel and communicate with each other. Use an App ID to initialize only one IRtcEngine instance. To change your App ID, call Destroy to destroy the current IRtcEngine instance and then call this method to initialize an IRtcEngine instance with the new App ID.

◆ areaCode

AREA_CODE agora_gaming_rtc.RtcEngineConfig.areaCode

The region for connection. This advanced feature applies to scenarios that have regional restrictions.

For the regions that Agora supports, see AREA_CODE. After specifying the region, the SDK connects to the Agora servers within that region.

◆ logConfig

LogConfig agora_gaming_rtc.RtcEngineConfig.logConfig

The configuration of the log files that the SDK outputs. See LogConfig.


By default, the SDK outputs five log files, agorasdk.log, agorasdk_1.log, agorasdk_2.log, agorasdk_3.log, agorasdk_4.log, each with a default size of 1024 KB. These log files are encoded in UTF-8. The SDK writes the latest logs in agorasdk.log. When agorasdk.log is full, the SDK deletes the log file with the earliest modification time among the other four, renames agorasdk.log to the name of the deleted log file, and creates a new agorasdk.log to record latest logs.

The documentation for this struct was generated from the following file: