网络及其他
介绍跟网络相关的方法以及其他方法和回调。
complain
enableEncryption
开启或关闭内置加密。
abstract enableEncryption(enabled: boolean, config: EncryptionConfig): number;
用户离开频道后，SDK 会自动关闭加密。如需重新开启加密，你需要在用户再次加入频道前调用该方法。
适用场景
对安全要求较高的场景。
调用时机
该方法需要在加入频道前调用。
调用限制
- 同一频道内的所有用户在调用该方法时，必须设置相同的加密模式和密钥。
- 如果开启了内置加密，则不能使用旁路推流功能。
参数
- enabled
- 是否开启内置加密：
- true: 开启内置加密。
- false:（默认）关闭内置加密。
- config
- 配置内置加密模式和密钥。详见 EncryptionConfig。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败
- -2: 调用了无效的参数。需重新指定参数。
- -4: 设置的加密模式不正确或加载外部加密库失败。需检查枚举值是否正确或重新加载外部加密库。
- -7: SDK 尚未初始化。需在调用 API 之前已创建 IRtcEngine 对象并完成初始化。
enableEncryptionEx
开启或关闭内置加密。
abstract enableEncryptionEx(
connection: RtcConnection,
enabled: boolean,
config: EncryptionConfig
): number;
用户离开频道后，SDK 会自动关闭加密。如需重新开启加密，你需要在用户再次加入频道前调用该方法。
适用场景
对安全要求较高的场景。
调用时机
该方法需要在加入频道前调用。
调用限制
- 同一频道内的所有用户在调用该方法时，必须设置相同的加密模式和密钥。
- 如果开启了内置加密，则不能使用旁路推流功能。
参数
- enabled
- 是否开启内置加密：
- true: 开启内置加密。
- false:（默认）关闭内置加密。
- config
- 配置内置加密模式和密钥。详见 EncryptionConfig。
- connection
- Connection 信息。详见 RtcConnection。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
enableWebSdkInteroperability
打开与 Web SDK 的互通（仅在直播场景适用）。
abstract enableWebSdkInteroperability(enabled: boolean): number;
详情
该方法打开或关闭与 Web SDK 的互通。如果有用户通过 Web SDK 加入频道，请确保调用该方法，否则 Web 端用户看 Native 端的画面会是黑屏。
该方法仅在直播场景下适用，通信场景下默认互通是打开的。
参数
- enabled
- 是否打开与 Web SDK 的互通：
true: 打开互通。false: (默认) 关闭互通。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
getCallId
getCallIdEx
使用连接 ID 获取通话 ID。
abstract getCallIdEx(connection: RtcConnection): string;
客户端在每次加入频道后会生成一个对应的 callId，标识该客户端的此次通话。你可以调用该方法获取 callId 参数，然后在调用 rate、complain 等方法时填入。
调用时机
该方法需要在加入频道后调用。
调用限制
无。
参数
- connection
- Connection 信息。详见 RtcConnection。
getConnectionState
获取当前网络连接状态。
abstract getConnectionState(): ConnectionStateType;
调用时机
加入频道前后均可调用。
调用限制
无。
返回值
当前网络连接状态。详见 ConnectionStateType。
所属接口类getConnectionStateEx
获取当前网络连接状态。
abstract getConnectionStateEx(connection: RtcConnection): ConnectionStateType;
调用时机
加入频道前后均可调用。
调用限制
无。
参数
- connection
- Connection 信息。详见 RtcConnection。
返回值
当前网络连接状态。详见 ConnectionStateType。
所属接口类getCurrentMonotonicTimeInMs
获取 SDK 当前的 Monotonic Time。
abstract getCurrentMonotonicTimeInMs(): number;
Monotonic Time 是指一个单调递增的时间序列，它的值会随着时间的推移而增加。单位为毫秒。
在自定义视频采集、自定义音频采集场景中，为确保音视频同步，声网建议你调用该方法获取 SDK 当前的 Monotonic Time 后，将该值传入采集的视频帧（VideoFrame）、音频帧（AudioFrame）的时间戳参数。
调用时机
加入频道前后均可调用。
调用限制
无。
返回值
- ≥ 0: 方法调用成功，返回 SDK 当前的 Monotonic Time（毫秒）。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
getErrorDescription
getNativeHandle
getNetworkType
getNtpWallTimeInMs
getVersion
isFeatureAvailableOnDevice
查询设备是否支持指定进阶功能。
abstract isFeatureAvailableOnDevice(type: FeatureType): boolean;
详情
查询当前设备能力是否满足虚拟背景、美颜等进阶功能的要求。
适用场景
在使用进阶音视频功能前，你可以根据查询结果判断当前设备是否支持这些功能，从而避免在低端设备上开启进阶功能导致性能下降或功能不可用的问题。你可以根据该方法的返回值，决定是否显示或启用相应的功能按钮，或者在设备能力不足时，为用户提示相应信息。
参数
- type
- 进阶功能类型，详见 FeatureType。
返回值
true: 设备支持指定进阶功能。false: 设备不支持指定进阶功能。
queryDeviceScore
rate
sendCustomReportMessage
sendCustomReportMessageEx
setAVSyncSource
设置发流端音画同步。
abstract setAVSyncSource(channelId: string, uid: number): number;
详情
同一用户可能使用两个设备分别发送音频流和视频流，为保证接收端听到和看到的音频和视频的时间同步性，你可以在视频发送端调用该方法，并传入音频发送端的频道名、用户 ID。 SDK 会以发送的音频流的时间戳为基准进行自动调节发送的视频流，以保证即使在两个发送端的上行网络情况不一致（如分别使用 Wi-Fi 和 4G 网络）的情况下，也能让接收到的音视频具有时间同步性。
参数
- channelId
- 标识音频发送端所在频道的频道名。
- uid
- 音频发送端的用户 ID。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setCloudProxy
设置云代理服务。
abstract setCloudProxy(proxyType: CloudProxyType): number;
详情
当用户的网络访问受到防火墙限制时，你需要将声网提供的 IP 和端口号添加到防火墙白名单，然后调用该方法开启云代理，并通过 proxyType 参数设置云代理类型。
成功连接云代理后，SDK 会触发 onConnectionStateChanged (ConnectionStateConnecting, ConnectionChangedSettingProxyServer) 回调。
如果你想关闭已设置的 Force UDP 或 Force TCP 云代理，请调用 setCloudProxy(NoneProxy)。
如果你想更改已设置的云代理类型，请先调用 setCloudProxy(NoneProxy)，再调用 setCloudProxy 并传入你期望的 proxyType 值。
- 建议你在频道外调用该方法。
- 如果用户处于内网防火墙环境下，使用 Force UDP 云代理时，旁路推流和跨频道媒体流转发功能不可用。
- 使用 Force UDP 云代理时，调用 startAudioMixing 方法时无法播放 HTTP 协议的在线音频文件。旁路推流和跨频道媒体流转发功能会使用 TCP 协议的云代理。
参数
- proxyType
云代理类型，详见 CloudProxyType。
该参数为必填参数，如果你不赋值，SDK 会报错。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- -2: 传入的参数无效。
- -7: SDK 尚未初始化。
setLocalAccessPoint
配置与声网私有媒体服务器接入模块的连接。
abstract setLocalAccessPoint(config: LocalAccessPointConfiguration): number;
成功部署声网私有媒体服务器并在内网终端集成 4.x RTC SDK 后，你可以调用该方法指定 Local Access Point，给 SDK 分配接入模块。
调用时机
该方法需要在加入频道前调用。
调用限制
该方法仅在部署声网混合云方案后生效。你可以联系销售了解和部署声网混合云。
参数
- config
- Local Access Point 配置。详见 LocalAccessPointConfiguration。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setLogFile
设置日志文件
abstract setLogFile(filePath: string): number;
设置 SDK 的输出 log 文件。SDK 运行时产生的所有 log 将写入该文件。
调用时机
该方法需要在 initialize 后立即调用，否则输出日志可能不完整。
调用限制
App 必须保证指定的目录存在而且可写。
参数
- filePath
- 日志文件的完整路径。该日志文件为 UTF-8 编码。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setLogFileSize
设置 SDK 输出的日志文件的大小。
abstract setLogFileSize(fileSizeInKBytes: number): number;
详情
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 日志文件的默认大小为 2,048 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相同。
该方法仅用于设置 agorasdk.log 文件的大小，对agoraapi.log不生效。
参数
- fileSizeInKBytes
- 单个
agorasdk.log日志文件的大小，单位为 KB，取值范围为 [128,20480]，默认值为 2,048 KB。如果你将fileSizeInKByte设为小于 128 KB，SDK 会自动调整到 128 KB；如果你将fileSizeInKByte设为大于 20,480 KB，SDK 会自动调整到 20,480 KB。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setLogFilter
设置日志输出等级。
abstract setLogFilter(filter: LogFilterType): number;
详情
该方法设置 SDK 的输出日志输出等级。不同的输出等级可以单独或组合使用。日志级别顺序依次为 LogFilterOff、LogFilterCritical、LogFilterError、LogFilterWarn、LogFilterInfo 和 LogFilterDebug。 选择一个级别，你就可以看到在该级别之前所有级别的日志信息。
例如，你选择 LogFilterWarn 级别，就可以看到在 LogFilterCritical、LogFilterError 和 LogFilterWarn 级别的日志信息。
参数
- filter
日志过滤等级。详见 LogFilterType。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setLogLevel
设置 SDK 的日志输出级别。
abstract setLogLevel(level: LogLevel): number;
选择一个级别，你就可以看到该级别的日志信息。
参数
- level
- 日志级别。详见 LogLevel。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setParameters
setRemoteSubscribeFallbackOption
设置弱网环境下订阅的音视频流回退选项。
abstract setRemoteSubscribeFallbackOption(
option: StreamFallbackOptions
): number;
详情
网络不理想的环境下，实时通信音视频的质量会下降。你可以调用该方法并将 option 设置为 StreamFallbackOptionVideoStreamLow 或 StreamFallbackOptionAudioOnly，SDK 会在下行弱网且音视频质量严重受影响时，将视频流切换为小流或关闭视频流，从而保证音频质量。同时，SDK 会持续监控网络质量，并在网络质量改善时恢复订阅音视频流。
当订阅流回退为音频流或由音频流恢复为音视频流时，SDK 会触发 onRemoteSubscribeFallbackToAudioOnly 回调。
参数
- option
- 订阅流的回退选项。详见 STREAM_FALLBACK_OPTIONS。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
startEchoTest
开始音视频通话回路测试。
abstract startEchoTest(config: EchoTestConfiguration): number;
为测试用户本地发流、收流是否正常，你可以调用该方法进行音视频通话回路测试，即测试系统的音视频设备和用户的上下行网络是否正常。
开始测试后，用户需发出声音或面对摄像头，音频或视频会在约 2 秒后播放出来。如果音频播放正常，则表示系统音频设备和用户上下行网络均正常； 如果视频播放正常，则表示系统视频设备和用户上下行网络均正常。
调用时机
该方法在加入频道前后均可调用。
调用限制
- 在频道内调用该方法时，需确保当前没有发布音视频流。
- 调用该方法后，必须调用 stopEchoTest 结束测试，否则该用户无法进行下一次音视频通话回路测试，也无法加入频道。
- 直播场景下，该方法仅能由主播调用。
参数
- config
- 音视频通话回路测试的配置。详见 EchoTestConfiguration。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
startLastmileProbeTest
开始通话前网络质量探测。
abstract startLastmileProbeTest(config: LastmileProbeConfig): number;
开始通话前网络质量探测，向用户反馈上下行网络的带宽、丢包、网络抖动和往返时延数据。
调用时机
该方法需要在加入频道前调用，且在收到 onLastmileQuality 和 onLastmileProbeResult 回调之前请不要调用其他方法，否则可能会由于 API 操作过于频繁导致此方法无法执行。
调用限制
无。
相关回调
- onLastmileQuality，视网络情况约 2 秒内返回。该回调通过打分反馈上下行网络质量，更贴近用户的主观感受。
- onLastmileProbeResult，视网络情况约 30 秒内返回。该回调通过具体数据反馈上下行网络质量，更加客观。
参数
- config
- Last mile 网络探测配置，详见 LastmileProbeConfig。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
stopEchoTest
停止语音通话回路测试。
abstract stopEchoTest(): number;
调用 startEchoTest 后，必须调用该方法结束测试，否则该用户无法进行下一次音视频通话回路测试，也无法加入频道。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
- -5(ERR_REFUSED): 停止测试失败，可能是测试不在运行中。
stopLastmileProbeTest
onConnectionBanned
网络连接已被服务器禁止回调。
onConnectionBanned?(connection: RtcConnection): void;
详情
参数
- connection
- Connection 信息。详见 RtcConnection。
onConnectionInterrupted
网络连接中断回调。
onConnectionInterrupted?(connection: RtcConnection): void;
详情
- onConnectionInterrupted 回调一定是发生在成功加入频道后，且 SDK 刚失去和服务器连接超过 4 秒时触发。
- onConnectionLost 回调是无论是否成功加入频道，只要 10 秒内和服务器无法建立连接都会触发。
参数
- connection
- Connection 信息。详见 RtcConnection。
onConnectionLost
网络连接中断，且 SDK 无法在 10 秒内连接服务器回调。
onConnectionLost?(connection: RtcConnection): void;
详情
SDK 在调用 joinChannel 后，无论是否加入成功，只要 10 秒和服务器无法连接就会触发该回调。如果 SDK 在断开连接后，20 分钟内还是没能重新加入频道，SDK 会停止尝试重连。
参数
- connection
- Connection 信息。详见 RtcConnection。
onConnectionStateChanged
网络连接状态已改变回调。
onConnectionStateChanged?(
connection: RtcConnection,
state: ConnectionStateType,
reason: ConnectionChangedReasonType
): void;
详情
该回调在网络连接状态发生改变的时候触发，并告知用户当前的网络连接状态和引起网络状态改变的原因。
参数
- connection
- Connection 信息。详见 RtcConnection。
- state
当前网络连接状态。详见 ConnectionStateType。
- reason
引起当前网络连接状态改变的原因。详见 ConnectionChangedReasonType。
onEncryptionError
内置加密出错回调。
onEncryptionError?(
connection: RtcConnection,
errorType: EncryptionErrorType
): void;
详情
调用 enableEncryption 开启加密后， 如果发流端、收流端出现加解密出错，SDK 会触发该回调。
参数
- connection
- Connection 信息。详见 RtcConnection。
- errorType
- 错误类型，详见 EncryptionErrorType。
onLastmileProbeResult
通话前网络上下行 Last mile 质量探测报告回调。
onLastmileProbeResult?(result: LastmileProbeResult): void;
详情
在调用 startLastmileProbeTest 之后，SDK 会在约 30 秒内返回该回调。
参数
- result
- 上下行 Last mile 质量探测结果。详见 LastmileProbeResult。
onLastmileQuality
网络上下行 last mile 质量报告回调。
onLastmileQuality?(quality: QualityType): void;
详情
该回调描述本地用户在加入频道前的 last mile 网络探测的结果，其中 last mile 是指设备到声网边缘服务器的网络状态。
加入频道前，调用 startLastmileProbeTest 之后，SDK 触发该回调报告本地用户在加入频道前的 last mile 网络探测的结果。
参数
- quality
- Last mile 网络质量。详见 QualityType。
onNetworkQuality
通话中每个用户的网络上下行 last mile 质量报告回调。
onNetworkQuality?(
connection: RtcConnection,
remoteUid: number,
txQuality: QualityType,
rxQuality: QualityType
): void;
详情
该回调描述每个用户在通话中的 last mile 网络状态，其中 last mile 是指设备到声网边缘服务器的网络状态。
该回调每 2 秒触发一次。如果远端有多个用户，该回调每 2 秒会被触发多次。
该回调通过频道内的广播包反馈网络质量。过多的广播包可能引发广播风暴。为防止广播风暴导致频道内大量数据传输，该回调默认支持同时反馈最多 4 个远端主播的网络质量。
Unknown；用户不收流时，rxQuality 为 Unknown。参数
- connection
- Connection 信息。详见 RtcConnection。
- remoteUid
用户 ID。表示该回调报告的是持有该 ID 的用户的网络质量。如果当 uid 为 0 时，返回的是本地用户的网络质量。
- txQuality
- 该用户的上行网络质量，基于发送码率、上行丢包率、平均往返时延和网络抖动计算。 该值代表当前的上行网络质量，帮助判断是否可以支持当前设置的视频编码属性。 假设上行码率是 1000 Kbps，那么支持直播场景下 640 × 480 的分辨率、15 fps 的帧率没有问题，但是支持 1280 × 720 的分辨率就会有困难。
- rxQuality
- 该用户的下行网络质量，基于下行网络的丢包率、平均往返延时和网络抖动计算。
onNetworkTypeChanged
本地网络类型发生改变回调。
onNetworkTypeChanged?(connection: RtcConnection, type: NetworkType): void;
详情
本地网络连接类型发生改变时，SDK 会触发该回调，并在回调中明确当前的网络连接类型。你可以通过该回调获取正在使用的网络类型；当连接中断时，该回调能辨别引起中断的原因是网络切换还是网络条件不好。
参数
- connection
- Connection 信息。详见 RtcConnection。
- type
本地网络连接类型。详见 NetworkType。
onPermissionError
获取设备权限出错回调。
onPermissionError?(permissionType: PermissionType): void;
详情
无法获取设备权限时，SDK 会触发该回调，报告哪个设备的权限无法获取。
参数
- permissionType
- 设备权限类型。详见 PermissionType。
onProxyConnected
代理连接状态回调。
onProxyConnected?(
channel: string,
uid: number,
proxyType: ProxyType,
localProxyIp: string,
elapsed: number
): void;
详情
通过该回调你可以监听 SDK 连接代理的状态。例如，当用户调用 setCloudProxy 设置代理并成功加入频道后，SDK 会触发该回调报告用户 ID、连接的代理类型和从调用 joinChannel 到触发该回调经过的时间等。
参数
- channel
- 频道名称。
- uid
- 用户 ID
- proxyType
- 连接上的代理类型。详见 ProxyType。
- localProxyIp
- 预留参数，暂不支持。
- elapsed
- 从调用 joinChannel 到 SDK 触发该回调的经过的时间（毫秒）。
onRemoteSubscribeFallbackToAudioOnly
订阅流已回退为音频流或恢复为音视频流回调。
onRemoteSubscribeFallbackToAudioOnly?(
uid: number,
isFallbackOrRecover: boolean
): void;
详情
- 下行网络环境较差，订阅的音视频流回退为音频流
- 下行网络环境改善，订阅音频流恢复为音视频流
参数
- uid
- 远端用户的用户 ID。
- isFallbackOrRecover
true: 由于网络环境不理想，订阅流已回退为音频流。false: 由于网络环境改善，订阅流已恢复为音视频流。
onUplinkNetworkInfoUpdated
上行网络信息变化回调。
onUplinkNetworkInfoUpdated?(info: UplinkNetworkInfo): void;
详情
只有当上行网络信息发生变化时，SDK 才会触发该回调。
参数
- info
- 上行网络信息，详见 UplinkNetworkInfo。