Interface JRTCRoomCallback

房间相关事件回调

interface JRTCRoomCallback {
    onRoomStateChanged(state, oldState): void;
    onRoomPropertyChanged(changeParam): void;
    onQuery(operationId, result, reason, queryInfo): void;
    onJoin(result, reason, roomId): void;
    onLeave(reason, roomId): void;
    onParticipantJoin(participant): void;
    onParticipantLeft(participant, reason): void;
    onParticipantUpdate(participant, changeParam): void;
    onMessageReceived(type, content, fromUserId): void;
    onDeliveryAbort(isShutDown, deliveryUserId, reason): void;
}

Methods

onRoomStateChanged onRoomPropertyChanged onQuery onJoin onLeave onParticipantJoin onParticipantLeft onParticipantUpdate onMessageReceived onDeliveryAbort

Methods

onRoomStateChanged

onRoomPropertyChanged

  • onRoomPropertyChanged(changeParam): void

  • 房间属性变化回调

    当房间的属性发生变化时，会收到此回调，例如房间中有成员发起屏幕共享、录制状态发生变化等。

    Parameters

    Returns void

onQuery

  • onQuery(operationId, result, reason, queryInfo): void

  • 查询房间信息结果回调

    调用 query 接口成功后，会收到此回调。

    Parameters

    • operationId: number

      操作id，对应 query 接口返回值

    • result: boolean

      查询房间信息是否成功 - true: 查询成功 - false: 查询失败

    • reason: ReasonCode

      查询失败原因，当 result 为 false 时该值有效。失败原因参见：ReasonCode

    • queryInfo: JRTCRoomQueryInfo

      JRTCRoomQueryInfo 对象，查询到的房间信息，当失败时只需关注 JRTCRoomQueryInfo.roomId

    Returns void

onJoin

  • onJoin(result, reason, roomId): void

  • 加入房间结果回调

    调用 join 接口成功后，会收到此回调。

    Parameters

    • result: boolean

      加入房间是否成功

      • true: 成功
      • false: 失败
    • reason: ReasonCode

      加入失败原因，当 result 为 false 时该值有效。失败原因参见：ReasonCode

    • roomId: undefined | string

      房间标识

    Returns void

onLeave

  • onLeave(reason, roomId): void

  • 离开房间结果回调

    调用 leave 接口成功后，会收到此回调。

    Parameters

    Returns void

onParticipantJoin

  • onParticipantJoin(participant): void

  • 新成员加入回调

    当有用户调用 JRTCRoom.join 接口加入房间成功时，已在房间中的成员会收到此回调。

    Parameters

    Returns void

onParticipantLeft

  • onParticipantLeft(participant, reason): void

  • 成员离开回调

    当房间中有成员调用 leave 接口离开房间后，房间中的其他成员会收到此回调。

    Parameters

    Returns void

onParticipantUpdate

  • onParticipantUpdate(participant, changeParam): void

  • 成员属性更新回调

    当房间中有成员的属性发生变化时，房间中的其他成员会收到此回调，例如音频上传状态、视频上传状态、网络状态等发生变化。

    Parameters

    Returns void

onMessageReceived

  • onMessageReceived(type, content, fromUserId): void

  • 接收房间消息的回调

    当房间中有成员调用 sendMessage 接口发送消息时，接收消息的成员会收到此回调。

    Parameters

    • type: string

      消息类型，对应 sendMessage 方法中的 type 参数

    • content: string

      消息内容，对应 sendMessage 方法中的 content 参数

    • fromUserId: string

      消息发送成员的用户ID

    Returns void

onDeliveryAbort

  • onDeliveryAbort(isShutDown, deliveryUserId, reason): void

  • 录制异常回调

    远程录制异常退出时会上报此回调。

    Parameters

    • isShutDown: boolean

      录制异常时服务器是否自动结束通话 - true: 自动结束通话 - false: 不自动结束通话

    • deliveryUserId: string

      录制异常的用户ID

    • reason: string

      录制异常的原因

    Returns void

设置

主题

Generated using TypeDoc