Enum
AiDenoiseMode
AI denoise mode
Details
AI denoise mode.
Properties
AI
AI=(0)AI mode noise suppression will cause great damage to music, so it cannot be used for noise suppression of audio sources that need to capture background sounds.
AIBalanced
AIBalanced=(1)Balanced AI mode noise suppression will cause great damage to music, so it cannot be used for noise suppression of audio sources that need to capture background sounds.
ExceptionCode
Details
Push and pull stream collection, encoding and decoding of abnormal or normal event codes
Properties
captureFpsToLow
captureFpsToLow=(1001)The video capture frame rate is too low.
captureVolumeToLow
captureVolumeToLow=(1002)The capture volume is too low.
sendVideoBitrateToLow
sendVideoBitrateToLow=(1003)The video bit rate sent is too low.
sendFpsToLow
sendFpsToLow=(1004)The video frame rate sent is too low.
sendAudioBitrateToLow
sendAudioBitrateToLow=(1005)The audio bit rate sent is too low.
receiveVolumeToLow
receiveVolumeToLow=(1006)The volume of audio received is too low.
receiveAudioDecodedFail
receiveAudioDecodedFail=(1007)The received audio failed to be decoded.
ReceiveVideoDecodedFail
ReceiveVideoDecodedFail=(1008)The received video failed to be decoded.
receiveVideoFpsDecodedToLow
receiveVideoFpsDecodedToLow=(1009)Received video decode frame rate is too low.
renderVideoFpsToLow
renderVideoFpsToLow=(1010)The rendered video frame rate is too low.
captureFpsNormal
captureFpsNormal=(2001)The video capture frame rate is normal.
captureVolumeNormal
captureVolumeNormal=(2002)The capture volume is normal.
sendVideoBitrateNormal
sendVideoBitrateNormal=(2003)The video bit rate sent is normal.
sendFpsNormal
sendFpsNormal=(2004)The video frame rate sent is normal.
sendAudioBitrateNormal
sendAudioBitrateNormal=(2005)The audio bit rate sent is normal.
receiveVolumeNormal
receiveVolumeNormal=(2006)The volume of audio received is normal.
receiveAudioDecodedNormal
receiveAudioDecodedNormal=(2007)The received audio successed to be decoded.
receiveVideoDecodedNormal
receiveVideoDecodedNormal=(2008)The received video successed to be decoded.
receiveVideoFpsDecodedNormal
receiveVideoFpsDecodedNormal=(2009)Received video decode frame rate is normal.
renderVideoFpsNormal
renderVideoFpsNormal=(2010)The rendered video frame rate is normal.
Segmentation
background processs mode
Properties
PortraitSegmentation
PortraitSegmentation=(0)portrait segmentation
TrafficControlFocusOnMode
Details
Factors that trigger streaming flow control.
Properties
TrafficControlFocusOnLocalOnly
TrafficControlFocusOnLocalOnly=(0)Focus only on local networks
TrafficControlFocusOnRemote
TrafficControlFocusOnRemote=(1)Focus on local network, but also take remote network into consideration. Currently only works in 1v1 scenarios
ZegoAudioCodecID
audio codec ID
Properties
ZegoAudioCodecIDNormal
ZegoAudioCodecIDNormal=(1)Can be used for RTC and CDN streaming; bitrate range 10kbps ~ 128kbps; supports dual channels; delay is around 500ms
ZegoAudioCodecIDNormal2
ZegoAudioCodecIDNormal2=(2)Can be used for RTC and CDN streaming; good compatibility, bit rate range 16kbps ~ 192kbps; supports dual channels; delay is about 350ms; at the same bit rate (lower bit rate), the sound quality is weaker than [Normal].
ZegoAudioCodecIDLow3
ZegoAudioCodecIDLow3=(6)Can only be used for RTC streaming; bitrate range 10kbps ~ 192kbps; supports dual channels; latency is around 200ms; at the same bitrate (lower bitrate), the sound quality is significantly better than [Normal] and [Normal2]; CPU overhead is lower.
ZegoAudioMixMode
Audio Mixing Mode
Properties
ZegoAudioMixModeRaw
ZegoAudioMixModeRaw=(0)Default mode, no special behavior
ZegoAudioMixModeFocused
ZegoAudioMixModeFocused=(1)Audio focus mode can highlight the sound of a certain stream among multiple audio streams.
ZegoCopyrightedMusicBillingMode
Song on demand billing mode.
Properties
Count
Count=(0)Pay-per-view. Each time a user obtains a song resource, a fee is charged, that is, the user is charged per time according to the actual call to obtain the song resource interface (such as the [requestResource] interface) and pass parameters.
User
User=(1)Billed monthly by user. A single user is billed on a monthly basis, that is, the statistical call to obtain song resources is passed as a user ID for a monthly subscription, and charges are made on a monthly basis.
Room
Room=(2)Monthly billing by room. Room users are billed on a monthly basis, that is, the statistical call to obtain song resources is passed as the roomID for a monthly subscription, and charges are made on a monthly basis.
Master
Master=(3)Billed monthly by the owner. Every time a user obtains a resource, it is counted as the owner’s acquisition of resources, that is, the roomID and masterID of the room are passed as the parameters of the interface for obtaining song resources actually called, and the fee is charged according to the homeowner.
ZegoCopyrightedMusicResourceType
Music resource type. Used in [ZegoCopyrightedMusicRequestConfig] configuration.
Properties
Song
Song=(0)Original song.
Accompaniment
Accompaniment=(1)Accompaniment.
AccompanimentClip
AccompanimentClip=(2)Accompaniment Clip
AccompanimentSegment
AccompanimentSegment=(3)Snatch a singing clip.
ZegoCopyrightedMusicVendorID
copyright party. For detailed information about the copyright owner, please contact ZEGO business personnel for consultation.
Properties
VendorDefault
VendorDefault=(0)The default copyright party.
Vendor1
Vendor1=(1)Copyright Party 1.
Vendor2
Vendor2=(2)Copyright Party 2.
Vendor3
Vendor3=(4)Copyright Party 3.
ZegoEncodeProfile
Video encoding specifications
Properties
ZegoEncodeProfileDefault
ZegoEncodeProfileDefault=(0)The default video encoding specification. The default value is the Main level video encoding specification.
ZegoEncodeProfileBaseline
ZegoEncodeProfileBaseline=(1)Baseline-level video encoding specifications have low decoding consumption and poor picture quality. They are generally used for low-level applications or applications that require additional fault tolerance.
ZegoEncodeProfileMain
ZegoEncodeProfileMain=(2)Main-level video encoding specification. The decoding consumption is slightly higher than Baseline, and the picture quality is better. It is generally used in mainstream consumer electronic products.
ZegoEncodeProfileHigh
ZegoEncodeProfileHigh=(3)High-level video encoding specification, with higher decoding consumption than Main and better picture quality. It is generally used for broadcasting, video disc storage, and high-definition television.
ZegoFontType
font type.
Properties
ZegoFontTypeSourceHanSans
ZegoFontTypeSourceHanSans=(0)Source han sans.
ZegoFontTypeAlibabaSans
ZegoFontTypeAlibabaSans=(1)Alibaba sans.
ZegoFontTypePangMenZhengDaoTitle
ZegoFontTypePangMenZhengDaoTitle=(2)Pang men zheng dao title.
ZegoFontTypeHappyZcool
ZegoFontTypeHappyZcool=(3)HappyZcool.
ZegoGeoFenceType
Geo fence type.
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.
ZegoInspectFlagType
Details
Submission for review indicator type.
Properties
Allow
Allow=(0)Allow for review
NotAllow
NotAllow=(1)Do not allow for review.
ZegoLiveAudioEffectMode
Sound quality enhancement effective mode.
Details
Sound quality enhancement effective mode.
Properties
None
None=(0)All closed.
Local
Local=(1)Valid only locally.
Publish
Publish=(2)Only push flow takes effect.
All
All=(3)Both local and streaming are effective.
ZegoLowlightEnhancementMode
Low light enhanced mode.
Properties
Off
Off=(0)On
On=(1)ZegoMixStreamRenderMode
Mix stream render mode
Details
Mixed-stream video rendering mode.
Properties
AspectFill
AspectFill=(0)Fill mode, proportional filling layout, part of the screen may be cropped.
AspectFit
AspectFit=(1)Fit mode, zoom the screen proportionally, there may be white space in the layout.
ZegoRangeAudioListenMode
Range voice listening mode.
Properties
All
All=(0)Listen to everyone mode, you can listen to the voices of everyone in the room.
World
World=(1)Only listen to people in the world mode, which only listens to the voices of people who are within range.
Team
Team=(2)Only listen to the squad mode you belong to, and only listen to the voices of members of the squad you belong to (not limited by range).
ZegoRangeAudioMicrophoneState
Microphone sending audio state.
Details
Microphone sending audio state.
- Use cases: Get the microphone switch status.
Properties
Off
Off=(0)Off
TurningOn
TurningOn=(1)Turning on
On
On=(2)On
ZegoRangeAudioMode
Range Audio Mode
Details
Range Audio Mode.
Properties
World
World=(0)World mode, you can communicate with everyone in the room
Team
Team=(1)Team mode only, only communicate with members of the team
SecretTeam
SecretTeam=(2)In stealth squad mode, you can communicate with members of the squad (not limited by range), and you can hear the voices of other players within range (not in the team).
ZegoRangeAudioSpeakMode
Range voice sending mode.
Properties
All
All=(0)Voice to everyone mode, everyone in the room can hear his voice.
World
World=(1)Voicing into world mode, only those within range can hear his voice.
Team
Team=(2)Voice to the team mode, only the members of the team can hear his voice (not restricted by range).
ZegoReverbPreset
Reverb presets.
Details
Reverb presets.
Properties
None
None=(0)No reverb.
SoftRoom
SoftRoom=(1)Small room reverb effect
LargeRoom
LargeRoom=(2)Large room reverb effect
ConcertHall
ConcertHall=(3)Concert hall reverberation effect
Valley
Valley=(4)Valley reverb effect
RecordingStudio
RecordingStudio=(5)Studio reverb effect
Basement
Basement=(6)basement reverb effect
KTV
KTV=(7)KTV Reverb Effect
Popular
Popular=(8)Pop reverb effect
Rock
Rock=(9)Rock reverb effect
VocalConcert
VocalConcert=(10)Concert reverb effect
GramoPhone
GramoPhone=(11)Phonograph Reverb Effect
EnhancedKTV
EnhancedKTV=(12)The enhanced KTV reverb effect provides a KTV effect with more concentrated vocals and better brightness. Compared with the original KTV sound effect, the reverberation time is shortened, and the dry-wet ratio is improved.
ZegoRoomStateChangedReason
Properties
Logining
Logining=('LOGINING')Logined
Logined=('LOGINED')LoginFailed
LoginFailed=('LOGIN_FAILED')Reconnecting
Reconnecting=('RECONNECTING')ReconnectFailed
ReconnectFailed=('RECONNECT_FAILED')Kickout
Kickout=('KICKOUT')Logout
Logout=('LOGOUT')LogoutFailed
LogoutFailed=('LOGOUT_FAILED')Reconnected
Reconnected=('RECONNECTED')ZegoRoomTransparentMessageMode
Details
Room mode.
Properties
ZegoRoomTransparentMessageModeOnlyClient
ZegoRoomTransparentMessageModeOnlyClient=(0)Sent to clients only.
ZegoRoomTransparentMessageModeOnlyServer
ZegoRoomTransparentMessageModeOnlyServer=(1)Server callback only, you need to configure the callback to the zego server.
ZegoRoomTransparentMessageModeClientAndServer
ZegoRoomTransparentMessageModeClientAndServer=(2)Client receives and server callbacks.
ZegoRoomTransparentMessageType
Details
Room mode.
Properties
ZegoRoomTransparentMessageNormal
ZegoRoomTransparentMessageNormal=(0)Single room mode.
ZegoRoomTransparentMessageSequence
ZegoRoomTransparentMessageSequence=(1)Messages are guaranteed to be eventually ordered.
ZegoSEIType
Details
SEI type.
Properties
ZegoDefined
ZegoDefined=(0)Packed in SEI (nalu type = 6, payload type = 243) type, this type is a type not specified by the SEI standard, and there is no conflict with the SEI in the video encoder or video file, and users do not need to filter according to the content of the SEI . The SDK uses this type to send SEI by default
UserUnregister
UserUnregister=(1)Packing with SEI (nalu type = 6, payload type = 5) type, the H.264 standard has a prescribed format for this type: startcode + nalu type(6) + payload type(5) + len + pay load(uuid + context ) + trailing bits; Because the video encoder itself will generate an SEI with a payload type of 5, or when the video file is used for streaming, such an SEI may also exist in the video file, so when this type is used, the user will use the uuid + context as a buffer and stuff it into the secondary Media sending interface; At this time, in order to distinguish the SEI generated by the video encoder itself, the App can fill in the service-specific uuid (the uuid length is 16 bytes) when sending this type of SEI. When the receiver uses the SDK to parse the SEI with the payload type of 5, it will The set filter string filters out SEIs that match the uuid and throws them to the business. If no filter string is set, the SDK will throw all the received SEIs to the business side; The uuid filter string setting interface, the uuid filter string set by setSEIConfig.
ZegoScenario
room scenario
Details
the value of room scenario
Properties
Default
Default=(3)defalut value
StandardVideoCall
StandardVideoCall=(4)standard video call 1v1
HighVideoCall
HighVideoCall=(5)high quality video call 1V1
StandardChatroom
StandardChatroom=(6)standard chat room
HighQualityChatroom
HighQualityChatroom=(7)High quality chatroom
Broadcast
Broadcast=(8)Broadcast
Karaoke
Karaoke=(9)Karaoke (KTV)
ZegoStreamUpdateType
Update audio and video type
Properties
video
video=(0)update video
audio
audio=(1)update audio
videoAndAudio
videoAndAudio=(2)update audio and video
ZegoVideoCodecID
Video encoding ID
Properties
ZegoVideoCodecIDDefault
ZegoVideoCodecIDDefault=(0)The default video encoding specification. The default value is h264.
ZegoVideoCodecIDVp8
ZegoVideoCodecIDVp8=(2)Vp8 encoding format.
ZegoVideoCodecIDH265
ZegoVideoCodecIDH265=(4)H265 encoding format.
ZegoVoiceChangerPreset
Preset value of voice changer
Details
Preset value of voice changer
Properties
NONE
NONE=(0)Original sound
MEN_TO_CHILD
MEN_TO_CHILD=(1)The male voice change to a child's voice
MEN_TO_WOMEN
MEN_TO_WOMEN=(2)The male voice changes to the female voice
WOMEN_TO_CHILD
WOMEN_TO_CHILD=(3)The female voice changes to the child's voice
WOMEN_TO_MEN
WOMEN_TO_MEN=(4)The female voice changes to the male voice
FOREIGNER
FOREIGNER=(5)Foreigner
OPTIMUS_PRIME
OPTIMUS_PRIME=(6)Autobot Optimus Prime sound effect
ANDROID
ANDROID=(7)Robot sound effect
ETHEREAL
ETHEREAL=(8)Ethereal sound effect
MALE_MAGNETIC
MALE_MAGNETIC=(9)Magnetic male voice effect
FEMALE_FRESH
FEMALE_FRESH=(10)Fresh female voice effect
MAJOR_C
MAJOR_C=(11)Electric sound effect in C major
MINOR_A
MINOR_A=(12)Electric sound effects in A minor
HARMONIC_MINOR
HARMONIC_MINOR=(13)Harmonic minor electric sound effects
FEMALE_ENERGETIC
FEMALE_ENERGETIC=(14)Female vitality sound
RICHNESS
RICHNESS=(15)Rich sound
MUFFLED
MUFFLED=(16)Muffled sound
ROUNDNESS
ROUNDNESS=(17)Mellow sound
FALSETTO
FALSETTO=(18)Falsetto sound
FULLNESS
FULLNESS=(19)Fullness
CLEAR
CLEAR=(20)Clear Sound
HIGHLY_RESONANT
HIGHLY_RESONANT=(21)Resonant sound
LOUD_CLEAR
LOUD_CLEAR=(22)Loud sound effect
