类型定义
- React
更新时间不可用
本页面提供所有 Interface 和 Class 的描述。
NetworkQualityEx
上下行 last mile 网络质量。
该接口类继承自 Web SDK 的 NetworkQuality，并新增以下属性：
| 属性 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
delay | number | 必选 | SDK 到声网边缘服务器的平均往返时延（Round-Trip Time)，单位 ms。 |
JoinOptions
加入频道所需参数。
| 属性 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
appid | string | 必选 | 声网项目的 App ID。 |
channel | string | Yes | 要加入的频道名称。详见 IAgoraRTCClient.join 的参数说明。 |
token | string | null | Yes | 用于鉴权的 Token，如果你的声网项目启用了 Token 鉴权机制，则需要提供有效的 Token；如果没有启用 Token 鉴权，则传入 null。详见 IAgoraRTCClient.join 的参数说明。 |
uid | UID |null | No | 用户 ID，如果不提供则由服务器自动生成一个 number 型的 uid。详见 IAgoraRTCClient.join 的参数说明。 |
AgoraRTCReactError
抛出的错误。
AgoraRTCReactError 继承自浏览器的 Error 对象。直接打印 AgoraRTCReactError 对象可以看到错误信息。
| 属性 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
rtcMethod | string | 必选 | 发生错误的 Web SDK 方法名。根据 Web SDK 的方法名可以定位发生错误的 Hook，对应关系见下表。 |
rtcMethod 与 Hook 的关系表
rtcMethod | 发生错误的 Hook |
|---|---|
"IAgoraRTCClient.join" | useJoin |
"IAgoraRTC.createCameraVideoTrack" | useLocalCameraTrack |
"IAgoraRTC.createMicrophoneAudioTrack" | useLocalMicrophoneTrack |
"IAgoraRTCClient.publish" | usePublish |
"IAgoraRTCClient.unsubscribe" 或 "IAgoraRTCClient.subscribe" | useRemoteUserTrack |
"IAgoraRTCClient.unsubscribe" 或 "IAgoraRTCClient.subscribe" 或 "IAgoraRTCClient.massUnsubscribe" | useRemoteVideoTracks |