跳转到主要内容

频道内事件(onNotifyChannelEvent)

通过 srtc.onNotifyChannelEvent 注册回调,建议在 join 前设置:
srtc.onNotifyChannelEvent = (evt: ChannelEvent) => {
  switch (evt.type) {
    case ChannelEventType.USER_JOIN:
      // evt.data as UserInfo
      break;
    case ChannelEventType.TRACK_PIP_ENTER:
      // evt.data as BaseTrack
      break;
  }
};

频道与连接

事件常量字符串值触发时机data 类型
JOIN_SUCCEED'join_succeed'首次加入频道成功ChannelInfo
CHANNEL_UPDATE'channel_update'频道自定义属性 props 被更新ChannelInfo
ME_UPDATE'me_update'自己的用户信息被服务端更新UserInfo
RECONNECTING'reconnecting'网络波动,开始自动重连
RECONNECTED'reconnected'自动重连成功ChannelInfo
DISCONNECTED'disconnected'被强制踢出或发生不可恢复错误DisconnectEventData
CUSTOM_MSG'custom_msg'收到频道内自定义消息CustomMsgData

远端用户与流

事件常量字符串值触发时机data 类型
USER_JOIN'user_join'远端用户加入频道UserInfo
USER_UPDATE'user_update'远端用户信息更新UserInfo
USER_LEAVE'user_leave'远端用户离开频道UserLeaveEventData
USER_TRACK_ADD'user_track_add'远端用户发布了新轨道{ user: UserInfo, track: TrackInfo }
USER_TRACK_UPDATE'user_track_update'远端用户更新了轨道信息{ user: UserInfo, track: TrackInfo }
USER_TRACK_REMOVE'user_track_remove'远端用户停止发布某轨道{ user: UserInfo, track: TrackInfo }
SDK 内部会在远端用户离开时自动取消订阅该用户的所有轨道;在 USER_TRACK_REMOVE 时自动取消订阅对应轨道。

轨道与外设

事件常量字符串值触发时机data 类型
TRACK_MUTED'track_muted'某轨道暂停发送数据BaseTrack
TRACK_UNMUTED'track_unmuted'某轨道恢复发送数据BaseTrack
TRACK_ENDED'track_ended'轨道停止,例如设备拔出、用户点击浏览器“停止共享”BaseTrack
TRACK_AUTOPLAY_FAIL'track_autoplay_fail'浏览器阻止自动播放,需要在用户手势后重新调用 startPlayBaseTrack
TRACK_PIP_ENTER'track_pip_enter'某视频轨道进入画中画模式BaseTrack
TRACK_PIP_EXIT'track_pip_exit'某视频轨道退出画中画模式BaseTrack
TRACK_POPOUT_OPEN'track_popout_open'某视频轨道弹出到独立窗口BaseTrack
TRACK_POPOUT_CLOSE'track_popout_close'某视频轨道关闭独立窗口BaseTrack
DEVICE_ADD'device_add'外设插入MediaDeviceInfo
DEVICE_REMOVE'device_remove'外设拔出MediaDeviceInfo

频道外消息事件(onNotifyImEvent)

通过 srtc.onNotifyImEvent 注册回调,需先调用 srtc.enableIm(token)
srtc.onNotifyImEvent = (evt: ImEvent) => {
  switch (evt.type) {
    case ImEventType.IM_MSG:
      // evt.data as ImMsgData
      break;
  }
};
事件常量字符串值触发时机data 类型
ENABLE_SUCCEED'enable_succeed'IM 首次连接成功
IM_MSG'im_msg'收到 IM 消息ImMsgData
RECONNECTING'reconnecting'IM 连接断开,开始重连
RECONNECTED'reconnected'IM 重连成功
DISCONNECTED'disconnected'IM 被强制断开ImDisconnectEventData