ZegoEventHandler

Declared in ZegoExpressEventHandler.h

Includes

Public Func Lists

Public Func Docs

onDebugError:funcName:info:

- (void)onDebugError:(int) errorCode funcName:(NSString *) funcName info:(NSString *) info;

调试错误信息回调

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

onEngineStateUpdate:

- (void)onEngineStateUpdate:(ZegoEngineState) state;

引擎状态更新回调

Parameters
state ---

onRoomStateUpdate:errorCode:extendedData:roomID:

- (void)onRoomStateUpdate:(ZegoRoomState) state errorCode:(int) errorCode extendedData:(nullable NSDictionary *) extendedData roomID:(NSString *) roomID;

房间状态变化通知

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

onRoomUserUpdate:userList:roomID:

- (void)onRoomUserUpdate:(ZegoUpdateType) updateType userList:(NSArray< ZegoUser * > *) userList roomID:(NSString *) roomID;

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

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

onRoomOnlineUserCountUpdate:roomID:

- (void)onRoomOnlineUserCountUpdate:(int) count roomID:(NSString *) roomID;

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

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

onRoomStreamUpdate:streamList:roomID:

- (void)onRoomStreamUpdate:(ZegoUpdateType) updateType streamList:(NSArray< ZegoStream * > *) streamList roomID:(NSString *) roomID;

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

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

onRoomStreamExtraInfoUpdate:roomID:

- (void)onRoomStreamExtraInfoUpdate:(NSArray< ZegoStream * > *) streamList roomID:(NSString *) roomID;

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

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

onPublisherStateUpdate:errorCode:extendedData:streamID:

- (void)onPublisherStateUpdate:(ZegoPublisherState) state errorCode:(int) errorCode extendedData:(nullable NSDictionary *) extendedData streamID:(NSString *) streamID;

推流状态回调

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

onPublisherQualityUpdate:streamID:

- (void)onPublisherQualityUpdate:(ZegoPublishStreamQuality *) quality streamID:(NSString *) streamID;

推流质量回调

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

onPublisherCapturedAudioFirstFrame

- (void)onPublisherCapturedAudioFirstFrame:;

推流端音频采集首帧回调

onPublisherCapturedVideoFirstFrame:

- (void)onPublisherCapturedVideoFirstFrame:(ZegoPublishChannel) channel;

推流端视频采集首帧回调

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

onPublisherVideoSizeChanged:channel:

- (void)onPublisherVideoSizeChanged:(CGSize) size channel:(ZegoPublishChannel) channel;

采集视频大小变更回调

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

onPublisherRelayCDNStateUpdate:streamID:

- (void)onPublisherRelayCDNStateUpdate:(NSArray< ZegoStreamRelayCDNInfo * > *) infoList streamID:(NSString *) streamID;

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

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

onPlayerStateUpdate:errorCode:extendedData:streamID:

- (void)onPlayerStateUpdate:(ZegoPlayerState) state errorCode:(int) errorCode extendedData:(nullable NSDictionary *) extendedData streamID:(NSString *) streamID;

拉流状态变更回调

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

onPlayerQualityUpdate:streamID:

- (void)onPlayerQualityUpdate:(ZegoPlayStreamQuality *) quality streamID:(NSString *) streamID;

拉流质量回调

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

onPlayerMediaEvent:streamID:

- (void)onPlayerMediaEvent:(ZegoPlayerMediaEvent) event streamID:(NSString *) streamID;

拉流媒体事件回调

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

onPlayerRecvAudioFirstFrame:

- (void)onPlayerRecvAudioFirstFrame:(NSString *) streamID;

拉流端音频接收首帧回调

Parameters
streamID 拉流的流 ID

onPlayerRecvVideoFirstFrame:

- (void)onPlayerRecvVideoFirstFrame:(NSString *) streamID;

拉流端视频接收首帧回调

Parameters
streamID 拉流的流 ID

onPlayerRenderVideoFirstFrame:

- (void)onPlayerRenderVideoFirstFrame:(NSString *) streamID;

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

Parameters
streamID 拉流的流 ID

onPlayerVideoSizeChanged:streamID:

- (void)onPlayerVideoSizeChanged:(CGSize) size streamID:(NSString *) streamID;

拉流分辨率变更通知

Parameters
size 视频分辨率
streamID 拉流的流 ID

onPlayerRecvSEI:streamID:

- (void)onPlayerRecvSEI:(NSData *) data streamID:(NSString *) streamID;

收到远端流的 SEI 内容

Parameters
data SEI 内容
streamID 拉流的流 ID

onMixerRelayCDNStateUpdate:taskID:

- (void)onMixerRelayCDNStateUpdate:(NSArray< ZegoStreamRelayCDNInfo * > *) infoList taskID:(NSString *) taskID;

混流转推 CDN 状态更新通知

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

onMixerSoundLevelUpdate:

- (void)onMixerSoundLevelUpdate:(NSDictionary< NSNumber *, NSNumber * > *) soundLevels;

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

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

onAudioDeviceStateChanged:updateType:deviceType:

- (void)onAudioDeviceStateChanged:(ZegoDeviceInfo *) deviceInfo updateType:(ZegoUpdateType) updateType deviceType:(ZegoAudioDeviceType) deviceType;

音频设备状态改变

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

onVideoDeviceStateChanged:updateType:

- (void)onVideoDeviceStateChanged:(ZegoDeviceInfo *) deviceInfo updateType:(ZegoUpdateType) updateType;

视频设备状态改变

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

onCapturedSoundLevelUpdate:

- (void)onCapturedSoundLevelUpdate:(NSNumber *) soundLevel;

本地采集音频声浪回调

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

onRemoteSoundLevelUpdate:

- (void)onRemoteSoundLevelUpdate:(NSDictionary< NSString *, NSNumber * > *) soundLevels;

远端拉流音频声浪回调

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

onCapturedAudioSpectrumUpdate:

- (void)onCapturedAudioSpectrumUpdate:(NSArray< NSNumber * > *) audioSpectrum;

本地采集音频频谱回调

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

onRemoteAudioSpectrumUpdate:

- (void)onRemoteAudioSpectrumUpdate:(NSDictionary< NSString *, NSArray< NSNumber * > * > *) audioSpectrums;

远端拉流音频频谱回调

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

onDeviceError:deviceName:

- (void)onDeviceError:(int) errorCode deviceName:(NSString *) deviceName;

设备异常通知

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

onRemoteCameraStateUpdate:streamID:

- (void)onRemoteCameraStateUpdate:(ZegoRemoteDeviceState) state streamID:(NSString *) streamID;

远端摄像头设备状态通知

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

onRemoteMicStateUpdate:streamID:

- (void)onRemoteMicStateUpdate:(ZegoRemoteDeviceState) state streamID:(NSString *) streamID;

远端麦克风设备状态通知

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

onIMRecvBroadcastMessage:roomID:

- (void)onIMRecvBroadcastMessage:(NSArray< ZegoBroadcastMessageInfo * > *) messageList roomID:(NSString *) roomID;

接收房间广播消息通知

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

onIMRecvBarrageMessage:roomID:

- (void)onIMRecvBarrageMessage:(NSArray< ZegoBarrageMessageInfo * > *) messageList roomID:(NSString *) roomID;

接收房间弹幕消息通知

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

onIMRecvCustomCommand:fromUser:roomID:

- (void)onIMRecvCustomCommand:(NSString *) command fromUser:(ZegoUser *) fromUser roomID:(NSString *) roomID;

接收自定义信令通知

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