ZEGO::EXPRESS::IZegoEventHandler

Declared in ZegoExpressEventHandler.h

onDebugError - 调试错误信息回调
onEngineStateUpdate - 引擎状态更新回调
onRoomStateUpdate - 房间状态变化通知
onRoomUserUpdate - 房间内其他用户增加或减少的通知回调
onRoomOnlineUserCountUpdate - 房间内当前在线用户数量回调
onRoomStreamUpdate - 相同房间内其他用户推的流增加或减少的通知
onRoomStreamExtraInfoUpdate - 房间内流附加信息更新通知
onPublisherStateUpdate - 推流状态回调
onPublisherQualityUpdate - 推流质量回调
onPublisherCapturedAudioFirstFrame - 推流端音频采集首帧回调
onPublisherCapturedVideoFirstFrame - 推流端视频采集首帧回调
onPublisherVideoSizeChanged - 采集视频大小变更回调
onPublisherRelayCDNStateUpdate - 添加/删除转推 CDN 地址状态回调
onPlayerStateUpdate - 拉流状态变更回调
onPlayerQualityUpdate - 拉流质量回调
onPlayerMediaEvent - 拉流媒体事件回调
onPlayerRecvAudioFirstFrame - 拉流端音频接收首帧回调
onPlayerRecvVideoFirstFrame - 拉流端视频接收首帧回调
onPlayerRenderVideoFirstFrame - 拉流端渲染完视频首帧回调
onPlayerVideoSizeChanged - 拉流分辨率变更通知
onPlayerRecvSEI - 收到远端流的 SEI 内容
onMixerRelayCDNStateUpdate - 混流转推 CDN 状态更新通知
onMixerSoundLevelUpdate - 混流中的每条单流的的声浪更新通知
onAudioDeviceStateChanged - 音频设备状态改变
onVideoDeviceStateChanged - 视频设备状态改变
onCapturedSoundLevelUpdate - 本地采集音频声浪回调
onRemoteSoundLevelUpdate - 远端拉流音频声浪回调
onCapturedAudioSpectrumUpdate - 本地采集音频频谱回调
onRemoteAudioSpectrumUpdate - 远端拉流音频频谱回调
onDeviceError - 设备异常通知
onRemoteCameraStateUpdate - 远端摄像头设备状态通知
onRemoteMicStateUpdate - 远端麦克风设备状态通知
onIMRecvBroadcastMessage - 接收房间广播消息通知
onIMRecvBarrageMessage - 接收房间弹幕消息通知
onIMRecvCustomCommand - 接收自定义信令通知

Public Func Docs

onDebugError

public void onDebugError (int, const std::string &, const std::string &)

调试错误信息回调

Parameters
errorCode	错误码，详情请参考常用错误码文档 []
funcName	接口名
info	错误的详细信息

onEngineStateUpdate

public void onEngineStateUpdate (ZegoEngineState)

引擎状态更新回调

Parameters
state	---

onRoomStateUpdate

public void onRoomStateUpdate (const std::string &, ZegoRoomState, int, const std::string &)

房间状态变化通知

Parameters
roomID	房间 ID，最大长度为 128 字节的字符串。
state	变化后的的房间状态
errorCode	错误码，详情请参考常用
extendedData	状态更新附带的扩展信息。备用，目前仅返回空 json 表

onRoomUserUpdate

public void onRoomUserUpdate (const std::string &, ZegoUpdateType, const std::vector< ZegoUser > &)

房间内其他用户增加或减少的通知回调

Parameters
roomID	用户已登录的房间 ID，最大长度为 128 字节的字符串。
updateType	更新类型（添加/删除）
userList	当前房间内变更的用户列表

onRoomOnlineUserCountUpdate

public void onRoomOnlineUserCountUpdate (const std::string &, int)

房间内当前在线用户数量回调

Parameters
roomID	用户已登录的房间 ID，最大长度为 128 字节的字符串。
count	当前在线用户数量

onRoomStreamUpdate

public void onRoomStreamUpdate (const std::string &, ZegoUpdateType, const std::vector< ZegoStream > &)

相同房间内其他用户推的流增加或减少的通知

Parameters
roomID	用户已登录的房间 ID，最大长度为 128 字节的字符串。
updateType	更新类型（添加/删除）
streamList	更新的流列表

onRoomStreamExtraInfoUpdate

public void onRoomStreamExtraInfoUpdate (const std::string &, const std::vector< ZegoStream > &)

房间内流附加信息更新通知

Parameters
roomID	用户已登录的房间 ID，最大长度为 128 字节的字符串。
streamList	流附加信息更新的流列表

onPublisherStateUpdate

public void onPublisherStateUpdate (const std::string &, ZegoPublisherState, int, const std::string &)

推流状态回调

Parameters
streamID	推流的流 ID
state	推流状态
errorCode	推流状态变更对应的错误码。请参考常见错误码文档 []
extendedData	状态更新附带的扩展信息。

onPublisherQualityUpdate

public void onPublisherQualityUpdate (const std::string &, const ZegoPublishStreamQuality &)

推流质量回调

Parameters
streamID	推流的流 ID
quality	推流质量，包含了音视频帧率、码率、分辨率，RTT 等值

onPublisherCapturedAudioFirstFrame

public void onPublisherCapturedAudioFirstFrame ()

推流端音频采集首帧回调

onPublisherCapturedVideoFirstFrame

public void onPublisherCapturedVideoFirstFrame (ZegoPublishChannel)

推流端视频采集首帧回调

Parameters
channel	推流通道，如果只推一路音视频流，可以不关注该参数。

onPublisherVideoSizeChanged

public void onPublisherVideoSizeChanged (int, int, ZegoPublishChannel)

采集视频大小变更回调

Parameters
width	视频采集分辨率宽
height	视频采集分辨率宽
channel	推流通道，如果只推一路音视频流，可以不关注该参数。

onPublisherRelayCDNStateUpdate

public void onPublisherRelayCDNStateUpdate (const std::string &, const std::vector< ZegoStreamRelayCDNInfo > &)

添加/删除转推 CDN 地址状态回调

Parameters
streamID	推流的流 ID
infoList	当前 CDN 正在转推的信息列表

onPlayerStateUpdate

public void onPlayerStateUpdate (const std::string &, ZegoPlayerState, int, const std::string &)

拉流状态变更回调

Parameters
streamID	流 ID
state	拉流状态
errorCode	拉流状态变更对应的错误码。请参考常见错误码文档 []
extendedData	状态更新附带的扩展信息。备用，目前仅返回空 json 表

onPlayerQualityUpdate

public void onPlayerQualityUpdate (const std::string &, const ZegoPlayStreamQuality &)

拉流质量回调

Parameters
streamID	拉流的流 ID
quality	拉流质量，包含了音视频帧率、码率、分辨率，RTT 等值

onPlayerMediaEvent

public void onPlayerMediaEvent (const std::string &, ZegoPlayerMediaEvent)

拉流媒体事件回调

Parameters
streamID	拉流的流 ID
event	拉流时收到的具体事件

onPlayerRecvAudioFirstFrame

public void onPlayerRecvAudioFirstFrame (const std::string &)

拉流端音频接收首帧回调

Parameters
streamID	拉流的流 ID

onPlayerRecvVideoFirstFrame

public void onPlayerRecvVideoFirstFrame (const std::string &)

拉流端视频接收首帧回调

Parameters
streamID	拉流的流 ID

onPlayerRenderVideoFirstFrame

public void onPlayerRenderVideoFirstFrame (const std::string &)

拉流端渲染完视频首帧回调

Parameters
streamID	拉流的流 ID

onPlayerVideoSizeChanged

public void onPlayerVideoSizeChanged (const std::string &, int, int)

拉流分辨率变更通知

Parameters
streamID	拉流的流 ID
width	视频分辨率宽
height	视频分辨率高

onPlayerRecvSEI

public void onPlayerRecvSEI (const std::string &, const unsigned char *, unsigned int)

收到远端流的 SEI 内容

Parameters
streamID	拉流的流 ID
data	SEI 内容
dataLength	SEI 内容长度

onMixerRelayCDNStateUpdate

public void onMixerRelayCDNStateUpdate (const std::string &, const std::vector< ZegoStreamRelayCDNInfo > &)

混流转推 CDN 状态更新通知

Parameters
taskID	混流任务 ID
infoList	当前 CDN 正在混流的信息列表

onMixerSoundLevelUpdate

public void onMixerSoundLevelUpdate (const std::unordered_map< unsigned int, float > &)

混流中的每条单流的的声浪更新通知

Parameters
soundLevels	混流中每条单流的声浪键值对，key 为每条单流的 soundLevelID，value 为对应的单流的声浪值，value 的取值范围为 0.0 ~ 100.0

onAudioDeviceStateChanged

public void onAudioDeviceStateChanged (ZegoUpdateType, ZegoAudioDeviceType, const ZegoDeviceInfo &)

音频设备状态改变

Parameters
updateType	更新类型（添加/删除）
deviceType	音频设备类型
deviceInfo	音频设备信息

onVideoDeviceStateChanged

public void onVideoDeviceStateChanged (ZegoUpdateType, const ZegoDeviceInfo &)

视频设备状态改变

Parameters
updateType	更新类型（添加/删除）
deviceInfo	视频设备信息

onCapturedSoundLevelUpdate

public void onCapturedSoundLevelUpdate (float)

本地采集音频声浪回调

Parameters
soundLevel	本地采集的声浪值，取值范围为 0.0 ~ 100.0

onRemoteSoundLevelUpdate

public void onRemoteSoundLevelUpdate (const std::unordered_map< std::string, float > &)

远端拉流音频声浪回调

Parameters
soundLevels	远端的声浪键值对，key 为流 ID，value 为对应的流的声浪值，value 取值范围为 0.0 ~ 100.0

onCapturedAudioSpectrumUpdate

public void onCapturedAudioSpectrumUpdate (const ZegoAudioSpectrum &)

本地采集音频频谱回调

Parameters
audioSpectrum	本地采集的音频频谱值数组，频谱值范围为 [0-2^30]

onRemoteAudioSpectrumUpdate

public void onRemoteAudioSpectrumUpdate (const std::unordered_map< std::string, ZegoAudioSpectrum > &)

远端拉流音频频谱回调

Parameters
audioSpectrums	远端音频频谱键值对，key 是流 ID，value 为对应的流的音频频谱值数组，频谱值范围为 [0-2^30]

onDeviceError

public void onDeviceError (int, const std::string &)

设备异常通知

Parameters
errorCode	设备异常的错误码。请参考常见错误码文档 []
deviceName	设备名称

onRemoteCameraStateUpdate

public void onRemoteCameraStateUpdate (const std::string &, ZegoRemoteDeviceState)

远端摄像头设备状态通知

Parameters
streamID	拉流的流 ID
state	远端摄像头状态

onRemoteMicStateUpdate

public void onRemoteMicStateUpdate (const std::string &, ZegoRemoteDeviceState)

远端麦克风设备状态通知

Parameters
streamID	拉流的流 ID
state	远端麦克风状态

onIMRecvBroadcastMessage

public void onIMRecvBroadcastMessage (const std::string &, std::vector< ZegoBroadcastMessageInfo >)

接收房间广播消息通知

Parameters
roomID	房间 ID
messageList	收到的消息列表

onIMRecvBarrageMessage

public void onIMRecvBarrageMessage (const std::string &, std::vector< ZegoBarrageMessageInfo >)

接收房间弹幕消息通知

Parameters
roomID	房间 ID
messageList	收到的消息列表

onIMRecvCustomCommand

public void onIMRecvCustomCommand (const std::string &, ZegoUser, const std::string &)

接收自定义信令通知

Parameters
roomID	房间 ID
fromUser	信令的发送人
command	信令内容