提交工单
咨询集成、功能及报价等问题
ZEGO Express SDKs provide rich APIs for you to quickly build audio/video calling and live streaming capabilities into your applications based on ZEGO's cloud live streaming platform. With a powerful audio/video processing engine and a global real-time network, the platform is providing high-quality and reliable cloud audio/video streaming services to businesses around the world.
ZEGO Express SDKs are available for all major platforms, including Android, iOS, Mac, Windows, and Web.
Method | Description |
---|---|
createEngine | Create ZegoExpressEngine singleton object and initialize SDK. |
destroyEngine | Destroy the ZegoExpressEngine singleton object and deinitialize the SDK. |
getEngine | Returns the singleton instance of ZegoExpressEngine. |
setEngineConfig | Set advanced engine configuration. |
setEngineConfig | Set advanced engine configuration with Android Application context. |
setLogConfig | Set log configuration. |
setRoomMode | Set room mode. |
getVersion | Gets the SDK's version number. |
setApiCalledCallback | Set method execution result callback. |
setEventHandler | Sets up the event notification callbacks that need to be handled. If the eventHandler is set to [null], all the callbacks set previously will be cleared. |
uploadLog | Uploads logs to the ZEGO server. |
uploadLog | Uploads logs to the ZEGO server. |
enableDebugAssistant | Enable the debugg assistant. Note, do not enable this feature in the online version! Use only during development phase! |
callExperimentalAPI | Call the RTC experimental API. |
setDummyCaptureImagePath | Set the path of the static picture would be published when the camera is closed. |
onDebugError | The callback for obtaining debugging error information. |
onApiCalledResult | Method execution result callback |
onEngineStateUpdate | The callback triggered when the audio/video engine state changes. |
onNetworkTimeSynchronized | Successful callback of network time synchronization.. |
Method | Description |
---|---|
loginRoom | Logs in to a room. You must log in to a room before publishing or playing streams. |
loginRoom | Logs in to a room with advanced room configurations. You must log in to a room before publishing or playing streams. |
loginRoom | Log in to the room by configuring advanced properties, and return the login result through the callback parameter. You must log in to the room before pushing or pulling the stream. |
logoutRoom | Logs out of a room. |
logoutRoom | Logs out of a room. |
logoutRoom | Logs out of a room. |
logoutRoom | Logs out of a room. |
switchRoom | Switch the room. |
switchRoom | Switch the room with advanced room configurations. |
renewToken | Renew token. |
setRoomExtraInfo | Set room extra information. |
onRoomStateUpdate | The callback triggered when the room connection state changes. |
onRoomStateChanged | The callback triggered when the room connection state changes. |
onRoomUserUpdate | The callback triggered when the number of other users in the room increases or decreases. |
onRoomOnlineUserCountUpdate | The callback triggered every 30 seconds to report the current number of online users. |
onRoomStreamUpdate | The callback triggered when the number of streams published by the other users in the same room increases or decreases. |
onRoomStreamExtraInfoUpdate | The callback triggered when there is an update on the extra information of the streams published by other users in the same room. |
onRoomExtraInfoUpdate | The callback triggered when there is an update on the extra information of the room. |
onRoomTokenWillExpire | Callback notification that room Token authentication is about to expire. |
Method | Description |
---|---|
startPublishingStream | Start publishing a stream. |
startPublishingStream | Starts publishing a stream (for the specified channel). You can call this function to publish a second stream. |
startPublishingStream | Starts publishing a stream. Support multi-room mode. |
stopPublishingStream | Stops publishing a stream. |
stopPublishingStream | Stops publishing a stream (for the specified channel). |
setStreamExtraInfo | Sets the extra information of the stream being published. |
setStreamExtraInfo | Sets the extra information of the stream being published for the specified publish channel. |
startPreview | Starts/Updates the local video preview. |
startPreview | Starts/Updates the local video preview (for the specified channel). |
stopPreview | Stops the local preview. |
stopPreview | Stops the local preview (for the specified channel). |
setVideoConfig | Sets up the video configurations. |
setVideoConfig | Sets up the video configurations (for the specified channel). |
getVideoConfig | Gets the current video configurations. |
getVideoConfig | Gets the current video configurations (for the specified channel). |
setVideoMirrorMode | Sets the video mirroring mode. |
setVideoMirrorMode | Sets the video mirroring mode (for the specified channel). |
setAppOrientation | Set the video orientation. |
setAppOrientation | Sets the video orientation (for the specified channel). |
setAudioConfig | Sets up the audio configurations. |
setAudioConfig | Sets up the audio configurations for the specified publish channel. |
getAudioConfig | Gets the current audio configurations. |
getAudioConfig | Gets the current audio configurations from the specified publish channel. |
setPublishStreamEncryptionKey | Set encryption key for the publishing stream. |
setPublishStreamEncryptionKey | Set encryption key for the publishing stream for the specified publish channel. |
takePublishStreamSnapshot | Take a snapshot of the publishing stream. |
takePublishStreamSnapshot | Take a snapshot of the publishing stream for the specified publish channel. |
mutePublishStreamAudio | Stops or resumes sending the audio part of a stream. |
mutePublishStreamAudio | Stops or resumes sending the audio part of a stream for the specified channel. |
mutePublishStreamVideo | Stops or resumes sending the video part of a stream. |
mutePublishStreamVideo | Stops or resumes sending the video part of a stream for the specified channel. |
setStreamAlignmentProperty | Enable or disable the stream mixing precision alignment function. |
enableTrafficControl | Enables or disables traffic control. |
enableTrafficControl | Enables or disables the traffic control for the specified publish channel. |
setMinVideoBitrateForTrafficControl | Set the minimum video bitrate threshold for traffic control. |
setMinVideoBitrateForTrafficControl | Sets the minimum video bitrate for traffic control for the specified publish channel. |
setMinVideoFpsForTrafficControl | Sets the minimum video frame rate threshold for traffic control. |
setMinVideoResolutionForTrafficControl | Sets the minimum video resolution threshold for traffic control. |
setTrafficControlFocusOn | Set the factors of concern that trigger traffic control. |
setTrafficControlFocusOn | Set the factors of concern that trigger traffic control for the specified publish channel. |
setCaptureVolume | Sets the audio recording volume for stream publishing. |
setAudioCaptureStereoMode | Set audio capture stereo mode. |
addPublishCdnUrl | Adds a target CDN URL to which the stream will be relayed from ZEGO RTC server. |
removePublishCdnUrl | Deletes the specified CDN URL, which is used for relaying streams from ZEGO RTC server to CDN. |
enablePublishDirectToCDN | Whether to directly push to CDN (without going through the ZEGO RTC server). |
enablePublishDirectToCDN | Whether to directly push to CDN (without going through the ZEGO RTC server), for the specified channel. |
setPublishWatermark | Sets up the stream watermark before stream publishing. |
setPublishWatermark | Sets up the stream watermark before stream publishing (for the specified channel). |
setSEIConfig | Set the Supplemental Enhancement Information type. |
sendSEI | Sends Supplemental Enhancement Information. |
sendSEI | Sends Supplemental Enhancement Information. |
sendSEISyncWithCustomVideo | Send the media supplementary enhancement information synchronized with the current video frame during custom video capture. |
sendAudioSideInfo | Send audio side information. |
enableHardwareEncoder | Enables or disables hardware encoding. |
setCapturePipelineScaleMode | Sets the timing of video scaling in the video capture workflow. You can choose to do video scaling right after video capture (the default value) or before encoding. |
enableH265EncodeFallback | Whether to enable H.265 encoding to automatically downgrade to H.264 encoding. |
isVideoEncoderSupported | Whether the specified video encoding type is supported. |
onPublisherStateUpdate | The callback triggered when the state of stream publishing changes. |
onPublisherQualityUpdate | Callback for current stream publishing quality. |
onPublisherCapturedAudioFirstFrame | The callback triggered when the first audio frame is captured. |
onPublisherCapturedVideoFirstFrame | The callback triggered when the first video frame is captured. |
onPublisherRenderVideoFirstFrame | The callback triggered when the first video frame is rendered. |
onPublisherVideoSizeChanged | The callback triggered when the video capture resolution changes. |
onPublisherRelayCDNStateUpdate | The callback triggered when the state of relayed streaming to CDN changes. |
onPublisherVideoEncoderChanged | The callback triggered when the video encoder changes in publishing stream. |
onPublisherStreamEvent | The callback triggered when publishing stream. |
Method | Description |
---|---|
startPlayingStream | Starts playing a stream from ZEGO RTC server. |
startPlayingStream | Starts playing a stream from ZEGO RTC server or from third-party CDN. Support multi-room mode. |
stopPlayingStream | Stops playing a stream. |
setPlayStreamDecryptionKey | Set decryption key for the playing stream. |
setPlayStreamCrossAppInfo | Set up cross App playing stream information. |
takePlayStreamSnapshot | Take a snapshot of the playing stream. |
setPlayVolume | Sets the stream playback volume. |
setAllPlayStreamVolume | Sets the all stream playback volume. |
setPlayStreamVideoType | Set play video stream type. |
setPlayStreamBufferIntervalRange | Set the adaptive adjustment interval range of the buffer for playing stream. |
setPlayStreamFocusOn | Set the weight of the pull stream priority. |
mutePlayStreamAudio | Whether the pull stream can receive the specified audio data. |
mutePlayStreamVideo | Whether the pull stream can receive the specified video data. |
muteAllPlayStreamAudio | Can the pull stream receive all audio data. |
muteAllPlayStreamVideo | Can the pull stream receive all video data. |
enableHardwareDecoder | Enables or disables hardware decoding. |
enableCheckPoc | Enables or disables frame order detection. |
isVideoDecoderSupported | Whether the specified video decoding format is supported. |
setPlayStreamsAlignmentProperty | Set the play stream alignment properties. |
onPlayerStateUpdate | The callback triggered when the state of stream playing changes. |
onPlayerQualityUpdate | Callback for current stream playing quality. |
onPlayerMediaEvent | The callback triggered when a media event occurs during streaming playing. |
onPlayerRecvAudioFirstFrame | The callback triggered when the first audio frame is received. |
onPlayerRecvVideoFirstFrame | The callback triggered when the first video frame is received. |
onPlayerRenderVideoFirstFrame | The callback triggered when the first video frame is rendered. |
onPlayerVideoSizeChanged | The callback triggered when the stream playback resolution changes. |
onPlayerRecvSEI | The callback triggered when Supplemental Enhancement Information is received. |
onPlayerRecvAudioSideInfo | Receive the audio side information content of the remote stream. |
onPlayerLowFpsWarning | Playing stream low frame rate warning. |
onPlayerStreamEvent | The callback triggered when playing stream. |
Method | Description |
---|---|
createRealTimeSequentialDataManager | Create the real time sequential data manager instance |
destroyRealTimeSequentialDataManager | Destroy the real time sequential data manager instance |
setEventHandler | Sets up the real-time sequential data event handler. |
startBroadcasting | Start broadcasting real-time sequential data stream. |
stopBroadcasting | Stop broadcasting real-time sequential data stream. |
sendRealTimeSequentialData | Send real-time sequential data to the broadcasting stream ID. |
startSubscribing | Start subscribing real-time sequential data stream. |
stopSubscribing | Stop subscribing real-time sequential data stream. |
getIndex | Get real-time sequential data manager index. |
onReceiveRealTimeSequentialData | Callback for receiving real-time sequential data. |
sendBroadcastMessage | Sends a Broadcast Message. |
sendBarrageMessage | Sends a Barrage Message (bullet screen) to all users in the same room, without guaranteeing the delivery. |
sendCustomCommand | Sends a Custom Command to the specified users in the same room. |
onIMRecvBroadcastMessage | The callback triggered when Broadcast Messages are received. |
onIMRecvBarrageMessage | The callback triggered when Barrage Messages are received. |
onIMRecvCustomCommand | The callback triggered when a Custom Command is received. |
Method | Description |
---|---|
startMixerTask | Starts a stream mixing task. |
stopMixerTask | Stops a stream mixing task. |
startAutoMixerTask | Starts an auto stream mixing task. |
stopAutoMixerTask | Stops an auto stream mixing task. |
onMixerRelayCDNStateUpdate | The callback triggered when the state of relayed streaming of the mixed stream to CDN changes. |
onMixerSoundLevelUpdate | The callback triggered when the sound level of any input stream changes in the stream mixing process. |
onAutoMixerSoundLevelUpdate | The callback triggered when the sound level of any input stream changes in the auto stream mixing process. |
Method | Description |
---|---|
enableAEC | Whether to enable acoustic echo cancellation (AEC). |
enableHeadphoneAEC | Whether to turn on acoustic echo cancellation (AEC) when using the headphone. |
setAECMode | Sets the acoustic echo cancellation (AEC) mode. |
enableAGC | Enables or disables automatic gain control (AGC). |
enableANS | Enables or disables active noise suppression (ANS, aka ANC). |
enableTransientANS | Enables or disables transient noise suppression. |
setANSMode | Sets the automatic noise suppression (ANS) mode. |
enableAudioMixing | Enables or disables audio mixing function. |
setAudioMixingHandler | Sets up the audio mixing event handler. |
muteLocalAudioMixing | Mute or resume local playback of the mixing audio. |
setAudioMixingVolume | Sets the audio mixing output volume for both local playback and the stream to be published. |
setAudioMixingVolume | Sets the audio mixing output volume for either local playback or the stream to published. |
startEffectsEnv | Enable the Effects beauty environment. |
stopEffectsEnv | Disable the Effects beauty environment. |
enableEffectsBeauty | Enables or disables the beauty effect. |
setEffectsBeautyParam | Set beautify param. |
setAudioEqualizerGain | Set the sound equalizer (EQ). |
setVoiceChangerPreset | Setting up the voice changer via preset enumeration. |
setVoiceChangerParam | Setting up the specific voice changer parameters. |
setReverbPreset | Setting up the reverberation via preset enumeration. |
setReverbAdvancedParam | Setting up the specific reverberation parameters. |
setReverbEchoParam | Setting up the specific reverberation echo parameters. |
enableVirtualStereo | Enable or disable the virtual stereo effect when publishing stream.. |
enablePlayStreamVirtualStereo | Enable or disable the virtual stereo effect when playing stream. |
setElectronicEffects | Turn on or off the electronic sound effect. |
onAudioMixingCopyData | Audio mixing callback. |
Method | Description |
---|---|
createMediaPlayer | Creates a media player instance. |
destroyMediaPlayer | Destroys a media player instance. |
start | Start playing. |
stop | Stop playing. |
pause | Pause playing. |
resume | resume playing. |
loadResource | Load media resource. |
getCurrentState | Get the current playback status. |
seekTo | Set the specified playback progress. |
setVolume | Set mediaplayer volume. Both the local play volume and the publish volume are set. |
setPlayVolume | Sets the stream playback volume. |
setPublishVolume | Set mediaplayer publish volume. |
getPlayVolume | Gets the current local playback volume of the mediaplayer, the range is 0 ~ 200, with the default value of 60. |
getPublishVolume | Gets the current publish volume of the mediaplayer, the range is 0 ~ 200, with the default value of 60. |
getTotalDuration | Get the total progress of your media resources. |
getCurrentProgress | Get current playing progress. |
muteLocal | Whether to play locally silently. |
setPlayerCanvas | Set the view of the player playing video. |
enableAux | Whether to mix the player's sound into the main stream channel being published. |
enableRepeat | Whether to repeat playback. |
setPlaySpeed | Set the speed of play. |
setProgressInterval | Set playback progress callback interval. |
getAudioTrackCount | Get the number of audio tracks of the playback file. |
setAudioTrackIndex | Set the audio track of the playback file. |
setVoiceChangerPreset | Setting up the voice changer via preset enumeration. |
setVoiceChangerParam | Setting up the specific voice changer parameters. |
takeSnapshot | Take a screenshot of the current playing screen of the media player. |
enableAccurateSeek | Open precise seek and set relevant attributes. |
setNetWorkResourceMaxCache | Set the maximum cache duration and cache data size of web materials. |
getNetWorkResourceCache | Get the playable duration and size of the cached data of the current network material cache queue |
setNetWorkBufferThreshold | Use this interface to set the cache threshold that the media player needs to resume playback. The SDK default value is 5000ms,The valid value is greater than or equal to 1000ms |
enableSoundLevelMonitor | Whether to enable sound level monitoring. |
enableFrequencySpectrumMonitor | Whether to enable frequency spectrum monitoring. |
setActiveAudioChannel | Set the playback channel. |
clearView | Clears the last frame of the playback control that remains on the control after playback ends. |
onMediaPlayerStateUpdate | MediaPlayer playback status callback. |
onMediaPlayerNetworkEvent | The callback triggered when the network status of the media player changes. |
onMediaPlayerPlayingProgress | The callback to report the current playback progress of the media player. |
onMediaPlayerRecvSEI | The callback triggered when the media player got media side info. |
onMediaPlayerSoundLevelUpdate | The callback of sound level update. |
onMediaPlayerFrequencySpectrumUpdate | The callback of frequency spectrum update. |
onVideoFrame | The callback triggered when the media player throws out video frame data. |
onVideoFrame | The callback triggered when the media player throws out video frame data. |
onAudioFrame | The callback triggered when the media player throws out audio frame data. |
Method | Description |
---|---|
createAudioEffectPlayer | Creates a audio effect player instance. |
destroyAudioEffectPlayer | Destroys a audio effect player instance. |
setEventHandler | Set audio effect player event handler. |
start | Start playing audio effect. |
stop | Stop playing audio effect. |
pause | Pause playing audio effect. |
resume | Resume playing audio effect. |
stopAll | Stop playing all audio effect. |
pauseAll | Pause playing all audio effect. |
resumeAll | Resume playing all audio effect. |
seekTo | Set the specified playback progress. |
setVolume | Set volume for a single audio effect. Both the local play volume and the publish volume are set. |
setVolumeAll | Set volume for all audio effect. Both the local play volume and the publish volume are set. |
setPlaySpeed | Set the playback speed for a given audio effect. Both the local play speed and the publish speed are set. (separate settings are not supported). |
getTotalDuration | Get the total duration of the specified audio effect resource. |
getCurrentProgress | Get current playback progress. |
loadResource | Load audio effect resource. |
unloadResource | Unload audio effect resource. |
getIndex | Get audio effect player index. |
onAudioEffectPlayStateUpdate | Audio effect playback state callback. |
Method | Description |
---|---|
startRecordingCapturedData | Starts to record and directly save the data to a file. |
stopRecordingCapturedData | Stops recording locally captured audio or video. |
setDataRecordEventHandler | Sets up the event callback handler for data recording. |
onCapturedDataRecordStateUpdate | The callback triggered when the state of data recording (to a file) changes. |
onCapturedDataRecordProgressUpdate | The callback to report the current recording progress. |
Method | Description |
---|---|
muteMicrophone | Mutes or unmutes the microphone. |
isMicrophoneMuted | Checks whether the microphone is muted. |
muteSpeaker | Mutes or unmutes the audio output speaker. |
isSpeakerMuted | Checks whether the audio output speaker is muted. |
useAudioDevice | Chooses to use the specified audio device. |
enableAudioCaptureDevice | Enables or disables the audio capture device. |
getAudioRouteType | get current audio route type. |
setAudioRouteToSpeaker | Whether to use the built-in speaker to play audio. |
enableCamera | Turns on/off the camera. |
enableCamera | Turns on/off the camera (for the specified channel). |
useFrontCamera | Switches to the front or the rear camera. |
useFrontCamera | Switches to the front or the rear camera (for the specified channel). |
isCameraFocusSupported | Whether the camera supports focusing. |
setCameraFocusMode | Set the camera focus mode. |
setCameraFocusPointInPreview | Set the focus point in the preview view. |
setCameraExposureMode | Set the camera exposure mode. |
setCameraExposurePointInPreview | Set the exposure point in the preview view. |
setCameraExposureCompensation | Set the camera exposure compensation value. |
setCameraExposureCompensation | Set the camera exposure compensation value. |
setCameraZoomFactor | Set the zoom factor of the camera. Every time the camera is restarted, the camera zoom factor will return to the initial value (1.0). |
setCameraZoomFactor | Set the zoom factor of the camera. Every time the camera is restarted, the camera zoom factor will return to the initial value (1.0). |
getCameraMaxZoomFactor | Get the maximum zoom factor of the camera. |
getCameraMaxZoomFactor | Get the maximum zoom factor of the camera. |
enableCameraAdaptiveFPS | Enable camera adaptive frame rate. |
startSoundLevelMonitor | Starts sound level monitoring. |
startSoundLevelMonitor | Starts sound level monitoring. Support setting the listening interval. |
startSoundLevelMonitor | Starts sound level monitoring. Support enable some advanced feature. |
stopSoundLevelMonitor | Stops sound level monitoring. |
startAudioSpectrumMonitor | Starts audio spectrum monitoring. |
startAudioSpectrumMonitor | Starts audio spectrum monitoring. Support setting the listening interval. |
stopAudioSpectrumMonitor | Stops audio spectrum monitoring. |
enableHeadphoneMonitor | Enables or disables headphone monitoring. |
setHeadphoneMonitorVolume | Sets the headphone monitor volume. |
startAudioVADStableStateMonitor | Start audio VAD stable state monitoring. |
startAudioVADStableStateMonitor | Start audio VAD stable state monitoring, and the monitoring period can be set. |
stopAudioVADStableStateMonitor | Stop audio VAD stable state monitoring. |
onCapturedSoundLevelUpdate | The local captured audio sound level callback. |
onCapturedSoundLevelInfoUpdate | The local captured audio sound level callback. |
onRemoteSoundLevelUpdate | The remote playing streams audio sound level callback. |
onRemoteSoundLevelInfoUpdate | The remote playing streams audio sound level callback. |
onCapturedAudioSpectrumUpdate | The local captured audio spectrum callback. |
onRemoteAudioSpectrumUpdate | The remote playing streams audio spectrum callback. |
onLocalDeviceExceptionOccurred | The callback triggered when a local device exception occurred. |
onRemoteCameraStateUpdate | The callback triggered when the state of the remote camera changes. |
onRemoteMicStateUpdate | The callback triggered when the state of the remote microphone changes. |
onRemoteSpeakerStateUpdate | The callback triggered when the state of the remote speaker changes. |
onAudioRouteChange | Callback for device's audio route changed. |
onAudioVADStateUpdate | Callback for audio VAD stable state update. |
Method | Description |
---|---|
enableCustomVideoRender | Enables or disables custom video rendering. |
setCustomVideoRenderHandler | Sets up the event callback handler for custom video rendering. |
enableCustomVideoCapture | Enables or disables custom video capture. |
enableCustomVideoCapture | Enables or disables custom video capture (for the specified channel). |
setCustomVideoCaptureHandler | Sets the event callback handler for custom video capture. |
sendCustomVideoCaptureRawData | Sends the video frames (Raw Data) produced by custom video capture to the SDK. |
sendCustomVideoCaptureRawData | Sends the video frames (Raw Data) produced by custom video capture to the SDK (for the specified channel). |
sendCustomVideoCaptureTextureData | Sends the video frames (Texture Data) produced by custom video capture to the SDK. |
sendCustomVideoCaptureTextureData | Sends the video frames (Texture Data) produced by custom video capture to the SDK (for the specified channel). |
getCustomVideoCaptureSurfaceTexture | Gets the SurfaceTexture instance from main channel. |
getCustomVideoCaptureSurfaceTexture | Gets the SurfaceTexture instance (for the specified channel). |
sendCustomVideoCaptureEncodedData | Sends the video frames (Encoded Data) produced by custom video capture to the SDK. |
sendCustomVideoCaptureEncodedData | Sends the video frames (Encoded Data) produced by custom video capture to the SDK (for the specified channel). |
setCustomVideoCaptureFillMode | Sets the video fill mode of custom video capture. |
setCustomVideoCaptureFillMode | Sets the video fill mode of custom video capture (for the specified channel). |
setCustomVideoCaptureFlipMode | Sets the video flip mode of custom video capture (for the specified channel). This function takes effect only if the custom video buffer type is Texture2D. |
setCustomVideoCaptureFlipMode | Sets the video flip mode of custom video capture (for the specified channel). This function takes effect only if the custom video buffer type is Texture2D. |
setCustomVideoCaptureRotation | Sets the video rotation of custom video capture (for the specified channel). |
setCustomVideoCaptureDeviceState | Sets device state of custom video capture (for the specified channel). |
setCustomVideoCaptureTransformMatrix | Sets the video transform matrix of custom video capture (for the specified channel). |
setCustomVideoCaptureRegionOfInterest | Set the region of interest (ROI) for encoder of custom video capture (for the specified channel). |
onStart | Customize the notification of the start of video capture. |
onStop | Customize the notification of the end of the collection. |
onEncodedDataTrafficControl | When network changes are detected during custom video capture, the developer is notified that traffic control is required, and the encoding configuration is adjusted according to the recommended parameters of the SDK. |
onCapturedVideoFrameRawData | When custom video rendering is enabled, the original video frame data collected by the local preview is called back. |
onRemoteVideoFrameRawData | When custom video rendering is enabled, the remote end pulls the original video frame data to call back, and distinguishes different streams by streamID. |
onRemoteVideoFrameEncodedData | The callback for obtianing the video frames (Encoded Data) of the remote stream. Different streams can be identified by streamID. |
enableCustomVideoProcessing | Enables or disables custom video processing. |
enableCustomVideoProcessing | Enables or disables custom video processing. |
setCustomVideoProcessHandler | Sets up the event callback handler for custom video processing. |
sendCustomVideoProcessedTextureData | Send the [Texture] type video data after the pre-processing of the custom video to the SDK. |
sendCustomVideoProcessedTextureData | Send the [Texture] type video data after the pre-processing of the custom video to the SDK (for the specified channel). |
onStart | The SDK informs the developer that it is about to start custom video processing. |
onStop | The SDK informs the developer to stop custom video processing. |
getCustomVideoProcessOutputSurfaceTexture | Get SurfaceTexture for output data. |
getCustomVideoProcessOutputSurfaceTexture | Get SurfaceTexture for output data (for the specified channel). |
onCapturedUnprocessedTextureData | Call back when the original video data of type [Texture] is obtained. |
getCustomVideoProcessInputSurfaceTexture | When the developer chooses the SurfaceTexture video pre-processing type, the SurfaceTexture used to input the original video data is obtained through this interface and passed to the SDK. |
Method | Description |
---|---|
enableCustomAudioCaptureProcessing | Enable local collection and custom audio processing(before ear return). |
enableCustomAudioCaptureProcessingAfterHeadphoneMonitor | Turn on local collection and custom audio processing (after ear return). |
enableCustomAudioRemoteProcessing | Enable custom audio processing for remote playing stream. |
enableCustomAudioPlaybackProcessing | Enable custom audio processing for SDK playback audio data. |
setCustomAudioProcessHandler | Set up callback handler for custom audio processing. |
startAudioDataObserver | Enable audio data observering. |
stopAudioDataObserver | Disable audio data observering. |
setAudioDataHandler | Sets up the event callback handler for receiving audio data. |
enableCustomAudioIO | Enables the custom audio I/O function. |
enableCustomAudioIO | Enables the custom audio I/O function (for the specified channel), support PCM, AAC format data. |
sendCustomAudioCaptureAACData | Sends AAC audio data produced by custom audio capture to the SDK (for the specified channel). |
sendCustomAudioCapturePCMData | Sends PCM audio data produced by custom audio capture to the SDK. |
sendCustomAudioCapturePCMData | Sends PCM audio data produced by custom audio capture to the SDK (for the specified channel). |
fetchCustomAudioRenderPCMData | Fetches PCM audio data of the remote stream from the SDK for custom audio rendering. |
onProcessCapturedAudioData | Custom audio processing local captured PCM audio frame callback. |
onProcessCapturedAudioDataAfterUsedHeadphoneMonitor | Custom audio processing local captured PCM audio frame callback after used headphone monitor. |
onProcessRemoteAudioData | Custom audio processing remote playing stream PCM audio frame callback. |
onProcessPlaybackAudioData | Custom audio processing SDK playback PCM audio frame callback. |
onCapturedAudioData | The callback for obtaining the audio data captured by the local microphone. |
onPlaybackAudioData | The callback for obtaining the audio data of all the streams playback by SDK. |
onMixedAudioData | The callback for obtaining the mixed audio data. Such mixed auido data are generated by the SDK by mixing the audio data of all the remote playing streams and the auido data captured locally. |
onPlayerAudioData | The callback for obtaining the audio data of each stream. |
Method | Description |
---|---|
startPerformanceMonitor | Start system performance monitoring. |
stopPerformanceMonitor | Stop system performance monitoring. |
startNetworkProbe | Start network probe. |
stopNetworkProbe | Stop network probe. |
testNetworkConnectivity | Test network connectivity. |
startNetworkSpeedTest | Start network speed test. |
startNetworkSpeedTest | Start network speed test. Support set speed test interval。 |
stopNetworkSpeedTest | Stop network speed test. |
getNetworkTimeInfo | Obtain synchronization network time information. |
onPerformanceStatusUpdate | The system performance status callback. (Note: Due to Android system limitations, CPU usage cannot be obtained) |
onNetworkModeChanged | Network mode changed callback. |
onNetworkSpeedTestError | Network speed test error callback. |
onNetworkSpeedTestQualityUpdate | Network speed test quality callback. |
onRecvExperimentalAPI | Receive experiment API JSON content. |
onNetworkQuality | The network quality callback of users who are publishing in the room. |
Method | Description |
---|---|
createRangeAudio | Creates a range audio instance. |
destroyRangeAudio | Destroys a range audio instance. |
setEventHandler | set range audio event handler. |
setAudioReceiveRange | Set the maximum range of received audio. |
updateSelfPosition | Update self position and orentation. |
updateAudioSource | Add or update audio source position information. |
enableSpatializer | Turn the 3D spatial sound on or off. |
enableMicrophone | Turn the microphone on or off. |
enableSpeaker | Turn the speaker on or off. |
setRangeAudioMode | Set range audio mode. |
setTeamID | Set team ID. |
muteUser | Whether can receive the audio data of the specified user. |
onRangeAudioMicrophoneStateUpdate | Range audio microphone state callback. |
Method | Description |
---|---|
createCopyrightedMusic | Creates a copyrighted music instance. |
destroyCopyrightedMusic | Destroys a copyrighted music instance. |
setEventHandler | set copyrighted music event handler. |
initCopyrightedMusic | Initialize the copyrighted music module. |
getCacheSize | Get cache size. |
clearCache | Clear cache. |
sendExtendedRequest | Send extended feature request. |
getLrcLyric | Get lyrics in lrc format. |
getKrcLyricByToken | Get lyrics in krc format. |
requestSong | Request a song. |
requestAccompaniment | Request accompaniment. |
requestAccompanimentClip | Request accompaniment clip. |
getMusicByToken | Get a song or accompaniment. |
download | Download song or accompaniment. |
queryCache | Query the resource's cache is existed or not. |
getDuration | Get the playing time of a song or accompaniment file. |
startScore | Start scoring. |
pauseScore | Pause scoring. |
resumeScore | Resume scoring. |
stopScore | Stop scoring. |
resetScore | Reset scoring. |
getPreviousScore | Get the score of the previous sentence. |
getAverageScore | Get average score. |
getTotalScore | Get total score . |
getStandardPitch | Get standard pitch data. |
getCurrentPitch | Get total score . |
onDownloadProgressUpdate | Callback for download song or accompaniment progress rate. |
onCurrentPitchValueUpdate | Real-time pitch line callback. |
Method | Description |
---|---|
enableBeautify | Enables or disables the beauty features for the main publish channel. |
enableBeautify | Enables or disables the beauty features for the specified publish channel. |
setBeautifyOption | Set beautify option. |
setBeautifyOption | Set beautify option. |
createEngine | [Deprecated] Create ZegoExpressEngine singleton object and initialize SDK. |
setDebugVerbose | [Deprecated] Turns on/off verbose debugging and sets up the log language. This function is deprecated in version 2.3.0, please use [enableDebugAssistant] to achieve the original function. |
loginMultiRoom | [Deprecated] Logs in multi room. This method has been deprecated after version 2.9.0 If you want to access the multi-room feature, Please set [setRoomMode] to select multi-room mode before the engine started, and then call [loginRoom] to use multi-room. If you call [loginRoom] function to log in to multiple rooms, please make sure to pass in the same user information. |
setPlayStreamVideoLayer | [Deprecated] Set the selected video layer of playing stream. This function has been deprecated since version 2.3.0, Please use [setPlayStreamVideoType] instead. |
enableAudioDataCallback | [Deprecated] Enables the callback for receiving audio data. This function has been deprecated since version 2.7.0, please use [startAudioDataObserver] and [stopAudioDataObserver] instead. |
setReverbParam | [Deprecated] Setting up the specific reverberation parameters. This function has been deprecated since version 1.18.0, please use [setReverbAdvancedParam] instead. |
setBuiltInSpeakerOn | [Deprecated] Whether to use the built-in speaker to play audio.This function has been deprecated since version 2.3.0 Please use [setAudioRouteToSpeaker] instead. |
onRoomStreamUpdate | [Deprecated] The callback triggered when the number of streams published by the other users in the same room increases or decreases.This callback function has been deprecated since version 1.18.0, please use the callback function with the same name with the [extendedData] parameter. |
onDeviceError | [Deprecated] The callback triggered when a device exception occurs. Deprecated since 2.15.0, please use [onLocalDeviceExceptionOccurred] instead. |
onNetworkQuality | [Deprecated] Callback the network quality of streams in the room. Deprecated since 2.10.0, please use the callback with the same name with [ZegoStreamQualityLevel] enumeration parameter instead. |
onProcessCapturedAudioData | [Deprecated] Custom audio processing local captured PCM audio frame callback.Deprecated since 2.13.0, please use the callback function with the same name with the [timestamp] parameter. |
onProcessRemoteAudioData | [Deprecated] Custom audio processing remote playing stream PCM audio frame callback. Deprecated since 2.13.0, please use the callback function with the same name with the [timestamp] parameter. |
onProcessPlaybackAudioData | [Deprecated] Custom audio processing SDK playback PCM audio frame callback. Deprecated since 2.13.0, please use the callback function with the same name with the [timestamp] parameter. |