RtcEngineContext class

Configurations for the RtcEngineContext instance.

Annotations

• @JsonSerializable(explicitToJson: true, includeIfNull: false)

Properties

appId → String?

The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one RtcEngine instance. To change your App ID, call release to destroy the current RtcEngine instance, and then create a new one.

final

areaCode → int?

The region for connection. This is an advanced feature and applies to scenarios that have regional restrictions. The area codes support bitwise operation.

final

audioScenario → AudioScenarioType?

The audio scenarios. Under different audio scenarios, the device uses different volume types. See AudioScenarioType.

final

autoRegisterAgoraExtensions → bool?

Whether to automatically register the Agora extensions when initializing RtcEngine : true : (Default) Automatically register the Agora extensions when initializing RtcEngine. false : Do not register the Agora extensions when initializing RtcEngine. You need to call enableExtension to register the Agora extensions.

final

channelProfile → ChannelProfileType?

The channel profile. See ChannelProfileType.

final

domainLimit → bool?

Whether to enable domain name restriction: true : Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator. false : (Default) Disables the domain name restriction. This value is suitable for most common scenarios.

final

hashCode → int

The hash code for this object.

no setter, inherited

logConfig → LogConfig?

The SDK log files are: agorasdk.log, agorasdk.1.log, agorasdk.2.log, agorasdk.3.log, and agorasdk.4.log. The API call log files are: agoraapi.log, agoraapi.1.log, agoraapi.2.log, agoraapi.3.log, and agoraapi.4.log. The default size of each SDK log file and API log file is 2,048 KB. These log files are encoded in UTF-8. The SDK writes the latest logs in agorasdk.log or agoraapi.log. When agorasdk.log is full, the SDK processes the log files in the following order: Delete the agorasdk.4.log file (if any). Rename agorasdk.3.log to agorasdk.4.log. Rename agorasdk.2.log to agorasdk.3.log. Rename agorasdk.1.log to agorasdk.2.log. Create a new agorasdk.log file. The overwrite rules for the agoraapi.log file are the same as for agorasdk.log. Sets the log file size. See LogConfig. By default, the SDK generates five SDK log files and five API call log files with the following rules:

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited