ZegoExpressDefines

Declared in ZegoExpressDefines.h

Methods

ZegoDestroyCompletionCallback

void(^ZegoDestroyCompletionCallback)();

Callback for asynchronous destruction completion.

Declared in ZegoExpressDefines.h

In general, developers do not need to listen to this callback.

ZegoRoomSetRoomExtraInfoCallback

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

Callback for setting room extra information.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoRoomLoginCallback

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

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
extendedData	NSDictionary *	Extended Information

ZegoRoomLogoutCallback

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

Logout room result callback.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
extendedData	NSDictionary *	Extended Information

ZegoUploadLogResultCallback

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

Log upload result callback.

Declared in ZegoExpressDefines.h

Parameters

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

Details

After calling [uploadLog] to upload the log, get the upload result through this callback.

Use cases: When uploading logs, in order to determine whether the logs are uploaded successfully, you can get them through this callback.
Caution: In the case of poor network, the return time of this callback may be longer.

ZegoPublisherSetStreamExtraInfoCallback

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

Callback for setting stream extra information.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoPublisherUpdateCdnUrlCallback

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

Callback for add/remove CDN URL.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoPublisherTakeSnapshotCallback

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

Results of take publish stream snapshot.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
image	ZGImage * _Nullable	Snapshot image

ZegoPublisherGetVideoEncoderSupportedCallback

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

Results of get video encoder supported.

Declared in ZegoExpressDefines.h

Name	Type	Description
support	int	0 - does not support the specified encoding capability, 1 - supports the specified encoding capability, 2 - undetermined.

ZegoPlayerTakeSnapshotCallback

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

Results of take play stream snapshot.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
image	ZGImage * _Nullable	Snapshot image

ZegoPlayerGetVideoDecoderSupportedCallback

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

Results of get video decoder supported.

Declared in ZegoExpressDefines.h

Name	Type	Description
support	int	0 - does not support the specified decoding capability, 1 - supports the specified decoding capability, 2 - undetermined.

ZegoMixerStartCallback

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

Results of starting a mixer task.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
extendedData	NSDictionary * _Nullable	Extended Information

ZegoMixerStopCallback

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

Results of stoping a mixer task.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoRealTimeSequentialDataSentCallback

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

Callback for sending real-time sequential data.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoIMSendBroadcastMessageCallback

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

Callback for sending broadcast messages.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
messageID	unsigned long long	ID of this message

ZegoIMSendBarrageMessageCallback

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

Callback for sending barrage message.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
messageID	NSString *	ID of this message

ZegoIMSendCustomCommandCallback

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

Callback for sending custom command.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoRoomSendTransparentMessageCallback

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

Callback for sending custom command.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoTestNetworkConnectivityCallback

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

Callback for test network connectivity.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
result	ZegoTestNetworkConnectivityResult *	Network connectivity test results

ZegoNetworkProbeResultCallback

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

Callback for network probe.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
result	ZegoNetworkProbeResult *	Network probe result

ZegoMediaPlayerLoadResourceCallback

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

Callback for media player loads resources.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoMediaPlayerSeekToCallback

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

Callback for media player seek to playback progress.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoMediaPlayerTakeSnapshotCallback

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

The callback of the screenshot of the media player playing screen

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
image	ZGImage * _Nullable	Snapshot image

ZegoAudioEffectPlayerLoadResourceCallback

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

Callback for audio effect player loads resources.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoAudioEffectPlayerSeekToCallback

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

Callback for audio effect player seek to playback progress.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoCopyrightedMusicInitCallback

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

Callback for copyrighted music init.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoCopyrightedMusicSendExtendedRequestCallback

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

Callback of sending extended feature request.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
command	NSString *	request command.
result	NSString *	request result, each request command has corresponding request result.

ZegoCopyrightedMusicGetLrcLyricCallback

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

Get lrc format lyrics complete callback.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
lyrics	NSString *	lrc format lyrics.

ZegoCopyrightedMusicGetKrcLyricByTokenCallback

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

Get verbatim lyrics complete callback.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
lyrics	NSString *	verbatim lyrics.

ZegoCopyrightedMusicRequestSongCallback

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

Callback for request song.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
resource	NSString *	The JSON string returned by the song ordering service, including song resource information.

ZegoCopyrightedMusicRequestAccompanimentCallback

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

Callback for request accompaniment.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
resource	NSString *	accompany resource information.

ZegoCopyrightedMusicRequestAccompanimentClipCallback

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

Callback for request accompaniment clip.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
resource	NSString *	accompany clip resource information.

ZegoCopyrightedMusicGetMusicByTokenCallback

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

Callback for acquire songs or accompaniment through authorization token.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
resource	NSString *	song or accompany resource information.

ZegoCopyrightedMusicRequestResourceCallback

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

Callback of requesting music resource.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
resource	NSString *	The JSON string returned by the song ordering service, including music resource information.

ZegoCopyrightedMusicGetSharedResourceCallback

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

Callback of getting shared music resource.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
resource	NSString *	The JSON string returned by the song ordering service, including music resource information.

ZegoCopyrightedMusicDownloadCallback

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

Callback for download song or accompaniment.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoCopyrightedMusicGetStandardPitchCallback

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

Get standard pitch data complete callback.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
pitch	NSString *	Standard pitch data.

ZegoRangeSceneLoginSceneCallback

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

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
config	ZegoSceneConfig *	State channel count.

ZegoRangeSceneLogoutSceneCallback

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

Logout scene result callback. Do not call the SDK interface in the callback thread.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoRangeSceneGetUserCountCallback

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

The callback of getting user count in scene. Do not call the SDK interface in the callback thread.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
count	unsigned int	User count in scene.

ZegoRangeSceneGetUserListInViewCallback

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

The callback of getting user list in view. Do not call the SDK interface in the callback thread.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
userList	NSArray<NSString >	User list in view.

ZegoRangeSceneSendCustomCommandCallback

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

The callback of send custom command. Do not call the SDK interface in the callback thread.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.

ZegoRangeSceneJoinTeamCallback

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

Join team result callback. Do not call the SDK interface in the callback thread.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
teamID	unsigned int	Team ID.

ZegoRangeSceneLeaveTeamCallback

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

Leave team result callback. Do not call the SDK interface in the callback thread.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
teamID	unsigned int	Team ID.

ZegoRangeSceneCreateItemCallback

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

Create item result callback. Do not call the SDK interface in the callback thread.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
itemID	long long	Item ID.

ZegoRangeSceneDestroyItemCallback

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

Destroy item result callback. Do not call the SDK interface in the callback thread.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
itemID	long long	Item ID.

ZegoRangeSceneBindItemCallback

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

Bind item result callback. Do not call the SDK interface in the callback thread.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
itemID	long long	Item ID.

ZegoRangeSceneUnbindItemCallback

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

Unbind item result callback. Do not call the SDK interface in the callback thread.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
itemID	long long	Item ID.

ZegoRangeSceneUpdateItemStatusCallback

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

Update item status result callback. Do not call the SDK interface in the callback thread.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
itemID	long long	Item ID.

ZegoRangeSceneUpdateItemCommandCallback

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

Update item command result callback. Do not call the SDK interface in the callback thread.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.
itemID	long long	Item ID.

ZegoAudioCaptureDeviceEnableCallback

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

Enable audio capture device result callback.

Declared in ZegoExpressDefines.h

Name	Type	Description
errorCode	int	Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details.