Events #

Events #

类型：interface

'first-remote-video-render' #

first-remote-video-render 事件
SDK 拉流首帧事件，客户端视频首帧渲染成功时触发的回调

• 参数
  无
• 示例

  vePlayer.on('first-remote-video-render', () => {
      // do something
  });
  

message #

message 事件
运行过程中，云机实例发送到客户端的自定义消息事件回调

• 类型

  (response: { userId: string; text: string; mid: string; time: number;}) => void
  

• 参数

  • response
    类型：{ userId: string; text: string; mid: string; time: number; }

    • 成员

      名称	类型	描述
      userId	string	消息发送方的用 ID
      text	string	消息内容
      mid	string	消息唯一标识 ID
      time	number	消息发送时的时间戳

• 示例

  vePlayer.on('message', (res) => {
     console.log(res);
   });
  

'general-message-received' #

运行过程中，云机实例发送到客户端的消息已接收回调

• 类型

  (response: { from: string; to: string; msg: any;}) => void
  

• 参数

  • response
    类型：{ from: string; to: string; msg: any; }

    • 成员

      名称	类型	描述
      from	string	消息发送端 ID
      to	string	消息接收端 ID
      msg	any	消息内容

• 示例

  vePlayer.on('general-message-received', (res) => {
     console.log(res);
   });
  

'clipboard-message-received' #

clipboard-message-received 事件
运行过程中，云机实例剪贴板发生变化时的回调。

• 类型

  (response: string[]) => void
  

• 参数

  • response
    类型：string[]
    剪贴板内容，为一个字符串数组

• 示例

  vePlayer.on('clipboard-message-received', (res) => {
     console.log(res[0]);
   });
  

'error' #

error 事件
SDK 运行过程中的错误回调

• 类型

  (err: { errorCode: number; errorMessage: string;}) => void
  

• 参数

  • err
    类型：{ errorCode: number; errorMessage: string; }

    • 成员

      名称	类型	描述
      errorCode	number	错误码
      errorMessage	string	错误信息

• 示例

  vePlayer.on('error', (err) => {
     console.log(err);
   });
  

'warning' #

warning 事件
SDK 运行过程中的警告回调

• 类型

  (warning: { warningCode: number; message: string;}) => void
  ts
  

• 参数

  • warning
    类型：{ warningCode: number; message: string; }

    • 成员

      名称	类型	描述
      warningCode	number	警告码
      message	string	警告信息

• 示例

  vePlayer.on('warning', (warning) => {
      console.log(err);
   });
  

'message-channel-connected' #

message-channel-connected 事件
消息收发通道就绪的事件

• 类型

  () => void
  

• 示例

  vePlayer.on('message-channel-connected', () => {
   });
  

'message-channel-online' #

message-channel-online 事件
通过消息通道收发消息时，云机实例在线的回调

• 类型

  () => void
  

• 示例

  vePlayer.on('message-channel-online', () => {
   });
  

'message-channel-offline' #

message-channel-offline 事件
通过消息通道收发消息时，云机实例离线的回调（发送消息可能失败）

• 类型

  () => void
  

• 示例

  vePlayer.on('message-channel-offline', () => {
   });
  

'stream-reconnecting' #

stream-reconnecting 事件
视频流开始重连的回调

• 类型

  () => void
  

• 示例

  vePlayer.on('stream-reconnecting', () => {
   });
  

'stream-reconnected' #

stream-reconnected 事件
视频流重连成功的回调

• 类型

  () => void
  

• 示例

  vePlayer.on('stream-reconnected', () => {
   });
  

'remote-app-switched-background' #

remote-app-switched-background 事件
云机应用切换到后台的回调

• 类型

  () => void
  

• 示例

  vePlayer.on('remote-app-switched-background', () => {
   });
  

'remote-app-switched-foreground' #

remote-app-switched-foreground 事件
云机应用切换到前台的回调

• 类型

  () => void
  

• 示例

  vePlayer.on('remote-app-switched-foreground', () => {
   });
  

'remote-stream-start-request' #

remote-stream-start-request 事件
收到云机请求开始音视频数据事件回调。

• 类型

  (response: { isAudio: boolean; isVideo: boolean; videoWidth?: number; videoHeight?: number; facingMode: string;}) => void
  

• 参数

  • response
    类型：{ isAudio: boolean; isVideo: boolean; videoWidth?: number | undefined; videoHeight?: number | undefined; facingMode: 'user' | 'environment'; }

    • 成员

      名称	类型	描述
      isAudio	boolean	是否音屏
      isVideo	boolean	是否视频
      videoWidth	number | undefined	视频宽度
      videoHeight	number | undefined	视频高度
      facingMode	string	云手机的摄像头类型。包含以下值： user：前置摄像头； environment：后置摄像头。 人脸识别类场景中，可以使用该参数判断是否增加亮度调节提示，以提升人脸识别成功率。

• 示例

  vePlayer.on('remote-stream-start-request', (res) => {
     console.log(res);
   });
  

'remote-stream-stop-request' #

remote-stream-stop-request 事件
收到云机请求停止音频数据事件回调。

• 类型

  (response: { isAudio: boolean; isVideo: boolean;}) => void
  

• 参数

  • response
    类型：{ isAudio: boolean; isVideo: boolean; }

    • 成员

      名称	类型	描述
      isAudio	boolean	是否音屏
      isVideo	boolean	是否视频

• 示例

  vePlayer.on('remote-stream-stop-request', (res) => {
     console.log(res);
   });
  

'start-audio-capture' #

start-audio-capture 事件
音频采集开始回调。

• 类型

  () => void
  

• 示例

  vePlayer.on('start-audio-capture', () => {
   });
  

'stop-audio-capture' #

stop-audio-capture 事件
音频采集结束回调。

• 类型

  () => void
  

• 示例

  vePlayer.on('stop-audio-capture', () => {
   });
  

'start-video-capture' #

start-video-capture 事件
相机采集开始回调。

• 类型

  () => void
  

• 示例

  vePlayer.on('start-video-capture', () => {
   });
  

'stop-video-capture' #

stop-video-capture 事件
相机采集结束回调。

• 类型

  () => void
  

• 示例

  vePlayer.on('stop-video-capture', () => {
   });
  

'audio-playback-route-updated' #

audio-playback-route-updated 事件
更新音频播放设备回调。

• 类型

  (response: { deviceId: string;}) => void
  

• 参数

  • response
    类型：{ deviceId: string; }

    • 成员

      名称	类型	描述
      deviceId	string	设备Id

• 示例

  vePlayer.on('audio-playback-route-updated', (res) => {
     console.log(res);
   });
  

'audio-capture-route-updated' #

audio-capture-route-updated 事件
更新音频采集设备回调。

• 类型

  (response: { deviceId: string;}) => void
  

• 参数

  • response
    类型：{ deviceId: string; }

    • 成员

      名称	类型	描述
      deviceId	string	设备Id

• 示例

  vePlayer.on('audio-capture-route-updated', (res) => {
     console.log(res);
   });
  

'send-stream-stats' #

send-stream-stats 事件
发送流状态回调。

• 类型

  (response: { stats: LocalAudioStats;}) => void
  

• 参数

  • response
    类型：{ stats: LocalAudioStats; }

    • 成员

      名称	类型	描述
      stats	LocalAudioStats	本地音频流统计信息及网络状况

• 示例

  vePlayer.on('send-stream-stats', (res) => {
     console.log(res);
   });
  

'received-stream-stats' #

received-stream-stats 事件
接收流状态回调。

• 类型

  (response: { stats: LocalVideoStats;}) => void
  

• 参数

  • response
    类型：{ stats: LocalVideoStats; }

    • 成员

      名称	类型	描述
      stats	LocalVideoStats	本地音频流统计信息以及网络状况

• 示例

  vePlayer.on('received-stream-stats', (res) => {
     console.log(res.stats);
   });