事件

IRTSRoomEvents

类型: interface

• API

onUserJoined

远端用户首次进房，或断网后重新连入房间时，房间内其他用户将收到该事件。

• 类型

  (userInfo: UserInfo) => void
  

• 参数

  • userInfo

    类型: UserInfo

    加入房间的用户的信息

onUserLeave

远端用户离开房间时，本地用户会收到此事件

• 类型

  (userId: string, reason: UserOfflineReason) => void
  

• 参数

  • userId

    类型: string

    离开房间的远端用户 ID。

  • reason

    类型: UserOfflineReason

    用户离开房间的原因。

onMessageReceived

接收到房间内广播消息的回调。
房间内其他用户调用 sendRoomMessage 发送广播消息时，收到此回调。

• 类型

  (userId: string, message: string) => void
  

• 参数

  • userId

    类型: string

    消息发送者 ID

  • message

    类型: string

    收到的消息内容

onBinaryMessageReceived

接收到房间内广播二进制消息的回调。
房间内其他用户调用 sendRoomBinaryMessage 发送广播二进制消息时，收到此回调。

• 类型

  (userId: string, message: ArrayBuffer) => void
  

• 参数

  • userId

    类型: string

    消息发送者 ID

  • message

    类型: ArrayBuffer

    收到的二进制消息内容

IRTSEvents

类型: interface

• API

onMessageReceived

收到远端用户调用 sendMessage 发来的文本消息时，会收到此回调

• 类型

  (userId: string, message: string) => void
  

• 参数

  • uid

    类型: string

    消息发送者 ID

  • message

    类型: string

    收到的文本消息内容

onBinaryMessageReceived

收到远端用户调用 sendBinaryMessage 发来的二进制消息时，会收到此回调

• 类型

  (userId: string, message: ArrayBuffer) => void
  

• 参数

  • uid

    类型: string

    消息发送者 ID

  • message

    类型: ArrayBuffer

    收到的二进制消息内容

onConnectionStateChanged

回调 SDK 与信令服务器连接状态相关事件。当 SDK 与信令服务器的网络连接状态改变时回调该事件。

• 类型

  (e: { state: ConnectionState;}) => void
  

• 注意

  该回调在信令服务器连接状态发生改变时触发，并告知用户当前的连接状态，和引起改变的原因。

• 参数

  • state

    类型: { state: ConnectionState; }

    当前 SDK 与信令服务器连接状态。

    • 成员

      名称	类型	描述
      state	ConnectionState

onWarning

发生警告回调。

• 类型

  () => void
  

• 注意

  SDK 运行时出现了警告，通常会自动恢复，警告信息可以忽略。

onError

发生错误回调。

• 类型

  (e: { errorCode: ErrorCode;}) => void
  

• 注意

  SDK 运行时出现了错误，且通常无法自动恢复，你可能需要干预。

• 参数

  • errorCode

    类型: { errorCode: ErrorCode; }

    错误代码

    • 成员

      名称	类型	描述
      errorCode	ErrorCode

onServerParamsSetResult

设置应用服务器参数的返回结果

• 类型

  (error?: ErrorCode) => void
  

• 注意

  • 调用 setServerParams 后，会收到此回调。
  • 当调用 setServerParams 设置服务器参数后断网，会在重连成功后收到本事件。

• 参数

  • errorCode

    类型: ErrorCode | undefined

    设置结果：

  • 返回 200，设置成功
    
  • 返回其他，设置失败