网络及其他
介绍跟网络相关的方法以及其他方法和回调。
enableEncryption
开启或关闭内置加密。
public abstract enableEncryption(enabled: boolean, config: EncryptionConfig): number;
用户离开频道后，SDK 会自动关闭加密。如需重新开启加密，你需要在用户再次加入频道前调用该方法。
适用场景
对安全要求较高的场景。
调用时机
该方法需要在加入频道前调用。
调用限制
- 同一频道内的所有用户在调用该方法时，必须设置相同的加密模式和密钥。
- 如果开启了内置加密，则不能使用旁路推流功能。
参数
- enabled
- 是否开启内置加密：
- true: 开启内置加密。
- false:（默认）关闭内置加密。
- config
- 配置内置加密模式和密钥。详见 EncryptionConfig。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败
- -2: 调用了无效的参数。需重新指定参数。
- -4: 设置的加密模式不正确或加载外部加密库失败。需检查枚举值是否正确或重新加载外部加密库。
- -7: SDK 尚未初始化。需在调用 API 之前已创建 RtcEngine 对象并完成初始化。
getCallId
getCallIdEx
使用连接 ID 获取通话 ID。
public abstract getCallIdEx(connection:RtcConnection):string;
客户端在每次加入频道后会生成一个对应的 callId，标识该客户端的此次通话。
调用时机
该方法需要在加入频道后调用。
调用限制
无。
参数
- connection
- Connection 信息。详见 RtcConnection。
getCurrentMonotonicTimeInMs
获取 SDK 当前的 Monotonic Time。
public abstract getCurrentMonotonicTimeInMs(): number;
Monotonic Time 是指一个单调递增的时间序列，它的值会随着时间的推移而增加。单位为毫秒。
在自定义视频采集、自定义音频采集场景中，为确保音视频同步，声网建议你调用该方法获取 SDK 当前的 Monotonic Time 后，将该值传入采集的视频帧（VideoFrame）、音频帧（AudioFrame）的时间戳参数。
调用时机
加入频道前后均可调用。
调用限制
无。
返回值
- ≥ 0: 方法调用成功，返回 SDK 当前的 Monotonic Time（毫秒）。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
getErrorDescription
getNativeHandle
getSdkVersion
setParameters
startLastmileProbeTest
开始通话前网络质量探测。
public abstract startLastmileProbeTest(config: LastmileProbeConfig): number;
开始通话前网络质量探测，向用户反馈上下行网络的带宽、丢包、网络抖动和往返时延数据。
调用时机
该方法需要在加入频道前调用，且在收到 onLastmileQuality 和 onLastmileProbeResult 回调之前请不要调用其他方法，否则可能会由于 API 操作过于频繁导致此方法无法执行。
调用限制
无。
相关回调
- onLastmileQuality，视网络情况约 2 秒内返回。该回调通过打分反馈上下行网络质量，更贴近用户的主观感受。
- onLastmileProbeResult，视网络情况约 30 秒内返回。该回调通过具体数据反馈上下行网络质量，更加客观。
参数
- config
- Last mile 网络探测配置，详见 LastmileProbeConfig。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
stopLastmileProbeTest
onConnectionLost
网络连接中断，且 SDK 无法在 10 秒内连接服务器回调。
onConnectionLost?:() => void;
详情
SDK 在调用 joinChannelWithOptions 后，无论是否加入成功，只要 10 秒和服务器无法连接就会触发该回调。如果 SDK 在断开连接后，20 分钟内还是没能重新加入频道，SDK 会停止尝试重连。
所属接口类onConnectionStateChanged
网络连接状态已改变回调。
onConnectionStateChanged ? : ( state: Constants.ConnectionState, reason: Constants.ConnectionChangedReason ) => void
详情
该回调在网络连接状态发生改变的时候触发，并告知用户当前的网络连接状态和引起网络状态改变的原因。
参数
- state
当前网络连接状态。详见 ConnectionState。
- reason
引起当前网络连接状态改变的原因。详见 ConnectionChangedReason。
onEncryptionError
内置加密出错回调。
onEncryptionError?:(errorType:Constants.EncryptionError) => void;
详情
调用 enableEncryption 开启加密后， 如果发流端、收流端出现加解密出错，SDK 会触发该回调。
参数
- errorType
- 错误类型，详见 EncryptionError。
onLastmileProbeResult
通话前网络上下行 Last mile 质量探测报告回调。
onLastmileProbeResult? : (result:LastmileProbeResult) => void;
详情
在调用 startLastmileProbeTest 之后，SDK 会在约 30 秒内返回该回调。
参数
- result
- 上下行 Last mile 质量探测结果。详见 LastmileProbeResult。
onLastmileQuality
网络上下行 last mile 质量报告回调。
onLastmileQuality? : (quality:Constants.QualityType) => void;
详情
该回调描述本地用户在加入频道前的 last mile 网络探测的结果，其中 last mile 是指设备到声网边缘服务器的网络状态。
加入频道前，调用 startLastmileProbeTest 之后，SDK 触发该回调报告本地用户在加入频道前的 last mile 网络探测的结果。
参数
- quality
- Last mile 网络质量。详见 NetworkQuality。
onNetworkQuality
通话中每个用户的网络上下行 last mile 质量报告回调。
onNetworkQuality? : (uid: number, txQuality: Constants.NetworkQuality, rxQuality: Constants.NetworkQuality) => void;
详情
该回调描述每个用户在通话中的 last mile 网络状态，其中 last mile 是指设备到声网边缘服务器的网络状态。
该回调每 2 秒触发一次。如果远端有多个用户，该回调每 2 秒会被触发多次。
该回调通过频道内的广播包反馈网络质量。过多的广播包可能引发广播风暴。为防止广播风暴导致频道内大量数据传输，该回调默认支持同时反馈最多 4 个远端主播的网络质量。
UNKNOWN；用户不收流时，rxQuality 为 UNKNOWN。参数
- uid
用户 ID。表示该回调报告的是持有该 ID 的用户的网络质量。如果当 uid 为 0 时，返回的是本地用户的网络质量。
- txQuality
- 该用户的上行网络质量，基于发送码率、上行丢包率、平均往返时延和网络抖动计算。 该值代表当前的上行网络质量，帮助判断是否可以支持当前设置的视频编码属性。 假设上行码率是 1000 Kbps，那么支持直播场景下 640 × 480 的分辨率、15 fps 的帧率没有问题，但是支持 1280 × 720 的分辨率就会有困难。详见 NetworkQuality。
- rxQuality
- 该用户的下行网络质量，基于下行网络的丢包率、平均往返延时和网络抖动计算。详见 NetworkQuality。
onPermissionError
获取设备权限出错回调。
onPermissionError?:(permission:Constants.PermissionType) => void;
详情
无法获取设备权限时，SDK 会触发该回调，报告哪个设备的权限无法获取。
参数
- permission
- 设备权限类型。详见 PermissionType。