RtcEngineContext

Defines RtcEngineContext.

export class RtcEngineContext {

  appId?: string;

  channelProfile?: ChannelProfileType;

  audioScenario?: AudioScenarioType;

  areaCode?: number;

  logConfig?: LogConfig;

  threadPriority?: ThreadPriorityType;

  useExternalEglContext?: boolean;

  domainLimit?: boolean;

  autoRegisterAgoraExtensions?: boolean;

}

Properties

appId
The App ID issued by Agora to the App developer. Apps using the same App ID can join the same channel for communication or live streaming. An App ID can only be used to create one IRtcEngine. To change the App ID, you must call release to destroy the current IRtcEngine before creating a new one.
channelProfile
Channel profile. See ChannelProfileType.
audioScenario
Audio scenario. Different scenarios correspond to different volume types on the device. See AudioScenarioType.
areaCode
Region for accessing the server. This is an advanced setting suitable for scenarios with restricted access. Supported regions are listed in AreaCode. Bitwise operations are supported for region codes.
logConfig
Sets the log files output by the SDK. See LogConfig. By default, the SDK generates 5 SDK log files and 5 API call log files, with the following rules:
domainLimit
Whether to enable domain restriction:
  • true: Enable domain restriction. This setting is suitable for IoT devices accessing the network via IoT SIM cards. The SDK only connects to servers in the domain or IP whitelist registered with the carrier.
  • false: (Default) Disable domain restriction. This setting is suitable for most general scenarios.
autoRegisterAgoraExtensions
Whether to automatically register Agora extensions when initializing IRtcEngine:
  • true: (Default) Automatically register Agora extensions when initializing IRtcEngine.
  • false: Do not register Agora extensions when initializing IRtcEngine. You need to call enableExtension to register them.