ZegoExpressEngine class

Available extensions

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addPublishCdnUrl(String streamID, String targetURL, {int? timeout}) → Future<ZegoPublisherUpdateCdnUrlResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Adds a target CDN URL to which the stream will be relayed from ZEGO RTC server.
callExperimentalAPI(String params) → Future<String>
Call the experimental API.
createAIVoiceChanger() → Future<ZegoAIVoiceChanger?>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineAIVoiceChanger extension

Creates an AI voice changer instance.
createAudioEffectPlayer() → Future<ZegoAudioEffectPlayer?>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineAudioEffectPlayer extension

Creates a audio effect player instance.
createCanvasView(dynamic onViewCreated(int viewID), {Key? key}) → Future<Widget?>

Available on ZegoExpressEngine, provided by the ZegoExpressCanvasViewUtils extension

Create a canvas view.
createCopyrightedMusic() → Future<ZegoCopyrightedMusic?>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCopyrightedMusic extension

Creates a copyrighted music instance.
createMediaDataPublisher(ZegoMediaDataPublisherConfig config) → Future<ZegoMediaDataPublisher?>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineMediaDataPublisher extension

Creates a media data publisher instance.
createMediaPlayer() → Future<ZegoMediaPlayer?>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineMediaPlayer extension

Creates a media player instance.
createRangeAudio() → Future<ZegoRangeAudio?>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineRangeAudio extension

Creates a range audio instance.
createRealTimeSequentialDataManager(String roomID) → Future<ZegoRealTimeSequentialDataManager?>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineIM extension

Create the real time sequential data manager instance
createScreenCaptureSource({int? sourceId, ZegoScreenCaptureSourceType? sourceType}) → Future<ZegoScreenCaptureSource?>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineScreenCapture extension

Create the screen capture source
destroyAIVoiceChanger(ZegoAIVoiceChanger aiVoiceChanger) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineAIVoiceChanger extension

Destroys an AI voice changer instance.
destroyAudioEffectPlayer(ZegoAudioEffectPlayer audioEffectPlayer) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineAudioEffectPlayer extension

Destroys a audio effect player instance.
destroyCanvasView(int viewID) → Future<bool>

Available on ZegoExpressEngine, provided by the ZegoExpressCanvasViewUtils extension

Destroy a canvas view.
destroyCopyrightedMusic(ZegoCopyrightedMusic copyrightedMusic) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCopyrightedMusic extension

Destroys a copyrighted music instance.
destroyMediaDataPublisher(ZegoMediaDataPublisher mediaDataPublisher) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineMediaDataPublisher extension

Destroys a media data publisher instance.
destroyMediaPlayer(ZegoMediaPlayer mediaPlayer) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineMediaPlayer extension

Destroys a media player instance.
destroyRangeAudio(ZegoRangeAudio rangeAudio) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineRangeAudio extension

Destroys a range audio instance.
destroyRealTimeSequentialDataManager(ZegoRealTimeSequentialDataManager manager) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineIM extension

Destroy the real time sequential data manager instance
destroyScreenCaptureSource(ZegoScreenCaptureSource source) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineScreenCapture extension

Destroy the screen capture source instance
enableAEC(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Whether to enable acoustic echo cancellation (AEC).
enableAGC(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Enables or disables automatic gain control (AGC).
enableAlignedAudioAuxData(bool enable, ZegoAudioFrameParam param) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCustomAudioIO extension

Enable feature of throwing audio aux frames which aligned with accompany.
enableAlphaChannelVideoEncoder(bool enable, ZegoAlphaLayoutType alphaLayout, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Enable video encoder alpha channel support.
enableANS(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Enables or disables active noise suppression (ANS, aka ANC).
enableAudioCaptureDevice(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Enables or disables the audio capture device.
enableAuxBgmBalance(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Turn on or off the adaptive mode to adjust the volume of the human voice according to the volume of the BGM.
enableBeautify(int featureBitmask, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDeprecatedApi extension

Deprecated Enables or disables the beauty features for the specified publish channel. Deprecated since 2.16.0, please use the enableEffectsBeauty function instead.
enableCamera(bool enable, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Turns on/off the camera (for the specified channel).
enableCameraAdaptiveFPS(bool enable, int minFPS, int maxFPS, ZegoPublishChannel channel) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Enable camera adaptive frame rate.
enableCheckPoc(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Enables or disables frame order detection.
enableColorEnhancement(bool enable, ZegoColorEnhancementParams params, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Enable color enhancement.
enableCustomAudioCaptureProcessing(bool enable, ZegoCustomAudioProcessConfig config) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCustomAudioIO extension

Enable local collection and custom audio processing(before ear return).
enableCustomAudioCaptureProcessingAfterHeadphoneMonitor(bool enable, ZegoCustomAudioProcessConfig config) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCustomAudioIO extension

Turn on local collection and custom audio processing (after ear return).
enableCustomAudioIO(bool enable, ZegoCustomAudioConfig config, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCustomAudioIO extension

Enables the custom audio I/O function (for the specified channel), support PCM, AAC format data.
enableCustomAudioPlaybackProcessing(bool enable, ZegoCustomAudioProcessConfig config) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCustomAudioIO extension

Enable custom audio processing for SDK playback audio data.
enableCustomAudioRemoteProcessing(bool enable, ZegoCustomAudioProcessConfig config) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCustomAudioIO extension

Enable custom audio processing for remote playing stream.
enableCustomVideoCapture(bool enable, {ZegoCustomVideoCaptureConfig? config, ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCustomVideoIO extension

Enables or disables custom video capture (for the specified channel).
enableCustomVideoProcessing(bool enable, ZegoCustomVideoProcessConfig config, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCustomVideoIO extension

Enables or disables custom video processing, and support specifying the publish channel.
enableCustomVideoRender(bool enable, ZegoCustomVideoRenderConfig config) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCustomVideoIO extension

Enables or disables custom video rendering.
enableDebugAssistant(bool enable) → Future<void>
Enable the debug assistant. Note, do not enable this feature in the online version! Use only during development phase!
enableEffectsBeauty(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Enables or disables the beauty effect.
enableH265EncodeFallback(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Whether to enable H.265 encoding to automatically downgrade to H.264 encoding.
enableHardwareDecoder(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Enables or disables hardware decoding.
enableHardwareEncoder(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Enables or disables hardware encoding.
enableHeadphoneAEC(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Whether to turn on acoustic echo cancellation (AEC) when using the headphone.
enableHeadphoneMonitor(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Enables or disables headphone monitoring.
enableMixEnginePlayout(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Enable or disable mix SDK playout to stream publishing.
enableMixSystemPlayout(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Enable or disable system audio capture.
enablePlayStreamVirtualStereo(bool enable, int angle, String streamID) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Enable or disable the virtual stereo effect when playing stream.
enablePublishDirectToCDN(bool enable, {ZegoCDNConfig? config, ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Whether to directly push to CDN (without going through the ZEGO RTC server), for the specified channel.
enableSpeechEnhance(bool enable, int level) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Enables or disables speech enhancement.
enableTrafficControl(bool enable, int property, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Enables or disables the traffic control for the specified publish channel.
enableTransientANS(bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Enables or disables transient noise suppression.
enableVideoObjectSegmentation(bool enable, ZegoObjectSegmentationConfig config, ZegoPublishChannel channel) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Enable video object segmentation.
enableVideoSuperResolution(String streamID, bool enable) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Enable video super resolution.
enableVirtualStereo(bool enable, int angle) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Enable or disable the virtual stereo effect when publishing stream.
fetchCustomAudioRenderPCMData(Uint8List data, int dataLength, ZegoAudioFrameParam param) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCustomAudioIO extension

Fetches PCM audio data of the remote stream from the SDK for custom audio rendering.
getAssetAbsolutePath(String assetPath) → Future<String?>

Available on ZegoExpressEngine, provided by the ZegoExpressAssetsUtils extension

Get the actual absolute path of the asset through the relative path of the asset
getAudioConfig({ZegoPublishChannel? channel}) → Future<ZegoAudioConfig>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Gets the current audio configurations from the specified publish channel.
getAudioDeviceList(ZegoAudioDeviceType deviceType) → Future<List<ZegoDeviceInfo>>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Gets a list of audio devices.
getAudioDeviceVolume(ZegoAudioDeviceType deviceType, String deviceID) → Future<int>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Get volume for the specified audio device.
getAudioRouteType() → Future<ZegoAudioRoute>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

get current audio route type.
getCameraMaxZoomFactor({ZegoPublishChannel? channel}) → Future<double>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Get the maximum zoom factor of the camera and support specifying the publish channel.
getCurrentAudioDevice(ZegoAudioDeviceType deviceType) → Future<ZegoDeviceInfo>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Get the audio device information currently in use.
getDefaultAudioDeviceID(ZegoAudioDeviceType deviceType) → Future<String>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Get the device ID of the default audio device.
getDefaultVideoDeviceID() → Future<String>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Get the device ID of the default video device.
getNetworkTimeInfo() → Future<ZegoNetworkTimeInfo>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineUtilities extension

Obtain synchronization network time information.
getRoomStreamList(String roomID, ZegoRoomStreamListType streamListType) → Future<ZegoRoomStreamList>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineRoom extension

Get room stream list.
getScreenCaptureSources(int thumbnailWidth, int thumbnailHeight, int iconWidth, int iconHeight) → Future<List<ZegoScreenCaptureSourceInfo>>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineScreenCapture extension

Get a list of screens or windows in a screen.
getSpeakerVolumeInAPP(String deviceID) → Future<int>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Get the volume of the speaker in the App, only support Windows.
getVideoConfig({ZegoPublishChannel? channel}) → Future<ZegoVideoConfig>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Gets the current video configurations (for the specified channel).
getVideoDeviceList() → Future<List<ZegoDeviceInfo>>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Gets a list of video devices.
initVideoSuperResolution() → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Init video super resolution.
isAIVoiceChangerSupported() → Future<bool>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineAIVoiceChanger extension

Check the device can run AI voice changer or not.
isAudioDeviceMuted(ZegoAudioDeviceType deviceType, String deviceID) → Future<bool>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Check if the audio device is muted.
isCameraFocusSupported({ZegoPublishChannel? channel}) → Future<bool>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Whether the camera supports focusing.
isMicrophoneMuted() → Future<bool>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Checks whether the microphone is muted.
isSpeakerMuted() → Future<bool>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Checks whether the audio output speaker is muted.
isVideoDecoderSupported(ZegoVideoCodecID codecID, {ZegoVideoCodecBackend? codecBackend}) → Future<int>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Whether the specified video decoding format is supported.
isVideoEncoderSupported(ZegoVideoCodecID codecID, {ZegoVideoCodecBackend? codecBackend}) → Future<int>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Whether the specified video encoding type and implementation are supported.
loginRoom(String roomID, ZegoUser user, {ZegoRoomConfig? config}) → Future<ZegoRoomLoginResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineRoom extension

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([String? roomID]) → Future<ZegoRoomLogoutResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineRoom extension

Exit the room of the specified room ID with callback.
muteAllPlayAudioStreams(bool mute) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Can the pull stream receive all audio data.
muteAllPlayStreamAudio(bool mute) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Can the pull stream receive all audio data. (When set to true, calling mutePlayStreamAudio will not take effect)
muteAllPlayStreamVideo(bool mute) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Can the pull stream receive all video data. (When set to true, calling mutePlayStreamVideo will not take effect)
muteAllPlayVideoStreams(bool mute) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Can the pull stream receive all video data.
muteAudioDevice(ZegoAudioDeviceType deviceType, String deviceID, bool mute) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Mutes or unmutes the audio device.
muteMicrophone(bool mute) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Mutes or unmutes the microphone.
mutePlayStreamAudio(String streamID, bool mute) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Whether the pull stream can receive the specified audio data.
mutePlayStreamVideo(String streamID, bool mute) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Whether the pull stream can receive the specified video data.
mutePublishStreamAudio(bool mute, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Stops or resumes sending the audio part of a stream for the specified channel.
mutePublishStreamVideo(bool mute, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Stops or resumes sending the video part of a stream for the specified channel.
muteSpeaker(bool mute) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Mutes or unmutes the audio output speaker.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeDumpData() → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineUtilities extension

Remove dumped data.
removePublishCdnUrl(String streamID, String targetURL) → Future<ZegoPublisherUpdateCdnUrlResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Deletes the specified CDN URL, which is used for relaying streams from ZEGO RTC server to CDN.
renewToken(String roomID, String token) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineRoom extension

Renew token.
sendAudioSideInfo(Uint8List data, double timeStampMs, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Send audio side information.
sendBarrageMessage(String roomID, String message) → Future<ZegoIMSendBarrageMessageResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineIM extension

Sends a Barrage Message (bullet screen) to all users in the same room, without guaranteeing the delivery.
sendBroadcastMessage(String roomID, String message) → Future<ZegoIMSendBroadcastMessageResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineIM extension

Sends a Broadcast Message.
sendCustomAudioCaptureAACData(Uint8List data, int dataLength, int configLength, int referenceTimeMillisecond, int samples, ZegoAudioFrameParam param, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCustomAudioIO extension

Sends AAC audio data produced by custom audio capture to the SDK (for the specified channel).
sendCustomAudioCapturePCMData(Uint8List data, int dataLength, ZegoAudioFrameParam param, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCustomAudioIO extension

Sends PCM audio data produced by custom audio capture to the SDK (for the specified channel).
sendCustomCommand(String roomID, String command, List<ZegoUser> toUserList) → Future<ZegoIMSendCustomCommandResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineIM extension

Sends a Custom Command to the specified users in the same room.
sendSEI(Uint8List data, int dataLength, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Sends Supplemental Enhancement Information to the specified publish channel.
sendTransparentMessage(String roomID, ZegoRoomSendTransparentMessage message) → Future<ZegoRoomSendTransparentMessageResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineIM extension

Sends a transparent message in room.
setAECMode(ZegoAECMode mode) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Sets the acoustic echo cancellation (AEC) mode.
setAllPlayStreamVolume(int volume) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Sets the all stream playback volume.
setANSMode(ZegoANSMode mode) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Sets the automatic noise suppression (ANS) mode.
setAppOrientation(DeviceOrientation orientation, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Sets the video orientation (for the specified channel).
setAppOrientationMode(ZegoOrientationMode mode) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Set the orientation mode of the video.
setAudioCaptureStereoMode(ZegoAudioCaptureStereoMode mode) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Set audio capture stereo mode.
setAudioConfig(ZegoAudioConfig config, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Sets up the audio configurations for the specified publish channel.
setAudioDeviceMode(ZegoAudioDeviceMode deviceMode) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Set the audio device mode.
setAudioDeviceVolume(ZegoAudioDeviceType deviceType, String deviceID, int volume) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Set volume for the specified audio device.
setAudioEqualizerGain(int bandIndex, double bandGain) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Set the sound equalizer (EQ).
setAudioRouteToSpeaker(bool defaultToSpeaker) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Whether to use the built-in speaker to play audio.
setAudioSource(ZegoAudioSourceType source, {ZegoAudioSourceMixConfig? config, ZegoPublishChannel? channel}) → Future<int>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Set audio capture source with audio mix config.
setBeautifyOption(ZegoBeautifyOption option, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDeprecatedApi extension

Deprecated Set beautify option. Deprecated since 2.16.0, please use the setEffectsBeautyParam function instead.
setCameraExposureCompensation(double value, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Set the camera exposure compensation value and support spedifying the publish channel.
setCameraExposureMode(ZegoCameraExposureMode mode, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Set the camera exposure mode.
setCameraExposurePointInPreview(double x, double y, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Set the exposure point in the preview view.
setCameraFocusMode(ZegoCameraFocusMode mode, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Set the camera focus mode.
setCameraFocusPointInPreview(double x, double y, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Set the focus point in the preview view.
setCameraStabilizationMode(int mode, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Set the camera stabilization mode.
setCameraZoomFactor(double factor, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Set the zoom factor of the camera and support specifying the publish channel. Every time the camera is restarted, the camera zoom factor will return to the initial value (1.0).
setCapturePipelineScaleMode(ZegoCapturePipelineScaleMode mode) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

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.
setCaptureVolume(int volume) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Sets the audio recording volume for stream publishing.
setDummyCaptureImageParams(ZegoDummyCaptureImageParams params, ZegoPublishChannel channel) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Set the params of the static picture would be published when the camera is closed.
setDummyCaptureImagePath(String filePath, ZegoPublishChannel channel) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Set the path of the static picture would be published when the camera is closed.
setEffectsBeautyParam(ZegoEffectsBeautyParam param) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Set beautify param.
setElectronicEffects(bool enable, ZegoElectronicEffectsMode mode, int tonal) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Turn on or off the electronic sound effect.
setHeadphoneMonitorVolume(int volume) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Sets the headphone monitor volume.
setLowlightEnhancement(ZegoLowlightEnhancementMode mode, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Set low light enhancement.
setLowlightEnhancementParams(ZegoExpLowlightEnhancementParams params, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Set low light enhancement params.
setMinVideoBitrateForTrafficControl(int bitrate, ZegoTrafficControlMinVideoBitrateMode mode, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Sets the minimum video bitrate for traffic control for the specified publish channel.
setMinVideoFpsForTrafficControl(int fps, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Sets the minimum video frame rate threshold for traffic control.
setMinVideoResolutionForTrafficControl(int width, int height, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Sets the minimum video resolution threshold for traffic control.
setMixSystemPlayoutVolume(int volume) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

set system audio capture volume.
setPlayStreamBufferIntervalRange(String streamID, int minBufferInterval, int maxBufferInterval) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Set the adaptive adjustment interval range of the buffer for playing stream.
setPlayStreamCrossAppInfo(String streamID, ZegoCrossAppInfo info) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Set up cross App playing stream information.
setPlayStreamDecryptionKey(String streamID, String key) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Set decryption key for the playing stream.
setPlayStreamFocusOn(String streamID) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Set the weight of the pull stream priority.
setPlayStreamsAlignmentProperty(ZegoStreamAlignmentMode mode) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Set the play stream alignment properties.
setPlayStreamVideoType(String streamID, ZegoVideoStreamType streamType) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Set play video stream type.
setPlayVolume(String streamID, int volume) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Sets the stream playback volume.
setPublishDualStreamConfig(List<ZegoPublishDualStreamConfig> configList, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Set dual stream config.
setPublishStreamEncryptionKey(String key, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Set encryption key for the publishing stream for the specified publish channel.
setPublishWatermark({ZegoWatermark? watermark, bool? isPreviewVisible, ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Sets up the stream watermark before stream publishing (for the specified channel).
setReverbAdvancedParam(ZegoReverbAdvancedParam param) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Setting up the specific reverberation parameters.
setReverbEchoParam(ZegoReverbEchoParam param) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Setting up the specific reverberation echo parameters.
setReverbPreset(ZegoReverbPreset preset) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Setting up the reverberation via preset enumeration.
setRoomExtraInfo(String roomID, String key, String value) → Future<ZegoRoomSetRoomExtraInfoResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineRoom extension

Set room extra information.
setRoomScenario(ZegoScenario scenario) → Future<void>
Set room scenario.
setSEIConfig(ZegoSEIConfig config) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Set the Supplemental Enhancement Information type.
setSpeakerVolumeInAPP(String deviceID, int volume) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Set the volume of the speaker in the App.
setStreamAlignmentProperty(int alignment, ZegoPublishChannel channel) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Enable or disable the stream precision alignment function.
setStreamExtraInfo(String extraInfo, {ZegoPublishChannel? channel}) → Future<ZegoPublisherSetStreamExtraInfoResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Sets the extra information of the stream being published for the specified publish channel.
setTrafficControlFocusOn(ZegoTrafficControlFocusOnMode mode, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Set the factors of concern that trigger traffic control for the specified publish channel.
setVideoConfig(ZegoVideoConfig config, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Sets up the video configurations (for the specified channel).
setVideoDenoiseParams(ZegoVideoDenoiseParams params, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Set video denoise params.
setVideoMirrorMode(ZegoVideoMirrorMode mirrorMode, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Sets the video mirroring mode (for the specified channel).
setVideoSource(ZegoVideoSourceType source, {int? instanceID, ZegoPublishChannel? channel}) → Future<int>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Set a video capture instance as video capture source for the specified channel.
setVoiceChangerParam(ZegoVoiceChangerParam param) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Setting up the specific voice changer parameters.
setVoiceChangerPreset(ZegoVoiceChangerPreset preset) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Setting up the voice changer via preset enumeration.
startAudioDataObserver(int observerBitMask, ZegoAudioFrameParam param) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCustomAudioIO extension

Enable audio data observering.
startAudioDeviceVolumeMonitor(ZegoAudioDeviceType deviceType, String deviceID) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Turn on audio device volume monitoring.
startAudioSpectrumMonitor({int? millisecond}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Starts audio spectrum monitoring. Support setting the listening interval.
startAudioVADStableStateMonitor(ZegoAudioVADStableStateMonitorType type, {int? millisecond}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Start audio VAD stable state monitoring, and the monitoring period can be set.
startAutoMixerTask(ZegoAutoMixerTask task) → Future<ZegoMixerStartResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineMixer extension

Starts an auto stream mixing task.
startDumpData(ZegoDumpDataConfig config) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineUtilities extension

Dump audio and video data.
startEffectsEnv() → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Enable the Effects beauty environment.
startMixerTask(ZegoMixerTask task) → Future<ZegoMixerStartResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineMixer extension

Starts a stream mixing task.
startNetworkProbe(ZegoNetworkProbeConfig config) → Future<ZegoNetworkProbeResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineUtilities extension

Start network probe.
startNetworkSpeedTest(ZegoNetworkSpeedTestConfig config, {int? interval}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineUtilities extension

Start network speed test. Support set speed test interval。
startPerformanceMonitor({int? millisecond}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineUtilities extension

Start system performance monitoring.
startPlayingStream(String streamID, {ZegoCanvas? canvas, ZegoPlayerConfig? config}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Starts playing a stream from ZEGO RTC server or from third-party CDN. Support multi-room mode.
startPreview({ZegoCanvas? canvas, ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Starts/Updates the local video preview (for the specified channel).
startPublishingStream(String streamID, {ZegoPublisherConfig? config, ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Starts publishing a stream. Support multi-room mode.
startRecordingCapturedData(ZegoDataRecordConfig config, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineRecord extension

Starts to record and directly save the data to a file.
startSoundLevelMonitor({ZegoSoundLevelConfig? config}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Starts sound level monitoring. Support enable some advanced feature.
stopAudioDataObserver() → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineCustomAudioIO extension

Disable audio data observering.
stopAudioDeviceVolumeMonitor(ZegoAudioDeviceType deviceType, String deviceID) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Turn off audio device volume monitoring. Only for Windows/macOS.
stopAudioSpectrumMonitor() → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Stops audio spectrum monitoring.
stopAudioVADStableStateMonitor(ZegoAudioVADStableStateMonitorType type) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Stop audio VAD stable state monitoring.
stopAutoMixerTask(ZegoAutoMixerTask task) → Future<ZegoMixerStopResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineMixer extension

Stops an auto stream mixing task.
stopDumpData() → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineUtilities extension

Stop dumping data.
stopEffectsEnv() → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePreprocess extension

Disable the Effects beauty environment.
stopMixerTask(ZegoMixerTask task) → Future<ZegoMixerStopResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineMixer extension

Stops a stream mixing task.
stopNetworkProbe() → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineUtilities extension

Stop network probe.
stopNetworkSpeedTest() → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineUtilities extension

Stop network speed test.
stopPerformanceMonitor() → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineUtilities extension

Stop system performance monitoring.
stopPlayingStream(String streamID) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Stops playing a stream.
stopPreview({ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Stops the local preview (for the specified channel).
stopPublishingStream({ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Stops publishing a stream (for the specified channel).
stopRecordingCapturedData({ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineRecord extension

Stops recording locally captured audio or video.
stopSoundLevelMonitor() → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Stops sound level monitoring.
switchPlayingStream(String fromStreamID, String toStreamID, ZegoPlayerConfig config) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Switch from playing a certain stream to playing another stream.
switchRoom(String fromRoomID, String toRoomID, {ZegoRoomConfig? config}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineRoom extension

Switch the room with advanced room configurations.
takePlayStreamSnapshot(String streamID) → Future<ZegoPlayerTakeSnapshotResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Take a snapshot of the playing stream.
takePublishStreamSnapshot({ZegoPublishChannel? channel}) → Future<ZegoPublisherTakeSnapshotResult>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePublisher extension

Take a snapshot of the publishing stream for the specified publish channel.
toString() → String
A string representation of this object.
inherited
uninitVideoSuperResolution() → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Uninit video super resolution.
updatePlayingCanvas(String streamID, ZegoCanvas canvas) → Future<int>

Available on ZegoExpressEngine, provided by the ZegoExpressEnginePlayer extension

Update playing canvas.
uploadDumpData() → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineUtilities extension

Upload dumped data to the ZEGO server.
uploadLog() → Future<void>
Uploads logs to the ZEGO server.
useAudioDevice(ZegoAudioDeviceType deviceType, String deviceID) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Chooses to use the specified audio device.
useAudioOutputDevice(int viewID, String deviceID) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Switch the audio output device.
useFrontCamera(bool enable, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Switches to the front or the rear camera (for the specified channel).
useVideoDevice(String deviceID, {ZegoPublishChannel? channel}) → Future<void>

Available on ZegoExpressEngine, provided by the ZegoExpressEngineDevice extension

Chooses to use the specified video device (for the specified channel).

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

instance → ZegoExpressEngine
Engine singleton instance
final
onAIVoiceChangerGetSpeakerList ↔ void Function(ZegoAIVoiceChanger aiVoiceChanger, int errorCode, List<ZegoAIVoiceChangerSpeakerInfo> speakerList)?
Get AI voice changer engine available speaker list callback.
getter/setter pair
onAIVoiceChangerInit ↔ void Function(ZegoAIVoiceChanger aiVoiceChanger, int errorCode)?
Initialize AI voice changer engine status callback.
getter/setter pair
onAIVoiceChangerUpdate ↔ void Function(ZegoAIVoiceChanger aiVoiceChanger, int errorCode)?
Update AI voice changer engine models status callback.
getter/setter pair
onAIVoiceChangerUpdateProgress ↔ void Function(ZegoAIVoiceChanger aiVoiceChanger, double percent, int fileIndex, int fileCount)?
Update AI voice changer engine models progress callback.
getter/setter pair
onAlignedAudioAuxData ↔ void Function(Uint8List data, ZegoAudioFrameParam param)?
Aligned audio aux frames callback.
getter/setter pair
onApiCalledResult ↔ void Function(int errorCode, String funcName, String info)?
Method execution result callback
getter/setter pair
onAudioDeviceStateChanged ↔ void Function(ZegoUpdateType updateType, ZegoAudioDeviceType deviceType, ZegoDeviceInfo deviceInfo)?
The callback triggered when there is a change to audio devices (i.e. new device added or existing device deleted).
getter/setter pair
onAudioDeviceVolumeChanged ↔ void Function(ZegoAudioDeviceType deviceType, String deviceID, int volume)?
The callback triggered when there is a change of the volume for the audio devices.
getter/setter pair
onAudioEffectPlayStateUpdate ↔ void Function(ZegoAudioEffectPlayer audioEffectPlayer, int audioEffectID, ZegoAudioEffectPlayState state, int errorCode)?
Audio effect playback state callback.
getter/setter pair
onAudioRouteChange ↔ void Function(ZegoAudioRoute audioRoute)?
Callback for device's audio route changed.
getter/setter pair
onAudioVADStateUpdate ↔ void Function(ZegoAudioVADStableStateMonitorType type, ZegoAudioVADType state)?
Callback for audio VAD stable state update.
getter/setter pair
onAutoMixerSoundLevelUpdate ↔ void Function(Map<String, double> soundLevels)?
The callback triggered when the sound level of any input stream changes in the auto stream mixing process.
getter/setter pair
onCapturedAudioData ↔ void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param)?
The callback for obtaining the audio data captured by the local microphone.
getter/setter pair
onCapturedAudioSpectrumUpdate ↔ void Function(List<double> audioSpectrum)?
The local captured audio spectrum callback.
getter/setter pair
onCapturedDataRecordProgressUpdate ↔ void Function(ZegoDataRecordProgress progress, ZegoDataRecordConfig config, ZegoPublishChannel channel)?
The callback to report the current recording progress.
getter/setter pair
onCapturedDataRecordStateUpdate ↔ void Function(ZegoDataRecordState state, int errorCode, ZegoDataRecordConfig config, ZegoPublishChannel channel)?
The callback triggered when the state of data recording (to a file) changes.
getter/setter pair
onCapturedSoundLevelInfoUpdate ↔ void Function(ZegoSoundLevelInfo soundLevelInfo)?
The local captured audio sound level callback, supported vad.
getter/setter pair
onCapturedSoundLevelUpdate ↔ void Function(double soundLevel)?
The local captured audio sound level callback.
getter/setter pair
onCurrentPitchValueUpdate ↔ void Function(ZegoCopyrightedMusic copyrightedMusic, String resourceID, int currentDuration, int pitchValue)?
Real-time pitch line callback.
getter/setter pair
onDebugError ↔ void Function(int errorCode, String funcName, String info)?
The callback for obtaining debugging error information.
getter/setter pair
onDownloadProgressUpdate ↔ void Function(ZegoCopyrightedMusic copyrightedMusic, String resourceID, double progressRate)?
Callback for download song or accompaniment progress rate.
getter/setter pair
onEngineStateUpdate ↔ void Function(ZegoEngineState state)?
The callback triggered when the audio/video engine state changes.
getter/setter pair
onExceptionOccurred ↔ void Function(ZegoScreenCaptureSource source, ZegoScreenCaptureSourceExceptionType exceptionType)?
The callback triggered when a screen capture source exception occurred
getter/setter pair
onFatalError ↔ void Function(int errorCode)?
The callback that triggered a fatal error, causing the SDK to malfunction and unable to function properly.
getter/setter pair
onIMRecvBarrageMessage ↔ void Function(String roomID, List<ZegoBarrageMessageInfo> messageList)?
The callback triggered when Barrage Messages are received.
getter/setter pair
onIMRecvBroadcastMessage ↔ void Function(String roomID, List<ZegoBroadcastMessageInfo> messageList)?
The callback triggered when Broadcast Messages are received.
getter/setter pair
onIMRecvCustomCommand ↔ void Function(String roomID, ZegoUser fromUser, String command)?
The callback triggered when a Custom Command is received.
getter/setter pair
onLocalDeviceExceptionOccurred ↔ void Function(ZegoDeviceExceptionType exceptionType, ZegoDeviceType deviceType, String deviceID)?
The callback triggered when a local device exception occurred.
getter/setter pair
onMediaDataPublisherFileClose ↔ void Function(ZegoMediaDataPublisher mediaDataPublisher, int errorCode, String path)?
The event callback of the media data publisher closing a media file.
getter/setter pair
onMediaDataPublisherFileDataBegin ↔ void Function(ZegoMediaDataPublisher mediaDataPublisher, String path)?
The event callback that the media data publisher has read data from the media file.
getter/setter pair
onMediaDataPublisherFileDataEnd ↔ void Function(ZegoMediaDataPublisher mediaDataPublisher, String path)?
The event callback that the media data publisher has completed a file stream publishing.
getter/setter pair
onMediaDataPublisherFileOpen ↔ void Function(ZegoMediaDataPublisher mediaDataPublisher, String path)?
The event callback of the media data publisher opening a media file.
getter/setter pair
onMediaPlayerFirstFrameEvent ↔ void Function(ZegoMediaPlayer mediaPlayer, ZegoMediaPlayerFirstFrameEvent event)?
The callback triggered when the media player plays the first frame.
getter/setter pair
onMediaPlayerFrequencySpectrumUpdate ↔ void Function(ZegoMediaPlayer mediaPlayer, List<double> spectrumList)?
The callback of frequency spectrum update.
getter/setter pair
onMediaPlayerLocalCache ↔ void Function(ZegoMediaPlayer mediaPlayer, int errorCode, String resource, String cachedFile)?
The callback triggered when the media player caches http/https network resource locally.
getter/setter pair
onMediaPlayerNetworkEvent ↔ void Function(ZegoMediaPlayer mediaPlayer, ZegoMediaPlayerNetworkEvent networkEvent)?
The callback triggered when the network status of the media player changes.
getter/setter pair
onMediaPlayerPlayingProgress ↔ void Function(ZegoMediaPlayer mediaPlayer, int millisecond)?
The callback to report the current playback progress of the media player.
getter/setter pair
onMediaPlayerRecvSEI ↔ void Function(ZegoMediaPlayer mediaPlayer, Uint8List data)?
The callback triggered when the media player got media side info.
getter/setter pair
onMediaPlayerRenderingProgress ↔ void Function(ZegoMediaPlayer mediaPlayer, int millisecond)?
The callback to report the current rendering progress of the media player.
getter/setter pair
onMediaPlayerSoundLevelUpdate ↔ void Function(ZegoMediaPlayer mediaPlayer, double soundLevel)?
The callback of sound level update.
getter/setter pair
onMediaPlayerStateUpdate ↔ void Function(ZegoMediaPlayer mediaPlayer, ZegoMediaPlayerState state, int errorCode)?
MediaPlayer playback status callback.
getter/setter pair
onMediaPlayerVideoSizeChanged ↔ void Function(ZegoMediaPlayer mediaPlayer, int width, int height)?
The callback triggered when when the resolution of the playback video changes.
getter/setter pair
onMixedAudioData ↔ void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param)?
Callback to get the audio data played by the SDK and the audio data captured by the local microphone. The audio data is the data mixed by the SDK.
getter/setter pair
onMixerRelayCDNStateUpdate ↔ void Function(String taskID, List<ZegoStreamRelayCDNInfo> infoList)?
The callback triggered when the state of relayed streaming of the mixed stream to CDN changes.
getter/setter pair
onMixerSoundLevelUpdate ↔ void Function(Map<int, double> soundLevels)?
The callback triggered when the sound level of any input stream changes in the stream mixing process.
getter/setter pair
onMobileScreenCaptureExceptionOccurred ↔ void Function(ZegoScreenCaptureExceptionType exceptionType)?
The callback triggered when a screen capture source exception occurred.
getter/setter pair
onMobileScreenCaptureStart ↔ void Function()?
The callback triggered when start screen capture.
getter/setter pair
onNetworkModeChanged ↔ void Function(ZegoNetworkMode mode)?
Network mode changed callback.
getter/setter pair
onNetworkQuality ↔ void Function(String userID, ZegoStreamQualityLevel upstreamQuality, ZegoStreamQualityLevel downstreamQuality)?
The network quality callback of users who are publishing in the room.
getter/setter pair
onNetworkSpeedTestError ↔ void Function(int errorCode, ZegoNetworkSpeedTestType type)?
Network speed test error callback.
getter/setter pair
onNetworkSpeedTestQualityUpdate ↔ void Function(ZegoNetworkSpeedTestQuality quality, ZegoNetworkSpeedTestType type)?
Network speed test quality callback.
getter/setter pair
onNetworkTimeSynchronized ↔ void Function()?
Successful callback of network time synchronization.
getter/setter pair
onPerformanceStatusUpdate ↔ void Function(ZegoPerformanceStatus status)?
System performance monitoring callback.
getter/setter pair
onPlaybackAudioData ↔ void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param)?
The callback for obtaining the audio data of all the streams playback by SDK.
getter/setter pair
onPlayerAudioData ↔ void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param, String streamID)?
The callback for obtaining the audio data of each stream.
getter/setter pair
onPlayerLowFpsWarning ↔ void Function(ZegoVideoCodecID codecID, String streamID)?
Playing stream low frame rate warning.
getter/setter pair
onPlayerMediaEvent ↔ void Function(String streamID, ZegoPlayerMediaEvent event)?
The callback triggered when a media event occurs during streaming playing.
getter/setter pair
onPlayerQualityUpdate ↔ void Function(String streamID, ZegoPlayStreamQuality quality)?
Callback for current stream playing quality.
getter/setter pair
onPlayerRecvAudioFirstFrame ↔ void Function(String streamID)?
The callback triggered when the first audio frame is received.
getter/setter pair
onPlayerRecvAudioSideInfo ↔ void Function(String streamID, Uint8List data)?
Receive the audio side information content of the remote stream.
getter/setter pair
onPlayerRecvMediaSideInfo ↔ void Function(ZegoMediaSideInfo info)?
The callback triggered when Supplemental Enhancement Information is received synchronously.
getter/setter pair
onPlayerRecvSEI ↔ void Function(String streamID, Uint8List data)?
The callback triggered when Supplemental Enhancement Information is received.
getter/setter pair
onPlayerRecvVideoFirstFrame ↔ void Function(String streamID)?
The callback triggered when the first video frame is received.
getter/setter pair
onPlayerRenderCameraVideoFirstFrame ↔ void Function(String streamID)?
Calls back when the stream playing end renders the first frame of the video from the remote camera.
getter/setter pair
onPlayerRenderVideoFirstFrame ↔ void Function(String streamID)?
The callback triggered when the first video frame is rendered.
getter/setter pair
onPlayerStateUpdate ↔ void Function(String streamID, ZegoPlayerState state, int errorCode, Map<String, dynamic> extendedData)?
The callback triggered when the state of stream playing changes.
getter/setter pair
onPlayerStreamEvent ↔ void Function(ZegoStreamEvent eventID, String streamID, String extraInfo)?
The callback triggered when playing stream.
getter/setter pair
onPlayerSwitched ↔ void Function(String streamID, int errorCode)?
Switch playing stream callback.
getter/setter pair
onPlayerVideoSizeChanged ↔ void Function(String streamID, int width, int height)?
The callback triggered when the stream playback resolution changes.
getter/setter pair
onPlayerVideoSuperResolutionUpdate ↔ void Function(String streamID, ZegoSuperResolutionState state, int errorCode)?
Playing stream video super resolution enabled state changes.
getter/setter pair
onProcessCapturedAudioData ↔ void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param, double timestamp)?
Custom audio processing local captured PCM audio frame callback.
getter/setter pair
onProcessCapturedAudioDataAfterUsedHeadphoneMonitor ↔ void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param, double timestamp)?
Custom audio processing local captured PCM audio frame callback after used headphone monitor.
getter/setter pair
onProcessPlaybackAudioData ↔ void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param, double timestamp)?
Custom audio processing SDK playback PCM audio frame callback.
getter/setter pair
onProcessRemoteAudioData ↔ void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param, String streamID, double timestamp)?
Custom audio processing remote playing stream PCM audio frame callback.
getter/setter pair
onPublisherCapturedAudioFirstFrame ↔ void Function()?
The callback triggered when the first audio frame is captured.
getter/setter pair
onPublisherCapturedVideoFirstFrame ↔ void Function(ZegoPublishChannel channel)?
The callback triggered when the first video frame is captured.
getter/setter pair
onPublisherDummyCaptureImagePathError ↔ void Function(int errorCode, String path, ZegoPublishChannel channel)?
The notification for setting the path of the static image displayed when the camera is turned off is incorrect.
getter/setter pair
onPublisherLowFpsWarning ↔ void Function(ZegoVideoCodecID codecID, ZegoPublishChannel channel)?
Video encoding low frame rate warning.
getter/setter pair
onPublisherQualityUpdate ↔ void Function(String streamID, ZegoPublishStreamQuality quality)?
Callback for current stream publishing quality.
getter/setter pair
onPublisherRelayCDNStateUpdate ↔ void Function(String streamID, List<ZegoStreamRelayCDNInfo> infoList)?
The callback triggered when the state of relayed streaming to CDN changes.
getter/setter pair
onPublisherRenderVideoFirstFrame ↔ void Function(ZegoPublishChannel channel)?
The callback triggered when the first video frame is rendered.
getter/setter pair
onPublisherSendAudioFirstFrame ↔ void Function(ZegoPublishChannel channel)?
The callback triggered when the first audio frame is sent.
getter/setter pair
onPublisherSendVideoFirstFrame ↔ void Function(ZegoPublishChannel channel)?
The callback triggered when the first video frame is sent.
getter/setter pair
onPublisherStateUpdate ↔ void Function(String streamID, ZegoPublisherState state, int errorCode, Map<String, dynamic> extendedData)?
The callback triggered when the state of stream publishing changes.
getter/setter pair
onPublisherStreamEvent ↔ void Function(ZegoStreamEvent eventID, String streamID, String extraInfo)?
The callback triggered when publishing stream.
getter/setter pair
onPublisherVideoEncoderChanged ↔ void Function(ZegoVideoCodecID fromCodecID, ZegoVideoCodecID toCodecID, ZegoPublishChannel channel)?
The callback triggered when the video encoder changes in publishing stream.
getter/setter pair
onPublisherVideoSizeChanged ↔ void Function(int width, int height, ZegoPublishChannel channel)?
The callback triggered when the video capture resolution changes.
getter/setter pair
onRangeAudioMicrophoneStateUpdate ↔ void Function(ZegoRangeAudio rangeAudio, ZegoRangeAudioMicrophoneState state, int errorCode)?
Range audio microphone state callback.
getter/setter pair
onReceiveRealTimeSequentialData ↔ void Function(ZegoRealTimeSequentialDataManager manager, Uint8List data, String streamID)?
Callback for receiving real-time sequential data.
getter/setter pair
onRectChanged ↔ void Function(ZegoScreenCaptureSource source, Rect captureRect)?
The callback will be triggered when the state of the capture target window change.
getter/setter pair
onRecvExperimentalAPI ↔ void Function(String content)?
Experimental API callback
getter/setter pair
onRecvRoomTransparentMessage ↔ void Function(String roomID, ZegoRoomRecvTransparentMessage message)?
The callback triggered when Barrage Messages are received.
getter/setter pair
onRemoteAudioSpectrumUpdate ↔ void Function(Map<String, List<double>> audioSpectrums)?
The remote playing streams audio spectrum callback.
getter/setter pair
onRemoteCameraStateUpdate ↔ void Function(String streamID, ZegoRemoteDeviceState state)?
The callback triggered when the state of the remote camera changes.
getter/setter pair
onRemoteMicStateUpdate ↔ void Function(String streamID, ZegoRemoteDeviceState state)?
The callback triggered when the state of the remote microphone changes.
getter/setter pair
onRemoteSoundLevelInfoUpdate ↔ void Function(Map<String, ZegoSoundLevelInfo> soundLevelInfos)?
The remote playing streams audio sound level callback, supported vad.
getter/setter pair
onRemoteSoundLevelUpdate ↔ void Function(Map<String, double> soundLevels)?
The remote playing streams audio sound level callback.
getter/setter pair
onRemoteSpeakerStateUpdate ↔ void Function(String streamID, ZegoRemoteDeviceState state)?
The callback triggered when the state of the remote speaker changes.
getter/setter pair
onRequestDumpData ↔ void Function()?
Request to dump data.
getter/setter pair
onRequestUploadDumpData ↔ void Function(String dumpDir, bool takePhoto)?
Request to dump data.
getter/setter pair
onRoomExtraInfoUpdate ↔ void Function(String roomID, List<ZegoRoomExtraInfo> roomExtraInfoList)?
The callback triggered when there is an update on the extra information of the room.
getter/setter pair
onRoomOnlineUserCountUpdate ↔ void Function(String roomID, int count)?
The callback triggered every 30 seconds to report the current number of online users.
getter/setter pair
onRoomStateChanged ↔ void Function(String roomID, ZegoRoomStateChangedReason reason, int errorCode, Map<String, dynamic> extendedData)?
Notification of the room connection state changes, including specific reasons for state change.
getter/setter pair
onRoomStateUpdate ↔ void Function(String roomID, ZegoRoomState state, int errorCode, Map<String, dynamic> extendedData)?
Notification of the room connection state changes.
getter/setter pair
onRoomStreamExtraInfoUpdate ↔ void Function(String roomID, List<ZegoStream> streamList)?
The callback triggered when there is an update on the extra information of the streams published by other users in the same room.
getter/setter pair
onRoomStreamUpdate ↔ void Function(String roomID, ZegoUpdateType updateType, List<ZegoStream> streamList, Map<String, dynamic> extendedData)?
The callback triggered when the number of streams published by the other users in the same room increases or decreases.
getter/setter pair
onRoomTokenWillExpire ↔ void Function(String roomID, int remainTimeInSecond)?
Callback notification that room Token authentication is about to expire.
getter/setter pair
onRoomUserUpdate ↔ void Function(String roomID, ZegoUpdateType updateType, List<ZegoUser> userList)?
The callback triggered when the number of other users in the room increases or decreases.
getter/setter pair
onStartDumpData ↔ void Function(int errorCode)?
Callback when starting to dump data.
getter/setter pair
onStopDumpData ↔ void Function(int errorCode, String dumpDir)?
Callback when stopping to dump data.
getter/setter pair
onUploadDumpData ↔ void Function(int errorCode)?
Callback after uploading the dump data.
getter/setter pair
onVideoDeviceStateChanged ↔ void Function(ZegoUpdateType updateType, ZegoDeviceInfo deviceInfo)?
The callback triggered when there is a change to video devices (i.e. new device added or existing device deleted).
getter/setter pair
onVideoObjectSegmentationStateChanged ↔ void Function(ZegoObjectSegmentationState state, ZegoPublishChannel channel, int errorCode)?
The video object segmentation state changed.
getter/setter pair
onWindowStateChanged ↔ void Function(ZegoScreenCaptureSource source, ZegoScreenCaptureWindowState windowState, Rect windowRect)?
The callback will be triggered when the state of the capture target window change.
getter/setter pair

Static Methods

createEngine(int appID, String appSign, bool isTestEnv, ZegoScenario scenario, {bool? enablePlatformView}) → Future<void>
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.
createEngineWithProfile(ZegoEngineProfile profile) → Future<void>
Create ZegoExpressEngine singleton object and initialize SDK.
destroyEngine() → Future<void>
Destroy the ZegoExpressEngine singleton object and deinitialize the SDK.
getVersion() → Future<String>
Gets the SDK's version number.
isFeatureSupported(ZegoFeatureType featureType) → Future<bool>
Query whether the current SDK supports the specified feature.
setCloudProxyConfig(List<ZegoProxyInfo> proxyList, String token, bool enable) → Future<void>
Set cloud proxy config.
setEngineConfig(ZegoEngineConfig config) → Future<void>
Set advanced engine configuration.
setGeoFence(ZegoGeoFenceType type, List<int> areaList) → Future<void>
Set Geo Fence.
setLicense(String license) → Future<void>
Set license auth.
setLocalProxyConfig(List<ZegoProxyInfo> proxyList, bool enable) → Future<void>
Set local proxy config.
setLogConfig(ZegoLogConfig config) → Future<void>
Set log configuration.
setRoomMode(ZegoRoomMode mode) → Future<void>
Set room mode.
submitLog() → Future<void>
Uploads logs to the ZEGO server.