Available Extensions

• ZegoExpressAssetsUtils
• ZegoExpressCanvasViewUtils
• ZegoExpressEngineAIVoiceChanger
• ZegoExpressEngineAudioEffectPlayer
• ZegoExpressEngineCopyrightedMusic
• ZegoExpressEngineCustomAudioIO
• ZegoExpressEngineCustomVideoIO
• ZegoExpressEngineDeprecatedApi
• ZegoExpressEngineDevice
• ZegoExpressEngineIM
• ZegoExpressEngineMediaDataPublisher
• ZegoExpressEngineMediaPlayer
• ZegoExpressEngineMixer
• ZegoExpressEnginePlayer
• ZegoExpressEnginePreprocess
• ZegoExpressEnginePublisher
• ZegoExpressEngineRangeAudio
• ZegoExpressEngineRecord
• ZegoExpressEngineRoom
• ZegoExpressEngineScreenCapture
• ZegoExpressEngineUtilities

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>

调用实验性 API。

enableDebugAssistant(bool enable) → Future<void>

开启调试助手。注意，请勿在线上版本开启此功能！仅在开发阶段使用！

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setRoomScenario(ZegoScenario scenario) → Future<void>

设置房间场景。

toString() → String

A string representation of this object.

inherited

uploadLog() → Future<void>

上传日志到 ZEGO 服务器。

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)?)

获取 AI 变声引擎可用音色列表回调。

getter/setter pair

onAIVoiceChangerInit ↔ (void Function(ZegoAIVoiceChanger aiVoiceChanger, int errorCode)?)

初始化 AI 变声引擎状态回调。

getter/setter pair

onAIVoiceChangerUpdate ↔ (void Function(ZegoAIVoiceChanger aiVoiceChanger, int errorCode)?)

更新 AI 变声引擎模型状态回调。

getter/setter pair

onAIVoiceChangerUpdateProgress ↔ (void Function(ZegoAIVoiceChanger aiVoiceChanger, double percent, int fileIndex, int fileCount)?)

更新 AI 变声引擎模型进度回调。

getter/setter pair

onAlignedAudioAuxData ↔ (void Function(Uint8List data, ZegoAudioFrameParam param)?)

与伴奏对齐的音频混音数据回调

getter/setter pair

onApiCalledResult ↔ (void Function(int errorCode, String funcName, String info)?)

方法执行结果回调。

getter/setter pair

onAudioDeviceStateChanged ↔ (void Function(ZegoUpdateType updateType, ZegoAudioDeviceType deviceType, ZegoDeviceInfo deviceInfo)?)

音频设备状态改变

getter/setter pair

onAudioDeviceVolumeChanged ↔ (void Function(ZegoAudioDeviceType deviceType, String deviceID, int volume)?)

音频设备音量变更。

getter/setter pair

onAudioEffectPlayStateUpdate ↔ (void Function(ZegoAudioEffectPlayer audioEffectPlayer, int audioEffectID, ZegoAudioEffectPlayState state, int errorCode)?)

音效播放状态回调。

getter/setter pair

onAudioRouteChange ↔ (void Function(ZegoAudioRoute audioRoute)?)

音频设备路由变更通知。

getter/setter pair

onAudioVADStateUpdate ↔ (void Function(ZegoAudioVADStableStateMonitorType type, ZegoAudioVADType state)?)

检测音频数据的稳态语音状态的回调。

getter/setter pair

onAutoMixerSoundLevelUpdate ↔ (void Function(Map<String, double> soundLevels)?)

自动混流中的每条单流的声浪更新通知

getter/setter pair

onCapturedAudioData ↔ (void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param)?)

获取本地麦克风采集到的音频数据的回调.

getter/setter pair

onCapturedAudioSpectrumUpdate ↔ (void Function(List<double> audioSpectrum)?)

本地采集音频频谱回调。

getter/setter pair

onCapturedDataRecordProgressUpdate ↔ (void Function(ZegoDataRecordProgress progress, ZegoDataRecordConfig config, ZegoPublishChannel channel)?)

录制进度更新回调。

getter/setter pair

onCapturedDataRecordStateUpdate ↔ (void Function(ZegoDataRecordState state, int errorCode, ZegoDataRecordConfig config, ZegoPublishChannel channel)?)

本地录制的状态更新回调，当录制过程状态变化时触发。

getter/setter pair

onCapturedSoundLevelInfoUpdate ↔ (void Function(ZegoSoundLevelInfo soundLevelInfo)?)

本地采集音频声浪回调，支持人声检测。

getter/setter pair

onCapturedSoundLevelUpdate ↔ (void Function(double soundLevel)?)

本地采集音频声浪回调。

getter/setter pair

onCurrentPitchValueUpdate ↔ (void Function(ZegoCopyrightedMusic copyrightedMusic, String resourceID, int currentDuration, int pitchValue)?)

实时音高线回调。

getter/setter pair

onDebugError ↔ (void Function(int errorCode, String funcName, String info)?)

调试错误信息回调。

getter/setter pair

onDownloadProgressUpdate ↔ (void Function(ZegoCopyrightedMusic copyrightedMusic, String resourceID, double progressRate)?)

加载歌曲或伴奏进度回调。

getter/setter pair

onEngineStateUpdate ↔ (void Function(ZegoEngineState state)?)

音视频引擎状态更新的回调通知。

getter/setter pair

onExceptionOccurred ↔ (void Function(ZegoScreenCaptureSource source, ZegoScreenCaptureSourceExceptionType exceptionType)?)

屏幕采集异常通知

getter/setter pair

onFatalError ↔ (void Function(int errorCode)?)

发生致命性错误的回调通知，SDK功能无法正常使用。

getter/setter pair

onIMRecvBarrageMessage ↔ (void Function(String roomID, List<ZegoBarrageMessageInfo> messageList)?)

接收房间弹幕消息通知。

getter/setter pair

onIMRecvBroadcastMessage ↔ (void Function(String roomID, List<ZegoBroadcastMessageInfo> messageList)?)

接收房间广播消息通知。

getter/setter pair

onIMRecvCustomCommand ↔ (void Function(String roomID, ZegoUser fromUser, String command)?)

接收自定义信令通知。

getter/setter pair

onLocalDeviceExceptionOccurred ↔ (void Function(ZegoDeviceExceptionType exceptionType, ZegoDeviceType deviceType, String deviceID)?)

本地设备异常通知。

getter/setter pair

onMediaDataPublisherFileClose ↔ (void Function(ZegoMediaDataPublisher mediaDataPublisher, int errorCode, String path)?)

媒体推流器关闭媒体文件的事件回调

getter/setter pair

onMediaDataPublisherFileDataBegin ↔ (void Function(ZegoMediaDataPublisher mediaDataPublisher, String path)?)

媒体推流器开始读取到了媒体文件数据的事件回调。

getter/setter pair

onMediaDataPublisherFileDataEnd ↔ (void Function(ZegoMediaDataPublisher mediaDataPublisher, String path)?)

媒体推流器已完成一个文件推流的回调。

getter/setter pair

onMediaDataPublisherFileOpen ↔ (void Function(ZegoMediaDataPublisher mediaDataPublisher, String path)?)

媒体推流器打开媒体文件的事件回调。

getter/setter pair

onMediaPlayerFirstFrameEvent ↔ (void Function(ZegoMediaPlayer mediaPlayer, ZegoMediaPlayerFirstFrameEvent event)?)

媒体播放器播放首帧回调。

getter/setter pair

onMediaPlayerFrequencySpectrumUpdate ↔ (void Function(ZegoMediaPlayer mediaPlayer, List<double> spectrumList)?)

频谱更新回调。

getter/setter pair

onMediaPlayerLocalCache ↔ (void Function(ZegoMediaPlayer mediaPlayer, int errorCode, String resource, String cachedFile)?)

媒体播放器本地缓存 http/https 网络资源后回调。

getter/setter pair

onMediaPlayerNetworkEvent ↔ (void Function(ZegoMediaPlayer mediaPlayer, ZegoMediaPlayerNetworkEvent networkEvent)?)

媒体播放器网络状态事件回调。

getter/setter pair

onMediaPlayerPlayingProgress ↔ (void Function(ZegoMediaPlayer mediaPlayer, int millisecond)?)

播放器播放进度回调。

getter/setter pair

onMediaPlayerRecvSEI ↔ (void Function(ZegoMediaPlayer mediaPlayer, Uint8List data)?)

媒体次要信息回调。

getter/setter pair

onMediaPlayerRenderingProgress ↔ (void Function(ZegoMediaPlayer mediaPlayer, int millisecond)?)

播放器渲染进度回调。

getter/setter pair

onMediaPlayerSoundLevelUpdate ↔ (void Function(ZegoMediaPlayer mediaPlayer, double soundLevel)?)

声浪更新回调。

getter/setter pair

onMediaPlayerStateUpdate ↔ (void Function(ZegoMediaPlayer mediaPlayer, ZegoMediaPlayerState state, int errorCode)?)

媒体播放器播放状态回调。

getter/setter pair

onMediaPlayerVideoSizeChanged ↔ (void Function(ZegoMediaPlayer mediaPlayer, int width, int height)?)

媒体播放器播放视频分辨率改变事件回调。

getter/setter pair

onMixedAudioData ↔ (void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param)?)

获取 SDK 播放的音频数据和本地麦克风采集到的音频数据的回调，该音频数据是经过 SDK 混合之后的数据。

getter/setter pair

onMixerRelayCDNStateUpdate ↔ (void Function(String taskID, List<ZegoStreamRelayCDNInfo> infoList)?)

混流转推 CDN 状态更新通知。

getter/setter pair

onMixerSoundLevelUpdate ↔ (void Function(Map<int, double> soundLevels)?)

混流中的每条单流的声浪更新通知。

getter/setter pair

onMobileScreenCaptureExceptionOccurred ↔ (void Function(ZegoScreenCaptureExceptionType exceptionType)?)

屏幕采集异常通知。

getter/setter pair

onMobileScreenCaptureStart ↔ (void Function()?)

屏幕采集开始通知。

getter/setter pair

onNetworkModeChanged ↔ (void Function(ZegoNetworkMode mode)?)

网络模式变更回调。

getter/setter pair

onNetworkQuality ↔ (void Function(String userID, ZegoStreamQualityLevel upstreamQuality, ZegoStreamQualityLevel downstreamQuality)?)

房间内正在推流的用户的网络质量回调。

getter/setter pair

onNetworkSpeedTestError ↔ (void Function(int errorCode, ZegoNetworkSpeedTestType type)?)

网络测速异常回调。

getter/setter pair

onNetworkSpeedTestQualityUpdate ↔ (void Function(ZegoNetworkSpeedTestQuality quality, ZegoNetworkSpeedTestType type)?)

网络测速质量回调。

getter/setter pair

onNetworkTimeSynchronized ↔ (void Function()?)

网络时间同步成功的回调

getter/setter pair

onPerformanceStatusUpdate ↔ (void Function(ZegoPerformanceStatus status)?)

系统性能监控回调。

getter/setter pair

onPlaybackAudioData ↔ (void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param)?)

获取 SDK 播放的音频数据的回调。

getter/setter pair

onPlayerAudioData ↔ (void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param, String streamID)?)

获取 SDK 每条拉流的音频数据的回调。

getter/setter pair

onPlayerLowFpsWarning ↔ (void Function(ZegoVideoCodecID codecID, String streamID)?)

拉流低帧率警告。

getter/setter pair

onPlayerMediaEvent ↔ (void Function(String streamID, ZegoPlayerMediaEvent event)?)

拉流媒体事件回调。

getter/setter pair

onPlayerQualityUpdate ↔ (void Function(String streamID, ZegoPlayStreamQuality quality)?)

拉流质量回调。

getter/setter pair

onPlayerRecvAudioFirstFrame ↔ (void Function(String streamID)?)

拉流端音频接收首帧回调。

getter/setter pair

onPlayerRecvAudioSideInfo ↔ (void Function(String streamID, Uint8List data)?)

收到远端流的音频次要信息内容。

getter/setter pair

onPlayerRecvMediaSideInfo ↔ (void Function(ZegoMediaSideInfo info)?)

同步接收远端流的 SEI 内容，包含时间戳。

getter/setter pair

onPlayerRecvSEI ↔ (void Function(String streamID, Uint8List data)?)

收到远端流的 SEI 内容。

getter/setter pair

onPlayerRecvVideoFirstFrame ↔ (void Function(String streamID)?)

拉流端视频接收首帧回调。

getter/setter pair

onPlayerRenderCameraVideoFirstFrame ↔ (void Function(String streamID)?)

拉流端渲染完远端摄像头视频首帧回调。

getter/setter pair

onPlayerRenderVideoFirstFrame ↔ (void Function(String streamID)?)

拉流端渲染完视频首帧回调。

getter/setter pair

onPlayerStateUpdate ↔ (void Function(String streamID, ZegoPlayerState state, int errorCode, Map<String, dynamic> extendedData)?)

拉流状态变更回调。

getter/setter pair

onPlayerStreamEvent ↔ (void Function(ZegoStreamEvent eventID, String streamID, String extraInfo)?)

拉流事件回调。

getter/setter pair

onPlayerSwitched ↔ (void Function(String streamID, int errorCode)?)

切换拉流结果回调。

getter/setter pair

onPlayerVideoSizeChanged ↔ (void Function(String streamID, int width, int height)?)

拉流分辨率变更通知。

getter/setter pair

onPlayerVideoSuperResolutionUpdate ↔ (void Function(String streamID, ZegoSuperResolutionState state, int errorCode)?)

拉流视频超分辨率开启状态变化。

getter/setter pair

onProcessCapturedAudioData ↔ (void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param, double timestamp)?)

自定义音频处理本地采集 PCM 音频帧回调。

getter/setter pair

onProcessCapturedAudioDataAfterUsedHeadphoneMonitor ↔ (void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param, double timestamp)?)

自定义音频处理本地采集使用耳返后的 PCM 音频帧回调。

getter/setter pair

onProcessPlaybackAudioData ↔ (void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param, double timestamp)?)

自定义音频处理 SDK 播放音频的 PCM 音频帧回调。

getter/setter pair

onProcessRemoteAudioData ↔ (void Function(Uint8List data, int dataLength, ZegoAudioFrameParam param, String streamID, double timestamp)?)

自定义音频处理远端拉流 PCM 音频帧回调。

getter/setter pair

onPublisherCapturedAudioFirstFrame ↔ (void Function()?)

音频采集首帧回调接口。

getter/setter pair

onPublisherCapturedVideoFirstFrame ↔ (void Function(ZegoPublishChannel channel)?)

视频采集首帧回调接口。

getter/setter pair

onPublisherDummyCaptureImagePathError ↔ (void Function(int errorCode, String path, ZegoPublishChannel channel)?)

通知设置关闭摄像头时所推静态图片的路径错误。

getter/setter pair

onPublisherLowFpsWarning ↔ (void Function(ZegoVideoCodecID codecID, ZegoPublishChannel channel)?)

视频编码低帧率警告。

getter/setter pair

onPublisherQualityUpdate ↔ (void Function(String streamID, ZegoPublishStreamQuality quality)?)

推流质量回调。

getter/setter pair

onPublisherRelayCDNStateUpdate ↔ (void Function(String streamID, List<ZegoStreamRelayCDNInfo> infoList)?)

添加/删除转推 CDN 地址状态回调。

getter/setter pair

onPublisherRenderVideoFirstFrame ↔ (void Function(ZegoPublishChannel channel)?)

推流端视频渲染首帧回调。

getter/setter pair

onPublisherSendAudioFirstFrame ↔ (void Function(ZegoPublishChannel channel)?)

推流端音频发送首帧回调。

getter/setter pair

onPublisherSendVideoFirstFrame ↔ (void Function(ZegoPublishChannel channel)?)

推流端视频发送首帧回调。

getter/setter pair

onPublisherStateUpdate ↔ (void Function(String streamID, ZegoPublisherState state, int errorCode, Map<String, dynamic> extendedData)?)

推流状态回调。

getter/setter pair

onPublisherStreamEvent ↔ (void Function(ZegoStreamEvent eventID, String streamID, String extraInfo)?)

推流事件回调。

getter/setter pair

onPublisherVideoEncoderChanged ↔ (void Function(ZegoVideoCodecID fromCodecID, ZegoVideoCodecID toCodecID, ZegoPublishChannel channel)?)

视频编码器变更回调。

getter/setter pair

onPublisherVideoSizeChanged ↔ (void Function(int width, int height, ZegoPublishChannel channel)?)

采集视频大小变更回调。

getter/setter pair

onRangeAudioMicrophoneStateUpdate ↔ (void Function(ZegoRangeAudio rangeAudio, ZegoRangeAudioMicrophoneState state, int errorCode)?)

范围语音麦克风使用状态回调。

getter/setter pair

onReceiveRealTimeSequentialData ↔ (void Function(ZegoRealTimeSequentialDataManager manager, Uint8List data, String streamID)?)

收到实时有序数据回调

getter/setter pair

onRectChanged ↔ (void Function(ZegoScreenCaptureSource source, Rect captureRect)?)

采集区域发生改变。

getter/setter pair

onRecvExperimentalAPI ↔ (void Function(String content)?)

实验性 API 回调。

getter/setter pair

onRecvRoomTransparentMessage ↔ (void Function(String roomID, ZegoRoomRecvTransparentMessage message)?)

接收房间透传消息。

getter/setter pair

onRemoteAudioSpectrumUpdate ↔ (void Function(Map<String, List<double>> audioSpectrums)?)

远端拉流音频频谱回调。

getter/setter pair

onRemoteCameraStateUpdate ↔ (void Function(String streamID, ZegoRemoteDeviceState state)?)

远端摄像头设备状态通知。

getter/setter pair

onRemoteMicStateUpdate ↔ (void Function(String streamID, ZegoRemoteDeviceState state)?)

远端麦克风设备状态通知。

getter/setter pair

onRemoteSoundLevelInfoUpdate ↔ (void Function(Map<String, ZegoSoundLevelInfo> soundLevelInfos)?)

远端拉流音频声浪回调，支持人声检测。

getter/setter pair

onRemoteSoundLevelUpdate ↔ (void Function(Map<String, double> soundLevels)?)

远端拉流音频声浪回调。

getter/setter pair

onRemoteSpeakerStateUpdate ↔ (void Function(String streamID, ZegoRemoteDeviceState state)?)

远端扬声器设备状态通知。

getter/setter pair

onRequestDumpData ↔ (void Function()?)

请求转储数据的回调。

getter/setter pair

onRequestUploadDumpData ↔ (void Function(String dumpDir, bool takePhoto)?)

请求转储数据的回调。

getter/setter pair

onRoomExtraInfoUpdate ↔ (void Function(String roomID, List<ZegoRoomExtraInfo> roomExtraInfoList)?)

房间附加信息更新通知。

getter/setter pair

onRoomOnlineUserCountUpdate ↔ (void Function(String roomID, int count)?)

房间内当前在线用户数量回调。

getter/setter pair

onRoomStateChanged ↔ (void Function(String roomID, ZegoRoomStateChangedReason reason, int errorCode, Map<String, dynamic> extendedData)?)

房间状态变化通知，包含具体的状态变化原因。

getter/setter pair

onRoomStateUpdate ↔ (void Function(String roomID, ZegoRoomState state, int errorCode, Map<String, dynamic> extendedData)?)

房间状态变化通知。

getter/setter pair

onRoomStreamExtraInfoUpdate ↔ (void Function(String roomID, List<ZegoStream> streamList)?)

房间内流附加信息更新通知。

getter/setter pair

onRoomStreamUpdate ↔ (void Function(String roomID, ZegoUpdateType updateType, List<ZegoStream> streamList, Map<String, dynamic> extendedData)?)

相同房间内其他用户推的流增加或减少的通知。

getter/setter pair

onRoomTokenWillExpire ↔ (void Function(String roomID, int remainTimeInSecond)?)

房间 Token 鉴权将要过期的回调通知。

getter/setter pair

onRoomUserUpdate ↔ (void Function(String roomID, ZegoUpdateType updateType, List<ZegoUser> userList)?)

房间内其他用户增加或减少的回调通知。

getter/setter pair

onStartDumpData ↔ (void Function(int errorCode)?)

开始转储数据时的回调。

getter/setter pair

onStopDumpData ↔ (void Function(int errorCode, String dumpDir)?)

停止转储数据时的回调。

getter/setter pair

onUploadDumpData ↔ (void Function(int errorCode)?)

上传转储数据完成后的回调。

getter/setter pair

onVideoDeviceStateChanged ↔ (void Function(ZegoUpdateType updateType, ZegoDeviceInfo deviceInfo)?)

视频设备状态改变。

getter/setter pair

onVideoObjectSegmentationStateChanged ↔ (void Function(ZegoObjectSegmentationState state, ZegoPublishChannel channel, int errorCode)?)

视频主体分割状态变化。

getter/setter pair

onWindowStateChanged ↔ (void Function(ZegoScreenCaptureSource source, ZegoScreenCaptureWindowState windowState, Rect windowRect)?)

采集目标窗口状态发生改变。

getter/setter pair

Static Methods

createEngine(int appID, String appSign, bool isTestEnv, ZegoScenario scenario, {bool? enablePlatformView}) → Future<void>

【已废弃】创建 ZegoExpressEngine 单例对象并初始化 SDK。此函数在 2.14.0 版本及以上已废弃，请使用不带 isTestEnv 参数的同名函数代替。请参考 测试环境废弃说明

createEngineWithProfile(ZegoEngineProfile profile) → Future<void>

创建 ZegoExpressEngine 单例对象并初始化 SDK。

destroyEngine() → Future<void>

销毁 ZegoExpressEngine 单例对象并反初始化 SDK。

getVersion() → Future<String>

获取 SDK 版本号。

isFeatureSupported(ZegoFeatureType featureType) → Future<bool>

查询当前 SDK 是否支持指定的功能特性。

setCloudProxyConfig(List<ZegoProxyInfo> proxyList, String token, bool enable) → Future<void>

设置云代理配置

setEngineConfig(ZegoEngineConfig config) → Future<void>

设置引擎进阶配置。

setGeoFence(ZegoGeoFenceType type, List<int> areaList) → Future<void>

设置地理围栏。

setLicense(String license) → Future<void>

设置 License 鉴权。

setLocalProxyConfig(List<ZegoProxyInfo> proxyList, bool enable) → Future<void>

设置本地代理配置

setLogConfig(ZegoLogConfig config) → Future<void>

设置日志配置。

setRoomMode(ZegoRoomMode mode) → Future<void>

设置房间模式。

submitLog() → Future<void>

上传日志到 ZEGO 服务器。