Interface


ZegoExpressDefines

ZegoExpressDefines

Declared in ZegoExpressDefines.h

方法

ZegoDestroyCompletionCallback

public ZegoDestroyCompletionCallback

引擎异步销毁完成的回调

Declared in ZegoExpressDefines.h

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

ZegoRoomSetRoomExtraInfoCallback

public ZegoRoomSetRoomExtraInfoCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRoomLoginCallback

public ZegoRoomLoginCallback

登录房间结果回调。

Declared in ZegoExpressDefines.h

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

ZegoRoomLogoutCallback

public ZegoRoomLogoutCallback

登出房间结果回调。

Declared in ZegoExpressDefines.h

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

ZegoUploadLogResultCallback

public ZegoUploadLogResultCallback

日志上传结果回调。

Declared in ZegoExpressDefines.h

参数

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

详情

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

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

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

ZegoPublisherSetStreamExtraInfoCallback

public ZegoPublisherSetStreamExtraInfoCallback

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

Declared in ZegoExpressDefines.h

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

ZegoPublisherUpdateCdnUrlCallback

public ZegoPublisherUpdateCdnUrlCallback

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

Declared in ZegoExpressDefines.h

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

ZegoPublisherTakeSnapshotCallback

public ZegoPublisherTakeSnapshotCallback

推流画面截图结果回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
image	void *	截图的图片 (Windows: HBITMAP; macOS/iOS: CGImageRef; Linux: QImage; Android: Bitmap)

ZegoPublisherGetVideoEncoderSupportedCallback

public ZegoPublisherGetVideoEncoderSupportedCallback

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

Declared in ZegoExpressDefines.h

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

ZegoPlayerTakeSnapshotCallback

public ZegoPlayerTakeSnapshotCallback

拉流画面截图结果回调

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
image	void *	截图的图片 (Windows: HBITMAP; macOS/iOS: CGImageRef; Linux: QImage; Android: Bitmap)

ZegoPlayerGetVideoDecoderSupportedCallback

public ZegoPlayerGetVideoDecoderSupportedCallback

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

Declared in ZegoExpressDefines.h

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

ZegoMixerStartCallback

public ZegoMixerStartCallback

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

Declared in ZegoExpressDefines.h

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

ZegoMixerStopCallback

public ZegoMixerStopCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRealTimeSequentialDataSentCallback

public ZegoRealTimeSequentialDataSentCallback

发送实时有序数据的回调

Declared in ZegoExpressDefines.h

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

ZegoIMSendBroadcastMessageCallback

public ZegoIMSendBroadcastMessageCallback

发送房间聊天消息的回调

Declared in ZegoExpressDefines.h

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

ZegoIMSendBarrageMessageCallback

public ZegoIMSendBarrageMessageCallback

发送房间弹幕消息的回调

Declared in ZegoExpressDefines.h

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

ZegoIMSendCustomCommandCallback

public ZegoIMSendCustomCommandCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRoomSendTransparentMessageCallback

public ZegoRoomSendTransparentMessageCallback

发送透传消息回调

Declared in ZegoExpressDefines.h

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

ZegoTestNetworkConnectivityCallback

public ZegoTestNetworkConnectivityCallback

网络连通性测试结果回调

Declared in ZegoExpressDefines.h

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

ZegoNetworkProbeResultCallback

public ZegoNetworkProbeResultCallback

网络探测结果回调

Declared in ZegoExpressDefines.h

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

ZegoMediaPlayerLoadResourceCallback

public ZegoMediaPlayerLoadResourceCallback

播放器加载资源完成回调

Declared in ZegoExpressDefines.h

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

ZegoMediaPlayerSeekToCallback

public ZegoMediaPlayerSeekToCallback

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

Declared in ZegoExpressDefines.h

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

ZegoMediaPlayerTakeSnapshotCallback

public ZegoMediaPlayerTakeSnapshotCallback

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

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
image	void *	截图的图片 (Windows: HBITMAP; macOS/iOS: CGImageRef; Linux: QImage; Android: Bitmap)

ZegoAudioEffectPlayerLoadResourceCallback

public ZegoAudioEffectPlayerLoadResourceCallback

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

Declared in ZegoExpressDefines.h

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

ZegoAudioEffectPlayerSeekToCallback

public ZegoAudioEffectPlayerSeekToCallback

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

Declared in ZegoExpressDefines.h

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

ZegoCopyrightedMusicInitCallback

public ZegoCopyrightedMusicInitCallback

版权音乐初始化完成回调

Declared in ZegoExpressDefines.h

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

ZegoCopyrightedMusicSendExtendedRequestCallback

public ZegoCopyrightedMusicSendExtendedRequestCallback

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

Declared in ZegoExpressDefines.h

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

ZegoCopyrightedMusicGetLrcLyricCallback

public ZegoCopyrightedMusicGetLrcLyricCallback

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

Declared in ZegoExpressDefines.h

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

ZegoCopyrightedMusicGetKrcLyricByTokenCallback

public ZegoCopyrightedMusicGetKrcLyricByTokenCallback

获取逐字歌词完成回调。

Declared in ZegoExpressDefines.h

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

ZegoCopyrightedMusicRequestSongCallback

public ZegoCopyrightedMusicRequestSongCallback

点歌完成回调。

Declared in ZegoExpressDefines.h

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

ZegoCopyrightedMusicRequestAccompanimentCallback

public ZegoCopyrightedMusicRequestAccompanimentCallback

点伴奏完成回调。

Declared in ZegoExpressDefines.h

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

ZegoCopyrightedMusicRequestAccompanimentClipCallback

public ZegoCopyrightedMusicRequestAccompanimentClipCallback

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

Declared in ZegoExpressDefines.h

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

ZegoCopyrightedMusicGetMusicByTokenCallback

public ZegoCopyrightedMusicGetMusicByTokenCallback

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

Declared in ZegoExpressDefines.h

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

ZegoCopyrightedMusicRequestResourceCallback

public ZegoCopyrightedMusicRequestResourceCallback

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

Declared in ZegoExpressDefines.h

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

ZegoCopyrightedMusicGetSharedResourceCallback

public ZegoCopyrightedMusicGetSharedResourceCallback

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

Declared in ZegoExpressDefines.h

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

ZegoCopyrightedMusicDownloadCallback

public ZegoCopyrightedMusicDownloadCallback

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

Declared in ZegoExpressDefines.h

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

ZegoCopyrightedMusicGetStandardPitchCallback

public ZegoCopyrightedMusicGetStandardPitchCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRangeSceneLoginSceneCallback

public ZegoRangeSceneLoginSceneCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRangeSceneLogoutSceneCallback

public ZegoRangeSceneLogoutSceneCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRangeSceneGetUserCountCallback

public ZegoRangeSceneGetUserCountCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRangeSceneGetUserListInViewCallback

public ZegoRangeSceneGetUserListInViewCallback

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

Declared in ZegoExpressDefines.h

名称	类型	描述
errorCode	int	错误码，详情请参考常见错误码
userList	const std::vector<std::string>&	范围内用户列表。

ZegoRangeSceneSendCustomCommandCallback

public ZegoRangeSceneSendCustomCommandCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRangeSceneJoinTeamCallback

public ZegoRangeSceneJoinTeamCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRangeSceneLeaveTeamCallback

public ZegoRangeSceneLeaveTeamCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRangeSceneCreateItemCallback

public ZegoRangeSceneCreateItemCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRangeSceneDestroyItemCallback

public ZegoRangeSceneDestroyItemCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRangeSceneBindItemCallback

public ZegoRangeSceneBindItemCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRangeSceneUnbindItemCallback

public ZegoRangeSceneUnbindItemCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRangeSceneUpdateItemStatusCallback

public ZegoRangeSceneUpdateItemStatusCallback

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

Declared in ZegoExpressDefines.h

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

ZegoRangeSceneUpdateItemCommandCallback

public ZegoRangeSceneUpdateItemCommandCallback

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

Declared in ZegoExpressDefines.h

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

ZegoAudioCaptureDeviceEnableCallback

public ZegoAudioCaptureDeviceEnableCallback

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

Declared in ZegoExpressDefines.h

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