ZegoExpressDefines

2026-03-13

ZegoExpressDefines

Declared in ZegoExpressDefines.h

方法

ZegoDestroyCompletionCallback

void(^ZegoDestroyCompletionCallback)();

引擎异步销毁完成的回调

Declared in ZegoExpressDefines.h

一般情况下开发者无需关注此回调

ZegoRoomSetRoomExtraInfoCallback

void(^ZegoRoomSetRoomExtraInfoCallback)((int) errorCode);

设置房间附加信息函数的回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoRoomLoginCallback

void(^ZegoRoomLoginCallback)((int) errorCode, (NSDictionary *) extendedData);

登录房间结果回调。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
extendedData	NSDictionary *	扩展信息

ZegoRoomLogoutCallback

void(^ZegoRoomLogoutCallback)((int) errorCode, (NSDictionary *) extendedData);

登出房间结果回调。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
extendedData	NSDictionary *	扩展信息

ZegoUploadLogResultCallback

void(^ZegoUploadLogResultCallback)((int) errorCode);

日志上传结果回调。

Declared in ZegoExpressDefines.h

参数

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

详情

调用 [uploadLog] 上传日志后，通过本回调获取上传结果。

业务场景：在上传日志时，为了确定日志是否上传成功，可以通过本回调来获取。

注意事项：在网络较差的情况下，该回调的返回时间可能较长。

ZegoPublisherSetStreamExtraInfoCallback

void(^ZegoPublisherSetStreamExtraInfoCallback)((int) errorCode);

设置流附加信息函数的回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoPublisherUpdateCdnUrlCallback

void(^ZegoPublisherUpdateCdnUrlCallback)((int) errorCode);

添加/删除转推 CDN 函数的回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoPublisherTakeSnapshotCallback

void(^ZegoPublisherTakeSnapshotCallback)((int) errorCode, (ZGImage * _Nullable) image);

推流画面截图结果回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
image	ZGImage * _Nullable	截图的图片

ZegoPublisherGetVideoEncoderSupportedCallback

void(^ZegoPublisherGetVideoEncoderSupportedCallback)((int) support);

是否支持指定视频编码结果的回调。

Declared in ZegoExpressDefines.h

名称	类型	描述
support	int	0 - 不支持指定编码能力，1 - 支持指定编码能力，2 - 未确定。

ZegoPlayerTakeSnapshotCallback

void(^ZegoPlayerTakeSnapshotCallback)((int) errorCode, (ZGImage * _Nullable) image);

拉流画面截图结果回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
image	ZGImage * _Nullable	截图的图片

ZegoPlayerGetVideoDecoderSupportedCallback

void(^ZegoPlayerGetVideoDecoderSupportedCallback)((int) support);

是否支持指定视频解码结果的回调。

Declared in ZegoExpressDefines.h

名称	类型	描述
support	int	0 - 不支持指定解码能力，1 - 支持指定解码能力，2 - 未确定。

ZegoMixerStartCallback

void(^ZegoMixerStartCallback)((int) errorCode, (NSDictionary * _Nullable) extendedData);

开始混流任务的结果的回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
extendedData	NSDictionary * _Nullable	扩展信息

ZegoMixerStopCallback

void(^ZegoMixerStopCallback)((int) errorCode);

结束混流任务的结果的回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoRealTimeSequentialDataSentCallback

void(^ZegoRealTimeSequentialDataSentCallback)((int) errorCode);

发送实时有序数据的回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoIMSendBroadcastMessageCallback

void(^ZegoIMSendBroadcastMessageCallback)((int) errorCode, (unsigned long long) messageID);

发送房间聊天消息的回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
messageID	unsigned long long	此消息的 ID

ZegoIMSendBarrageMessageCallback

void(^ZegoIMSendBarrageMessageCallback)((int) errorCode, (NSString *) messageID);

发送房间弹幕消息的回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
messageID	NSString *	此消息的 ID

ZegoIMSendCustomCommandCallback

void(^ZegoIMSendCustomCommandCallback)((int) errorCode);

发送房间自定义信令的回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoRoomSendTransparentMessageCallback

void(^ZegoRoomSendTransparentMessageCallback)((int) errorCode);

发送透传消息回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoTestNetworkConnectivityCallback

void(^ZegoTestNetworkConnectivityCallback)((int) errorCode, (ZegoTestNetworkConnectivityResult *) result);

网络连通性测试结果回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
result	ZegoTestNetworkConnectivityResult *	网络连通性测试结果

ZegoNetworkProbeResultCallback

void(^ZegoNetworkProbeResultCallback)((int) errorCode, (ZegoNetworkProbeResult *) result);

网络探测结果回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
result	ZegoNetworkProbeResult *	网络探测结果

ZegoMediaPlayerLoadResourceCallback

void(^ZegoMediaPlayerLoadResourceCallback)((int) errorCode);

播放器加载资源完成回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoMediaPlayerSeekToCallback

void(^ZegoMediaPlayerSeekToCallback)((int) errorCode);

播放器设置指定播放进度回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoMediaPlayerTakeSnapshotCallback

void(^ZegoMediaPlayerTakeSnapshotCallback)((int) errorCode, (ZGImage * _Nullable) image);

媒体播放器播放画面截图的回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
image	ZGImage * _Nullable	截图的图片

ZegoAudioEffectPlayerLoadResourceCallback

void(^ZegoAudioEffectPlayerLoadResourceCallback)((int) errorCode);

音效播放器加载资源完成回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoAudioEffectPlayerSeekToCallback

void(^ZegoAudioEffectPlayerSeekToCallback)((int) errorCode);

音效播放器设置指定播放进度回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoCopyrightedMusicInitCallback

void(^ZegoCopyrightedMusicInitCallback)((int) errorCode);

版权音乐初始化完成回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoCopyrightedMusicSendExtendedRequestCallback

void(^ZegoCopyrightedMusicSendExtendedRequestCallback)((int) errorCode, (NSString *) command, (NSString *) result);

发送扩展功能请求完成回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
command	NSString *	请求命令，具体支持的命令详见 /online-ktv-android/client-api/send-extended-request
result	NSString *	请求结果，每个请求命令具备对应的请求结果，详细见 /online-ktv-android/client-api/send-extended-request

ZegoCopyrightedMusicGetLrcLyricCallback

void(^ZegoCopyrightedMusicGetLrcLyricCallback)((int) errorCode, (NSString *) lyrics);

获取 lrc 格式歌词完成回调。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
lyrics	NSString *	lrc 格式歌词，专用于逐行格式歌词场景，详情请参考 /online-ktv-ios/client-api/apis-to-obtain-songs-and-lyrics#2_1

ZegoCopyrightedMusicGetKrcLyricByTokenCallback

void(^ZegoCopyrightedMusicGetKrcLyricByTokenCallback)((int) errorCode, (NSString *) lyrics);

获取逐字歌词完成回调。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
lyrics	NSString *	逐字歌词，详情请参考 /online-ktv-ios/client-api/apis-to-obtain-songs-and-lyrics#2_2

ZegoCopyrightedMusicRequestSongCallback

void(^ZegoCopyrightedMusicRequestSongCallback)((int) errorCode, (NSString *) resource);

点歌完成回调。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
resource	NSString *	点歌服务返回的 JSON 字符串，包含歌曲资源信息，详细请参考 /online-ktv-ios/client-api/apis-to-obtain-songs-and-lyrics#1_1

ZegoCopyrightedMusicRequestAccompanimentCallback

void(^ZegoCopyrightedMusicRequestAccompanimentCallback)((int) errorCode, (NSString *) resource);

点伴奏完成回调。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
resource	NSString *	伴奏资源信息，详情请参考 /online-ktv-ios/client-api/apis-to-obtain-songs-and-lyrics#1_2

ZegoCopyrightedMusicRequestAccompanimentClipCallback

void(^ZegoCopyrightedMusicRequestAccompanimentClipCallback)((int) errorCode, (NSString *) resource);

点伴奏长分片高潮片段完成回调。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
resource	NSString *	伴奏长分片高潮片段资源信息，详情请参考 /online-ktv-ios/client-api/apis-to-obtain-songs-and-lyrics#1_3

ZegoCopyrightedMusicGetMusicByTokenCallback

void(^ZegoCopyrightedMusicGetMusicByTokenCallback)((int) errorCode, (NSString *) resource);

通过授权 token 获取歌曲或伴奏完成回调。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
resource	NSString *	歌曲、伴奏或高潮片段资源信息，详情请参考 /online-ktv-ios/client-api/apis-to-obtain-songs-and-lyrics#1_4

ZegoCopyrightedMusicRequestResourceCallback

void(^ZegoCopyrightedMusicRequestResourceCallback)((int) errorCode, (NSString *) resource);

获取音乐资源的完成回调。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
resource	NSString *	点歌服务返回的 JSON 字符串，包含歌曲资源信息，详细请参考 /online-ktv-ios/client-api/apis-to-obtain-songs-and-lyrics#1_1

ZegoCopyrightedMusicGetSharedResourceCallback

void(^ZegoCopyrightedMusicGetSharedResourceCallback)((int) errorCode, (NSString *) resource);

获取分享音乐资源的完成回调。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
resource	NSString *	点歌服务返回的 JSON 字符串，包含歌曲资源信息，详细请参考 /online-ktv-ios/client-api/apis-to-obtain-songs-and-lyrics#1_4

ZegoCopyrightedMusicDownloadCallback

void(^ZegoCopyrightedMusicDownloadCallback)((int) errorCode);

下载歌曲或伴奏完成回调。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoCopyrightedMusicGetStandardPitchCallback

void(^ZegoCopyrightedMusicGetStandardPitchCallback)((int) errorCode, (NSString *) pitch);

获取标准音高数据完成回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
pitch	NSString *	标准音高线数据。详情请参考 Android：/online-ktv-android/zego-content-center/scoring-component, iOS：/online-ktv-ios/zego-content-center/scoring-component

ZegoRangeSceneLoginSceneCallback

void(^ZegoRangeSceneLoginSceneCallback)((int) errorCode, (ZegoSceneConfig *) config);

登录场景结果回调。请勿在回调线程中调用 SDK 接口。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
config	ZegoSceneConfig *	通道数。

ZegoRangeSceneLogoutSceneCallback

void(^ZegoRangeSceneLogoutSceneCallback)((int) errorCode);

退出场景结果回调。请勿在回调线程中调用 SDK 接口。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoRangeSceneGetUserCountCallback

void(^ZegoRangeSceneGetUserCountCallback)((int) errorCode, (unsigned int) count);

获取场景内用户总人数结果回调。请勿在回调线程中调用 SDK 接口。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
count	unsigned int	场景内总人数。

ZegoRangeSceneGetUserListInViewCallback

void(^ZegoRangeSceneGetUserListInViewCallback)((int) errorCode, (NSArray<NSString *> *) userList);

获取范围内用户列表结果回调。请勿在回调线程中调用 SDK 接口。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
userList	NSArray<NSString >	范围内用户列表。

ZegoRangeSceneSendCustomCommandCallback

void(^ZegoRangeSceneSendCustomCommandCallback)((int) errorCode);

发送用户自定义信令结果回调。请勿在回调线程中调用 SDK 接口。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码

ZegoRangeSceneJoinTeamCallback

void(^ZegoRangeSceneJoinTeamCallback)((int) errorCode, (unsigned int) teamID);

加入小队结果回调。请勿在回调线程中调用 SDK 接口。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
teamID	unsigned int	小队 ID。

ZegoRangeSceneLeaveTeamCallback

void(^ZegoRangeSceneLeaveTeamCallback)((int) errorCode, (unsigned int) teamID);

离开小队结果回调。请勿在回调线程中调用 SDK 接口。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
teamID	unsigned int	小队 ID。

ZegoRangeSceneCreateItemCallback

void(^ZegoRangeSceneCreateItemCallback)((int) errorCode, (long long) itemID);

创建物品结果回调。请勿在回调线程中调用 SDK 接口。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
itemID	long long	物品 ID。

ZegoRangeSceneDestroyItemCallback

void(^ZegoRangeSceneDestroyItemCallback)((int) errorCode, (long long) itemID);

销毁物品结果回调。请勿在回调线程中调用 SDK 接口。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
itemID	long long	物品 ID。

ZegoRangeSceneBindItemCallback

void(^ZegoRangeSceneBindItemCallback)((int) errorCode, (long long) itemID);

绑定物品结果回调。请勿在回调线程中调用 SDK 接口。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
itemID	long long	物品 ID。

ZegoRangeSceneUnbindItemCallback

void(^ZegoRangeSceneUnbindItemCallback)((int) errorCode, (long long) itemID);

解绑物品结果回调。请勿在回调线程中调用 SDK 接口。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
itemID	long long	物品 ID。

ZegoRangeSceneUpdateItemStatusCallback

void(^ZegoRangeSceneUpdateItemStatusCallback)((int) errorCode, (long long) itemID);

更新物品状态结果回调。请勿在回调线程中调用 SDK 接口。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
itemID	long long	物品 ID。

ZegoRangeSceneUpdateItemCommandCallback

void(^ZegoRangeSceneUpdateItemCommandCallback)((int) errorCode, (long long) itemID);

更新物品命令结果回调。请勿在回调线程中调用 SDK 接口。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
itemID	long long	物品 ID。

ZegoAudioCaptureDeviceEnableCallback

void(^ZegoAudioCaptureDeviceEnableCallback)((int) errorCode);

开关音频采集设备结果回调。

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码