事件

EngineEvents

类型: interface

• API

onPlayerEvent

播放器事件

• 类型

  (event: PlayerEvent) => void
  

• 参数

  • event

    类型: PlayerEvent

onUserJoined

远端可见用户加入房间，或房内不可见用户切换为可见的回调

• 类型

  (event: onUserJoinedEvent) => void
  

• 参数

  • event

    类型: onUserJoinedEvent

onUserLeave

远端可见用户离开房间，或房内可见用户切换为隐身的回调

• 类型

  (event: onUserLeaveEvent) => void
  

• 参数

  • event

    类型: onUserLeaveEvent

onConnectionStateChanged

连接状态发生变化

• 类型

  (event: ConnectionStateChangeEvent) => void
  

• 参数

  • event

    类型: ConnectionStateChangeEvent

onUserPublishStream

房间内新增远端摄像头/麦克风采集音视频流的回调。

• 类型

  (event: { userId: string; mediaType: MediaType;}) => void
  

• 注意

  当房间内的远端用户调用 publishStream 成功发布由摄像头/麦克风采集的媒体流时，本地用户会收到该回调，此时本地用户可以自行选择是否调用 subscribeStream 订阅此流。

• 参数

  • event

    类型: { userId: string; mediaType: MediaType; }

    • 成员

      名称	类型	描述
      userId	string	远端流发布用户的用户 ID
      mediaType	MediaType	远端媒体流的类型

onUserUnpublishStream

房间内远端摄像头/麦克风采集的媒体流移除的回调。

• 类型

  (event: { userId: string; mediaType: MediaType; reason: StreamRemoveReason;}) => void
  

• 注意

  当房间内的远端用户调用 unpublishStream 成功取消发布由摄像头/麦克风采集的媒体流时，本地用户会收到该回调，此时本地用户可以自行选择是否调用 unsubscribeStream 取消订阅此流。

• 参数

  • event

    类型: { userId: string; mediaType: MediaType; reason: StreamRemoveReason; }

    • 成员

      名称	类型	描述
      userId	string	移除的远端流发布用户的用户 ID
      mediaType	MediaType	远端媒体流的类型
      reason	StreamRemoveReason	远端流移除的原因

onUserPublishScreen

房间内新增远端屏幕共享音视频流的回调。

• 类型

  (event: { userId: string; mediaType: MediaType;}) => void
  

• 注意

  当房间内的远端用户调用 publishScreen 成功发布来自屏幕共享的音视频流时，本地用户会收到该回调，此时本地用户可以自行选择是否调用 subscribeScreen 订阅此流。

• 参数

  • event

    类型: { userId: string; mediaType: MediaType; }

    • 成员

      名称	类型	描述
      userId	string	远端流发布用户的用户 ID
      mediaType	MediaType	远端媒体流的类型

onUserUnpublishScreen

房间内远端屏幕共享音视频流移除的回调。

• 类型

  (event: { userId: string; mediaType: MediaType; reason: StreamRemoveReason;}) => void
  

• 注意

  当房间内的远端用户调用 unpublishScreen 成功取消发布由摄像头/麦克风采集的媒体流时，本地用户会收到该回调，此时本地用户可以自行选择是否调用 unsubscribeScreen 取消订阅此流。

• 参数

  • event

    类型: { userId: string; mediaType: MediaType; reason: StreamRemoveReason; }

    • 成员

      名称	类型	描述
      userId	string	移除的远端流发布用户的用户 ID
      mediaType	MediaType	远端媒体流的类型
      reason	StreamRemoveReason	远端流移除的原因

onRemoteVideoFirstFrame

视频首帧渲染

• 类型

  (event: onVideoFirstFrameRenderedEvent) => void
  

• 参数

  • event

    类型: onVideoFirstFrameRenderedEvent

onRemoteAudioFirstFrame

远端音频首帧播放事件

• 类型

  (event: onAudioFirstFrameDecodedEvent) => void
  

• 参数

  • event

    类型: onAudioFirstFrameDecodedEvent

onVideoDeviceStateChanged

视频媒体设备状态改变。

• 类型

  (event: DeviceInfo) => void
  

• 参数

  • event

    类型: DeviceInfo

    媒体设备信息及状态。

onAudioDeviceStateChanged

音频媒体设备状态改变。

• 类型

  (event: DeviceInfo) => void
  

• 参数

  • event

    类型: DeviceInfo

    媒体设备信息及状态。

onTrackEnded

断流事件，建议在回调里重新采集。

• 类型

  (event: { kind: string; isScreen: boolean;}) => void
  

• 参数

  • event

    类型: { kind: string; isScreen: boolean; }

    • 成员

      名称	类型	描述
      kind	string	媒体流类型，参看 kind。
      isScreen	boolean	是否屏幕流

onRoomMessageReceived

接收到房间内广播消息的事件。

• 类型

  (event: { userId: string; message: any;}) => void
  

• 参数

  • event

    类型: { userId: string; message: any; }

    • 成员

      名称	类型	描述
      userId	string	发送消息用户的 userId
      message	any	消息内容

onRoomBinaryMessageReceived

接收到房间内二进制广播消息的事件。

• 类型

  (event: { userId: string; message: ArrayBuffer;}) => void
  

• 参数

  • event

    类型: { userId: string; message: ArrayBuffer; }

    • 成员

      名称	类型	描述
      userId	string	发送消息用户的 userId
      message	ArrayBuffer	消息内容

onUserMessageReceived

收到来自房间中其他用户通过 sendUserMessage 发来的点对点文本消息时，会收到此事件

• 类型

  (event: UserMessageEvent) => void
  

• 参数

  • event

    类型: UserMessageEvent

onUserBinaryMessageReceived

收到来自房间中其他用户通过 sendUserBinaryMessage 发来的点对点二进制消息时，会收到此事件

• 类型

  (event: UserBinaryMessageEvent) => void
  

• 参数

  • event

    类型: UserBinaryMessageEvent

onRemoteStreamStats

用户订阅的远端音/视频流统计信息以及网络状况，统计周期为 2s

• 类型

  (stats: RemoteStreamStats) => void
  

• 参数

  • stats

    类型: RemoteStreamStats

onLocalStreamStats

本地音/视频流统计信息以及网络状况，统计周期为 2s

• 类型

  (stats: LocalStreamStats) => void
  

• 参数

  • stats

    类型: LocalStreamStats