zego_express_engine library

Classes

ZegoAccurateSeekConfig
Precise seek configuration
ZegoAIVoiceChanger
ZegoAIVoiceChangerSpeakerInfo
AI voice changer speaker detail.
ZegoAudioConfig
Audio configuration.
ZegoAudioDataCallbackBitMask
Audio data callback function enable bitmask enumeration.
ZegoAudioEffectPlayConfig
AudioEffectPlayer play configuration.
ZegoAudioEffectPlayer
ZegoAudioEffectPlayerLoadResourceResult
Callback for audio effect player loads resources.
ZegoAudioEffectPlayerSeekToResult
Callback for audio effect player seek to playback progress.
ZegoAudioFrameParam
Parameter object for audio frame.
ZegoAudioMixingData
audio mixing data.
ZegoAudioSourceMixConfig
Audio source mix config
ZegoAutoMixerTask
Auto mix stream task object.
ZegoBackgroundConfig
Background config.
ZegoBarrageMessageInfo
Barrage message info.
ZegoBeautifyFeature
Beauty feature (bitmask enumeration).
ZegoBeautifyOption
Beauty configuration options.
ZegoBroadcastMessageInfo
Broadcast message info.
ZegoCanvas
View object.
ZegoCDNConfig
CDN config object.
ZegoColorEnhancementParams
Color enhancement params.
ZegoCopyrightedMusic
ZegoCopyrightedMusicConfig
CopyrightedMusic play configuration.
ZegoCopyrightedMusicDownloadResult
Callback for download song or accompaniment.
ZegoCopyrightedMusicGetKrcLyricByTokenResult
Get verbatim lyrics complete callback.
ZegoCopyrightedMusicGetLrcLyricResult
Get lrc format lyrics complete callback.
ZegoCopyrightedMusicGetLyricConfig
The configuration of getting lyric.
ZegoCopyrightedMusicGetMusicByTokenResult
Callback for acquire songs or accompaniment through authorization token.
ZegoCopyrightedMusicGetSharedConfig
The configuration of getting shared resource.
ZegoCopyrightedMusicGetSharedConfigV2
The configuration of getting shared resource.
ZegoCopyrightedMusicGetSharedResourceResult
Callback of getting shared music resource.
ZegoCopyrightedMusicGetStandardPitchResult
Get standard pitch data complete callback.
ZegoCopyrightedMusicInitResult
Callback for copyrighted music init.
ZegoCopyrightedMusicQueryCacheConfig
The configuration of querying cache.
ZegoCopyrightedMusicQueryCacheConfigV2
The configuration of querying cache.
ZegoCopyrightedMusicRequestAccompanimentClipResult
Callback for request accompaniment clip.
ZegoCopyrightedMusicRequestAccompanimentResult
Callback for request accompaniment.
ZegoCopyrightedMusicRequestConfig
The configuration of requesting resource.
ZegoCopyrightedMusicRequestConfigV2
The configuration of requesting resource.
ZegoCopyrightedMusicRequestResourceResult
Callback of requesting music resource.
ZegoCopyrightedMusicRequestSongResult
Callback for request song.
ZegoCopyrightedMusicSendExtendedRequestResult
Callback of sending extended feature request.
ZegoCrossAppInfo
Cross APP playing stream configuration.
ZegoCustomAudioConfig
Custom audio configuration.
ZegoCustomAudioProcessConfig
Customize the audio processing configuration object.
ZegoCustomPlayerResourceConfig
Custom play stream resource type configuration.
ZegoCustomVideoCaptureConfig
Custom video capture configuration.
ZegoCustomVideoProcessConfig
Custom video process configuration.
ZegoCustomVideoRenderConfig
Custom video render configuration.
ZegoDataRecordConfig
Record config.
ZegoDataRecordProgress
File recording progress.
ZegoDeviceInfo
Device Info.
ZegoDumpDataConfig
Dump data config.
ZegoEffectsBeautyParam
Beauty configuration param.
ZegoEngineConfig
Advanced engine configuration.
ZegoEngineProfile
Profile for create engine
ZegoErrorCode
ZegoExpressEngine
ZegoFontStyle
Font style.
ZegoGeoFenceAreaCode
Geo fence area code.
ZegoIMSendBarrageMessageResult
Callback for sending barrage message.
ZegoIMSendBroadcastMessageResult
Callback for sending broadcast messages.
ZegoIMSendCustomCommandResult
Callback for sending custom command.
ZegoLabelInfo
Label info.
ZegoLogConfig
Log config.
ZegoMediaDataPublisher
ZegoMediaDataPublisherConfig
Used to config the media data publisher.
ZegoMediaPlayer
ZegoMediaPlayerLoadResourceResult
Callback for media player loads resources.
ZegoMediaPlayerMediaInfo
Media Infomration of media file.
ZegoMediaPlayerResource
Multimedia resource for ZEGO media player.
ZegoMediaPlayerSeekToResult
Callback for media player seek to playback progress.
ZegoMediaPlayerStatisticsInfo
Media player play statistics.
ZegoMediaPlayerTakeSnapshotResult
The callback of the screenshot of the media player playing screen
ZegoMediaSideInfo
SEI Callback info.
ZegoMixerAudioConfig
Mix stream audio configuration.
ZegoMixerImageInfo
Set the image information of a single input stream in the mux.
ZegoMixerInput
Mixer input.
ZegoMixerOutput
Mixer output object, currently, a mixed-stream task only supports a maximum of four video streams with different resolutions.
ZegoMixerOutputRoomInfo
Room information for the output stream in a mixed stream.
ZegoMixerOutputVideoConfig
Mix stream output video config object.
ZegoMixerStartResult
Results of starting a mixer task.
ZegoMixerStopResult
Results of stoping a mixer task.
ZegoMixerTask
Mix stream task object.
ZegoMixerVideoConfig
Mix stream video config object.
ZegoMixerWhiteboard
Mixer whiteboard object.
ZegoNetworkProbeConfig
Network probe config
ZegoNetworkProbeHttpResult
http probe result
ZegoNetworkProbeResult
Network probe result
ZegoNetworkProbeTcpResult
tcp probe result
ZegoNetworkProbeTracerouteResult
traceroute result
ZegoNetworkProbeUdpResult
udp probe result
ZegoNetWorkResourceCache
Media player network cache information
ZegoNetworkSpeedTestConfig
Network speed test config
ZegoNetworkSpeedTestQuality
network speed test quality
ZegoNetworkTimeInfo
The NTP info
ZegoObjectSegmentationConfig
Object segmentation config.
ZegoPerformanceStatus
System performance monitoring status
ZegoPlayerConfig
Advanced player configuration.
ZegoPlayerTakeSnapshotResult
Results of take play stream snapshot.
ZegoPlayStreamQuality
Played stream quality information.
ZegoProxyInfo
Proxy config.
ZegoPublishDualStreamConfig
Dual stream info.
ZegoPublisherConfig
Advanced publisher configuration.
ZegoPublisherSetStreamExtraInfoResult
Callback for setting stream extra information.
ZegoPublisherTakeSnapshotResult
Results of take publish stream snapshot.
ZegoPublisherUpdateCdnUrlResult
Callback for add/remove CDN URL.
ZegoPublishStreamQuality
Published stream quality information.
ZegoRangeAudio
ZegoRealTimeSequentialDataManager
ZegoRealTimeSequentialDataSentResult
Callback for sending real-time sequential data.
ZegoReceiveRangeParam
Receive range configuration.
ZegoReverbAdvancedParam
Audio reverberation advanced parameters.
ZegoReverbEchoParam
Audio reverberation echo parameters.
ZegoRoomCapabilityNegotiationTypesBitMask
Capability negotiation enable bitmask enumeration.
ZegoRoomConfig
Advanced room configuration.
ZegoRoomExtraInfo
Room extra information.
ZegoRoomLoginResult
Login room result callback.
ZegoRoomLogoutResult
Logout room result callback.
ZegoRoomRecvTransparentMessage
Received a transparent message from the room.
ZegoRoomSendTransparentMessage
Transparent message info.
ZegoRoomSendTransparentMessageResult
Callback for sending custom command.
ZegoRoomSetRoomExtraInfoResult
Callback for setting room extra information.
ZegoRoomStreamList
Room stream list.
ZegoScreenCaptureConfig
Screen capture configuration parameters.
ZegoScreenCaptureSource
ZegoScreenCaptureSourceInfo
The screen captures source information.
ZegoSEIConfig
SEI configuration
ZegoSoundLevelConfig
Configuration for start sound level monitor.
ZegoSoundLevelInfo
Sound level info object.
ZegoStream
Stream object.
ZegoStreamRelayCDNInfo
Relay to CDN info.
ZegoTrafficControlProperty
Traffic control property (bitmask enumeration).
ZegoUser
User object.
ZegoVideoConfig
Video config.
ZegoVideoDenoiseParams
Video denoise params.
ZegoVocalRangeParam
Vocal range configuration.
ZegoVoiceChangerParam
Voice changer parameter.
ZegoWatermark
Watermark object.

Enums

ZegoAECMode
Audio echo cancellation mode.
ZegoAlphaLayoutType
Alpha channel data layout.
ZegoANSMode
Active Noise Suppression mode.
ZegoAudioCaptureStereoMode
Audio capture stereo mode.
ZegoAudioChannel
Audio channel type.
ZegoAudioCodecID
Audio codec ID.
ZegoAudioConfigPreset
Audio Config Preset.
ZegoAudioDeviceMode
Audio device mode.
ZegoAudioDeviceType
Audio device type.
ZegoAudioEffectPlayState
AudioEffectPlayer state.
ZegoAudioMixMode
Audio mix mode.
ZegoAudioRoute
Audio route
ZegoAudioSampleRate
audio sample rate.
ZegoAudioSourceType
Audio capture source type.
ZegoAudioVADStableStateMonitorType
stable voice activity detection type
ZegoAudioVADType
voice activity detection type
ZegoBackgroundBlurLevel
Background blur level.
ZegoBackgroundProcessType
Video background process type.
ZegoCameraExposureMode
Camera exposure mode.
ZegoCameraFocusMode
Camera focus mode.
ZegoCapabilityNegotiationType
Type of capability negotiation for publish stream references.
ZegoCapturePipelineScaleMode
Capture pipeline scale mode.
ZegoCDNProtocol
CDN network protocol types supported by ZEGO
ZegoCopyrightedMusicBillingMode
VOD billing mode.
ZegoCopyrightedMusicResourceQualityType
The music resource quality type. For ZegoCopyrightedMusicQueryCacheConfig.
ZegoCopyrightedMusicResourceType
The music resource type. For ZegoCopyrightedMusicRequestConfig, ZegoCopyrightedMusicGetSharedConfig and ZegoCopyrightedMusicQueryCacheConfig.
ZegoCopyrightedMusicType
The music resource type. For querycache interface.
ZegoCopyrightedMusicVendorID
Copyright music resource song copyright provider. For more information about the copyright owner, please contact ZEGO business personnel.
ZegoDataRecordState
Record state.
ZegoDataRecordType
Record type.
ZegoDeviceExceptionType
The exception type for the device.
ZegoDeviceType
Device type.
ZegoDumpDataType
Dump data type.
ZegoElectronicEffectsMode
Mode of Electronic Effects.
ZegoEncodeProfile
video encode profile.
ZegoEngineState
engine state.
ZegoFeatureType
SDK feature type.
ZegoFontType
Font type.
ZegoGeoFenceType
Geo fence type.
ZegoHttpDNSType
Supported httpDNS service types.
ZegoLanguage
Language.
ZegoLiveAudioEffectMode
Live audio effect mode.
ZegoLowlightEnhancementMode
Low light enhanced mode.
ZegoMediaDataPublisherMode
The config of the media data publisher.
ZegoMediaPlayerAudioChannel
Audio channel.
ZegoMediaPlayerAudioTrackMode
Player audio track mode.
ZegoMediaPlayerFirstFrameEvent
Media player first frame event type.
ZegoMediaPlayerNetworkEvent
Player network event.
ZegoMediaPlayerState
Player state.
ZegoMediaStreamType
Media stream type.
ZegoMixerInputContentType
Mix stream content type.
ZegoMixImageCheckMode
Mixed stream sets the image parameter check mode.
ZegoMixRenderMode
Mixing stream video view render mode.
ZegoMultimediaLoadType
Multimedia load type.
ZegoNetworkMode
Network mode
ZegoNetworkSpeedTestType
network speed test type
ZegoObjectSegmentationState
Object segmentation state.
ZegoObjectSegmentationType
Object segmentation type.
ZegoOrientationMode
Orientation mode of the video.
ZegoPlayerMediaEvent
Media event when playing.
ZegoPlayerState
Playing stream status.
ZegoPublishChannel
Publish channel.
ZegoPublisherState
Publish stream status.
ZegoRangeAudioListenMode
Range audio listening mode
ZegoRangeAudioMicrophoneState
Range audio microphone state.
ZegoRangeAudioMode
Range audio mode
ZegoRangeAudioSpeakMode
Range audio speak mode
ZegoRemoteDeviceState
Remote device status.
ZegoResourceType
Resource Type.
ZegoReverbPreset
Reverberation preset value.
ZegoRoomMode
Room mode.
ZegoRoomState
Room state.
ZegoRoomStateChangedReason
Room state change reason.
ZegoRoomStreamListType
Get room stream list type.
ZegoRoomTransparentMessageMode
Room mode.
ZegoRoomTransparentMessageType
Room mode.
ZegoScenario
Room scenario.
ZegoScreenCaptureExceptionType
Screen capture source exception type. (only for Android)
ZegoScreenCaptureSourceExceptionType
Screen capture source exception type.
ZegoScreenCaptureSourceType
Type of capture target.
ZegoScreenCaptureWindowState
The state of the screen capture source window changes.
ZegoSEIType
SEI type
ZegoStreamAlignmentMode
Stream alignment mode.
ZegoStreamCensorshipMode
Publish CensorshipMode.
ZegoStreamEvent
Publish or play stream event
ZegoStreamQualityLevel
Stream quality level.
ZegoStreamRelayCDNState
State of CDN relay.
ZegoStreamRelayCDNUpdateReason
Reason for state of CDN relay changed.
ZegoStreamResourceMode
Stream Resource Mode
ZegoStreamResourceSwitchMode
Stream Switch Resource Mode
ZegoStreamResourceType
Stream Resource Type
ZegoSuperResolutionState
Super resolution mode.
ZegoTrafficControlFocusOnMode
Factors that trigger traffic control
ZegoTrafficControlMinVideoBitrateMode
Video transmission mode when current bitrate is lower than the set minimum bitrate.
ZegoUpdateType
Update type.
ZegoVideoBufferType
Video frame buffer type.
ZegoVideoCodecBackend
Backend implementation of video codec.
ZegoVideoCodecID
Video codec ID.
ZegoVideoConfigPreset
Video configuration resolution and bitrate preset enumeration. The preset resolutions are adapted for mobile and desktop. On mobile, height is longer than width, and desktop is the opposite. For example, 1080p is actually 1080(w) x 1920(h) on mobile and 1920(w) x 1080(h) on desktop.
ZegoVideoDenoiseMode
Video denoise mode.
ZegoVideoDenoiseStrength
Video denoise strength.
ZegoVideoFlipMode
Video frame flip mode.
ZegoVideoFrameFormat
Video frame format.
ZegoVideoFrameFormatSeries
Video frame format series.
ZegoVideoMirrorMode
Mirror mode for previewing or playing the of the stream.
ZegoVideoRateControlMode
Video rate control mode, the default mode is constant video rate.
ZegoVideoSourceType
video capture source.
ZegoVideoStreamType
Video stream type
ZegoViewMode
Video rendering fill mode.
ZegoVoiceChangerPreset
Voice changer preset value.
ZegoVolumeType
volume type.

Extensions

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