Enum
ZegoAECMode
Audio echo cancellation mode.
Declared in ZegoExpressDefines.h
Properties
ZegoAECModeAggressive
ZegoAECModeAggressive=(0)Aggressive echo cancellation may affect the sound quality slightly, but the echo will be very clean.
ZegoAECModeMedium
ZegoAECModeMedium=(1)Moderate echo cancellation, which may slightly affect a little bit of sound, but the residual echo will be less.
ZegoAECModeSoft
ZegoAECModeSoft=(2)Comfortable echo cancellation, that is, echo cancellation does not affect the sound quality of the sound, and sometimes there may be a little echo, but it will not affect the normal listening.
ZegoAECModeAI
ZegoAECModeAI=(3)AI echo cancellation. Supports intelligent recognition and elimination of echo, with a significant improvement in vocal fidelity compared to traditional AEC algorithms, without additional delay or power consumption increase.
ZegoAECModeAIAggressive
ZegoAECModeAIAggressive=(4)AI Aggressive echo cancellation, Similar to ZegoAECModeAI, it offers cleaner echo cancellation in scenarios with significant reverberation, making it recommended for use in chat rooms with large reverberation. It can be left off in other scenarios, especially in KTV settings where music is played out loud, as it may cause slightly more distortion to the human voice.
ZegoAECModeAIBalanced
ZegoAECModeAIBalanced=(5)Balanced AI echo cancellation, Compared with ZegoAECModeAIAggressive, the echo suppression is cleaner, but the human voice will be more damaged. It is recommended to use it in voice chat scenarios.
ZegoAIVoiceChangerEvent
AI voice changer event.
Declared in ZegoExpressDefines.h
Properties
ZegoAIVoiceChangerEventSucceed
ZegoAIVoiceChangerEventSucceed=(0)Succeed.
ZegoAIVoiceChangerEventBackgroundPerformanceInsufficient
ZegoAIVoiceChangerEventBackgroundPerformanceInsufficient=(1)Background performance insufficient.
ZegoAIVoiceChangerEventForegroundPerformanceInsufficient
ZegoAIVoiceChangerEventForegroundPerformanceInsufficient=(2)Foreground performance insufficient.
ZegoAIVoiceChangerEventOthers
ZegoAIVoiceChangerEventOthers=(3)Others.
ZegoAIVoiceChangerEventSetSpeakerFailed
ZegoAIVoiceChangerEventSetSpeakerFailed=(10)Set speaker failed.
ZegoANSMode
Active Noise Suppression mode.
Declared in ZegoExpressDefines.h
Properties
ZegoANSModeSoft
ZegoANSModeSoft=(0)Soft ANS. In most instances, the sound quality will not be damaged, but some noise will remain.
ZegoANSModeMedium
ZegoANSModeMedium=(1)Medium ANS. It may damage some sound quality, but it has a good noise reduction effect.
ZegoANSModeAggressive
ZegoANSModeAggressive=(2)Aggressive ANS. It may significantly impair the sound quality, but it has a good noise reduction effect.
ZegoANSModeAI
ZegoANSModeAI=(3)AI mode ANS. It will cause great damage to music, so it can not be used for noise suppression of sound sources that need to collect background sound. Please contact ZEGO technical support before use.
ZegoANSModeAIBalanced
ZegoANSModeAIBalanced=(4)Balanced AI mode ANS. It will cause great damage to music, so it can not be used for noise suppression of sound sources that need to collect background sound. Please contact ZEGO technical support before use.
ZegoANSModeAILowLatency
ZegoANSModeAILowLatency=(5)Low latency AI mode ANS. It will cause great damage to music, so it can not be used for noise suppression of sound sources that need to collect background sound. Please contact ZEGO technical support before use.
ZegoANSModeAIAggressive
ZegoANSModeAIAggressive=(6)Aggressive AI mode ANS. It will cause great damage to music, so it can not be used for noise suppression of sound sources that need to collect background sound. Please contact ZEGO technical support before use.
ZegoAlphaLayoutType
Alpha channel data layout.
Declared in ZegoExpressDefines.h
Properties
ZegoAlphaLayoutTypeNone
ZegoAlphaLayoutTypeNone=(0)There is no alpha data.
ZegoAlphaLayoutTypeLeft
ZegoAlphaLayoutTypeLeft=(1)Alpha channel data is to the left of RGB/YUV data.
ZegoAlphaLayoutTypeRight
ZegoAlphaLayoutTypeRight=(2)Alpha channel data is to the right of RGB/YUV data.
ZegoAlphaLayoutTypeBottom
ZegoAlphaLayoutTypeBottom=(3)Alpha channel data is to the bottom of RGB/YUV data.
ZegoAlphaLayoutTypeRightTop
ZegoAlphaLayoutTypeRightTop=(4)Alpha channel data is to the upper right of RGB/YUV data.
ZegoAudioCaptureStereoMode
Audio capture stereo mode.
Declared in ZegoExpressDefines.h
Properties
ZegoAudioCaptureStereoModeNone
ZegoAudioCaptureStereoModeNone=(0)Disable stereo capture, that is, mono.
ZegoAudioCaptureStereoModeAlways
ZegoAudioCaptureStereoModeAlways=(1)Always enable stereo capture.
ZegoAudioCaptureStereoModeAdaptive
ZegoAudioCaptureStereoModeAdaptive=(2)[Deprecated] Same as [Always], that is, always enable stereo capture, this mode has been deprecated since version 2.16.0.
ZegoAudioChannel
Audio channel type.
Declared in ZegoExpressDefines.h
Properties
ZegoAudioChannelUnknown
ZegoAudioChannelUnknown=(0)Unknown
ZegoAudioChannelMono
ZegoAudioChannelMono=(1)Mono
ZegoAudioChannelStereo
ZegoAudioChannelStereo=(2)Stereo
ZegoAudioCodecID
Audio codec ID.
Declared in ZegoExpressDefines.h
Properties
ZegoAudioCodecIDDefault
ZegoAudioCodecIDDefault=(0)Default, determined by the [scenario] when calling [createEngine].
ZegoAudioCodecIDNormal
ZegoAudioCodecIDNormal=(1)Can be used for RTC and CDN streaming; bitrate range from 10kbps to 128kbps; supports stereo; latency is around 500ms. Server cloud transcoding is required when communicating with the Web SDK, and it is not required when relaying to CDN.
ZegoAudioCodecIDNormal2
ZegoAudioCodecIDNormal2=(2)Can be used for RTC and CDN streaming; good compatibility; bitrate range from 16kbps to 192kbps; supports stereo; latency is around 350ms; the sound quality is worse than [Normal] in the same (low) bitrate. Server cloud transcoding is required when communicating with the Web SDK, and it is not required when relaying to CDN.
ZegoAudioCodecIDNormal3
ZegoAudioCodecIDNormal3=(3)Not recommended; if you need to use it, please contact ZEGO technical support. Can only be used for RTC streaming.
ZegoAudioCodecIDLow
ZegoAudioCodecIDLow=(4)Not recommended; if you need to use it, please contact ZEGO technical support. Can only be used for RTC streaming.
ZegoAudioCodecIDLow2
ZegoAudioCodecIDLow2=(5)Not recommended; if you need to use it, please contact ZEGO technical support. Can only be used for RTC streaming; maximum bitrate is 16kbps.
ZegoAudioCodecIDLow3
ZegoAudioCodecIDLow3=(6)Can only be used for RTC streaming; bitrate range from 6kbps to 192kbps; supports stereo; latency is around 200ms; Under the same bitrate (low bitrate), the sound quality is significantly better than [Normal] and [Normal2]; low CPU overhead. Server cloud transcoding is not required when communicating with the Web SDK, and it is required when relaying to CDN.
ZegoAudioConfigPreset
Audio Config Preset.
Declared in ZegoExpressDefines.h
Properties
ZegoAudioConfigPresetBasicQuality
ZegoAudioConfigPresetBasicQuality=(0)Basic sound quality (16 kbps, Mono, ZegoAudioCodecIDDefault)
ZegoAudioConfigPresetStandardQuality
ZegoAudioConfigPresetStandardQuality=(1)Standard sound quality (48 kbps, Mono, ZegoAudioCodecIDDefault)
ZegoAudioConfigPresetStandardQualityStereo
ZegoAudioConfigPresetStandardQualityStereo=(2)Standard sound quality (56 kbps, Stereo, ZegoAudioCodecIDDefault)
ZegoAudioConfigPresetHighQuality
ZegoAudioConfigPresetHighQuality=(3)High sound quality (128 kbps, Mono, ZegoAudioCodecIDDefault)
ZegoAudioConfigPresetHighQualityStereo
ZegoAudioConfigPresetHighQualityStereo=(4)High sound quality (192 kbps, Stereo, ZegoAudioCodecIDDefault)
ZegoAudioDataCallbackBitMask
Audio data callback function enable bitmask enumeration.
Declared in ZegoExpressDefines.h
Properties
ZegoAudioDataCallbackBitMaskCaptured
ZegoAudioDataCallbackBitMaskCaptured=(0)The mask bit of this field corresponds to the enable [onCapturedAudioData] callback function
ZegoAudioDataCallbackBitMaskPlayback
ZegoAudioDataCallbackBitMaskPlayback=(1)The mask bit of this field corresponds to the enable [onPlaybackAudioData] callback function
ZegoAudioDataCallbackBitMaskMixed
ZegoAudioDataCallbackBitMaskMixed=(2)The mask bit of this field corresponds to the enable [onMixedAudioData] callback function
ZegoAudioDataCallbackBitMaskPlayer
ZegoAudioDataCallbackBitMaskPlayer=(3)The mask bit of this field corresponds to the enable [onPlayerAudioData] callback function
ZegoAudioDeviceMode
Audio device mode.
Declared in ZegoExpressDefines.h
Properties
ZegoAudioDeviceModeCommunication
ZegoAudioDeviceModeCommunication=(1)Enable system echo cancellation.
ZegoAudioDeviceModeGeneral
ZegoAudioDeviceModeGeneral=(2)The system echo cancellation function is disabled.
ZegoAudioDeviceModeAuto
ZegoAudioDeviceModeAuto=(3)Automatically select whether to enable system echo cancellation based on the scenario.
ZegoAudioDeviceModeCommunication2
ZegoAudioDeviceModeCommunication2=(4)Enable system echo cancellation. Compared with Communication, this mode always occupies the microphone device.
ZegoAudioDeviceModeCommunication3
ZegoAudioDeviceModeCommunication3=(5)Enable system echo cancellation. Compared with Communication, in this mode, the microphone is released and the media volume is reduced.
ZegoAudioDeviceModeGeneral2
ZegoAudioDeviceModeGeneral2=(6)Disable system echo cancellation. Compared with General, this mode is not released when a microphone device is used.
ZegoAudioDeviceModeGeneral3
ZegoAudioDeviceModeGeneral3=(7)Disable system echo cancellation. Compared with General, this mode will always occupy the microphone device.
ZegoAudioDeviceModeCommunication4
ZegoAudioDeviceModeCommunication4=(8)Enable system echo cancellation. Compared with Communication, this mode of wheat after releasing the microphone, maintain the call volume.
ZegoAudioDeviceType
Audio device type.
Declared in ZegoExpressDefines.h
Properties
ZegoAudioDeviceTypeInput
ZegoAudioDeviceTypeInput=(0)Audio input type
ZegoAudioDeviceTypeOutput
ZegoAudioDeviceTypeOutput=(1)Audio output type
ZegoAudioDeviceTypeLoopback
ZegoAudioDeviceTypeLoopback=(2)Audio loopback type. It is only supported in the [useAudioDevice] interface and only on Windows.
ZegoAudioEffectPlayState
AudioEffectPlayer state.
Declared in ZegoExpressDefines.h
Properties
ZegoAudioEffectPlayStateNoPlay
ZegoAudioEffectPlayStateNoPlay=(0)Not playing
ZegoAudioEffectPlayStatePlaying
ZegoAudioEffectPlayStatePlaying=(1)Playing
ZegoAudioEffectPlayStatePausing
ZegoAudioEffectPlayStatePausing=(2)Pausing
ZegoAudioEffectPlayStatePlayEnded
ZegoAudioEffectPlayStatePlayEnded=(3)End of play
ZegoAudioMixMode
Audio mix mode.
Declared in ZegoExpressDefines.h
Properties
ZegoAudioMixModeRaw
ZegoAudioMixModeRaw=(0)Default mode, no special behavior
ZegoAudioMixModeFocused
ZegoAudioMixModeFocused=(1)Audio focus mode, which can highlight the sound of a certain stream in multiple audio streams
ZegoAudioRoute
Audio route
Declared in ZegoExpressDefines.h
Properties
ZegoAudioRouteSpeaker
ZegoAudioRouteSpeaker=(0)Speaker
ZegoAudioRouteHeadphone
ZegoAudioRouteHeadphone=(1)Headphone
ZegoAudioRouteBluetooth
ZegoAudioRouteBluetooth=(2)Bluetooth device
ZegoAudioRouteReceiver
ZegoAudioRouteReceiver=(3)Receiver
ZegoAudioRouteExternalUSB
ZegoAudioRouteExternalUSB=(4)External USB audio device
ZegoAudioRouteAirPlay
ZegoAudioRouteAirPlay=(5)Apple AirPlay
ZegoAudioSampleRate
audio sample rate.
Declared in ZegoExpressDefines.h
Properties
ZegoAudioSampleRateUnknown
ZegoAudioSampleRateUnknown=(0)Unknown
ZegoAudioSampleRate8K
ZegoAudioSampleRate8K=(8000)8K
ZegoAudioSampleRate16K
ZegoAudioSampleRate16K=(16000)16K
ZegoAudioSampleRate22K
ZegoAudioSampleRate22K=(22050)22.05K
ZegoAudioSampleRate24K
ZegoAudioSampleRate24K=(24000)24K
ZegoAudioSampleRate32K
ZegoAudioSampleRate32K=(32000)32K
ZegoAudioSampleRate44K
ZegoAudioSampleRate44K=(44100)44.1K
ZegoAudioSampleRate48K
ZegoAudioSampleRate48K=(48000)48K
ZegoAudioSourceType
Audio capture source type.
Declared in ZegoExpressDefines.h
Properties
ZegoAudioSourceTypeDefault
ZegoAudioSourceTypeDefault=(0)Default audio capture source (the main channel uses custom audio capture by default; the aux channel uses the same sound as main channel by default).
ZegoAudioSourceTypeCustom
ZegoAudioSourceTypeCustom=(1)Use custom audio capture, refer to [enableCustomAudioIO] or [setAudioSource].
ZegoAudioSourceTypeMediaPlayer
ZegoAudioSourceTypeMediaPlayer=(2)Use media player as audio source, only support aux channel.
ZegoAudioSourceTypeNone
ZegoAudioSourceTypeNone=(3)No audio source. This audio source type can only be used in [setAudioSource] interface, has no effect when used in [enableCustomAudioIO] interface.
ZegoAudioSourceTypeMicrophone
ZegoAudioSourceTypeMicrophone=(4)Using microphone as audio source. This audio source type can only be used in [setAudioSource] interface, has no effect when used in [enableCustomAudioIO] interface.
ZegoAudioSourceTypeMainPublishChannel
ZegoAudioSourceTypeMainPublishChannel=(5)Using main channel as audio source. Ineffective when used in main channel. This audio source type can only be used in [setAudioSource] interface, has no effect when used in [enableCustomAudioIO] interface.
ZegoAudioSourceTypeScreenCapture
ZegoAudioSourceTypeScreenCapture=(6)Using screen capture as audio source. Typically used in mobile screen sharing scenarios. This audio source type can only be used in [setAudioSource] interface, has no effect when used in [enableCustomAudioIO] interface.
ZegoAudioVADStableStateMonitorType
stable voice activity detection type
Declared in ZegoExpressDefines.h
Properties
ZegoAudioVADStableStateMonitorTypeCaptured
ZegoAudioVADStableStateMonitorTypeCaptured=(0)captured
ZegoAudioVADStableStateMonitorTypeCustomProcessed
ZegoAudioVADStableStateMonitorTypeCustomProcessed=(1)custom processed
ZegoAudioVADType
voice activity detection type
Declared in ZegoExpressDefines.h
Properties
ZegoAudioVADTypeNoise
ZegoAudioVADTypeNoise=(0)noise
ZegoAudioVADTypeSpeech
ZegoAudioVADTypeSpeech=(1)speech
ZegoBackgroundBlurLevel
Background blur level.
Declared in ZegoExpressDefines.h
Properties
ZegoBackgroundBlurLevelLow
ZegoBackgroundBlurLevelLow=(0)Background blur level low.
ZegoBackgroundBlurLevelMedium
ZegoBackgroundBlurLevelMedium=(1)Background blur level medium.
ZegoBackgroundBlurLevelHigh
ZegoBackgroundBlurLevelHigh=(2)Background blur level high.
ZegoBackgroundProcessType
Video background process type.
Declared in ZegoExpressDefines.h
Properties
ZegoBackgroundProcessTypeTransparent
ZegoBackgroundProcessTypeTransparent=(0)Background is transparent.
ZegoBackgroundProcessTypeColor
ZegoBackgroundProcessTypeColor=(1)Fill the background with a solid color.
ZegoBackgroundProcessTypeBlur
ZegoBackgroundProcessTypeBlur=(2)Blur background.
ZegoBackgroundProcessTypeImage
ZegoBackgroundProcessTypeImage=(3)The background is the specified image.
ZegoBackgroundProcessTypeVideo
ZegoBackgroundProcessTypeVideo=(4)The background is the specified video.
ZegoBroadcastMode
Broadcast user's own information mode.
Declared in ZegoExpressDefines.h
Properties
ZegoBroadcastModeNone
ZegoBroadcastModeNone=(0)Do not broadcast user's own information.
ZegoBroadcastModeAll
ZegoBroadcastModeAll=(1)Broadcast user's own information.
ZegoCDNProtocol
CDN network protocol types supported by ZEGO
Declared in ZegoExpressDefines.h
Properties
ZegoCDNProtocolTCP
ZegoCDNProtocolTCP=(1)TCP protocol
ZegoCDNProtocolQUIC
ZegoCDNProtocolQUIC=(2)QUIC protocol
ZegoCameraExposureMode
Camera exposure mode.
Declared in ZegoExpressDefines.h
Properties
ZegoCameraExposureModeAutoExposure
ZegoCameraExposureModeAutoExposure=(0)Auto exposure.
ZegoCameraExposureModeContinuousAutoExposure
ZegoCameraExposureModeContinuousAutoExposure=(1)Continuous auto exposure.
ZegoCameraFocusMode
Camera focus mode.
Declared in ZegoExpressDefines.h
Properties
ZegoCameraFocusModeAutoFocus
ZegoCameraFocusModeAutoFocus=(0)Auto focus.
ZegoCameraFocusModeContinuousAutoFocus
ZegoCameraFocusModeContinuousAutoFocus=(1)Continuous auto focus.
ZegoCapabilityNegotiationType
Type of capability negotiation for publish stream references.
Declared in ZegoExpressDefines.h
Properties
ZegoCapabilityNegotiationTypeNone
ZegoCapabilityNegotiationTypeNone=(0)no reference to the outcome of the capability negotiation.
ZegoCapabilityNegotiationTypeAll
ZegoCapabilityNegotiationTypeAll=(1)refer to the outcome of the capability negotiation of all user in the room.
ZegoCapabilityNegotiationTypePublisher
ZegoCapabilityNegotiationTypePublisher=(2)refer to the outcome of the capability negotiation of publisher in the room.
ZegoCapturePipelineScaleMode
Capture pipeline scale mode.
Declared in ZegoExpressDefines.h
Properties
ZegoCapturePipelineScaleModePre
ZegoCapturePipelineScaleModePre=(0)Zoom immediately after acquisition, default
ZegoCapturePipelineScaleModePost
ZegoCapturePipelineScaleModePost=(1)Scaling while encoding
ZegoCopyrightedMusicBillingMode
VOD billing mode.
Declared in ZegoExpressDefines.h
Properties
ZegoCopyrightedMusicBillingModeCount
ZegoCopyrightedMusicBillingModeCount=(0)Pay-per-use.Each time a user obtains a song resource, a charge is required, that is, the user will be charged for each time based on the actual call to obtain the song resource interface (such as [requestResource] etc.).
ZegoCopyrightedMusicBillingModeUser
ZegoCopyrightedMusicBillingModeUser=(1)Monthly billing by user.Billing for a single user is based on the monthly dimension, that is, the statistics call to obtain song resources (such as [requestResource], etc.) and the parameters are the user ID of the monthly subscription, and the charging is based on the monthly dimension.
ZegoCopyrightedMusicBillingModeRoom
ZegoCopyrightedMusicBillingModeRoom=(2)Monthly billing by room.The room users are billed on a monthly basis, that is, statistical calls to obtain song resources (such as [requestResource], etc.) are passed as Roomid for a monthly subscription of the room, and fees are charged on a monthly basis.
ZegoCopyrightedMusicBillingModeMaster
ZegoCopyrightedMusicBillingModeMaster=(3)Monthly billing by master. Every time a user obtains a resource, it is counted as the owner’s acquisition of resources, that is, according to the actual call to obtain the song resource interface (such as [requestResource], etc.), the parameters are passed as the Roomid of the room and the Masterid of the owner, and the fee is charged according to the owner.
ZegoCopyrightedMusicResourceQualityType
The music resource quality type. For [ZegoCopyrightedMusicQueryCacheConfig].
Declared in ZegoExpressDefines.h
Properties
ZegoCopyrightedMusicResourceQualityNormal
ZegoCopyrightedMusicResourceQualityNormal=(0)Standard Definition Audio.
ZegoCopyrightedMusicResourceQualityHQ
ZegoCopyrightedMusicResourceQualityHQ=(1)High Definition Audio.
ZegoCopyrightedMusicResourceQualitySQ
ZegoCopyrightedMusicResourceQualitySQ=(2)Lossless Audio Quality.
ZegoCopyrightedMusicResourceType
The music resource type. For [ZegoCopyrightedMusicRequestConfig], [ZegoCopyrightedMusicGetSharedConfig] and [ZegoCopyrightedMusicQueryCacheConfig].
Declared in ZegoExpressDefines.h
Properties
ZegoCopyrightedMusicResourceSong
ZegoCopyrightedMusicResourceSong=(0)Song.
ZegoCopyrightedMusicResourceAccompaniment
ZegoCopyrightedMusicResourceAccompaniment=(1)Song accompaniment.
ZegoCopyrightedMusicResourceAccompanimentClip
ZegoCopyrightedMusicResourceAccompanimentClip=(2)Song accompaniment clip.
ZegoCopyrightedMusicResourceAccompanimentSegment
ZegoCopyrightedMusicResourceAccompanimentSegment=(3)Song accompaniment segment.
ZegoCopyrightedMusicType
The music resource type. For [querycache] interface.
Declared in ZegoExpressDefines.h
Properties
ZegoCopyrightedMusicSong
ZegoCopyrightedMusicSong=(0)Song. Deprecated since version 3.9.0.
ZegoCopyrightedMusicSongHQ
ZegoCopyrightedMusicSongHQ=(1)Song with high quality. Deprecated since version 3.9.0.
ZegoCopyrightedMusicSongSQ
ZegoCopyrightedMusicSongSQ=(2)Song with super quality. Deprecated since version 3.9.0.
ZegoCopyrightedMusicAccompaniment
ZegoCopyrightedMusicAccompaniment=(3)Song accompaniment. Deprecated since version 3.9.0.
ZegoCopyrightedMusicAccompanimentClip
ZegoCopyrightedMusicAccompanimentClip=(4)Song accompaniment clip. Deprecated since version 3.9.0.
ZegoCopyrightedMusicAccompanimentSegment
ZegoCopyrightedMusicAccompanimentSegment=(5)Song accompaniment segment. Deprecated since version 3.9.0.
ZegoCopyrightedMusicVendorID
Copyright music resource song copyright provider. For more information about the copyright owner, please contact ZEGO business personnel.
Declared in ZegoExpressDefines.h
Properties
ZegoCopyrightedMusicVendorDefault
ZegoCopyrightedMusicVendorDefault=(0)Default copyright provider.
ZegoCopyrightedMusicVendor1
ZegoCopyrightedMusicVendor1=(1)First copyright provider.
ZegoCopyrightedMusicVendor2
ZegoCopyrightedMusicVendor2=(2)Second copyright provider.
ZegoCopyrightedMusicVendor3
ZegoCopyrightedMusicVendor3=(4)Third copyright provider.
ZegoCreateItemMode
The mode of create item.
Declared in ZegoExpressDefines.h
Properties
ZegoCreateItemModeNoBind
ZegoCreateItemModeNoBind=(0)Do not bind user after item is created.
ZegoCreateItemModeBind
ZegoCreateItemModeBind=(1)Bind the user after creating the item.
ZegoCustomAudioProcessType
Customize the audio processing configuration type.
Declared in ZegoExpressDefines.h
Properties
ZegoCustomAudioProcessTypeRemote
ZegoCustomAudioProcessTypeRemote=(0)Remote audio processing
ZegoCustomAudioProcessTypeCapture
ZegoCustomAudioProcessTypeCapture=(1)Capture audio processing
ZegoCustomAudioProcessTypeCaptureAndRemote
ZegoCustomAudioProcessTypeCaptureAndRemote=(2)Remote audio and capture audio processing
ZegoDataRecordState
Record state.
Declared in ZegoExpressDefines.h
Properties
ZegoDataRecordStateNoRecord
ZegoDataRecordStateNoRecord=(0)Unrecorded state, which is the state when a recording error occurs or before recording starts.
ZegoDataRecordStateRecording
ZegoDataRecordStateRecording=(1)Recording in progress, in this state after successfully call [startRecordingCapturedData] function
ZegoDataRecordStateSuccess
ZegoDataRecordStateSuccess=(2)Record successs
ZegoDataRecordType
Record type.
Declared in ZegoExpressDefines.h
Properties
ZegoDataRecordTypeDefault
ZegoDataRecordTypeDefault=(0)This field indicates that the Express-Audio SDK records audio by default, and the Express-Video SDK records audio and video by default. When recording files in .aac format, audio is also recorded by default.
ZegoDataRecordTypeOnlyAudio
ZegoDataRecordTypeOnlyAudio=(1)only record audio
ZegoDataRecordTypeOnlyVideo
ZegoDataRecordTypeOnlyVideo=(2)only record video, Audio SDK and recording .aac format files are invalid.
ZegoDataRecordTypeAudioAndVideo
ZegoDataRecordTypeAudioAndVideo=(3)record audio and video. Express-Audio SDK and .aac format files are recorded only audio.
ZegoDeviceExceptionType
The exception type for the device.
Declared in ZegoExpressDefines.h
Properties
ZegoDeviceExceptionTypeUnknown
ZegoDeviceExceptionTypeUnknown=(0)Unknown device exception.
ZegoDeviceExceptionTypeGeneric
ZegoDeviceExceptionTypeGeneric=(1)Generic device exception.
ZegoDeviceExceptionTypeInvalidId
ZegoDeviceExceptionTypeInvalidId=(2)Invalid device ID exception.
ZegoDeviceExceptionTypePermissionNotGranted
ZegoDeviceExceptionTypePermissionNotGranted=(3)Device permission is not granted.
ZegoDeviceExceptionTypeZeroCaptureFps
ZegoDeviceExceptionTypeZeroCaptureFps=(4)The capture frame rate of the device is 0.
ZegoDeviceExceptionTypeDeviceOccupied
ZegoDeviceExceptionTypeDeviceOccupied=(5)The device is being occupied.
ZegoDeviceExceptionTypeDeviceUnplugged
ZegoDeviceExceptionTypeDeviceUnplugged=(6)The device is unplugged (not plugged in).
ZegoDeviceExceptionTypeRebootRequired
ZegoDeviceExceptionTypeRebootRequired=(7)The device requires the system to restart before it can work (Windows platform only).
ZegoDeviceExceptionTypeMediaServicesWereLost
ZegoDeviceExceptionTypeMediaServicesWereLost=(8)The system media service is unavailable, e.g. when the iOS system detects that the current pressure is huge (such as playing a lot of animation), it is possible to disable all media related services (Apple platform only).
ZegoDeviceExceptionTypeSiriIsRecording
ZegoDeviceExceptionTypeSiriIsRecording=(9)The device is being occupied by Siri (Apple platform only).
ZegoDeviceExceptionTypeSoundLevelTooLow
ZegoDeviceExceptionTypeSoundLevelTooLow=(10)The device captured sound level is too low (Windows platform only).
ZegoDeviceExceptionTypeMagneticCase
ZegoDeviceExceptionTypeMagneticCase=(11)The device is being occupied, and maybe cause by iPad magnetic case (Apple platform only).
ZegoDeviceExceptionTypeAudioSessionDeactive
ZegoDeviceExceptionTypeAudioSessionDeactive=(12)Audio session deactive (Apple platform only).
ZegoDeviceExceptionTypeAudioSessionCategoryChange
ZegoDeviceExceptionTypeAudioSessionCategoryChange=(13)Audio session category change (Apple platform only).
ZegoDeviceState
Device state.
Declared in ZegoExpressDefines.h
Properties
ZegoDeviceStateClose
ZegoDeviceStateClose=(0)Device off.
ZegoDeviceStateOpen
ZegoDeviceStateOpen=(1)Device on.
ZegoDeviceType
Device type.
Declared in ZegoExpressDefines.h
Properties
ZegoDeviceTypeUnknown
ZegoDeviceTypeUnknown=(0)Unknown device type.
ZegoDeviceTypeCamera
ZegoDeviceTypeCamera=(1)Camera device.
ZegoDeviceTypeMicrophone
ZegoDeviceTypeMicrophone=(2)Microphone device.
ZegoDeviceTypeSpeaker
ZegoDeviceTypeSpeaker=(3)Speaker device.
ZegoDeviceTypeAudioDevice
ZegoDeviceTypeAudioDevice=(4)Audio device. (Other audio device that cannot be accurately classified into microphones or speakers.)
ZegoDeviceTypeAudioSession
ZegoDeviceTypeAudioSession=(5)Audio Session.
ZegoDummyCaptureImageMode
Dummy capture image mode.
Declared in ZegoExpressDefines.h
Properties
ZegoDummyCaptureImageModeManual
ZegoDummyCaptureImageModeManual=(0)Manual mode. The user needs to call the [EnableCamera] interface to turn off camera capture, and the SDK will use dummy capture image.
ZegoDummyCaptureImageModeAuto
ZegoDummyCaptureImageModeAuto=(1)Auto mode. After the SDK detects that the camera is unavailable, it uses dummy capture image to puublish the stream.
ZegoDumpDataType
Dump data type.
Declared in ZegoExpressDefines.h
Properties
ZegoDumpDataTypeAudio
ZegoDumpDataTypeAudio=(0)Audio.
ZegoDumpDataTypeVideo
ZegoDumpDataTypeVideo=(1)Video.
ZegoElectronicEffectsMode
Mode of Electronic Effects.
Declared in ZegoExpressDefines.h
Properties
ZegoElectronicEffectsModeMajor
ZegoElectronicEffectsModeMajor=(0)Major
ZegoElectronicEffectsModeMinor
ZegoElectronicEffectsModeMinor=(1)Minor
ZegoElectronicEffectsModeHarmonicMinor
ZegoElectronicEffectsModeHarmonicMinor=(2)Harmonic Minor
ZegoEncodeProfile
video encode profile.
Declared in ZegoExpressDefines.h
Properties
ZegoEncodeProfileDefault
ZegoEncodeProfileDefault=(0)The default video encode specifications, The default value is the video encoding specification at the Main level.
ZegoEncodeProfileBaseline
ZegoEncodeProfileBaseline=(1)Baseline-level video encode specifications have low decoding consumption and poor picture effects. They are generally used for low-level applications or applications that require additional fault tolerance.
ZegoEncodeProfileMain
ZegoEncodeProfileMain=(2)Main-level video encode specifications, decoding consumption is slightly higher than Baseline, the picture effect is also better, generally used in mainstream consumer electronic products.
ZegoEncodeProfileHigh
ZegoEncodeProfileHigh=(3)High-level video encode specifications, decoding consumption is higher than Main, the picture effect is better, generally used for broadcasting and video disc storage, high-definition TV.
ZegoEngineState
engine state.
Declared in ZegoExpressDefines.h
Properties
ZegoEngineStateStart
ZegoEngineStateStart=(0)The engine has started
ZegoEngineStateStop
ZegoEngineStateStop=(1)The engine has stoped
ZegoExpLowlightEnhancementType
Low light enhanced type.
Declared in ZegoExpressDefines.h
Properties
ZegoExpLowlightEnhancementTypeNormal
ZegoExpLowlightEnhancementTypeNormal=(0)Normal low light enhancement.
ZegoExpLowlightEnhancementTypeAI
ZegoExpLowlightEnhancementTypeAI=(1)AI low light enhancement. If you want to use this function, contact ZEGO technical support.
ZegoFeatureType
SDK feature type.
Declared in ZegoExpressDefines.h
Properties
ZegoFeatureTypeAudio
ZegoFeatureTypeAudio=(0)Basic audio feature.
ZegoFeatureTypeVideo
ZegoFeatureTypeVideo=(1)Basic video feature.
ZegoFeatureTypeMediaPlayer
ZegoFeatureTypeMediaPlayer=(2)Media player feature.
ZegoFeatureTypeMediaDataRecorder
ZegoFeatureTypeMediaDataRecorder=(3)Local media data recorder feature.
ZegoFeatureTypeMediaDataPublisher
ZegoFeatureTypeMediaDataPublisher=(4)Media data publisher feature.
ZegoFeatureTypeSEI
ZegoFeatureTypeSEI=(5)Supplemental Enhancement Information (media side info) feature.
ZegoFeatureTypeSdkVideoCapture
ZegoFeatureTypeSdkVideoCapture=(6)SDK video capture feature.
ZegoFeatureTypeCustomVideoCapture
ZegoFeatureTypeCustomVideoCapture=(7)Custom video capture feature.
ZegoFeatureTypeSdkVideoRender
ZegoFeatureTypeSdkVideoRender=(8)SDK video rendering feature.
ZegoFeatureTypeCustomVideoRender
ZegoFeatureTypeCustomVideoRender=(9)Custom video rendering feature.
ZegoFeatureTypeSdkVideoProcessing
ZegoFeatureTypeSdkVideoProcessing=(10)SDK video processing feature (including low-light enhancement feature).
ZegoFeatureTypeCustomVideoProcessing
ZegoFeatureTypeCustomVideoProcessing=(11)Custom video processing feature.
ZegoFeatureTypeStreamEncryption
ZegoFeatureTypeStreamEncryption=(12)Streaming encryption / decryption feature.
ZegoFeatureTypeRtmp
ZegoFeatureTypeRtmp=(13)RTMP streaming feature.
ZegoFeatureTypeRtmps
ZegoFeatureTypeRtmps=(14)RTMPS streaming feature.
ZegoFeatureTypeRtmpOverQuic
ZegoFeatureTypeRtmpOverQuic=(15)RTMP over QUIC streaming feature.
ZegoFeatureTypeHttpFlv
ZegoFeatureTypeHttpFlv=(16)RTMP streaming feature.
ZegoFeatureTypeHttpsFlv
ZegoFeatureTypeHttpsFlv=(17)HTTPS-FLV streaming feature.
ZegoFeatureTypeHttpFlvOverQuic
ZegoFeatureTypeHttpFlvOverQuic=(18)HTTP-FLV over QUIC streaming feature.
ZegoFeatureTypeSuperResolution
ZegoFeatureTypeSuperResolution=(19)Super resolution imaging feature.
ZegoFeatureTypeEffectsBeauty
ZegoFeatureTypeEffectsBeauty=(20)Effects beauty feature.
ZegoFeatureTypeWhiteboard
ZegoFeatureTypeWhiteboard=(21)Whiteboard beauty feature.
ZegoFeatureTypeRangeAudio
ZegoFeatureTypeRangeAudio=(22)Range audio feature.
ZegoFeatureTypeCopyRightedMusic
ZegoFeatureTypeCopyRightedMusic=(23)Copy righted music feature.
ZegoFeatureTypeVideoObjectSegmentation
ZegoFeatureTypeVideoObjectSegmentation=(24)Video object segmentation feature.
ZegoFeatureTypeRangeScene
ZegoFeatureTypeRangeScene=(25)Range scene feature. (3.0.0 and above support)
ZegoFeatureTypeScreenCapture
ZegoFeatureTypeScreenCapture=(26)Screen capture feature. (3.1.0 and above support)
ZegoFeatureTypeAIVoiceChanger
ZegoFeatureTypeAIVoiceChanger=(27)AI voice changer feature. (3.8.0 and above support)
ZegoFontType
Font type.
Declared in ZegoExpressDefines.h
Properties
ZegoFontTypeSourceHanSans
ZegoFontTypeSourceHanSans=(0)Source han sans.
ZegoFontTypeAlibabaSans
ZegoFontTypeAlibabaSans=(1)Alibaba sans.
ZegoFontTypePangMenZhengDaoTitle
ZegoFontTypePangMenZhengDaoTitle=(2)Pang men zheng dao title.
ZegoFontTypeHappyZcool
ZegoFontTypeHappyZcool=(3)HappyZcool.
ZegoGeoFenceAreaCode
Geo fence area code.
Declared in ZegoExpressDefines.h
Properties
ZegoGeoFenceAreaCodeCN
ZegoGeoFenceAreaCodeCN=(2)Chinese mainland (excluding Hong Kong, Macao and Taiwan).
ZegoGeoFenceAreaCodeNA
ZegoGeoFenceAreaCodeNA=(3)North America.
ZegoGeoFenceAreaCodeEU
ZegoGeoFenceAreaCodeEU=(4)Europe, including the UK.
ZegoGeoFenceAreaCodeAS
ZegoGeoFenceAreaCodeAS=(5)Asia, excluding Chinese mainland and India.
ZegoGeoFenceAreaCodeIN
ZegoGeoFenceAreaCodeIN=(6)India.
ZegoGeoFenceType
Geo fence type.
Declared in ZegoExpressDefines.h
Properties
ZegoGeoFenceTypeNone
ZegoGeoFenceTypeNone=(0)Not use geo fence.
ZegoGeoFenceTypeInclude
ZegoGeoFenceTypeInclude=(1)Include the specified geo fence areas.
ZegoGeoFenceTypeExclude
ZegoGeoFenceTypeExclude=(2)Exclude the specified geo fence areas.
ZegoHttpDNSType
Supported httpDNS service types.
Declared in ZegoExpressDefines.h
Properties
ZegoHttpDNSTypeNone
ZegoHttpDNSTypeNone=(0)None.
ZegoHttpDNSTypeWangsu
ZegoHttpDNSTypeWangsu=(1)wangsu httpdns.
ZegoHttpDNSTypeTencent
ZegoHttpDNSTypeTencent=(2)tencent httpdns.
ZegoHttpDNSTypeAliyun
ZegoHttpDNSTypeAliyun=(3)aliyun httpdns.
ZegoLanguage
Language.
Declared in ZegoExpressDefines.h
Properties
ZegoLanguageEnglish
ZegoLanguageEnglish=(0)English
ZegoLanguageChinese
ZegoLanguageChinese=(1)Chinese
ZegoLiveAudioEffectMode
Live audio effect mode.
Declared in ZegoExpressDefines.h
Properties
ZegoLiveAudioEffectModeNone
ZegoLiveAudioEffectModeNone=(0)No audio effect.
ZegoLiveAudioEffectModeLocal
ZegoLiveAudioEffectModeLocal=(1)Only local play.
ZegoLiveAudioEffectModePublish
ZegoLiveAudioEffectModePublish=(2)Only publish.
ZegoLiveAudioEffectModeAll
ZegoLiveAudioEffectModeAll=(3)Publish and local play.
ZegoLowlightEnhancementMode
Low light enhanced mode.
Declared in ZegoExpressDefines.h
Properties
ZegoLowlightEnhancementModeOff
ZegoLowlightEnhancementModeOff=(0)Turn off the low-light enhancement, and the brightness of the captured image remains unchanged.
ZegoLowlightEnhancementModeOn
ZegoLowlightEnhancementModeOn=(1)Turn on low-light enhancement to enhance the brightness of the captured image.
ZegoLowlightEnhancementModeAuto
ZegoLowlightEnhancementModeAuto=(2)Automatic low-light enhancement, the brightness enhancement value of the captured picture is dynamically adjusted with the ambient brightness.
ZegoMediaDataPublisherMode
The config of the media data publisher.
Declared in ZegoExpressDefines.h
Properties
ZegoMediaDataPublisherModeBothVideoAndAudio
ZegoMediaDataPublisherModeBothVideoAndAudio=(0)Both publish video and audio.
ZegoMediaDataPublisherModeOnlyVideo
ZegoMediaDataPublisherModeOnlyVideo=(1)Only publish video.
ZegoMediaPlayerAudioChannel
Audio channel.
Declared in ZegoExpressDefines.h
Properties
ZegoMediaPlayerAudioChannelLeft
ZegoMediaPlayerAudioChannelLeft=(0)Audio channel left
ZegoMediaPlayerAudioChannelRight
ZegoMediaPlayerAudioChannelRight=(1)Audio channel right
ZegoMediaPlayerAudioChannelAll
ZegoMediaPlayerAudioChannelAll=(2)Audio channel all
ZegoMediaPlayerAudioTrackMode
Player audio track mode.
Declared in ZegoExpressDefines.h
Properties
ZegoMediaPlayerAudioTrackModeNormal
ZegoMediaPlayerAudioTrackModeNormal=(0)Normal audio track mode
ZegoMediaPlayerAudioTrackModeMultiple
ZegoMediaPlayerAudioTrackModeMultiple=(1)Multiple audio track mode
ZegoMediaPlayerFirstFrameEvent
Media player first frame event type.
Declared in ZegoExpressDefines.h
Properties
ZegoMediaPlayerFirstFrameEventVideoRendered
ZegoMediaPlayerFirstFrameEventVideoRendered=(0)The first video frame is rendered event.
ZegoMediaPlayerFirstFrameEventAudioRendered
ZegoMediaPlayerFirstFrameEventAudioRendered=(1)The first audio frame is rendered event.
ZegoMediaPlayerNetworkEvent
Player network event.
Declared in ZegoExpressDefines.h
Properties
ZegoMediaPlayerNetworkEventBufferBegin
ZegoMediaPlayerNetworkEventBufferBegin=(0)Network resources are not playing well, and start trying to cache data
ZegoMediaPlayerNetworkEventBufferEnded
ZegoMediaPlayerNetworkEventBufferEnded=(1)Network resources can be played smoothly
ZegoMediaPlayerState
Player state.
Declared in ZegoExpressDefines.h
Properties
ZegoMediaPlayerStateNoPlay
ZegoMediaPlayerStateNoPlay=(0)Not playing
ZegoMediaPlayerStatePlaying
ZegoMediaPlayerStatePlaying=(1)Playing
ZegoMediaPlayerStatePausing
ZegoMediaPlayerStatePausing=(2)Pausing
ZegoMediaPlayerStatePlayEnded
ZegoMediaPlayerStatePlayEnded=(3)End of play
ZegoMediaStreamType
Media stream type.
Declared in ZegoExpressDefines.h
Properties
ZegoMediaStreamTypeAudio
ZegoMediaStreamTypeAudio=(0)Media audio stream.
ZegoMediaStreamTypeVideo
ZegoMediaStreamTypeVideo=(1)Media video stream.
ZegoMediaStreamTypeAV
ZegoMediaStreamTypeAV=(2)Media audio and video stream.
ZegoMixImageCheckMode
Mixed stream sets the image parameter check mode.
Declared in ZegoExpressDefines.h
Properties
ZegoMixImageCheckModeNormal
ZegoMixImageCheckModeNormal=(0)Strictly perform image verification, set the background image, watermark will verify the image path, the image occupy set in the mixed flow input parameter will also verify whether the set image resource request is successful, in order to normally initiate mixed flow, otherwise fail to initiate mixed flow.
ZegoMixImageCheckModePath
ZegoMixImageCheckModePath=(1)Only verify image path URI/URL As long as the path is correct, the mixed flow is successfully initiated.
ZegoMixImageCheckModeNothing
ZegoMixImageCheckModeNothing=(2)The mixed flow can be initiated successfully without checking the related parameters of the picture.
ZegoMixRenderMode
Mixing stream video view render mode.
Declared in ZegoExpressDefines.h
Properties
ZegoMixRenderModeFill
ZegoMixRenderModeFill=(0)The proportional zoom fills the entire area and may be partially cut.
ZegoMixRenderModeFit
ZegoMixRenderModeFit=(1)Scale the filled area proportionally. If the scale does not match the set size after scaling, the extra part will be displayed as transparent.
ZegoMixerInputContentType
Mix stream content type.
Declared in ZegoExpressDefines.h
Properties
ZegoMixerInputContentTypeAudio
ZegoMixerInputContentTypeAudio=(0)Mix stream for audio only
ZegoMixerInputContentTypeVideo
ZegoMixerInputContentTypeVideo=(1)Mix stream for both audio and video
ZegoMixerInputContentTypeVideoOnly
ZegoMixerInputContentTypeVideoOnly=(2)Mix stream for video only. On web platforms, this property does not take effect
ZegoMultimediaLoadType
Multimedia load type.
Declared in ZegoExpressDefines.h
Properties
ZegoMultimediaLoadTypeFilePath
ZegoMultimediaLoadTypeFilePath=(0)Load by file path.
ZegoMultimediaLoadTypeMemory
ZegoMultimediaLoadTypeMemory=(1)Load by memory.
ZegoMultimediaLoadTypeResourceID
ZegoMultimediaLoadTypeResourceID=(2)Load by copyrighted music resource ID.
ZegoNetworkMode
Network mode
Declared in ZegoExpressDefines.h
Properties
ZegoNetworkModeOffline
ZegoNetworkModeOffline=(0)Offline (No network)
ZegoNetworkModeUnknown
ZegoNetworkModeUnknown=(1)Unknown network mode
ZegoNetworkModeEthernet
ZegoNetworkModeEthernet=(2)Wired Ethernet (LAN)
ZegoNetworkModeWiFi
ZegoNetworkModeWiFi=(3)Wi-Fi (WLAN)
ZegoNetworkMode2G
ZegoNetworkMode2G=(4)2G Network (GPRS/EDGE/CDMA1x/etc.)
ZegoNetworkMode3G
ZegoNetworkMode3G=(5)3G Network (WCDMA/HSDPA/EVDO/etc.)
ZegoNetworkMode4G
ZegoNetworkMode4G=(6)4G Network (LTE)
ZegoNetworkMode5G
ZegoNetworkMode5G=(7)5G Network (NR (NSA/SA))
ZegoNetworkSpeedTestType
network speed test type
Declared in ZegoExpressDefines.h
Properties
ZegoNetworkSpeedTestTypeUplink
ZegoNetworkSpeedTestTypeUplink=(0)uplink
ZegoNetworkSpeedTestTypeDownlink
ZegoNetworkSpeedTestTypeDownlink=(1)downlink
ZegoObjectSegmentationState
Object segmentation state.
Declared in ZegoExpressDefines.h
Properties
ZegoObjectSegmentationStateOff
ZegoObjectSegmentationStateOff=(0)Object segmentation turned off.
ZegoObjectSegmentationStateOn
ZegoObjectSegmentationStateOn=(1)Object segmentation turned on.
ZegoObjectSegmentationType
Object segmentation type.
Declared in ZegoExpressDefines.h
Properties
ZegoObjectSegmentationTypeAnyBackground
ZegoObjectSegmentationTypeAnyBackground=(0)Any background object segmentation.
ZegoObjectSegmentationTypeGreenScreenBackground
ZegoObjectSegmentationTypeGreenScreenBackground=(1)Green screen background object segmentation.
ZegoOrientation
Video screen rotation direction.
Declared in ZegoExpressDefines.h
Properties
ZegoOrientation_0
ZegoOrientation_0=(0)Not rotate
ZegoOrientation_90
ZegoOrientation_90=(1)Rotate 90 degrees counterclockwise
ZegoOrientation_180
ZegoOrientation_180=(2)Rotate 180 degrees counterclockwise
ZegoOrientation_270
ZegoOrientation_270=(3)Rotate 270 degrees counterclockwise
ZegoOrientationMode
Orientation mode of the video.
Declared in ZegoExpressDefines.h
Properties
ZegoOrientationModeCustom
ZegoOrientationModeCustom=(0)Custom mode. The default is the custom mode. In this mode, the user needs to set the orientation through [SetAppOrientation], and set the video resolution through [SetVideoConfig] to control the video ratio. The SDK rotates the video at the stream publishing end.
ZegoOrientationModeAdaption
ZegoOrientationModeAdaption=(1)Player self adaption mode. The video orientation of the stream playing end is automatically vertically upward, and the user of the stream publishing end no longer needs to set the orientation through [SetAppOrientation], and no longer need to set the video resolution to control the video ratio through [SetVideoConfig].
- Caution: 1. Both the stream publishing end and the stream playing end need to be set to [ZegoOrientationModeAdaption] mode. 2. Media players, cloud recording, local recording, and publish or play streaming scenarios via CDN are not supported. 3. In this mode, the SDK will automatically swap the width and height of the encoding resolution according to the actual orientation of the device.
ZegoOrientationModeAlignment
ZegoOrientationModeAlignment=(2)Player adapt to pulisher mode. Taking the Status Bar as a reference, the video direction of the stream playing end is the same as the preview video direction of the stream publishing end. The SDK will use the Status Bar as a reference to rotate the image on the stream playing end, and the rotation angle is the same as the rotation angle of the preview on the stream publishing end. Stream publishing end users no longer need to set the orientation through [SetAppOrientation], and no longer need to set the video resolution to control the video ratio through [SetVideoConfig].
- Caution: 1. Media players, cloud recording, local recording, and publish or play streaming scenarios via CDN are not supported.2. In this mode, the SDK will automatically swap the width and height of the encoding resolution according to the actual position of the Status Bar.
ZegoOrientationModeFixedResolutionRatio
ZegoOrientationModeFixedResolutionRatio=(3)Fixed resolution ratio mode. Taking the Status Bar as a reference, the video orientation of the stream playing end is the same as the previewed video direction of the stream publishing end, and the video resolution is the same as the encoding resolution. Users of the streaming end no longer need to set the orientation through [SetAppOrientation].
ZegoPlayerMediaEvent
Media event when playing.
Declared in ZegoExpressDefines.h
Properties
ZegoPlayerMediaEventAudioBreakOccur
ZegoPlayerMediaEventAudioBreakOccur=(0)Audio stuck event when playing
ZegoPlayerMediaEventAudioBreakResume
ZegoPlayerMediaEventAudioBreakResume=(1)Audio stuck event recovery when playing
ZegoPlayerMediaEventVideoBreakOccur
ZegoPlayerMediaEventVideoBreakOccur=(2)Video stuck event when playing
ZegoPlayerMediaEventVideoBreakResume
ZegoPlayerMediaEventVideoBreakResume=(3)Video stuck event recovery when playing
ZegoPlayerState
Playing stream status.
Declared in ZegoExpressDefines.h
Properties
ZegoPlayerStateNoPlay
ZegoPlayerStateNoPlay=(0)The state of the flow is not played, and it is in this state before the stream is played. If the steady flow anomaly occurs during the playing process, such as AppID or Token are incorrect, it will enter this state.
ZegoPlayerStatePlayRequesting
ZegoPlayerStatePlayRequesting=(1)The state that the stream is being requested for playing. After the [startPlayingStream] function is successfully called, it will enter the state. The UI is usually displayed through this state. If the connection is interrupted due to poor network quality, the SDK will perform an internal retry and will return to the requesting state.
ZegoPlayerStatePlaying
ZegoPlayerStatePlaying=(2)The state that the stream is being playing, entering the state indicates that the stream has been successfully played, and the user can communicate normally.
ZegoProcessedDataUsageType
Usage of Custom video processed data.
Declared in ZegoExpressDefines.h
Properties
ZegoProcessedDataUsageTypePreview
ZegoProcessedDataUsageTypePreview=(0)Preview.
ZegoProcessedDataUsageTypePublish
ZegoProcessedDataUsageTypePublish=(1)Publish.
ZegoProcessedDataUsageTypeBoth
ZegoProcessedDataUsageTypeBoth=(2)Both preview and publish.
ZegoPublishChannel
Publish channel.
Declared in ZegoExpressDefines.h
Properties
ZegoPublishChannelMain
ZegoPublishChannelMain=(0)The main (default/first) publish channel.
ZegoPublishChannelAux
ZegoPublishChannelAux=(1)The auxiliary (second) publish channel
ZegoPublishChannelThird
ZegoPublishChannelThird=(2)The third publish channel
ZegoPublishChannelFourth
ZegoPublishChannelFourth=(3)The fourth publish channel
ZegoPublisherState
Publish stream status.
Declared in ZegoExpressDefines.h
Properties
ZegoPublisherStateNoPublish
ZegoPublisherStateNoPublish=(0)The state is not published, and it is in this state before publishing the stream. If a steady-state exception occurs in the publish process, such as AppID or Token are incorrect, or if other users are already publishing the stream, there will be a failure and enter this state.
ZegoPublisherStatePublishRequesting
ZegoPublisherStatePublishRequesting=(1)The state that it is requesting to publish the stream after the [startPublishingStream] function is successfully called. The UI is usually displayed through this state. If the connection is interrupted due to poor network quality, the SDK will perform an internal retry and will return to the requesting state.
ZegoPublisherStatePublishing
ZegoPublisherStatePublishing=(2)The state that the stream is being published, entering the state indicates that the stream has been successfully published, and the user can communicate normally.
ZegoPublisherTakeSnapshotPosition
The position of taking snapshot.
Declared in ZegoExpressDefines.h
Properties
ZegoPublisherTakeSnapshotPositionAfterProcess
ZegoPublisherTakeSnapshotPositionAfterProcess=(0)After video process.
ZegoPublisherTakeSnapshotPositionOnCapture
ZegoPublisherTakeSnapshotPositionOnCapture=(1)On capture.
ZegoPublisherTakeSnapshotPositionOnPreview
ZegoPublisherTakeSnapshotPositionOnPreview=(2)On preview. Only support harmonyos
ZegoRangeAudioListenMode
Range audio listening mode
Declared in ZegoExpressDefines.h
Properties
ZegoRangeAudioListenModeAll
ZegoRangeAudioListenModeAll=(0)All mode, can hear everyone in the room.
ZegoRangeAudioListenModeWorld
ZegoRangeAudioListenModeWorld=(1)Only world mode, only listen to people within range.
ZegoRangeAudioListenModeTeam
ZegoRangeAudioListenModeTeam=(2)Only team mode, only listen to the voices of members of the team you belong to (not restricted by range).
ZegoRangeAudioMicrophoneState
Range audio microphone state.
Declared in ZegoExpressDefines.h
Properties
ZegoRangeAudioMicrophoneStateOff
ZegoRangeAudioMicrophoneStateOff=(0)The range audio microphone is off.
ZegoRangeAudioMicrophoneStateTurningOn
ZegoRangeAudioMicrophoneStateTurningOn=(1)The range audio microphone is turning on.
ZegoRangeAudioMicrophoneStateOn
ZegoRangeAudioMicrophoneStateOn=(2)The range audio microphone is on.
ZegoRangeAudioMode
Range audio mode
Declared in ZegoExpressDefines.h
Properties
ZegoRangeAudioModeWorld
ZegoRangeAudioModeWorld=(0)World mode, you can communicate with everyone in the room.
ZegoRangeAudioModeTeam
ZegoRangeAudioModeTeam=(1)Team mode, only communicate with members of the team.
ZegoRangeAudioModeSecretTeam
ZegoRangeAudioModeSecretTeam=(2)Secret team mode, communicate with members of the team (with team members), can hear the voices of members who within the audio receive range (except the team members).
ZegoRangeAudioSpeakMode
Range audio speak mode
Declared in ZegoExpressDefines.h
Properties
ZegoRangeAudioSpeakModeAll
ZegoRangeAudioSpeakModeAll=(0)All mode, his voice can be heard by members of the team and by those within range.
ZegoRangeAudioSpeakModeWorld
ZegoRangeAudioSpeakModeWorld=(1)Only world mode, only those within range can hear his voice.
ZegoRangeAudioSpeakModeTeam
ZegoRangeAudioSpeakModeTeam=(2)Only team mode, only members of the team can hear his voice (not restricted by range).
ZegoRemoteDeviceState
Remote device status.
Declared in ZegoExpressDefines.h
Properties
ZegoRemoteDeviceStateOpen
ZegoRemoteDeviceStateOpen=(0)Device on
ZegoRemoteDeviceStateGenericError
ZegoRemoteDeviceStateGenericError=(1)General device error
ZegoRemoteDeviceStateInvalidID
ZegoRemoteDeviceStateInvalidID=(2)Invalid device ID
ZegoRemoteDeviceStateNoAuthorization
ZegoRemoteDeviceStateNoAuthorization=(3)No permission
ZegoRemoteDeviceStateZeroFPS
ZegoRemoteDeviceStateZeroFPS=(4)Captured frame rate is 0
ZegoRemoteDeviceStateInUseByOther
ZegoRemoteDeviceStateInUseByOther=(5)The device is occupied
ZegoRemoteDeviceStateUnplugged
ZegoRemoteDeviceStateUnplugged=(6)The device is not plugged in or unplugged
ZegoRemoteDeviceStateRebootRequired
ZegoRemoteDeviceStateRebootRequired=(7)The system needs to be restarted
ZegoRemoteDeviceStateSystemMediaServicesLost
ZegoRemoteDeviceStateSystemMediaServicesLost=(8)System media services stop, such as under the iOS platform, when the system detects that the current pressure is huge (such as playing a lot of animation), it is possible to disable all media related services.
ZegoRemoteDeviceStateDisable
ZegoRemoteDeviceStateDisable=(9)The remote user calls [enableCamera] or [enableAudioCaptureDevice] to disable the camera or microphone.
ZegoRemoteDeviceStateMute
ZegoRemoteDeviceStateMute=(10)The remote user actively calls [muteMicrophone] or [mutePublishStreamAudio] or [mutePublishStreamVideo] to stop publish the audio or video stream.
ZegoRemoteDeviceStateInterruption
ZegoRemoteDeviceStateInterruption=(11)The device is interrupted, such as a phone call interruption, etc.
ZegoRemoteDeviceStateInBackground
ZegoRemoteDeviceStateInBackground=(12)There are multiple apps at the same time in the foreground, such as the iPad app split screen, the system will prohibit all apps from using the camera.
ZegoRemoteDeviceStateMultiForegroundApp
ZegoRemoteDeviceStateMultiForegroundApp=(13)CDN server actively disconnected
ZegoRemoteDeviceStateBySystemPressure
ZegoRemoteDeviceStateBySystemPressure=(14)The system is under high load pressure and may cause abnormal equipment.
ZegoRemoteDeviceStateNotSupport
ZegoRemoteDeviceStateNotSupport=(15)The remote device is not supported to publish the device state.
ZegoResourceType
Resource Type.
Declared in ZegoExpressDefines.h
Properties
ZegoResourceTypeCDN
ZegoResourceTypeCDN=(0)CDN
ZegoResourceTypeRTC
ZegoResourceTypeRTC=(1)RTC
ZegoResourceTypeL3
ZegoResourceTypeL3=(2)L3
ZegoReverbPreset
Reverberation preset value.
Declared in ZegoExpressDefines.h
Properties
ZegoReverbPresetNone
ZegoReverbPresetNone=(0)No Reverberation
ZegoReverbPresetSoftRoom
ZegoReverbPresetSoftRoom=(1)Soft room reverb effect
ZegoReverbPresetLargeRoom
ZegoReverbPresetLargeRoom=(2)Large room reverb effect
ZegoReverbPresetConcertHall
ZegoReverbPresetConcertHall=(3)Concert hall reverb effect
ZegoReverbPresetValley
ZegoReverbPresetValley=(4)Valley reverb effect
ZegoReverbPresetRecordingStudio
ZegoReverbPresetRecordingStudio=(5)Recording studio reverb effect
ZegoReverbPresetBasement
ZegoReverbPresetBasement=(6)Basement reverb effect
ZegoReverbPresetKTV
ZegoReverbPresetKTV=(7)KTV reverb effect
ZegoReverbPresetPopular
ZegoReverbPresetPopular=(8)Popular reverb effect
ZegoReverbPresetRock
ZegoReverbPresetRock=(9)Rock reverb effect
ZegoReverbPresetVocalConcert
ZegoReverbPresetVocalConcert=(10)Vocal concert reverb effect
ZegoReverbPresetGramoPhone
ZegoReverbPresetGramoPhone=(11)Gramophone reverb effect
ZegoReverbPresetEnhancedKTV
ZegoReverbPresetEnhancedKTV=(12)Enhanced KTV reverb effect. Provide KTV effect with more concentrated voice and better brightness. Compared with the original KTV reverb effect, the reverberation time is shortened and the dry-wet ratio is increased.
ZegoReverbPresetEnhancedRock
ZegoReverbPresetEnhancedRock=(13)Enhanced Rock reverb effect
ZegoReverbPresetEnhancedMisty
ZegoReverbPresetEnhancedMisty=(14)Enhanced misty reverb effect
ZegoReverbPresetHipHop
ZegoReverbPresetHipHop=(15)Hip Hop reverb effect
ZegoReverbPresetMisty
ZegoReverbPresetMisty=(16)Misty reverb effect
ZegoReverbPresetThreeDimensionalVoice
ZegoReverbPresetThreeDimensionalVoice=(17)3D voice reverb effect
ZegoReverbPresetTheatre
ZegoReverbPresetTheatre=(18)Theatre reverb effect
ZegoReverbPresetCustomRecordStudio
ZegoReverbPresetCustomRecordStudio=(19)Recording studio reverb effect (Only vivo)
ZegoRoomCapabilityNegotiationTypesBitMask
Capability negotiation enable bitmask enumeration.
Declared in ZegoExpressDefines.h
Properties
ZegoRoomCapabilityNegotiationTypesBitMaskAll
ZegoRoomCapabilityNegotiationTypesBitMaskAll=(0)The mask bit of this field corresponds to enable the capability negotiation of all user in the room.
ZegoRoomCapabilityNegotiationTypesPublisher
ZegoRoomCapabilityNegotiationTypesPublisher=(1)The mask bit of this field corresponds to enable the capability negotiation of publisher in the room.
ZegoRoomMode
Room mode.
Declared in ZegoExpressDefines.h
Properties
ZegoRoomModeSingleRoom
ZegoRoomModeSingleRoom=(0)Single room mode.
ZegoRoomModeMultiRoom
ZegoRoomModeMultiRoom=(1)Multiple room mode.
ZegoRoomState
Room state.
Declared in ZegoExpressDefines.h
Properties
ZegoRoomStateDisconnected
ZegoRoomStateDisconnected=(0)Unconnected state, enter this state before logging in and after exiting the room. If there is a steady state abnormality in the process of logging in to the room, such as AppID or Token are incorrect, or if the same user name is logged in elsewhere and the local end is KickOut, it will enter this state.
ZegoRoomStateConnecting
ZegoRoomStateConnecting=(1)The state that the connection is being requested. It will enter this state after successful execution login room function. The display of the UI is usually performed using this state. If the connection is interrupted due to poor network quality, the SDK will perform an internal retry and will return to the requesting connection status.
ZegoRoomStateConnected
ZegoRoomStateConnected=(2)The status that is successfully connected. Entering this status indicates that the login to the room has been successful. The user can receive the callback notification of the user and the stream information in the room.
ZegoRoomStateChangedReason
Room state change reason.
Declared in ZegoExpressDefines.h
Properties
ZegoRoomStateChangedReasonLogining
ZegoRoomStateChangedReasonLogining=(0)Logging in to the room. When calling [loginRoom] to log in to the room or [switchRoom] to switch to the target room, it will enter this state, indicating that it is requesting to connect to the server. The application interface is usually displayed through this state.
ZegoRoomStateChangedReasonLogined
ZegoRoomStateChangedReasonLogined=(1)Log in to the room successfully. When the room is successfully logged in or switched, it will enter this state, indicating that the login to the room has been successful, and users can normally receive callback notifications of other users in the room and all stream information additions and deletions.
ZegoRoomStateChangedReasonLoginFailed
ZegoRoomStateChangedReasonLoginFailed=(2)Failed to log in to the room. When the login or switch room fails, it will enter this state, indicating that the login or switch room has failed, for example, AppID or Token is incorrect, etc.
ZegoRoomStateChangedReasonReconnecting
ZegoRoomStateChangedReasonReconnecting=(3)The room connection is temporarily interrupted. If the interruption occurs due to poor network quality, the SDK will retry internally.
ZegoRoomStateChangedReasonReconnected
ZegoRoomStateChangedReasonReconnected=(4)The room is successfully reconnected. If there is an interruption due to poor network quality, the SDK will retry internally, and enter this state after successful reconnection.
ZegoRoomStateChangedReasonReconnectFailed
ZegoRoomStateChangedReasonReconnectFailed=(5)The room fails to reconnect. If there is an interruption due to poor network quality, the SDK will retry internally, and enter this state after the reconnection fails.
ZegoRoomStateChangedReasonKickOut
ZegoRoomStateChangedReasonKickOut=(6)Kicked out of the room by the server. For example, if you log in to the room with the same user name in other places, and the local end is kicked out of the room, it will enter this state.
ZegoRoomStateChangedReasonLogout
ZegoRoomStateChangedReasonLogout=(7)Logout of the room is successful. It is in this state by default before logging into the room. When calling [logoutRoom] to log out of the room successfully or [switchRoom] to log out of the current room successfully, it will enter this state.
ZegoRoomStateChangedReasonLogoutFailed
ZegoRoomStateChangedReasonLogoutFailed=(8)Failed to log out of the room. Enter this state when calling [logoutRoom] fails to log out of the room or [switchRoom] fails to log out of the current room internally.
ZegoRoomStreamListType
Get room stream list type.
Declared in ZegoExpressDefines.h
Properties
ZegoRoomStreamListTypePlay
ZegoRoomStreamListTypePlay=(0)List of all online streams in the current room, excluding your own streams
ZegoRoomStreamListTypeAll
ZegoRoomStreamListTypeAll=(1)List of all online streams in the current room, including your own streams
ZegoRoomTransparentMessageMode
Room mode.
Declared in ZegoExpressDefines.h
Properties
ZegoRoomTransparentMessageModeOnlyClient
ZegoRoomTransparentMessageModeOnlyClient=(0)Single room mode.
ZegoRoomTransparentMessageModeOnlyServer
ZegoRoomTransparentMessageModeOnlyServer=(1)Multiple room mode.
ZegoRoomTransparentMessageModeClientAndServer
ZegoRoomTransparentMessageModeClientAndServer=(2)Multiple room mode.
ZegoRoomTransparentMessageType
Room mode.
Declared in ZegoExpressDefines.h
Properties
ZegoRoomTransparentMessageNormal
ZegoRoomTransparentMessageNormal=(0)Single room mode.
ZegoRoomTransparentMessageSequence
ZegoRoomTransparentMessageSequence=(1)Multiple room mode.
ZegoSEIType
SEI type
Declared in ZegoExpressDefines.h
Properties
ZegoSEITypeZegoDefined
ZegoSEITypeZegoDefined=(0)Using H.264 SEI (nalu type = 6, payload type = 243) type packaging, this type is not specified by the SEI standard, there is no conflict with the video encoder or the SEI in the video file, users do not need to follow the SEI content Do filtering, SDK uses this type by default.
ZegoSEITypeUserUnregister
ZegoSEITypeUserUnregister=(1)SEI (nalu type = 6, payload type = 5) of H.264 is used for packaging. The H.264 standard has a prescribed format for this type: startcode + nalu type (6) + payload type (5) + len + payload (uuid + content) + trailing bits. Because the video encoder itself generates an SEI with a payload type of 5, or when a video file is used for streaming, such SEI may also exist in the video file, so when using this type, the user needs to use uuid + context as a buffer sending SEI. At this time, in order to distinguish the SEI generated by the video encoder itself, when the App sends this type of SEI, it can fill in the service-specific uuid (uuid length is 16 bytes). When the receiver uses the SDK to parse the SEI of the payload type 5, it will set filter string filters out the SEI matching the uuid and throws it to the business. If the filter string is not set, the SDK will throw all received SEI to the developer. uuid filter string setting function, [ZegoEngineConfig.advancedConfig("unregister_sei_filter","XXXXXX")], where unregister_sei_filter is the key, and XXXXX is the uuid filter string to be set.
ZegoScenario
Room scenario.
- Available since: 1.1.0 To ensure that the selected room scene mode meets the developer's business scene experience requirements, it is recommended to carefully read the /real-time-video-ios-oc/quick-start/scenario-based-audio-video-configuration document to understand the scene setting method, the differences between different scenes, and how to choose the right scene.
Declared in ZegoExpressDefines.h
Properties
ZegoScenarioGeneral
ZegoScenarioGeneral=(0)[Deprecated] Legacy general scenario, this scenario has been deprecated since version 3.0.0, and it is not recommended to use, please migrate to other new scenario as soon as possible.
ZegoScenarioCommunication
ZegoScenarioCommunication=(1)[Deprecated] Legacy communication scenario, this scenario has been deprecated since version 3.0.0, and it is not recommended to use, please migrate to other new scenario as soon as possible.
ZegoScenarioLive
ZegoScenarioLive=(2)[Deprecated] Legacy live broadcast scenario, this scenario has been deprecated since version 3.0.0, and it is not recommended to use, please migrate to other new scenario as soon as possible.
ZegoScenarioDefault
ZegoScenarioDefault=(3)The default (generic) scenario. If none of the following scenarios conform to your actual application scenario, this default scenario can be used.
- Available since: 3.0.0.
ZegoScenarioStandardVideoCall
ZegoScenarioStandardVideoCall=(4)Standard video call scenario, it is suitable for one-to-one video call scenarios.
- Available since: 3.0.0.
ZegoScenarioHighQualityVideoCall
ZegoScenarioHighQualityVideoCall=(5)High quality video call scenario, it is similar to the standard video call scenario, but this scenario uses a higher video frame rate, bit rate, and resolution (540p) by default, which is suitable for video call scenario with high image quality requirements.
- Available since: 3.0.0.
ZegoScenarioStandardChatroom
ZegoScenarioStandardChatroom=(6)Standard chatroom scenario, suitable for multi-person pure voice calls (low data usage). On the ExpressVideo SDK, the camera is not enabled by default in this scenario.
- Available since: 3.0.0.
ZegoScenarioHighQualityChatroom
ZegoScenarioHighQualityChatroom=(7)High quality chatroom scenario, it is similar to the standard chatroom scenario, but this scenario uses a higher audio bit rate than the standard chatroom scenario by default. It is suitable for multi-person pure voice call scenarios with high requirements on sound quality. On the ExpressVideo SDK, the camera is not enabled by default in this scenario.
- Available since: 3.0.0.
ZegoScenarioBroadcast
ZegoScenarioBroadcast=(8)Live broadcast scenario, it is suitable for one-to-many live broadcast scenarios such as shows, games, e-commerce, and large educational classes. The audio and video quality, fluency, and compatibility have been optimized. Even in live broadcast scenarios, the SDK has no business "roles" (such as anchors and viewers), and all users in the room can publish and play streams.
- Available since: 3.0.0.
ZegoScenarioKaraoke
ZegoScenarioKaraoke=(9)Karaoke (KTV) scenario, it is suitable for real-time chorus and online karaoke scenarios, and has optimized delay, sound quality, ear return, echo cancellation, etc., and also ensures accurate alignment and ultra-low delay when multiple people chorus.
- Available since: 3.0.0.
ZegoScenarioStandardVoiceCall
ZegoScenarioStandardVoiceCall=(10)Standard voice call scenario, it is suitable for one-to-one video or voice call scenarios. On the ExpressVideo SDK, the camera is not enabled by default in this scenario.
- Available since: 3.3.0.
ZegoSceneState
Range scene state change reason.
Declared in ZegoExpressDefines.h
Properties
ZegoSceneStateLogining
ZegoSceneStateLogining=(0)Logging in to the scene. When calling [loginScene] to log in to the scene, it will enter this state, indicating that it is requesting to connect to the server. The application interface is usually displayed through this state.
ZegoSceneStateLogined
ZegoSceneStateLogined=(1)Log in to the scene successfully. When the scene is successfully logged in, it will enter this state, indicating that the login to the scene has been successful, and users can normally use the range scene capabilities.
ZegoSceneStateLoginFailed
ZegoSceneStateLoginFailed=(2)Failed to log in to the scene. When the login fails, it will enter this state, indicating that the login scene has failed, for example, AppID or Token is incorrect, etc.
ZegoSceneStateReconnecting
ZegoSceneStateReconnecting=(3)The scene connection is temporarily interrupted. If the interruption occurs due to poor network quality, the SDK will retry internally.
ZegoSceneStateReconnected
ZegoSceneStateReconnected=(4)The scene is successfully reconnected. If there is an interruption due to poor network quality, the SDK will retry internally, and enter this state after successful reconnection.
ZegoSceneStateReconnectFailed
ZegoSceneStateReconnectFailed=(5)The scene fails to reconnect. If there is an interruption due to poor network quality, the SDK will retry internally, and enter this state after the reconnection fails.
ZegoSceneStateKickOut
ZegoSceneStateKickOut=(6)Kicked out of the scene by the server. For example, if you log in to the scene with the same user name in other places, and the local end is kicked out of the scene, it will enter this state.
ZegoSceneStateLogout
ZegoSceneStateLogout=(7)Logout of the scene is successful. It is in this state by default before logging into the scene. When calling [logoutScene] to log out of the scene successfully, it will enter this state.
ZegoScreenCaptureExceptionType
Screen capture source exception type. (only for Android and iOS)
Declared in ZegoExpressDefines.h
Properties
ZegoScreenCaptureExceptionTypeUnknown
ZegoScreenCaptureExceptionTypeUnknown=(0)Unknown exception type.
ZegoScreenCaptureExceptionTypeVideoNotSupported
ZegoScreenCaptureExceptionTypeVideoNotSupported=(1)The video capture system version does not support it, and Android only supports 5.0 and above.
ZegoScreenCaptureExceptionTypeAudioNotSupported
ZegoScreenCaptureExceptionTypeAudioNotSupported=(2)The capture target fails, such as the monitor is unplugged and the window is closed.
ZegoScreenCaptureExceptionTypeAudioCreateFailed
ZegoScreenCaptureExceptionTypeAudioCreateFailed=(3)Audio recording object creation failed. Possible reasons: 1. The audio recording permission is not enabled; 2. The allocated memory for audio recording is insufficient; 3. The creation of AudioRecord fails.
ZegoScreenCaptureExceptionTypeMediaProjectionPermissionDenied
ZegoScreenCaptureExceptionTypeMediaProjectionPermissionDenied=(4)MediaProjection request for dynamic permissions was denied.
ZegoScreenCaptureExceptionTypeNotStartCapture
ZegoScreenCaptureExceptionTypeNotStartCapture=(5)Capture is not started. Need to start capturing with [startScreenCapture] first.
ZegoScreenCaptureExceptionTypeAlreadyStarted
ZegoScreenCaptureExceptionTypeAlreadyStarted=(6)Screen capture has already started, repeated calls failed. You need to stop the capture with [stopScreenCapture] first.
ZegoScreenCaptureExceptionTypeForegroundServiceFailed
ZegoScreenCaptureExceptionTypeForegroundServiceFailed=(7)Failed to start the foreground service.
ZegoScreenCaptureExceptionTypeSourceNotSpecified
ZegoScreenCaptureExceptionTypeSourceNotSpecified=(8)Before starting screen capture, you need to call [setVideoSource], [setAudioSource] to specify the video and audio source ScreenCapture.
ZegoScreenCaptureExceptionTypeSystemError
ZegoScreenCaptureExceptionTypeSystemError=(9)System error exception. For example, low memory, etc.
ZegoScreenCaptureExceptionTypeExceptionInterrupted
ZegoScreenCaptureExceptionTypeExceptionInterrupted=(10)Exception interrupted. For example, the user clicks the stop button in the control center during the capture process.
ZegoScreenCaptureExceptionTypeAudioDeviceException
ZegoScreenCaptureExceptionTypeAudioDeviceException=(11)Audio device exception. You need to restart the capture.
ZegoScreenCaptureOrientation
Screen capture orientation.
Declared in ZegoExpressDefines.h
Properties
ZegoScreenCaptureOrientationAuto
ZegoScreenCaptureOrientationAuto=(0)Auto follow system orientation.
ZegoScreenCaptureOrientationPortrait
ZegoScreenCaptureOrientationPortrait=(1)Fixed portrait.
ZegoScreenCaptureOrientationLandscape
ZegoScreenCaptureOrientationLandscape=(2)Fixed landscape.
ZegoScreenCaptureSourceExceptionType
Screen capture source exception type.
Declared in ZegoExpressDefines.h
Properties
ZegoScreenCaptureSourceExceptionTypeUnknown
ZegoScreenCaptureSourceExceptionTypeUnknown=(0)Unknown exception type.
ZegoScreenCaptureSourceExceptionTypeInvalid
ZegoScreenCaptureSourceExceptionTypeInvalid=(1)The capture target fails, such as the monitor is unplugged and the window is closed.
ZegoScreenCaptureSourceExceptionTypeFailed
ZegoScreenCaptureSourceExceptionTypeFailed=(2)Failed to collect target, internal reasons of the system.
ZegoScreenCaptureSourceExceptionTypePublishRegionInvalid
ZegoScreenCaptureSourceExceptionTypePublishRegionInvalid=(3)The set publish region is invalid, and the publish region is not within the capture screen region.
ZegoScreenCaptureSourceType
Type of capture target.
Declared in ZegoExpressDefines.h
Properties
ZegoScreenCaptureSourceTypeUnknow
ZegoScreenCaptureSourceTypeUnknow=(0)Unknow.
ZegoScreenCaptureSourceTypeWindow
ZegoScreenCaptureSourceTypeWindow=(1)The capture target is a certain window.
ZegoScreenCaptureSourceTypeScreen
ZegoScreenCaptureSourceTypeScreen=(2)The capture target is the screen of a certain monitor.
ZegoScreenCaptureWindowState
The state of the screen capture source window changes.
Declared in ZegoExpressDefines.h
Properties
ZegoScreenCaptureWindowStateOnScreen
ZegoScreenCaptureWindowStateOnScreen=(0)The window is on the current screen, and the coordinate area changes.
ZegoScreenCaptureWindowStateOffScreen
ZegoScreenCaptureWindowStateOffScreen=(1)The window leaves the current screen and pauses the capture.
ZegoScreenCaptureWindowStateDestroy
ZegoScreenCaptureWindowStateDestroy=(2)The window is destroy.
ZegoStreamAlignmentMode
Stream alignment mode.
Declared in ZegoExpressDefines.h
Properties
ZegoStreamAlignmentModeNone
ZegoStreamAlignmentModeNone=(0)Disable stream alignment.
ZegoStreamAlignmentModeTry
ZegoStreamAlignmentModeTry=(1)Streams should be aligned as much as possible, call the [setStreamAlignmentProperty] function to enable the stream alignment of the push stream network time alignment of the specified channel.
ZegoStreamAlignmentVolumeControlMode
Stream alignment volume control mode.
Declared in ZegoExpressDefines.h
Properties
ZegoStreamAlignmentVolumeControlModeClose
ZegoStreamAlignmentVolumeControlModeClose=(0)Disable volume control when stream alignment.
ZegoStreamAlignmentVolumeControlModeOpen
ZegoStreamAlignmentVolumeControlModeOpen=(1)Enable volume control when stream alignment.
ZegoStreamCensorshipMode
Publish CensorshipMode.
Declared in ZegoExpressDefines.h
Properties
ZegoStreamCensorshipModeNone
ZegoStreamCensorshipModeNone=(0)no censorship.
ZegoStreamCensorshipModeAudio
ZegoStreamCensorshipModeAudio=(1)only censorship stream audio.
ZegoStreamCensorshipModeVideo
ZegoStreamCensorshipModeVideo=(2)only censorship stream video.
ZegoStreamCensorshipModeAudioAndVideo
ZegoStreamCensorshipModeAudioAndVideo=(3)censorship stream audio and video.
ZegoStreamDecodeMode
Stream decode Mode
Declared in ZegoExpressDefines.h
Properties
ZegoStreamDecodeModeAllFrame
ZegoStreamDecodeModeAllFrame=(0)Decode all frame.
ZegoStreamDecodeModeOnlyIFrame
ZegoStreamDecodeModeOnlyIFrame=(1)Only Decode I Frame.
ZegoStreamDecodeModeNoneFrame
ZegoStreamDecodeModeNoneFrame=(2)none decode frame.
ZegoStreamEvent
Publish or play stream event
Declared in ZegoExpressDefines.h
Properties
ZegoStreamEventPublishStart
ZegoStreamEventPublishStart=(100)Start publishing stream
ZegoStreamEventPublishSuccess
ZegoStreamEventPublishSuccess=(101)The first publish stream was successful
ZegoStreamEventPublishFail
ZegoStreamEventPublishFail=(102)Failed to publish stream for the first time
ZegoStreamEventRetryPublishStart
ZegoStreamEventRetryPublishStart=(103)Start retrying publishing stream
ZegoStreamEventRetryPublishSuccess
ZegoStreamEventRetryPublishSuccess=(104)Retry publishing stream successfully
ZegoStreamEventRetryPublishFail
ZegoStreamEventRetryPublishFail=(105)Failed to retry publishing stream
ZegoStreamEventPublishEnd
ZegoStreamEventPublishEnd=(106)End of publishing stream
ZegoStreamEventPlayStart
ZegoStreamEventPlayStart=(200)Start playing stream
ZegoStreamEventPlaySuccess
ZegoStreamEventPlaySuccess=(201)The first play stream was successful
ZegoStreamEventPlayFail
ZegoStreamEventPlayFail=(202)Failed to play stream for the first time
ZegoStreamEventRetryPlayStart
ZegoStreamEventRetryPlayStart=(203)Start retrying playing stream
ZegoStreamEventRetryPlaySuccess
ZegoStreamEventRetryPlaySuccess=(204)Retry playing stream successfully
ZegoStreamEventRetryPlayFail
ZegoStreamEventRetryPlayFail=(205)Failed to retry playing stream
ZegoStreamEventPlayEnd
ZegoStreamEventPlayEnd=(206)End of playing stream
ZegoStreamQualityLevel
Stream quality level.
Declared in ZegoExpressDefines.h
Properties
ZegoStreamQualityLevelExcellent
ZegoStreamQualityLevelExcellent=(0)Excellent
ZegoStreamQualityLevelGood
ZegoStreamQualityLevelGood=(1)Good
ZegoStreamQualityLevelMedium
ZegoStreamQualityLevelMedium=(2)Normal
ZegoStreamQualityLevelBad
ZegoStreamQualityLevelBad=(3)Bad
ZegoStreamQualityLevelDie
ZegoStreamQualityLevelDie=(4)Failed
ZegoStreamQualityLevelUnknown
ZegoStreamQualityLevelUnknown=(5)Unknown
ZegoStreamRelayCDNState
State of CDN relay.
Declared in ZegoExpressDefines.h
Properties
ZegoStreamRelayCDNStateNoRelay
ZegoStreamRelayCDNStateNoRelay=(0)The state indicates that there is no CDN relay
ZegoStreamRelayCDNStateRelayRequesting
ZegoStreamRelayCDNStateRelayRequesting=(1)The CDN relay is being requested
ZegoStreamRelayCDNStateRelaying
ZegoStreamRelayCDNStateRelaying=(2)Entering this status indicates that the CDN relay has been successful
ZegoStreamRelayCDNUpdateReason
Reason for state of CDN relay changed.
Declared in ZegoExpressDefines.h
Properties
ZegoStreamRelayCDNUpdateReasonNone
ZegoStreamRelayCDNUpdateReasonNone=(0)No error
ZegoStreamRelayCDNUpdateReasonServerError
ZegoStreamRelayCDNUpdateReasonServerError=(1)Server error
ZegoStreamRelayCDNUpdateReasonHandshakeFailed
ZegoStreamRelayCDNUpdateReasonHandshakeFailed=(2)Handshake error
ZegoStreamRelayCDNUpdateReasonAccessPointError
ZegoStreamRelayCDNUpdateReasonAccessPointError=(3)Access point error
ZegoStreamRelayCDNUpdateReasonCreateStreamFailed
ZegoStreamRelayCDNUpdateReasonCreateStreamFailed=(4)Stream create failure
ZegoStreamRelayCDNUpdateReasonBadName
ZegoStreamRelayCDNUpdateReasonBadName=(5)Bad stream ID
ZegoStreamRelayCDNUpdateReasonCDNServerDisconnected
ZegoStreamRelayCDNUpdateReasonCDNServerDisconnected=(6)CDN server actively disconnected
ZegoStreamRelayCDNUpdateReasonDisconnected
ZegoStreamRelayCDNUpdateReasonDisconnected=(7)Active disconnect
ZegoStreamRelayCDNUpdateReasonMixStreamAllInputStreamClosed
ZegoStreamRelayCDNUpdateReasonMixStreamAllInputStreamClosed=(8)All mixer input streams sessions closed
ZegoStreamRelayCDNUpdateReasonMixStreamAllInputStreamNoData
ZegoStreamRelayCDNUpdateReasonMixStreamAllInputStreamNoData=(9)All mixer input streams have no data
ZegoStreamRelayCDNUpdateReasonMixStreamServerInternalError
ZegoStreamRelayCDNUpdateReasonMixStreamServerInternalError=(10)Internal error of stream mixer server
ZegoStreamResourceMode
Stream Resource Mode
Declared in ZegoExpressDefines.h
Properties
ZegoStreamResourceModeDefault
ZegoStreamResourceModeDefault=(0)Default mode. The SDK will automatically select the streaming resource according to the cdnConfig parameters set by the player config and the ready-made background configuration.
ZegoStreamResourceModeOnlyCDN
ZegoStreamResourceModeOnlyCDN=(1)Playing stream only from CDN.
ZegoStreamResourceModeOnlyL3
ZegoStreamResourceModeOnlyL3=(2)Playing stream only from L3.
ZegoStreamResourceModeOnlyRTC
ZegoStreamResourceModeOnlyRTC=(3)Playing stream only from RTC.
ZegoStreamResourceModeCDNPlus
ZegoStreamResourceModeCDNPlus=(4)[Deprecated] CDN Plus mode. The SDK will automatically select the streaming resource according to the network condition.
ZegoStreamResourceModeCustom
ZegoStreamResourceModeCustom=(5)Custom mode. The SDK selects the streaming resource based on the customResourceConfig parameter of the streaming settings.
ZegoStreamResourceSwitchMode
Stream Switch Resource Mode
Declared in ZegoExpressDefines.h
Properties
ZegoStreamResourceSwitchModeDefault
ZegoStreamResourceSwitchModeDefault=(0)Default mode. The SDK will automatically select the streaming resource according to the parameters set by the player config and the ready-made background configuration.
ZegoStreamResourceSwitchModeSwitchToRTC
ZegoStreamResourceSwitchModeSwitchToRTC=(1)Auto switch to RTC resource when publishing.
ZegoStreamResourceSwitchModeKeepOriginal
ZegoStreamResourceSwitchModeKeepOriginal=(2)Keep using original resource when publishing, not switch to RTC resource.
ZegoStreamResourceType
Stream Resource Type
Declared in ZegoExpressDefines.h
Properties
ZegoStreamResourceTypeDefault
ZegoStreamResourceTypeDefault=(0)Default mode. The SDK will automatically select the streaming resource according to the parameters set by the player config and the ready-made background configuration.
ZegoStreamResourceTypeCDN
ZegoStreamResourceTypeCDN=(1)CDN resource.
ZegoStreamResourceTypeL3
ZegoStreamResourceTypeL3=(2)L3 resource.
ZegoStreamState
Stream state.
Declared in ZegoExpressDefines.h
Properties
ZegoStreamStateStoped
ZegoStreamStateStoped=(0)Stop playing stream.
ZegoStreamStateStarting
ZegoStreamStateStarting=(1)Start request playing stream.
ZegoStreamStateStarted
ZegoStreamStateStarted=(2)Start playing stream.
ZegoSuperResolutionState
Super resolution mode.
Declared in ZegoExpressDefines.h
Properties
ZegoSuperResolutionStateOff
ZegoSuperResolutionStateOff=(0)Super resolution turned off.
ZegoSuperResolutionStateOn
ZegoSuperResolutionStateOn=(1)Super resolution turned on.
ZegoSwitchPlayingStreamType
Switch playing stream type.
Declared in ZegoExpressDefines.h
Properties
ZegoSwitchPlayingStreamTypeDefault
ZegoSwitchPlayingStreamTypeDefault=(0)Default, smooth switching.
ZegoSwitchPlayingStreamTypeForce
ZegoSwitchPlayingStreamTypeForce=(1)Force switching, Only the timestamp is guaranteed not to be refunded, and smooth switching is not guaranteed.
ZegoTeamState
Team state.
Declared in ZegoExpressDefines.h
Properties
ZegoTeamStateLogining
ZegoTeamStateLogining=(0)Joining the team. When calling [joinTeam] to join the team, it will enter this state, indicating that it is requesting to connect to the server. The application interface is usually displayed through this state.
ZegoTeamStateLogined
ZegoTeamStateLogined=(1)Join the room successfully. When joined the team successfully, it will enter this state.
ZegoTeamStateLoginFailed
ZegoTeamStateLoginFailed=(2)Failed to join the room. When the join team fails, it will enter this state.
ZegoTeamStateReconnecting
ZegoTeamStateReconnecting=(3)The team connection is temporarily interrupted. If the interruption occurs due to poor network quality, the SDK will retry internally.
ZegoTeamStateReconnected
ZegoTeamStateReconnected=(4)The team connection is successfully reconnected. If there is an interruption due to poor network quality, the SDK will retry internally, and enter this state after successful reconnection.
ZegoTeamStateReconnectFailed
ZegoTeamStateReconnectFailed=(5)The team connection fails to reconnect. If there is an interruption due to poor network quality, the SDK will retry internally, and enter this state after the reconnection fails.
ZegoTeamStateKickOut
ZegoTeamStateKickOut=(6)Kicked out of the team by the server. For example, if you join the team with the same user name in other places, and the local end is kicked out of the team, it will enter this state.
ZegoTeamStateLogout
ZegoTeamStateLogout=(7)Leave the team is successful. It is in this state by default before join the team. When calling [leaveTeam] to leave the team successfully, it will enter this state.
ZegoTrafficControlFocusOnMode
Factors that trigger traffic control
Declared in ZegoExpressDefines.h
Properties
ZegoTrafficControlFounsOnLocalOnly
ZegoTrafficControlFounsOnLocalOnly=(0)Focus only on the local network
ZegoTrafficControlFounsOnRemote
ZegoTrafficControlFounsOnRemote=(1)Pay attention to the local network, but also take into account the remote network, currently only effective in the 1v1 scenario
ZegoTrafficControlMinVideoBitrateMode
Video transmission mode when current bitrate is lower than the set minimum bitrate.
Declared in ZegoExpressDefines.h
Properties
ZegoTrafficControlMinVideoBitrateModeNoVideo
ZegoTrafficControlMinVideoBitrateModeNoVideo=(0)Stop video transmission when current bitrate is lower than the set minimum bitrate
ZegoTrafficControlMinVideoBitrateModeUltraLowFPS
ZegoTrafficControlMinVideoBitrateModeUltraLowFPS=(1)Video is sent at a very low frequency (no more than 2fps) which is lower than the set minimum bitrate
ZegoTrafficControlProperty
Traffic control property (bitmask enumeration).
Declared in ZegoExpressDefines.h
Properties
ZegoTrafficControlPropertyBasic
ZegoTrafficControlPropertyBasic=(0)Basic (Adaptive (reduce) video bitrate)
ZegoTrafficControlPropertyAdaptiveFPS
ZegoTrafficControlPropertyAdaptiveFPS=(1)Adaptive (reduce) video FPS
ZegoTrafficControlPropertyAdaptiveResolution
ZegoTrafficControlPropertyAdaptiveResolution=(2)Adaptive (reduce) video resolution
ZegoTrafficControlPropertyAdaptiveAudioBitrate
ZegoTrafficControlPropertyAdaptiveAudioBitrate=(4)Adaptive (reduce) audio bitrate
ZegoUpdateType
Update type.
Declared in ZegoExpressDefines.h
Properties
ZegoUpdateTypeAdd
ZegoUpdateTypeAdd=(0)Add
ZegoUpdateTypeDelete
ZegoUpdateTypeDelete=(1)Delete
ZegoVideoBufferType
Video frame buffer type.
Declared in ZegoExpressDefines.h
Properties
ZegoVideoBufferTypeUnknown
ZegoVideoBufferTypeUnknown=(0)Raw data type video frame
ZegoVideoBufferTypeRawData
ZegoVideoBufferTypeRawData=(1)Raw data type video frame
ZegoVideoBufferTypeEncodedData
ZegoVideoBufferTypeEncodedData=(2)Encoded data type video frame
ZegoVideoBufferTypeCVPixelBuffer
ZegoVideoBufferTypeCVPixelBuffer=(4)CVPixelBuffer type video frame
ZegoVideoBufferTypeD3DTexture2D
ZegoVideoBufferTypeD3DTexture2D=(8)D3D Texture2D type video frame
ZegoVideoCodecBackend
Backend implementation of video codec.
Declared in ZegoExpressDefines.h
Properties
ZegoVideoCodecBackendAny
ZegoVideoCodecBackendAny=(0)Software or Hardware
ZegoVideoCodecBackendSoftware
ZegoVideoCodecBackendSoftware=(1)Software
ZegoVideoCodecBackendHardware
ZegoVideoCodecBackendHardware=(2)Hardware
ZegoVideoCodecID
Video codec ID.
Declared in ZegoExpressDefines.h
Properties
ZegoVideoCodecIDDefault
ZegoVideoCodecIDDefault=(0)Default (H.264)
ZegoVideoCodecIDSvc
ZegoVideoCodecIDSvc=(1)Scalable Video Coding (H.264 SVC)
ZegoVideoCodecIDVp8
ZegoVideoCodecIDVp8=(2)VP8
ZegoVideoCodecIDH265
ZegoVideoCodecIDH265=(3)H.265
ZegoVideoCodecIDH264DualStream
ZegoVideoCodecIDH264DualStream=(4)Dualstream Scalable Video Coding
ZegoVideoCodecIDUnknown
ZegoVideoCodecIDUnknown=(100)Unknown Video Coding
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.
Declared in ZegoExpressDefines.h
Properties
ZegoVideoConfigPreset180P
ZegoVideoConfigPreset180P=(0)Set the resolution to 320x180, the default is 15 fps, the code rate is 300 kbps
ZegoVideoConfigPreset270P
ZegoVideoConfigPreset270P=(1)Set the resolution to 480x270, the default is 15 fps, the code rate is 400 kbps
ZegoVideoConfigPreset360P
ZegoVideoConfigPreset360P=(2)Set the resolution to 640x360, the default is 15 fps, the code rate is 600 kbps
ZegoVideoConfigPreset540P
ZegoVideoConfigPreset540P=(3)Set the resolution to 960x540, the default is 15 fps, the code rate is 1200 kbps
ZegoVideoConfigPreset720P
ZegoVideoConfigPreset720P=(4)Set the resolution to 1280x720, the default is 15 fps, the code rate is 1500 kbps
ZegoVideoConfigPreset1080P
ZegoVideoConfigPreset1080P=(5)Set the resolution to 1920x1080, the default is 15 fps, the code rate is 3000 kbps
ZegoVideoEncodedFrameFormat
Video encoded frame format.
Declared in ZegoExpressDefines.h
Properties
ZegoVideoEncodedFrameFormatAVCC
ZegoVideoEncodedFrameFormatAVCC=(0)AVC AVCC format
ZegoVideoEncodedFrameFormatAnnexB
ZegoVideoEncodedFrameFormatAnnexB=(1)AVC Annex-B format
ZegoVideoEncodedFrameFormatVP8
ZegoVideoEncodedFrameFormatVP8=(2)VP8 format
ZegoVideoEncodedFrameFormatHEVCAVCC
ZegoVideoEncodedFrameFormatHEVCAVCC=(3)HEVC AVCC format
ZegoVideoEncodedFrameFormatHEVCAnnexB
ZegoVideoEncodedFrameFormatHEVCAnnexB=(4)HEVC Annex-B format
ZegoVideoFlipMode
Video frame flip mode.
Declared in ZegoExpressDefines.h
Properties
ZegoVideoFlipModeNone
ZegoVideoFlipModeNone=(0)No flip
ZegoVideoFlipModeX
ZegoVideoFlipModeX=(1)X-axis flip
ZegoVideoFlipModeY
ZegoVideoFlipModeY=(2)Y-axis flip
ZegoVideoFlipModeXY
ZegoVideoFlipModeXY=(3)X-Y-axis flip
ZegoVideoFrameFormat
Video frame format.
Declared in ZegoExpressDefines.h
Properties
ZegoVideoFrameFormatUnknown
ZegoVideoFrameFormatUnknown=(0)Unknown format, will take platform default
ZegoVideoFrameFormatI420
ZegoVideoFrameFormatI420=(1)I420 (YUV420Planar) format
ZegoVideoFrameFormatNV12
ZegoVideoFrameFormatNV12=(2)NV12 (YUV420SemiPlanar) format
ZegoVideoFrameFormatNV21
ZegoVideoFrameFormatNV21=(3)NV21 (YUV420SemiPlanar) format
ZegoVideoFrameFormatBGRA32
ZegoVideoFrameFormatBGRA32=(4)BGRA32 format
ZegoVideoFrameFormatRGBA32
ZegoVideoFrameFormatRGBA32=(5)RGBA32 format
ZegoVideoFrameFormatARGB32
ZegoVideoFrameFormatARGB32=(6)ARGB32 format
ZegoVideoFrameFormatABGR32
ZegoVideoFrameFormatABGR32=(7)ABGR32 format
ZegoVideoFrameFormatI422
ZegoVideoFrameFormatI422=(8)I422 (YUV422Planar) format
ZegoVideoFrameFormatBGR24
ZegoVideoFrameFormatBGR24=(9)BGR24 format
ZegoVideoFrameFormatRGB24
ZegoVideoFrameFormatRGB24=(10)RGB24 format
ZegoVideoFrameFormatSeries
Video frame format series.
Declared in ZegoExpressDefines.h
Properties
ZegoVideoFrameFormatSeriesRGB
ZegoVideoFrameFormatSeriesRGB=(0)RGB series
ZegoVideoFrameFormatSeriesYUV
ZegoVideoFrameFormatSeriesYUV=(1)YUV series
ZegoVideoMirrorMode
Mirror mode for previewing or playing the of the stream.
Declared in ZegoExpressDefines.h
Properties
ZegoVideoMirrorModeOnlyPreviewMirror
ZegoVideoMirrorModeOnlyPreviewMirror=(0)The mirror image only for previewing locally. This mode is used by default. When the mobile terminal uses a rear camera, this mode is still used by default, but it does not work. Local preview does not set mirroring.
ZegoVideoMirrorModeBothMirror
ZegoVideoMirrorModeBothMirror=(1)Both the video previewed locally and the far end playing the stream will see mirror image.
ZegoVideoMirrorModeNoMirror
ZegoVideoMirrorModeNoMirror=(2)Both the video previewed locally and the far end playing the stream will not see mirror image.
ZegoVideoMirrorModeOnlyPublishMirror
ZegoVideoMirrorModeOnlyPublishMirror=(3)The mirror image only for far end playing the stream.
ZegoVideoRateControlMode
Video rate control mode, the default mode is constant video rate.
Declared in ZegoExpressDefines.h
Properties
ZegoVideoRateControlModeConstantRate
ZegoVideoRateControlModeConstantRate=(0)Constant rate.
ZegoVideoRateControlModeConstantQuality
ZegoVideoRateControlModeConstantQuality=(1)Constant quality, if this mode is used, the video rate fluctuates according to the network speed. For example, in the live broadcast of games, the constant quality mode will be used to improve the video quality in order to let the audience see smooth operation pictures.
ZegoVideoSourceType
video capture source.
Declared in ZegoExpressDefines.h
Properties
ZegoVideoSourceTypeNone
ZegoVideoSourceTypeNone=(1)No capture, i.e. no video data.
ZegoVideoSourceTypeCamera
ZegoVideoSourceTypeCamera=(2)The video source comes from the camera (main channel default, and front camera is captured by default). The default is front camera, which can be adjusted to rear via [useFrontCamera].
ZegoVideoSourceTypeCustom
ZegoVideoSourceTypeCustom=(3)Video source from custom capture.
ZegoVideoSourceTypeMainPublishChannel
ZegoVideoSourceTypeMainPublishChannel=(4)Video source from the main publish channel. When publishing the main channel, this value cannot be set.
ZegoVideoSourceTypePlayer
ZegoVideoSourceTypePlayer=(5)Video source from media player.
ZegoVideoSourceTypeScreenCapture
ZegoVideoSourceTypeScreenCapture=(6)Video source from screen capture.
ZegoVideoSourceDefault
ZegoVideoSourceDefault=(7)[Deprecated] this video source type has been deprecated since version 3.2.0.
ZegoVideoSourceNone
ZegoVideoSourceNone=(8)[Deprecated] Same as [Camera], that is, no capture, this video source type has been deprecated since version 3.2.0.
ZegoVideoSourceCamera
ZegoVideoSourceCamera=(9)[Deprecated] Same as [Camera], that is, video source from camera, this video source type has been deprecated since version 3.2.0.
ZegoVideoSourceExternalCapture
ZegoVideoSourceExternalCapture=(10)[Deprecated] Same as [Custom], that is, video source from custom capture, this video source type has been deprecated since version 3.2.0.
ZegoVideoSourceMainPublishChannel
ZegoVideoSourceMainPublishChannel=(11)[Deprecated] Same as [MainPublishChannel], that is, video source from the main publish channel, this video source type has been deprecated since version 3.2.0.
ZegoVideoSourcePlayer
ZegoVideoSourcePlayer=(12)[Deprecated] Same as [Player], that is, video source from media player, this video source type has been deprecated since version 3.2.0.
ZegoVideoSourceScreenCapture
ZegoVideoSourceScreenCapture=(13)[Deprecated] Same as [ScreenCapture], that is, video source from screen capture, this video source type has been deprecated since version 3.2.0.
ZegoVideoSourceTypeSecondaryCamera
ZegoVideoSourceTypeSecondaryCamera=(14)Video source from secondary camera, the rear camera when [useFrontCamera] is set to true, otherwise the front camera, only support iOS.
ZegoVideoSourceTypePicture
ZegoVideoSourceTypePicture=(15)Video source from picture capture.
ZegoVideoStreamType
Video stream type
Declared in ZegoExpressDefines.h
Properties
ZegoVideoStreamTypeDefault
ZegoVideoStreamTypeDefault=(0)The type to be played depends on the network status
ZegoVideoStreamTypeSmall
ZegoVideoStreamTypeSmall=(1)small resolution type
ZegoVideoStreamTypeBig
ZegoVideoStreamTypeBig=(2)big resolution type
ZegoViewMode
Video rendering fill mode.
Declared in ZegoExpressDefines.h
Properties
ZegoViewModeAspectFit
ZegoViewModeAspectFit=(0)The proportional scaling up, there may be black borders
ZegoViewModeAspectFill
ZegoViewModeAspectFill=(1)The proportional zoom fills the entire View and may be partially cut
ZegoViewModeScaleToFill
ZegoViewModeScaleToFill=(2)Fill the entire view, the image may be stretched
ZegoVoiceChangerPreset
Voice changer preset value.
Declared in ZegoExpressDefines.h
Properties
ZegoVoiceChangerPresetNone
ZegoVoiceChangerPresetNone=(0)No Voice changer
ZegoVoiceChangerPresetMenToChild
ZegoVoiceChangerPresetMenToChild=(1)Male to child voice (loli voice effect)
ZegoVoiceChangerPresetMenToWomen
ZegoVoiceChangerPresetMenToWomen=(2)Male to female voice (kindergarten voice effect)
ZegoVoiceChangerPresetWomenToChild
ZegoVoiceChangerPresetWomenToChild=(3)Female to child voice
ZegoVoiceChangerPresetWomenToMen
ZegoVoiceChangerPresetWomenToMen=(4)Female to male voice
ZegoVoiceChangerPresetForeigner
ZegoVoiceChangerPresetForeigner=(5)Foreigner voice effect
ZegoVoiceChangerPresetOptimusPrime
ZegoVoiceChangerPresetOptimusPrime=(6)Autobot Optimus Prime voice effect
ZegoVoiceChangerPresetAndroid
ZegoVoiceChangerPresetAndroid=(7)Android robot voice effect
ZegoVoiceChangerPresetEthereal
ZegoVoiceChangerPresetEthereal=(8)Ethereal voice effect
ZegoVoiceChangerPresetMaleMagnetic
ZegoVoiceChangerPresetMaleMagnetic=(9)Magnetic(Male) voice effect
ZegoVoiceChangerPresetFemaleFresh
ZegoVoiceChangerPresetFemaleFresh=(10)Fresh(Female) voice effect
ZegoVoiceChangerPresetMajorC
ZegoVoiceChangerPresetMajorC=(11)Electronic effects in C major voice effect
ZegoVoiceChangerPresetMinorA
ZegoVoiceChangerPresetMinorA=(12)Electronic effects in A minor voice effect
ZegoVoiceChangerPresetHarmonicMinor
ZegoVoiceChangerPresetHarmonicMinor=(13)Electronic effects in harmonic minor voice effect
ZegoVoiceChangerPresetFemaleEnergetic
ZegoVoiceChangerPresetFemaleEnergetic=(14)Female Vitality Sound effect
ZegoVoiceChangerPresetRichNess
ZegoVoiceChangerPresetRichNess=(15)Richness effect
ZegoVoiceChangerPresetMuffled
ZegoVoiceChangerPresetMuffled=(16)Muffled effect
ZegoVoiceChangerPresetRoundness
ZegoVoiceChangerPresetRoundness=(17)Roundness effect
ZegoVoiceChangerPresetFalsetto
ZegoVoiceChangerPresetFalsetto=(18)Falsetto effect
ZegoVoiceChangerPresetFullness
ZegoVoiceChangerPresetFullness=(19)Fullness effect
ZegoVoiceChangerPresetClear
ZegoVoiceChangerPresetClear=(20)Clear effect
ZegoVoiceChangerPresetHighlyResonant
ZegoVoiceChangerPresetHighlyResonant=(21)Hight effect
ZegoVoiceChangerPresetLoudClear
ZegoVoiceChangerPresetLoudClear=(22)Loud clear effect
ZegoVoiceChangerPresetMinions
ZegoVoiceChangerPresetMinions=(23)Minions effect
ZegoVoiceChangerPresetSunshine
ZegoVoiceChangerPresetSunshine=(24)Sunshine effect
ZegoVoiceChangerPresetGentle
ZegoVoiceChangerPresetGentle=(25)Gentle effect
ZegoVoiceChangerPresetSweet
ZegoVoiceChangerPresetSweet=(26)Sweet effect
ZegoVoiceChangerPresetSweetMale
ZegoVoiceChangerPresetSweetMale=(27)Sweet male effect
ZegoVoiceChangerPresetSweetFemale
ZegoVoiceChangerPresetSweetFemale=(28)Sweet female effec
ZegoVoiceChangerPresetBright
ZegoVoiceChangerPresetBright=(29)Bright effect
ZegoVoiceChangerPresetAutobot
ZegoVoiceChangerPresetAutobot=(30)Autobot effect
ZegoVoiceChangerPresetOutOfPower
ZegoVoiceChangerPresetOutOfPower=(31)Out of power effect
ZegoVolumeType
volume type.
Declared in ZegoExpressDefines.h
Properties
ZegoVolumeTypeLocal
ZegoVolumeTypeLocal=(0)volume local
ZegoVolumeTypeRemote
ZegoVolumeTypeRemote=(1)volume remote
