Documentation
Video Call
Function Overview
Function Overview

Function Overview

Last updated：2023-12-18 17:43

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
createEngineWithProfile	Create ZegoExpressEngine singleton object and initialize SDK.
destroyEngine	Destroy the ZegoExpressEngine singleton object and deinitialize the SDK.
setEngineConfig	Set advanced engine configuration.
setRoomMode	Set room mode.
getVersion	Gets the SDK's version number.
uploadLog	Uploads logs to the ZEGO server.
callExperimentalAPI	Call the experimental API.
on	Register event handler
off	Unregister event handler
debugError	The callback for obtaining debugging error information.
apiCalledResult	Method execution result callback
engineStateUpdate	The callback triggered when the audio/video engine state changes.

Room functions

Method	Description
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	Exit the room of the specified room ID with callback.
switchRoom	Switch the room with advanced room configurations.
renewToken	Renew token.
setRoomExtraInfo	Set room extra information.
roomStateUpdate	Notification of the room connection state changes.
roomStateChanged	Notification of the room connection state changes, including specific reasons for state change.
roomUserUpdate	The callback triggered when the number of other users in the room increases or decreases.
roomOnlineUserCountUpdate	The callback triggered every 30 seconds to report the current number of online users.
roomStreamUpdate	The callback triggered when the number of streams published by the other users in the same room increases or decreases.
roomStreamExtraInfoUpdate	The callback triggered when there is an update on the extra information of the streams published by other users in the same room.
roomExtraInfoUpdate	The callback triggered when there is an update on the extra information of the room.
roomTokenWillExpire	Callback notification that room Token authentication is about to expire.

Stream Publishing Functions

Method	Description
startPublishingStream	Starts publishing a stream. Support multi-room mode.
stopPublishingStream	Stops publishing a stream (for the specified channel).
setStreamExtraInfo	Sets the extra information of the stream being published for the specified publish channel.
startPreview	Starts/Updates the local video preview (for the specified channel).
stopPreview	Stops the local preview (for the specified channel).
setVideoConfig	Sets up the video configurations (for the specified channel).
getVideoConfig	Gets the current video configurations (for the specified channel).
setVideoMirrorMode	Sets the video mirroring mode (for the specified channel).
setAppOrientation	Sets the video orientation (for the specified channel).
setAudioConfig	Sets up the audio configurations for the specified publish channel.
getAudioConfig	Gets the current audio configurations from the specified publish channel.
takePublishStreamSnapshot	Take a snapshot of the publishing stream for the specified publish channel.
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 for the specified channel.
setCaptureVolume	Sets the audio recording volume for stream publishing.
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), for the specified channel.
sendSEI	Sends Supplemental Enhancement Information to the specified publish channel.
enableHardwareEncoder	Enables or disables hardware encoding.
enableH265EncodeFallback	Whether to enable H.265 encoding to automatically downgrade to H.264 encoding.
isVideoEncoderSupported	Whether the specified video encoding type is supported.
setVideoSource	Set video capture source for the specified channel.
setAudioSource	Set audio capture source for the specified channel.
enableVideoObjectSegmentation	Enable video object segmentation.
enableAlphaChannelVideoEncoder	Enable video encoder alpha channel support.
publisherStateUpdate	The callback triggered when the state of stream publishing changes.
publisherQualityUpdate	Callback for current stream publishing quality.
publisherCapturedAudioFirstFrame	The callback triggered when the first audio frame is captured.
publisherCapturedVideoFirstFrame	The callback triggered when the first video frame is captured.
publisherRenderVideoFirstFrame	The callback triggered when the first video frame is rendered.
publisherVideoSizeChanged	The callback triggered when the video capture resolution changes.
publisherRelayCDNStateUpdate	The callback triggered when the state of relayed streaming to CDN changes.
publisherVideoEncoderChanged	The callback triggered when the video encoder changes in publishing stream.
publisherStreamEvent	The callback triggered when publishing stream.
videoObjectSegmentationStateChanged	The video object segmentation state changed.

Stream Playing Functions

Method	Description
startPlayingStream	Starts playing a stream from ZEGO RTC server or from third-party CDN. Support multi-room mode.
stopPlayingStream	Stops playing a stream.
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.
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.
isVideoDecoderSupported	Whether the specified video decoding format is supported.
playerStateUpdate	The callback triggered when the state of stream playing changes.
playerQualityUpdate	Callback for current stream playing quality.
playerMediaEvent	The callback triggered when a media event occurs during streaming playing.
playerRecvAudioFirstFrame	The callback triggered when the first audio frame is received.
playerRecvVideoFirstFrame	The callback triggered when the first video frame is received. Except for Linux systems, this callback is thrown from the ui thread by default.
playerRenderVideoFirstFrame	The callback triggered when the first video frame is rendered.
playerVideoSizeChanged	The callback triggered when the stream playback resolution changes.
playerRecvSEI	The callback triggered when Supplemental Enhancement Information is received.

Instant Messaging Functions

Method	Description
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.
IMRecvBroadcastMessage	The callback triggered when Broadcast Messages are received.
IMRecvBarrageMessage	The callback triggered when Barrage Messages are received.
IMRecvCustomCommand	The callback triggered when a Custom Command is received.

Stream Mixing Functions

Method	Description
startMixerTask	Starts a stream mixing task.
stopMixerTask	Stops a stream mixing task.
mixerRelayCDNStateUpdate	The callback triggered when the state of relayed streaming of the mixed stream to CDN changes.
mixerSoundLevelUpdate	The callback triggered when the sound level of any input stream changes in the stream mixing process.

Audio and Video Preprocessing Functions

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).
setANSMode	Sets the automatic noise suppression (ANS) mode.
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.
setElectronicEffects	Turn on or off the electronic sound effect.

MediaPlayer Functions

Method	Description
createMediaPlayer	Creates a media player instance.
destroyMediaPlayer	Destroys a media player instance.
loadResource	Load local or network media resource.
loadResourceWithConfig	Load local or network media resource with config.
start	Start playing.
stop	Stop playing.
pause	Pause playing.
resume	Resume playing.
seekTo	Set the specified playback progress.
enableRepeat	Whether to repeat playback.
setPlaySpeed	Set the speed of play.
enableAux	Whether to mix the player's sound into the stream being published.
muteLocal	Whether to play locally silently.
setPlayerView	Set the view of the player playing video.
setVolume	Set mediaplayer volume. Both the local play volume and the publish volume are set.
setPlayVolume	Set mediaplayer local playback volume.
setPublishVolume	Set mediaplayer publish volume.
setProgressInterval	Set playback progress callback interval.
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.
getCurrentRenderingProgress	Get current rendering progress.
getAudioTrackCount	Get the number of audio tracks of the playback file.
setAudioTrackIndex	Set the audio track of the playback file.
getCurrentState	Get the current playback status.
getIndex	Get media player index.
on	Register the event handler of mediaplayer
off	Unregister the event handler of mediaplayer
mediaPlayerStateUpdate	MediaPlayer playback status callback.
mediaPlayerNetworkEvent	The callback triggered when the network status of the media player changes.
mediaPlayerPlayingProgress	The callback to report the current playback progress of the media player.
mediaPlayerRenderingProgress	The callback to report the current rendering progress of the media player.

AudioEffectPlayer Functions

Method	Description
createAudioEffectPlayer	Creates a audio effect player instance.
destroyAudioEffectPlayer	Destroys a audio effect player instance.
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.
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.
audioEffectPlayerStateUpdate	Audio effect playback state callback.
on	Register the event handler of mediaplayer
off	Unregister the event handler of mediaplayer

Recording Functions

Method	Description
startRecordingCapturedData	Starts to record and directly save the data to a file.
stopRecordingCapturedData	Stops recording locally captured audio or video.
capturedDataRecordStateUpdate	The callback triggered when the state of data recording (to a file) changes.
capturedDataRecordProgressUpdate	The callback to report the current recording progress.

Device Management Functions

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.
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 (for the specified channel).
useFrontCamera	Switches to the front or the rear camera (for the specified channel).
startSoundLevelMonitor	Starts sound level monitoring. Support enable some advanced feature.
stopSoundLevelMonitor	Stops sound level monitoring.
enableHeadphoneMonitor	Enables or disables headphone monitoring.
capturedSoundLevelUpdate	The local captured audio sound level callback.
remoteSoundLevelUpdate	The remote playing streams audio sound level callback.
localDeviceExceptionOccurred	The callback triggered when a local device exception occurred.
remoteCameraStateUpdate	The callback triggered when the state of the remote camera changes.
remoteMicStateUpdate	The callback triggered when the state of the remote microphone changes.
audioRouteChange	Callback for device's audio route changed.

Custom Video Capture or Rendering Functions

Method	Description
enableCustomVideoProcessing	Enables or disables custom video processing, and support specifying the publish channel.

Custom Audio Capture or Rendering Functions

Method	Description
enableCustomAudioIO	Enables the custom audio I/O function (for the specified channel), support PCM, AAC format data.

Media Publisher Functions

Not supported currently.

Utilities Functions

Method	Description
startNetworkSpeedTest	Start network speed test. Support set speed test interval。
stopNetworkSpeedTest	Stop network speed test.
getNetworkTimeInfo	Obtain synchronization network time information.
networkSpeedTestError	Network speed test error callback.
networkSpeedTestQualityUpdate	Network speed test quality callback.
networkQuality	The network quality callback of users who are publishing in the room.

RangeAudio Functions

Not supported currently.

CopyrightedMusic Functions

Not supported currently.

Deprecated APIs

Method	Description
enableBeautify	[Deprecated] Enables or disables the beauty features for the specified publish channel. Deprecated since 2.16.0, please use the [enableEffectsBeauty] function instead.
setBeautifyOption	[Deprecated] Set beautify option. Deprecated since 2.16.0, please use the [setEffectsBeautyParam] function instead.
createEngine	[Deprecated] Create ZegoExpressEngine singleton object and initialize SDK. Deprecated since 2.14.0, please use the method with the same name without [isTestEnv] parameter instead. Please refer to Testing environment deprecation for more details.

Function Overview

SDK Initialization Related Functions

Room functions

Stream Publishing Functions

Stream Playing Functions

Instant Messaging Functions

Stream Mixing Functions

Audio and Video Preprocessing Functions

MediaPlayer Functions

AudioEffectPlayer Functions

Recording Functions

Device Management Functions

Custom Video Capture or Rendering Functions

Custom Audio Capture or Rendering Functions

Media Publisher Functions

Utilities Functions

RangeAudio Functions

CopyrightedMusic Functions

Deprecated APIs