Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRoomEventListener

房间资源、状态回调

Hierarchy

  • IRoomEventListener

Index

Methods

Methods

Optional onAudioMuteChange

  • 房间用户禁用/启用音频

    Parameters

    Returns void

Optional onKickOff

  • 当本端被剔出房间时触发

    description

    被踢出房间可能是由于服务端超出一定时间未能收到 rtcPing 消息，所以认为己方离线。 另一种可能是己方 rtcPing 失败次数超出上限

    Parameters

    • byServer: boolean

      当值为 false 时，说明本端 rtcPing 超时；当值为 true 时，说明本端收到被踢出房间通知

    • Optional state: RCKickReason

    Returns void

Optional onMessageReceive

  • onMessageReceive(name: string, content: any, senderUserId: string, messageUId: string): void

  • 接收到房间信令时回调，用户可通过房间实例的 sendMessage 接口发送信令

    Parameters

    • name: string

      信令名

    • content: any

      信令内容

    • senderUserId: string

      发送者 Id

    • messageUId: string

      消息唯一标识

    Returns void

Optional onRoomAttributeChange

  • onRoomAttributeChange(name: string, content?: string): void

  • 房间属性变更回调

    Parameters

    • name: string
    • Optional content: string

    Returns void

Optional onStreamPublish

  • 房间内用户发布资源

    Parameters

    Returns void

Optional onStreamUnpublish

  • 房间用户取消发布资源

    Parameters

    Returns void

Optional onUserJoin

  • onUserJoin(userIds: string[]): void

  • 人员加入

    Parameters

    • userIds: string[]

      加入的人员 id 列表

    Returns void

Optional onUserLeave

  • onUserLeave(userIds: string[]): void

  • 人员退出

    Parameters

    • userIds: string[]

    Returns void

Optional onVideoMuteChange

  • 房间用户禁用/启用视频

    Parameters

    Returns void

Generated using TypeDoc