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

callExperimentalAPI(String params) → Future<String>
Call the experimental API.
enableDebugAssistant(bool enable) → Future<void>
Enable the debug assistant. Note, do not enable this feature in the online version! Use only during development phase!
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setRoomScenario(ZegoScenario scenario) → Future<void>
Set room scenario.
toString() → String
A string representation of this object.
inherited
uploadLog() → Future<void>
Uploads logs to the ZEGO server.

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.