事件参考

频道内事件（onNotifyChannelEvent）

通过 srtc.onNotifyChannelEvent 注册回调，建议在 join 前设置：

srtc.onNotifyChannelEvent = (evt: ChannelEvent) => {
  switch (evt.type) {
    case ChannelEventType.USER_JOIN:
      // evt.data
      break;
    case ChannelEventType.TRACK_PIP_ENTER:
      // evt.data
      break;
  }
};

ChannelEvent 与 ImEvent 在类型层面均为判别联合：当你按 switch (evt.type) 分支处理时，evt.data 会跟随事件类型自动收窄到对应的数据结构。若只在 TypeScript 中用它们做类型标注，建议使用 import type 导入。

频道与连接

事件常量	字符串值	触发时机	data 类型
`JOIN_SUCCEED`	`'join_succeed'`	首次加入频道成功	`ChannelInfo`
`CHANNEL_UPDATE`	`'channel_update'`	频道自定义属性 `props` 被更新	`ChannelInfo`
`ME_UPDATE`	`'me_update'`	自己的用户信息被服务端更新	`UserInfo`
`RECONNECTING`	`'reconnecting'`	网络波动，开始自动重连	无
`RECONNECTED`	`'reconnected'`	自动重连成功	无
`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'`	浏览器阻止自动播放，需要在用户手势后重新调用 `startPlay`	`BaseTrack`
`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`

网络质量与活跃说话人

事件常量	字符串值	触发时机	data 类型
`CONNECTION_QUALITY_CHANGED`	`'connection_quality_changed'`	连接质量等级发生变化	`ConnectionQualityEventData`
`CPU_CONSTRAINED`	`'cpu_constrained'`	发送端持续受到 CPU 限制	`QualityEvaluation`
`BANDWIDTH_CONSTRAINED`	`'bandwidth_constrained'`	发送端持续受到带宽限制	`QualityEvaluation`
`ACTIVE_SPEAKERS_CHANGED`	`'active_speakers_changed'`	当前活跃说话人列表发生变化，仅 SeaStart SFU 支持	`ActiveSpeakersEventData`

ACTIVE_SPEAKERS_CHANGED 的 data.speakers 为当前正在说话用户的全量快照，按 level 从高到低排序；无人说话时返回空数组，业务层可直接覆盖 UI 状态，无需自行合并增量。

频道外消息事件（onNotifyImEvent）

通过 srtc.onNotifyImEvent 注册回调，需先调用 srtc.enableIm(token)：

srtc.onNotifyImEvent = (evt: ImEvent) => {
  switch (evt.type) {
    case ImEventType.IM_MSG:
      // evt.data
      break;
  }
};

事件常量	字符串值	触发时机	data 类型
`ENABLE_SUCCEED`	`'enable_succeed'`	IM 首次连接成功	无
`IM_MSG`	`'im_msg'`	收到 IM 消息	`ImMsgData`
`RECONNECTING`	`'reconnecting'`	IM 连接断开，开始重连	无
`RECONNECTED`	`'reconnected'`	IM 重连成功	无
`DISCONNECTED`	`'disconnected'`	IM 被强制断开	`ImDisconnectEventData`

概览

iOS SDK

Swift SDK（iOS/macOS）

Android SDK

Windows SDK

Web SDK

微信小程序 SDK

服务端 API

全平台 C++ SDK

频道内事件（onNotifyChannelEvent）

频道与连接

远端用户与流

轨道与外设

网络质量与活跃说话人

频道外消息事件（onNotifyImEvent）

​频道内事件（onNotifyChannelEvent）

​频道与连接

​远端用户与流

​轨道与外设

​网络质量与活跃说话人

​频道外消息事件（onNotifyImEvent）

频道内事件（onNotifyChannelEvent）

频道与连接

远端用户与流

轨道与外设

网络质量与活跃说话人

频道外消息事件（onNotifyImEvent）