Enum

Aggressive echo cancellation may affect the sound quality slightly, but the echo will be very clean.

Moderate echo cancellation, which may slightly affect a little bit of sound, but the residual echo will be less.

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.

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.

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.

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.

Soft ANS. In most instances, the sound quality will not be damaged, but some noise will remain.

Medium ANS. It may damage some sound quality, but it has a good noise reduction effect.

Aggressive ANS. It may significantly impair the sound quality, but it has a good noise reduction effect.

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.

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.

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.

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.

There is no alpha data.

Alpha channel data is to the left of RGB/YUV data.

Alpha channel data is to the right of RGB/YUV data.

Alpha channel data is to the bottom of RGB/YUV data.

Alpha channel data is to the upper right of RGB/YUV data.

Disable stereo capture, that is, mono.

Always enable stereo capture.

[Deprecated] Same as [Always], that is, always enable stereo capture, this mode has been deprecated since version 2.16.0.

Unknown

Mono

Stereo

Default, determined by the [scenario] when calling [createEngine].

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.

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.

Not recommended; if you need to use it, please contact ZEGO technical support. Can only be used for RTC streaming.

Not recommended; if you need to use it, please contact ZEGO technical support. Can only be used for RTC streaming.

Not recommended; if you need to use it, please contact ZEGO technical support. Can only be used for RTC streaming; maximum bitrate is 16kbps.

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.

Basic sound quality (16 kbps, Mono, ZegoAudioCodecIDDefault)

Standard sound quality (48 kbps, Mono, ZegoAudioCodecIDDefault)

Standard sound quality (56 kbps, Stereo, ZegoAudioCodecIDDefault)

High sound quality (128 kbps, Mono, ZegoAudioCodecIDDefault)

High sound quality (192 kbps, Stereo, ZegoAudioCodecIDDefault)

Audio input type

Audio output type

Not playing

Playing

Pausing

End of play

Speaker

Headphone

Bluetooth device

Receiver

External USB audio device

Apple AirPlay

Unknown

8K

16K

22.05K

24K

32K

44.1K

48K

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

Use custom audio capture, refer to [enableCustomAudioIO] or [setAudioSource].

Use media player as audio source, only support aux channel.

No audio source. This audio source type can only be used in [setAudioSource] interface, has no effect when used in [enableCustomAudioIO] interface.

Using microphone as audio source. This audio source type can only be used in [setAudioSource] interface, has no effect when used in [enableCustomAudioIO] interface.

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.

captured

custom processed

noise

speech

Background blur level low.

Background blur level medium.

Background blur level high.

Background is transparent.

Fill the background with a solid color.

Blur background.

The background is the specified image.

The background is the specified video.

Auto exposure.

Continuous auto exposure.

Auto focus.

Continuous auto focus.

Zoom immediately after acquisition, default

Scaling while encoding

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

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.

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.

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.

Standard Definition Audio.

High Definition Audio.

Lossless Audio Quality.

Song.

Song accompaniment.

Song accompaniment clip.

Song accompaniment segment.

Song. Deprecated since version 3.9.0.

Song with high quality. Deprecated since version 3.9.0.

Song with super quality. Deprecated since version 3.9.0.

Song accompaniment. Deprecated since version 3.9.0.

Song accompaniment clip. Deprecated since version 3.9.0.

Song accompaniment segment. Deprecated since version 3.9.0.

Default copyright provider.

First copyright provider.

Second copyright provider.

Third copyright provider.

Before ear return.

After ear return.

Unrecorded state, which is the state when a recording error occurs or before recording starts.

Recording in progress, in this state after successfully call [startRecordingCapturedData] function

Record successs

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.

only record audio

only record video, Audio SDK and recording .aac format files are invalid.

record audio and video. Express-Audio SDK and .aac format files are recorded only audio.

Unknown device exception.

Generic device exception.

Invalid device ID exception.

Device permission is not granted.

The capture frame rate of the device is 0.

The device is being occupied.

The device is unplugged (not plugged in).

The device requires the system to restart before it can work (Windows platform only).

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

The device is being occupied by Siri (Apple platform only).

The device captured sound level is too low (Windows platform only).

The device is being occupied, and maybe cause by iPad magnetic case (Apple platform only).

Audio session deactive (Apple platform only).

Audio session category change (Apple platform only).

Unknown device type.

Camera device.

Microphone device.

Speaker device.

Audio device. (Other audio device that cannot be accurately classified into microphones or speakers.)

Audio Session.

The default video encode specifications, The default value is the video encoding specification at the Main level.

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.

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.

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.

The engine has started

The engine has stoped

Basic audio feature.

Basic video feature.

Media player feature.

Local media data recorder feature.

Media data publisher feature.

Supplemental Enhancement Information (media side info) feature.

SDK video capture feature.

Custom video capture feature.

SDK video rendering feature.

Custom video rendering feature.

SDK video processing feature (including low-light enhancement feature).

Custom video processing feature.

Streaming encryption / decryption feature.

RTMP streaming feature.

RTMPS streaming feature.

RTMP over QUIC streaming feature.

RTMP streaming feature.

HTTPS-FLV streaming feature.

HTTP-FLV over QUIC streaming feature.

Super resolution imaging feature.

Effects beauty feature.

Whiteboard beauty feature.

Range audio feature.

Copy righted music feature.

Video object segmentation feature.

Range scene feature. (3.0.0 and above support)

Screen capture feature. (3.1.0 and above support)

AI voice changer feature. (3.8.0 and above support)

Source han sans.

Alibaba sans.

Pang men zheng dao title.

HappyZcool.

Not use geo fence.

Include the specified geo fence areas.

Exclude the specified geo fence areas.

English

Chinese

No audio effect.

Only local play.

Only publish.

Publish and local play.

Turn off the low-light enhancement, and the brightness of the captured image remains unchanged.

Turn on low-light enhancement to enhance the brightness of the captured image.

Automatic low-light enhancement, the brightness enhancement value of the captured picture is dynamically adjusted with the ambient brightness.

Audio channel left

Audio channel right

Audio channel all

The first video frame is rendered event.

The first audio frame is rendered event.

Network resources are not playing well, and start trying to cache data

Network resources can be played smoothly

Not playing

Playing

Pausing

End of play

The proportional zoom fills the entire area and may be partially cut.

Scale the filled area proportionally. If the scale does not match the set size after scaling, the extra part will be displayed as transparent.

Mix stream for audio only

Mix stream for both audio and video

Mix stream for video only. On web platforms, this property does not take effect

Offline (No network)

Unknown network mode

Wired Ethernet (LAN)

Wi-Fi (WLAN)

2G Network (GPRS/EDGE/CDMA1x/etc.)

3G Network (WCDMA/HSDPA/EVDO/etc.)

4G Network (LTE)

5G Network (NR (NSA/SA))

uplink

downlink

Object segmentation turned off.

Object segmentation turned on.

Any background object segmentation.

Green screen background object segmentation.

Audio stuck event when playing

Audio stuck event recovery when playing

Video stuck event when playing

Video stuck event recovery when playing

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.

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.

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.

The main (default/first) publish channel.

The auxiliary (second) publish channel

The third publish channel

The fourth publish channel

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.

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.

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.

Device on

General device error

Invalid device ID

No permission

Captured frame rate is 0

The device is occupied

The device is not plugged in or unplugged

The system needs to be restarted

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.

The remote user calls [enableCamera] or [enableAudioCaptureDevice] to disable the camera or microphone.

The remote user actively calls [muteMicrophone] or [mutePublishStreamAudio] or [mutePublishStreamVideo] to stop publish the audio or video stream.

The device is interrupted, such as a phone call interruption, etc.

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.

CDN server actively disconnected

The system is under high load pressure and may cause abnormal equipment.

The remote device is not supported to publish the device state.

CDN

RTC

L3

No Reverberation

Soft room reverb effect

Large room reverb effect

Concert hall reverb effect

Valley reverb effect

Recording studio reverb effect

Basement reverb effect

KTV reverb effect

Popular reverb effect

Rock reverb effect

Vocal concert reverb effect

Gramophone reverb effect

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.

Enhanced Rock reverb effect

Enhanced misty reverb effect

Hip Hop reverb effect

Misty reverb effect

3D voice reverb effect

Theatre reverb effect

Recording studio reverb effect (Only vivo)

Single room mode.

Multiple room mode.

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.

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.

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.

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.

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.

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.

The room connection is temporarily interrupted. If the interruption occurs due to poor network quality, the SDK will retry internally.

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.

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.

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.

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.

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.

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.

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.

[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.

[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.

[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.

The default (generic) scenario. If none of the following scenarios conform to your actual application scenario, this default scenario can be used.

Standard video call scenario, it is suitable for one-to-one video call scenarios.

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.

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.

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.

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.

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.

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.

Unknown exception type.

The capture target fails, such as the monitor is unplugged and the window is closed.

Failed to collect target, internal reasons of the system.

The set publish region is invalid, and the publish region is not within the capture screen region.

Unknow.

The capture target is a certain window.

The capture target is the screen of a certain monitor.

Disable stream alignment.

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.

no censorship.

only censorship stream audio.

only censorship stream video.

censorship stream audio and video.

Excellent

Good

Normal

Bad

Failed

Unknown

The state indicates that there is no CDN relay

The CDN relay is being requested

Entering this status indicates that the CDN relay has been successful

No error

Server error

Handshake error

Access point error

Stream create failure

Bad stream ID

CDN server actively disconnected

Active disconnect

All mixer input streams sessions closed

All mixer input streams have no data

Internal error of stream mixer server

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.

Playing stream only from CDN.

Playing stream only from L3.

Playing stream only from RTC.

[Deprecated] CDN Plus mode. The SDK will automatically select the streaming resource according to the network condition.

Custom mode. The SDK selects the streaming resource based on the customResourceConfig parameter of the streaming settings.

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.

Auto switch to RTC resource when publishing.

Keep using original resource when publishing, not switch to RTC resource.

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.

CDN resource.

L3 resource.

Focus only on the local network

Pay attention to the local network, but also take into account the remote network, currently only effective in the 1v1 scenario

Stop video transmission when current bitrate is lower than the set minimum bitrate

Video is sent at a very low frequency (no more than 2fps) which is lower than the set minimum bitrate

Basic (Adaptive (reduce) video bitrate)

Adaptive (reduce) video FPS

Adaptive (reduce) video resolution

Adaptive (reduce) audio bitrate

Add

Delete

Raw data type video frame

Raw data type video frame

Encoded data type video frame

Texture 2D type video frame

CVPixelBuffer type video frame

Surface Texture type video frame

GL_TEXTURE_EXTERNAL_OES type video frame

Texture 2D and raw data type video frame

D3D Texture2D type video frame

CVPixelBuffer type nv12 format video frame. Only for custom video processing

Software or Hardware

Software

Hardware

Default (H.264)

Scalable Video Coding (H.264 SVC)

VP8

H.265

Dualstream Scalable Video Coding

Unknown Video Coding

Set the resolution to 320x180, the default is 15 fps, the code rate is 300 kbps

Set the resolution to 480x270, the default is 15 fps, the code rate is 400 kbps

Set the resolution to 640x360, the default is 15 fps, the code rate is 600 kbps

Set the resolution to 960x540, the default is 15 fps, the code rate is 1200 kbps

Set the resolution to 1280x720, the default is 15 fps, the code rate is 1500 kbps

Set the resolution to 1920x1080, the default is 15 fps, the code rate is 3000 kbps

No flip

X-axis flip

Y-axis flip

X-Y-axis flip

Unknown format, will take platform default

I420 (YUV420Planar) format

NV12 (YUV420SemiPlanar) format

NV21 (YUV420SemiPlanar) format

BGRA32 format

RGBA32 format

ARGB32 format

ABGR32 format

I422 (YUV422Planar) format

BGR24 format

RGB24 format

RGB series

YUV series

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.

Both the video previewed locally and the far end playing the stream will see mirror image.

Both the video previewed locally and the far end playing the stream will not see mirror image.

The mirror image only for far end playing the stream.

Constant rate.

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.

No capture, i.e. no video data.

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].

Video source from custom capture.

Video source from the main publish channel. When publishing the main channel, this value cannot be set.

Video source from media player.

Video source from screen capture.

[Deprecated] this video source type has been deprecated since version 3.2.0.

[Deprecated] Same as [Camera], that is, no capture, this video source type has been deprecated since version 3.2.0.

[Deprecated] Same as [Camera], that is, video source from camera, this video source type has been deprecated since version 3.2.0.

[Deprecated] Same as [Custom], that is, video source from custom capture, this video source type has been deprecated since version 3.2.0.

[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.

[Deprecated] Same as [Player], that is, video source from media player, this video source type has been deprecated since version 3.2.0.

[Deprecated] Same as [ScreenCapture], that is, video source from screen capture, this video source type has been deprecated since version 3.2.0.

Video source from secondary camera, the rear camera when [useFrontCamera] is set to true, otherwise the front camera, only support iOS.

Video source from picture capture.

The type to be played depends on the network status

small resolution type

big resolution type

The proportional scaling up, there may be black borders

The proportional zoom fills the entire View and may be partially cut

Fill the entire view, the image may be stretched

No Voice changer

Male to child voice (loli voice effect)

Male to female voice (kindergarten voice effect)

Female to child voice

Female to male voice

Foreigner voice effect

Autobot Optimus Prime voice effect

Android robot voice effect

Ethereal voice effect

Magnetic(Male) voice effect

Fresh(Female) voice effect

Electronic effects in C major voice effect

Electronic effects in A minor voice effect

Electronic effects in harmonic minor voice effect

Female Vitality Sound effect

Richness effect

Muffled effect

Roundness effect

Falsetto effect

Fullness effect

Clear effect

Hight effect

Loud clear effect

Minions effect

Sunshine effect

Gentle effect

Sweet effect

Sweet male effect

Sweet female effec

Bright effect

Autobot effect

Out of power effect