Interface


ZegoExpressDefines

ZegoExpressDefines

Declared in ZegoExpressDefines.h

Methods

ZegoDestroyCompletionCallback

public ZegoDestroyCompletionCallback

Callback for asynchronous destruction completion.

Declared in ZegoExpressDefines.h

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

ZegoRoomSetRoomExtraInfoCallback

public ZegoRoomSetRoomExtraInfoCallback

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

public ZegoRoomLoginCallback

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	std::string	Extended Information

ZegoRoomLogoutCallback

public ZegoRoomLogoutCallback

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	std::string	Extended Information

ZegoUploadLogResultCallback

public ZegoUploadLogResultCallback

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

public ZegoPublisherSetStreamExtraInfoCallback

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

public ZegoPublisherUpdateCdnUrlCallback

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

public ZegoPublisherTakeSnapshotCallback

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	void *	Snapshot image (Windows: HBITMAP; macOS/iOS: CGImageRef; Linux: QImage; Android: Bitmap)

ZegoPublisherGetVideoEncoderSupportedCallback

public ZegoPublisherGetVideoEncoderSupportedCallback

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

public ZegoPlayerTakeSnapshotCallback

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	void *	Snapshot image (Windows: HBITMAP; macOS/iOS: CGImageRef; Linux: QImage; Android: Bitmap)

ZegoPlayerGetVideoDecoderSupportedCallback

public ZegoPlayerGetVideoDecoderSupportedCallback

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

public ZegoMixerStartCallback

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	std::string	Extended Information

ZegoMixerStopCallback

public ZegoMixerStopCallback

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

public ZegoRealTimeSequentialDataSentCallback

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

public ZegoIMSendBroadcastMessageCallback

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

public ZegoIMSendBarrageMessageCallback

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	std::string	ID of this message

ZegoIMSendCustomCommandCallback

public ZegoIMSendCustomCommandCallback

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

public ZegoRoomSendTransparentMessageCallback

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

public ZegoTestNetworkConnectivityCallback

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

public ZegoNetworkProbeResultCallback

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	const ZegoNetworkProbeResult&	Network probe result

ZegoMediaPlayerLoadResourceCallback

public ZegoMediaPlayerLoadResourceCallback

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

public ZegoMediaPlayerSeekToCallback

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

public ZegoMediaPlayerTakeSnapshotCallback

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	void *	Snapshot image (Windows: HBITMAP; macOS/iOS: CGImageRef; Linux: QImage; Android: Bitmap)

ZegoAudioEffectPlayerLoadResourceCallback

public ZegoAudioEffectPlayerLoadResourceCallback

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

public ZegoAudioEffectPlayerSeekToCallback

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

public ZegoCopyrightedMusicInitCallback

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

public ZegoCopyrightedMusicSendExtendedRequestCallback

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	std::string	request command.
result	std::string	request result, each request command has corresponding request result.

ZegoCopyrightedMusicGetLrcLyricCallback

public ZegoCopyrightedMusicGetLrcLyricCallback

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	std::string	lrc format lyrics.

ZegoCopyrightedMusicGetKrcLyricByTokenCallback

public ZegoCopyrightedMusicGetKrcLyricByTokenCallback

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	std::string	verbatim lyrics.

ZegoCopyrightedMusicRequestSongCallback

public ZegoCopyrightedMusicRequestSongCallback

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	std::string	The JSON string returned by the song ordering service, including song resource information.

ZegoCopyrightedMusicRequestAccompanimentCallback

public ZegoCopyrightedMusicRequestAccompanimentCallback

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	std::string	accompany resource information.

ZegoCopyrightedMusicRequestAccompanimentClipCallback

public ZegoCopyrightedMusicRequestAccompanimentClipCallback

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	std::string	accompany clip resource information.

ZegoCopyrightedMusicGetMusicByTokenCallback

public ZegoCopyrightedMusicGetMusicByTokenCallback

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	std::string	song or accompany resource information.

ZegoCopyrightedMusicRequestResourceCallback

public ZegoCopyrightedMusicRequestResourceCallback

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	std::string	The JSON string returned by the song ordering service, including music resource information.

ZegoCopyrightedMusicGetSharedResourceCallback

public ZegoCopyrightedMusicGetSharedResourceCallback

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	std::string	The JSON string returned by the song ordering service, including music resource information.

ZegoCopyrightedMusicDownloadCallback

public ZegoCopyrightedMusicDownloadCallback

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

public ZegoCopyrightedMusicGetStandardPitchCallback

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	std::string	Standard pitch data.

ZegoRangeSceneLoginSceneCallback

public ZegoRangeSceneLoginSceneCallback

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	const ZegoSceneConfig&	State channel count.

ZegoRangeSceneLogoutSceneCallback

public ZegoRangeSceneLogoutSceneCallback

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

public ZegoRangeSceneGetUserCountCallback

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

public ZegoRangeSceneGetUserListInViewCallback

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	const std::vector<std::string>&	User list in view.

ZegoRangeSceneSendCustomCommandCallback

public ZegoRangeSceneSendCustomCommandCallback

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

public ZegoRangeSceneJoinTeamCallback

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

public ZegoRangeSceneLeaveTeamCallback

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

public ZegoRangeSceneCreateItemCallback

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

public ZegoRangeSceneDestroyItemCallback

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

public ZegoRangeSceneBindItemCallback

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

public ZegoRangeSceneUnbindItemCallback

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

public ZegoRangeSceneUpdateItemStatusCallback

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

public ZegoRangeSceneUpdateItemCommandCallback

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

public ZegoAudioCaptureDeviceEnableCallback

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.