Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRoomEventListener

Hierarchy

  • IRCRTCTrackEventListener
    • IRoomEventListener

Index

Methods

Methods

Optional onTrackReady

  • 订阅的音视频流通道已建立, track 已可以进行播放

    Parameters

    Returns void

Optional onRTCPeerConnectionCloseByException

  • onRTCPeerConnectionCloseByException(): void

  • 当 RTCPeerConnection 连接被异常关闭时触发，此时需业务层重新加入房间并重新发布、订阅资源。 引起连接异常中断的原因包括但不限于：电脑休眠、浏览器页面长期后台运行等

    since

    5.1.5

    Returns void

Optional onKickOff

  • onKickOff(byServer: boolean, state?: RCKickReason, kickExtra?: any): void

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

    description

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

    Parameters

    • byServer: boolean

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

    • Optional state: RCKickReason
    • Optional kickExtra: any

    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 onAudioMuteChange

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

    Parameters

    Returns void

Optional onVideoMuteChange

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

    Parameters

    Returns void

Optional onTrackPublish

  • 房间内用户发布资源

    Parameters

    • tracks: RCRemoteTrack[]

      新发布的音轨与视轨数据列表，包含新发布的 RCRemoteAudioTrack 与 RCRemoteVideoTrack 实例

    Returns void

Optional onTrackUnpublish

  • 房间用户取消发布资源

    description

    当资源被取消发布时，SDK 内部会取消对相关资源的订阅，业务层仅需处理 UI 业务

    Parameters

    • tracks: RCRemoteTrack[]

      被取消发布的音轨与视轨数据列表

    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 onCDNEnableChange

  • onCDNEnableChange(enable: boolean): void

  • 主播开启、停止推 CDN 状态通知

    Parameters

    • enable: boolean

    Returns void

Optional onPing

  • RTC 每次 Ping 的结果

    since

    version: 5.1.5

    Parameters

    Returns void

Optional onSwitchRole

  • 主播和观众切换身份通知

    Parameters

    Returns void