You need to enable JavaScript to run this app.
导航

数据类型

最近更新时间2023.08.28 12:05:33

首次发布时间2022.09.14 20:26:33

UserInfo

类型: interface

用户信息

userId

类型: string

用户 ID,长度在 128 字节以内的非空字符串。

extraInfo

类型: string | undefined

用户传递的额外信息,最大长度为 200 字节。会在 onUserJoined 中回调给远端用户。

  • 注意

    支持以下字符集范围:

    • 26 个大写字母 A ~ Z
    • 26 个小写字母 a ~ z
    • 10 个数字 0 ~ 9
    • 下划线 "_",at 符 "@",减 号 "-"

UserOfflineReason

类型: enum

用户离开房间的原因

  • 成员

    属性描述
    QUIT0远端用户调用 leaveRoom 主动退出房间。
    DROPPED1远端用户因 Token 过期或网络原因等掉线。
    KICKED_BY_ADMIN2远端用户调用 setUserVisibility 切换至不可见状态。

USER_ONLINE_STATUS

类型: enum

用户在线状态

  • 成员

    属性描述
    OFFLINE0对端用户离线
    对端用户已经调用 logout,或者没有调用 login 进行登录,无法收发消息
    ONLINE1对端用户在线
    对端用户调用 login 登录,并且连接状态正常。
    UNREACHABLE2无法获取对端用户在线状态
    发生级联错误、对端用户在线状态异常时返回

ConnectionState

类型: enum

SDK 与 RTC 服务器连接状态。

  • 成员

    属性描述
    CONNECTION_START0进行连接前准备,锁定相关资源。
    CONNECTION_STATE_DISCONNECTED1连接断开,且断开时长超过 12s,SDK 会自动重连。
    CONNECTION_STATE_CONNECTING2首次请求建立连接,正在连接中。
    CONNECTION_STATE_CONNECTED3首次连接成功。
    CONNECTION_STATE_RECONNECTING4涵盖了以下情况:
    + 首次连接时,10 秒内未连接成功;
    + 连接成功后,断连 10 秒。自动重连中。
    CONNECTION_STATE_RECONNECTED5连接断开后重连成功。