Module: interface/ClientInterface

Interfaces

• ClientConfig
• NetworkQualityStats
• RTCRemoteUser

Type aliases

ClientRole

ClientRole: "audience" | "host"

用户角色。

• "host": 直播场景中的主播，可以发布和订阅音视频轨道。
• "audience": 直播场景中的观众，只能订阅，不能发布音视频轨道。

---

ConnectionState

ConnectionState: "DISCONNECTED" | "CONNECTING" | "CONNECTED" | "DISCONNECTING" | "RECONNECTING"

SDK 和服务器的连接状态，可以通过 connectionState 获取。

SDK 和服务器有以下 5 种连接状态:

• "DISCONNECTED": 连接断开。该状态表示用户处于以下任一阶段：
• 尚未通过 join 加入频道。
• 已经通过 leave 离开频道。
• 被踢出频道或者连接失败等异常情况。
• "CONNECTING": 正在连接中。当调用 join 时为此状态。
• "CONNECTED": 已连接。该状态表示用户已经加入频道，可以在频道内发布或订阅媒体流。
• "RECONNECTING": 正在重连中。因网络断开或切换而导致 SDK 与服务器的连接中断，SDK 会自动重连，此时连接状态变为 "RECONNECTING"。
• "DISCONNECTING": 正在断开连接。在调用 leave 的时候为此状态。

---

UID

UID: number | string

用于标识用户的 ID。同一频道中每个用户都具有唯一的 ID，且数据类型相同。