RtcEngineContext
RtcEngineContext 定义。
@JsonSerializable(explicitToJson: true, includeIfNull: false) class RtcEngineContext { const RtcEngineContext( {this.appId, this.channelProfile, this.audioScenario, this.areaCode, this.logConfig, this.threadPriority, this.domainLimit, this.autoRegisterAgoraExtensions}); @JsonKey(name: 'appId') final String? appId; @JsonKey(name: 'channelProfile') final ChannelProfileType? channelProfile; @JsonKey(name: 'audioScenario') final AudioScenarioType? audioScenario; @JsonKey(name: 'areaCode') final int? areaCode; @JsonKey(name: 'logConfig') final LogConfig? logConfig; @JsonKey(name: 'threadPriority') final ThreadPriorityType? threadPriority; @JsonKey(name: 'domainLimit') final bool? domainLimit; @JsonKey(name: 'autoRegisterAgoraExtensions') final bool? autoRegisterAgoraExtensions; factory RtcEngineContext.fromJson(Map<String, dynamic> json) => _$RtcEngineContextFromJson(json); Map<String, dynamic> toJson() => _$RtcEngineContextToJson(this); }
属性
- appId
- 声网为 app 开发者签发的 App ID。 使用同一个 App ID 的 app 才能进入同一个频道进行通话或直播。一个 App ID 只能用于创建一个 RtcEngine。如需更换 App ID,必须先调用 release 销毁当前 RtcEngine 再重新创建。
- channelProfile
-
频道使用场景。详见 ChannelProfileType。
- audioScenario
- 音频场景。详见 AudioScenarioType 。不同的音频场景下,设备的音量类型是不同的。
- areaCode
- 服务器的访问区域。该功能为高级设置,适用于有访问安全限制的场景。支持的区域详见 AreaCode。区域码支持位操作。
- logConfig
-
设置 SDK 输出的日志文件。详见 LogConfig。
默认情况下,SDK 会生成 5 个 SDK 日志文件和 5 个 API 调用日志文件,规则如下:
- SDK 日志文件的名称分别为:
agorasdk.log
、agorasdk.1.log
、agorasdk.2.log
、agorasdk.3.log
、agorasdk.4.log
。 - API 调用日志文件的名称分别为:
agoraapi.log
、agoraapi.1.log
、agoraapi.2.log
、agoraapi.3.log
、agoraapi.4.log
。 - 每个 SDK 日志文件的默认大小为 1,024 KB;API 调用日志文件的默认大小为 2,048 KB。日志文件均为 UTF-8 编码。
- 最新的日志永远写在
agorasdk.log
和agoraapi.log
中。 - 当
agorasdk.log
写满后,SDK 会按照以下顺序对日志文件进行操作:- 删除
agorasdk.4.log
文件(如有)。 - 将
agorasdk.3.log
重命名为agorasdk.4.log
。 - 将
agorasdk.2.log
重命名为agorasdk.3.log
。 - 将
agorasdk.1.log
重命名为agorasdk.2.log
。 - 新建
agorasdk.log
文件。
- 删除
agoraapi.log
文件的覆盖规则与agorasdk.log
相同。
- SDK 日志文件的名称分别为:
- domainLimit
-
是否开启域名限制:
true
:开启域名限制。该设置适用于 IoT 设备使用物联网卡进行网络访问的场景。SDK 会仅连接到已向运营商报备的域名或 IP 白名单中的服务器。false
:(默认)关闭域名限制。该设置适用于大部分普通场景。
- autoRegisterAgoraExtensions
-
是否在初始化 RtcEngine 时自动注册声网插件:
true
:(默认)初始化 RtcEngine 时自动注册声网插件。false
:初始化 RtcEngine 时不注册声网插件。你需要调用 enableExtension 来注册声网插件。