API Reference for windows - IChannelEventHandler
更新时间: 2023-10-23 16:45:52
rtc::IRTCChannelEventHandler类 参考
Public 成员函数 | |
virtual | ~IRTCChannelEventHandler () |
virtual void | onJoinChannelSuccess (const char *channelId, uint32_t uid) |
virtual void | onLeaveChannel (const char *channelId) |
virtual void | onUserJoined (const char *chcannelId, uint32_t uid) |
virtual void | onUserOffline (const char *channelId, uint32_t uid) |
virtual void | onChannelWarning (const char *channelId, int warn, const char *msg) |
virtual void | onChannelError (const char *channelId, int err, const char *msg) |
virtual void | onFirstRemoteVideoFrame (const char *channelId, uint32_t uid, int width, int height, int elapsed) |
virtual void | onFirstRemoteAudioFrame (const char *channelId, uint32_t uid, int elapsed) |
virtual void | onRemoteVideoStateChanged (const char *channelId, uint32_t uid, RTC_REMOTE_VIDEO_STATE state, RTC_REMOTE_VIDEO_STATE_REASON reason, int elapsed) |
virtual void | onRemoteAudioStateChanged (const char *channelId, uint32_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) |
virtual void | onRtcStats (const char *channelId, const rtc::RTCStats &stats) |
virtual void | onClientRoleChanged (const char *channelId, CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole) |
virtual void | onSeiTimestampArrived (const char *channelId, UserId uid, uint64_t seiTime) |
virtual void | onConnectionStateChanged (const char *channelId, rtc::RTC_CONNECTION_STATE_TYPE state, rtc::CONNECTION_CHANGED_REASON_TYPE reason) |
virtual void | onVideoBufferingStateChanged (UserId uid, rtc::VIDEO_BUFFERING_STATE state, int64_t timestampInMs) |
virtual void | onStreamMessage (UserId uid, const char *data, size_t length) |
virtual void | onRemoteStreamSubscribeAdvice (const char *channelId, UserId uid, rtc::REMOTE_VIDEO_STREAM_TYPE currentStreamType, rtc::REMOTE_VIDEO_STREAM_TYPE suitableStreamType) |
virtual void | onAudioPublishStateChange (const char *channelId, rtc::STREAM_PUBLISH_STATE oldState, rtc::STREAM_PUBLISH_STATE newState, int elapseSinceLastState) |
virtual void | onVideoPublishStateChange (const char *channelId, rtc::STREAM_PUBLISH_STATE oldState, rtc::STREAM_PUBLISH_STATE newState, int elapseSinceLastState) |
virtual void | onAudioSubscribeStateChange (const char *channelId, UserId uid, rtc::STREAM_SUBSCRIBE_STATE oldState, rtc::STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) |
virtual void | onVideoSubscribeStateChange (const char *channelId, UserId uid, rtc::STREAM_SUBSCRIBE_STATE oldState, rtc::STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) |
virtual void | onRtmpStreamingStateChanged (const char *channelId, const char *url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR errCode) |
virtual void | onRemoteVideoStats (const RemoteVideoStats stats) |
virtual void | onRemoteAudioStats (const RemoteAudioStats stats) |
virtual void | onChannelMediaRelayStateChanged (CHANNEL_MEDIA_RELAY_STATE state, CHANNEL_MEDIA_RELAY_ERROR code) |
virtual void | onChannelMediaRelayEvent (CHANNEL_MEDIA_RELAY_EVENT code) |
构造及析构函数说明
◆ ~IRTCChannelEventHandler()
| virtual |
成员函数说明
◆ onJoinChannelSuccess()
| virtual |
加入频道回调。
该回调方法表示该客户端 joinChannel 成功加入了指定的频道。
- 参数
channelId channel对象 myId 用户id room 房间名
◆ onLeaveChannel()
| virtual |
退出频道回调。
该回调方法表示该客户端 leaveChannel 成功退出了指定的频道。
- 参数
channelId channel对象 channelId 用户ID
◆ onUserJoined()
| virtual |
有用户加入房间; 由 joinChannel 接口触发
- 参数
channelId channel对象 [in] uid 加入房间的用户
◆ onUserOffline()
| virtual |
当有用户退出房间; 由leaveChannel 接口触发
- 参数
channelId channel对象 [in] uid 退出房间的用户
◆ onChannelWarning()
| virtual |
房间内警告消息
- 参数
channelId channel对象 warn 警告码,详见 RTC_RET_CODE msg 警告信息
◆ onChannelError()
| virtual |
LiveRoom 内部一些处理结果通知
- 参数
channelId channel对象 code 执行结果。详见: RTC_RET_CODE msg 消息
◆ onFirstRemoteVideoFrame()
| virtual |
收到远程用户共享的第一帧视频, 只有使用sdk渲染才能收到该回调, 使用自渲染收不到该回调
- 参数
channelId channel对象 uid 用户id width 宽 height 高
◆ onFirstRemoteAudioFrame()
| virtual |
收到远程用户共享的第一帧音频
- 参数
channelId channel对象 uid uid elapsed 从本地用户调用 joinChannel 方法到发生本事件经历的时间,单位为 ms。
◆ onRemoteVideoStateChanged()
| virtual |
远端视频状态回调
- 参数
channelId channel对象 uid 用户id state 详见: RTC_REMOTE_VIDEO_STATE reason 详见: RTC_REMOTE_VIDEO_STATE_REASON elapsed 详见: 从本地用户调用 joinRoom 方法到发生本事件经历的时间,单位为 ms。
◆ onRemoteAudioStateChanged()
| virtual |
远端音频状态的回调
- 参数
channelId channel对象 uid 用户id state 详见: REMOTE_AUDIO_STATE reason 详见: REMOTE_AUDIO_STATE_REASON elapsed 从本地用户调用 joinRoom 方法到发生本事件经历的时间,单位为 ms。
◆ onRtcStats()
| virtual |
每两秒钟报告一次当前呼叫会话的统计信息
- 参数
channelId channel对象 stats 详见: RTCStats
◆ onClientRoleChanged()
| virtual |
新增回调,自己在房间的角色发生变化,角色类型:主播和观众;该变化由 setClientRole 接口触发
- 参数
channelId channel对象 oldRole 原来的角色 newRole 新的角色
◆ onSeiTimestampArrived()
| virtual |
本端收到sei时间戳的回调, 单位ms, 接收频率取决于发送端的发送频率, 业务端还可以使用 getCurSeiTimestamp 获取当前最新时间戳
- 参数
channelId channel对象 uid 用户id seiTime seiTime
◆ onConnectionStateChanged()
| virtual |
网络连接状态已改变回调。 该回调在网络连接状态发生改变的时候触发,并告知用户当前的网络连接状态和引起网络状态改变的原因。
- 参数
channelId channel对象 state 详见 RTC_CONNECTION_STATE_TYPE reason 原因
◆ onVideoBufferingStateChanged()
| virtual |
远端卡顿回调
- 参数
channelId channel对象 uid 远端用户ID, state 详见: VIDEO_BUFFERING_STATE timestampInMs 时间戳
◆ onStreamMessage()
| virtual |
irc信息
- 参数
channelId channel对象 uid 远端用户ID, data irc数据 length data长度
◆ onRemoteStreamSubscribeAdvice()
| virtual |
建议设置的流类型
- 参数
channelId channel对象 uid 用户Id currentStreamType 当前流类型 详见:REMOTE_VIDEO_STREAM_TYPE suitableStreamType 建议流类型 详见:REMOTE_VIDEO_STREAM_TYPE
◆ onAudioPublishStateChange()
| virtual |
音频发布状态改变回调。
- 参数
channelId channel对象 oldState 之前的发布状态 详见: STREAM_PUBLISH_STATE newState 当前的发布状态 详见: STREAM_PUBLISH_STATE elapseSinceLastState 两次状态变化时间间隔(毫秒)
◆ onVideoPublishStateChange()
| virtual |
视频发布状态改变回调。
- 参数
channelId channel对象 channel 频道名 oldState 之前的发布状态 详见: STREAM_PUBLISH_STATE newState 当前的发布状态 详见: STREAM_PUBLISH_STATE elapseSinceLastState 两次状态变化时间间隔(毫秒)
◆ onAudioSubscribeStateChange()
| virtual |
音频订阅状态发生改变回调。
- 参数
channelId channel对象 channel 频道名 uid 远端用户的 ID。 oldState 之前的发布状态 详见: STREAM_SUBSCRIBE_STATE newState 当前的发布状态 详见: STREAM_SUBSCRIBE_STATE elapseSinceLastState 两次状态变化时间间隔(毫秒)
◆ onVideoSubscribeStateChange()
| virtual |
视频订阅状态发生改变回调。
- 参数
channelId channel对象 channel 频道名 uid 远端用户的 ID。 oldState 之前的发布状态 详见: STREAM_SUBSCRIBE_STATE newState 当前的发布状态 详见: STREAM_SUBSCRIBE_STATE elapseSinceLastState 两次状态变化时间间隔(毫秒)
◆ onRtmpStreamingStateChanged()
| virtual |
rtmp 旁路推流状态发生变化及原因
- 参数
channelId channel对象 url 推流地址 state 详见: RTMP_STREAM_PUBLISH_STATE errCode 详见: RTMP_STREAM_PUBLISH_ERROR
◆ onRemoteVideoStats()
| virtual |
通话中远端视频流的统计信息回调。
- 参数
stats 详见: RemoteVideoStats
◆ onRemoteAudioStats()
| virtual |
通话中远端视频流的统计信息回调。
- 参数
stats 详见: RemoteAudioStats
◆ onChannelMediaRelayStateChanged()
| virtual |
跨频道媒体流转发状态发生改变回调。 当跨频道媒体流转发状态发生改变时,SDK 会触发该回调, 并报告当前的转发状态以及相关的错误信息
- 参数
state 跨频道媒体流转发状态 详见: CHANNEL_MEDIA_RELAY_STATE code 跨频道媒体流转发出错的错误码 详见: CHANNEL_MEDIA_RELAY_ERROR
◆ onChannelMediaRelayEvent()
| virtual |
跨频道媒体流转发事件回调。 该回调报告跨频道媒体流转发过程中发生的事件。
- 参数
code 跨频道媒体流转发事件码 详见: CHANNEL_MEDIA_RELAY_EVENT
该类的文档由以下文件生成: