Interface
IZegoAudioEffectPlayerLoadResourceCallback
Declared in callback/IZegoAudioEffectPlayerLoadResourceCallback.java
Methods
onLoadResourceCallback
onLoadResourceCallback
public onLoadResourceCallback(int errorCode)Callback for audio effect player loads resources.
Declared in
callback/IZegoAudioEffectPlayerLoadResourceCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
IZegoAudioEffectPlayerSeekToCallback
Declared in callback/IZegoAudioEffectPlayerSeekToCallback.java
Methods
onSeekToCallback
onSeekToCallback
public onSeekToCallback(int errorCode)Callback for audio effect player seek to playback progress.
Declared in
callback/IZegoAudioEffectPlayerSeekToCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
IZegoCopyrightedMusicDownloadCallback
Declared in callback/IZegoCopyrightedMusicDownloadCallback.java
Methods
onDownloadCallback
onDownloadCallback
public onDownloadCallback(int errorCode)Callback for download song or accompaniment.
Declared in
callback/IZegoCopyrightedMusicDownloadCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
IZegoCopyrightedMusicGetKrcLyricByTokenCallback
Declared in callback/IZegoCopyrightedMusicGetKrcLyricByTokenCallback.java
Methods
onGetKrcLyricByTokenCallback
onGetKrcLyricByTokenCallback
public onGetKrcLyricByTokenCallback(int errorCode, String lyrics)Get verbatim lyrics complete callback.
Declared in
callback/IZegoCopyrightedMusicGetKrcLyricByTokenCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| lyrics | String | verbatim lyrics. |
IZegoCopyrightedMusicGetLrcLyricCallback
Declared in callback/IZegoCopyrightedMusicGetLrcLyricCallback.java
Methods
onGetLrcLyricCallback
onGetLrcLyricCallback
public onGetLrcLyricCallback(int errorCode, String lyrics)Get lrc format lyrics complete callback.
Declared in
callback/IZegoCopyrightedMusicGetLrcLyricCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| lyrics | String | lrc format lyrics. |
IZegoCopyrightedMusicGetMusicByTokenCallback
Declared in callback/IZegoCopyrightedMusicGetMusicByTokenCallback.java
Methods
onGetMusicByTokenCallback
onGetMusicByTokenCallback
public onGetMusicByTokenCallback(int errorCode, String resource)Callback for acquire songs or accompaniment through authorization token.
Declared in
callback/IZegoCopyrightedMusicGetMusicByTokenCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| resource | String | song or accompany resource information. |
IZegoCopyrightedMusicGetSharedResourceCallback
Declared in callback/IZegoCopyrightedMusicGetSharedResourceCallback.java
Methods
onGetSharedResourceCallback
onGetSharedResourceCallback
public onGetSharedResourceCallback(int errorCode, String resource)Callback of getting shared music resource.
Declared in
callback/IZegoCopyrightedMusicGetSharedResourceCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| resource | String | The JSON string returned by the song ordering service, including music resource information. |
IZegoCopyrightedMusicGetStandardPitchCallback
Declared in callback/IZegoCopyrightedMusicGetStandardPitchCallback.java
Methods
onGetStandardPitchCallback
onGetStandardPitchCallback
public onGetStandardPitchCallback(int errorCode, String pitch)Get standard pitch data complete callback.
Declared in
callback/IZegoCopyrightedMusicGetStandardPitchCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| pitch | String | Standard pitch data. |
IZegoCopyrightedMusicInitCallback
Declared in callback/IZegoCopyrightedMusicInitCallback.java
Methods
onInitCallback
onInitCallback
public onInitCallback(int errorCode)Callback for copyrighted music init.
Declared in
callback/IZegoCopyrightedMusicInitCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
IZegoCopyrightedMusicRequestAccompanimentCallback
Declared in callback/IZegoCopyrightedMusicRequestAccompanimentCallback.java
Methods
onRequestAccompanimentCallback
onRequestAccompanimentCallback
public onRequestAccompanimentCallback(int errorCode, String resource)Callback for request accompaniment.
Declared in
callback/IZegoCopyrightedMusicRequestAccompanimentCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| resource | String | accompany resource information. |
IZegoCopyrightedMusicRequestAccompanimentClipCallback
Declared in callback/IZegoCopyrightedMusicRequestAccompanimentClipCallback.java
Methods
onRequestAccompanimentClipCallback
onRequestAccompanimentClipCallback
public onRequestAccompanimentClipCallback(int errorCode, String resource)Callback for request accompaniment clip.
Declared in
callback/IZegoCopyrightedMusicRequestAccompanimentClipCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| resource | String | accompany clip resource information. |
IZegoCopyrightedMusicRequestResourceCallback
Declared in callback/IZegoCopyrightedMusicRequestResourceCallback.java
Methods
onRequestResourceCallback
onRequestResourceCallback
public onRequestResourceCallback(int errorCode, String resource)Callback of requesting music resource.
Declared in
callback/IZegoCopyrightedMusicRequestResourceCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| resource | String | The JSON string returned by the song ordering service, including music resource information. |
IZegoCopyrightedMusicRequestSongCallback
Declared in callback/IZegoCopyrightedMusicRequestSongCallback.java
Methods
onRequestSongCallback
onRequestSongCallback
public onRequestSongCallback(int errorCode, String resource)Callback for request song.
Declared in
callback/IZegoCopyrightedMusicRequestSongCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| resource | String | The JSON string returned by the song ordering service, including song resource information. |
IZegoCopyrightedMusicSendExtendedRequestCallback
Declared in callback/IZegoCopyrightedMusicSendExtendedRequestCallback.java
Methods
onSendExtendedRequestCallback
onSendExtendedRequestCallback
public onSendExtendedRequestCallback(int errorCode, String command, String result)Callback of sending extended feature request.
Declared in
callback/IZegoCopyrightedMusicSendExtendedRequestCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| command | String | request command. |
| result | String | request result, each request command has corresponding request result. |
IZegoDestroyCompletionCallback
Declared in callback/IZegoDestroyCompletionCallback.java
Methods
onDestroyCompletion
onDestroyCompletion
public onDestroyCompletion()Callback for asynchronous destruction completion.
Declared in
callback/IZegoDestroyCompletionCallback.javaIn general, developers do not need to listen to this callback.
IZegoIMSendBarrageMessageCallback
Declared in callback/IZegoIMSendBarrageMessageCallback.java
Methods
onIMSendBarrageMessageResult
onIMSendBarrageMessageResult
public onIMSendBarrageMessageResult(int errorCode, String messageID)Callback for sending barrage message.
Declared in
callback/IZegoIMSendBarrageMessageCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| messageID | String | ID of this message |
IZegoIMSendBroadcastMessageCallback
Declared in callback/IZegoIMSendBroadcastMessageCallback.java
Methods
onIMSendBroadcastMessageResult
onIMSendBroadcastMessageResult
public onIMSendBroadcastMessageResult(int errorCode, long messageID)Callback for sending broadcast messages.
Declared in
callback/IZegoIMSendBroadcastMessageCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| messageID | long | ID of this message |
IZegoIMSendCustomCommandCallback
Declared in callback/IZegoIMSendCustomCommandCallback.java
Methods
onIMSendCustomCommandResult
onIMSendCustomCommandResult
public onIMSendCustomCommandResult(int errorCode)Callback for sending custom command.
Declared in
callback/IZegoIMSendCustomCommandCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
IZegoMediaPlayerAudioHandler
Declared in callback/IZegoMediaPlayerAudioHandler.java
Methods
onAudioFrame
onAudioFrame
public void onAudioFrame(ZegoMediaPlayer mediaPlayer, ByteBuffer data, int dataLength, ZegoAudioFrameParam param)The callback triggered when the media player throws out audio frame data.
Declared in
callback/IZegoMediaPlayerAudioHandler.javaParameters
| Name | Type | Description |
|---|---|---|
| mediaPlayer | ZegoMediaPlayer | Callback player object. |
| data | ByteBuffer | Raw data of audio frames. |
| dataLength | int | Data length. |
| param | ZegoAudioFrameParam | audio frame flip mode. |
Details
The callback triggered when the media player throws out audio frame data.
- Trigger: The callback is generated when the media player starts playing.
- Caution: The callback does not actually take effect until call [setAudioHandler] to set.
- Available since: 1.3.4
- Restrictions: When playing copyrighted music, this callback will be disabled by default. If necessary, please contact ZEGO technical support.
IZegoMediaPlayerLoadResourceCallback
Declared in callback/IZegoMediaPlayerLoadResourceCallback.java
Methods
onLoadResourceCallback
onLoadResourceCallback
public onLoadResourceCallback(int errorCode)Callback for media player loads resources.
Declared in
callback/IZegoMediaPlayerLoadResourceCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
IZegoMediaPlayerSeekToCallback
Declared in callback/IZegoMediaPlayerSeekToCallback.java
Methods
onSeekToTimeCallback
onSeekToTimeCallback
public onSeekToTimeCallback(int errorCode)Callback for media player seek to playback progress.
Declared in
callback/IZegoMediaPlayerSeekToCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
IZegoMediaPlayerVideoHandler
Declared in callback/IZegoMediaPlayerVideoHandler.java
Methods
onVideoFrame
onVideoFrame
public void onVideoFrame(ZegoMediaPlayer mediaPlayer, ByteBuffer[] data, int[] dataLength, ZegoVideoFrameParam param)The callback triggered when the media player throws out video frame data.
Declared in
callback/IZegoMediaPlayerVideoHandler.javaParameters
| Name | Type | Description |
|---|---|---|
| mediaPlayer | ZegoMediaPlayer | Callback player object. |
| data | ByteBuffer[] | Raw data of video frames (eg: RGBA only needs to consider data[0], I420 needs to consider data[0,1,2]). |
| dataLength | int[] | Data length (eg: RGBA only needs to consider dataLength[0], I420 needs to consider dataLength[0,1,2]). |
| param | ZegoVideoFrameParam | Video frame flip mode. |
Details
The callback triggered when the media player throws out video frame data.
- Trigger: The callback is generated when the media player starts playing.
- Caution: The callback does not actually take effect until call [setVideoHandler] to set.
- Available since: 1.3.4
- Restrictions: When playing copyrighted music, this callback will be disabled by default. If necessary, please contact ZEGO technical support.
onVideoFrame
onVideoFrame
public void onVideoFrame(ZegoMediaPlayer mediaPlayer, ByteBuffer[] data, int[] dataLength, ZegoVideoFrameParam param, String extraInfo)The callback triggered when the media player throws out video frame data, with additional information for the video frame.
Declared in
callback/IZegoMediaPlayerVideoHandler.javaParameters
| Name | Type | Description |
|---|---|---|
| mediaPlayer | ZegoMediaPlayer | Callback player object. |
| data | ByteBuffer[] | Raw data of video frames (eg: RGBA only needs to consider data[0], I420 needs to consider data[0,1,2]). |
| dataLength | int[] | Data length (eg: RGBA only needs to consider dataLength[0], I420 needs to consider dataLength[0,1,2]). |
| param | ZegoVideoFrameParam | Video frame flip mode. |
| extraInfo | String | Video frame extra info. |
Details
The callback triggered when the media player throws out video frame data.
- Trigger: The callback is generated when the media player starts playing.
- Caution: The callback does not actually take effect until call [setVideoHandler] to set.
- Available since: 2.16.0
- Restrictions: When playing copyrighted music, this callback will be disabled by default. If necessary, please contact ZEGO technical support.
IZegoMixerStartCallback
Declared in callback/IZegoMixerStartCallback.java
Methods
onMixerStartResult
onMixerStartResult
public onMixerStartResult(int errorCode, String extendedData)Results of starting a mixer task.
Declared in
callback/IZegoMixerStartCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| extendedData | String | Extended Information |
IZegoMixerStopCallback
Declared in callback/IZegoMixerStopCallback.java
Methods
onMixerStopResult
onMixerStopResult
public onMixerStopResult(int errorCode)Results of stoping a mixer task.
Declared in
callback/IZegoMixerStopCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
IZegoNetworkProbeResultCallback
Declared in callback/IZegoNetworkProbeResultCallback.java
Methods
onNetworkProbeResult
onNetworkProbeResult
public onNetworkProbeResult(int errorCode, ZegoNetworkProbeResult result)Callback for network probe.
Declared in
callback/IZegoNetworkProbeResultCallback.java| 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 |
IZegoPublisherSetStreamExtraInfoCallback
Declared in callback/IZegoPublisherSetStreamExtraInfoCallback.java
Methods
onPublisherSetStreamExtraInfoResult
onPublisherSetStreamExtraInfoResult
public onPublisherSetStreamExtraInfoResult(int errorCode)Callback for setting stream extra information.
Declared in
callback/IZegoPublisherSetStreamExtraInfoCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
IZegoPublisherUpdateCdnUrlCallback
Declared in callback/IZegoPublisherUpdateCdnUrlCallback.java
Methods
onPublisherUpdateCdnUrlResult
onPublisherUpdateCdnUrlResult
public onPublisherUpdateCdnUrlResult(int errorCode)Callback for add/remove CDN URL.
Declared in
callback/IZegoPublisherUpdateCdnUrlCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
IZegoRealTimeSequentialDataSentCallback
Declared in callback/IZegoRealTimeSequentialDataSentCallback.java
Methods
onRealTimeSequentialDataSent
onRealTimeSequentialDataSent
public onRealTimeSequentialDataSent(int errorCode)Callback for sending real-time sequential data.
Declared in
callback/IZegoRealTimeSequentialDataSentCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
IZegoRoomLoginCallback
Declared in callback/IZegoRoomLoginCallback.java
Methods
onRoomLoginResult
onRoomLoginResult
public onRoomLoginResult(int errorCode, String extendedData)Login room result callback.
Declared in
callback/IZegoRoomLoginCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| extendedData | String | Extended Information |
IZegoRoomLogoutCallback
Declared in callback/IZegoRoomLogoutCallback.java
Methods
onRoomLogoutResult
onRoomLogoutResult
public onRoomLogoutResult(int errorCode, String extendedData)Logout room result callback.
Declared in
callback/IZegoRoomLogoutCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
| extendedData | String | Extended Information |
IZegoRoomSendTransparentMessageCallback
Declared in callback/IZegoRoomSendTransparentMessageCallback.java
Methods
onRoomSendTransparentMessageResult
onRoomSendTransparentMessageResult
public onRoomSendTransparentMessageResult(int errorCode)Callback for sending custom command.
Declared in
callback/IZegoRoomSendTransparentMessageCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
IZegoRoomSetRoomExtraInfoCallback
Declared in callback/IZegoRoomSetRoomExtraInfoCallback.java
Methods
onRoomSetRoomExtraInfoResult
onRoomSetRoomExtraInfoResult
public onRoomSetRoomExtraInfoResult(int errorCode)Callback for setting room extra information.
Declared in
callback/IZegoRoomSetRoomExtraInfoCallback.java| Name | Type | Description |
|---|---|---|
| errorCode | int | Error code, please refer to the error codes document https://docs.zegocloud.com/en/5548.html for details. |
IZegoTestNetworkConnectivityCallback
Declared in callback/IZegoTestNetworkConnectivityCallback.java
Methods
onTestNetworkConnectivityCallback
onTestNetworkConnectivityCallback
public onTestNetworkConnectivityCallback(int errorCode, ZegoTestNetworkConnectivityResult result)Callback for test network connectivity.
Declared in
callback/IZegoTestNetworkConnectivityCallback.java| 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 |
IZegoUploadLogResultCallback
Declared in callback/IZegoUploadLogResultCallback.java
Methods
onUploadLogResult
onUploadLogResult
public onUploadLogResult(int errorCode)Log upload result callback.
Declared in
callback/IZegoUploadLogResultCallback.javaParameters
| 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.