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. Only 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 first call release to destroy the current IRtcEngine and then recreate it.
channelProfile
The channel profile. See ChannelProfileType.
audioScenario
The audio scenario. Different audio scenarios use different volume types. See AudioScenarioType.
areaCode
The region for connecting to the server. This is an advanced setting for scenarios with access security requirements. 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: Enables domain restriction. This setting is applicable when IoT devices access the network using IoT SIM cards. The SDK connects only to servers on the domain or IP whitelist reported to the carrier.
  • false: (Default) Disables domain restriction. This setting is suitable for most common scenarios.
autoRegisterAgoraExtensions
Whether to automatically register Agora extensions when initializing IRtcEngine:
  • true: (Default) Automatically registers Agora extensions when initializing IRtcEngine.
  • false: Does not register Agora extensions when initializing IRtcEngine. You need to call enableExtension to register the Agora extensions.