Global

Members

(constant) ZegoAECMode :number

Audio echo cancellation mode.
Type:
  • number
Properties:
Name Type Description
Aggressive number Aggressive echo cancellation may affect the sound quality slightly, but the echo will be very clean.
Medium number Moderate echo cancellation, which may slightly affect a little bit of sound, but the residual echo will be less.
Soft number 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.
Source:

(constant) ZegoANSMode :number

Active Noise Suppression mode.
Type:
  • number
Properties:
Name Type Description
Soft number Soft ANS. In most instances, the sound quality will not be damaged, but some noise will remain.
Medium number Medium ANS. It may damage some sound quality, but it has a good noise reduction effect.
Aggressive number Aggressive ANS. It may significantly impair the sound quality, but it has a good noise reduction effect.
Source:

(constant) ZegoAudioCaptureStereoMode :number

Audio capture stereo mode.
Type:
  • number
Properties:
Name Type Description
None number Disable capture stereo, i.e. capture mono
Always number Always enable capture stereo
Adaptive number Adaptive mode, capture stereo when publishing stream only, capture mono when publishing and playing stream (e.g. talk/intercom scenes)
Source:

(constant) ZegoAudioChannel :number

Audio channel type.
Type:
  • number
Properties:
Name Type Description
Unknown number Unknown
Mono number Mono
Stereo number Stereo
Source:

(constant) ZegoAudioCodecID :number

Audio Codec ID.
Type:
  • number
Properties:
Name Type Description
Default number default
Normal number Normal
Normal2 number Normal2
Normal3 number Normal3
Low number Low
Low2 number Low2
Low3 number Low3
Source:

(constant) ZegoAudioConfigPreset :number

Audio Config Preset.
Type:
  • number
Properties:
Name Type Description
BasicQuality number Basic sound quality (16 kbps, Mono, ZegoAudioCodecIDDefault)
StandardQuality number Standard sound quality (48 kbps, Mono, ZegoAudioCodecIDDefault)
StandardQualityStereo number Standard sound quality (56 kbps, Stereo, ZegoAudioCodecIDDefault)
HighQuality number High sound quality (128 kbps, Mono, ZegoAudioCodecIDDefault)
HighQualityStereo number High sound quality (192 kbps, Stereo, ZegoAudioCodecIDDefault)
Source:

(constant) ZegoAudioDeviceType :number

Audio device type.
Type:
  • number
Properties:
Name Type Description
Input number Audio input type
Output number Audio output type
Source:

(constant) ZegoAudioEffectPlayState :number

AudioEffectPlayer state.
Type:
  • number
Properties:
Name Type Description
NoPlay number Not playing
Playing number Playing
Pausing number Pausing
PlayEnded number End of play
Source:

(constant) ZegoAudioRoute :number

Audio route
Type:
  • number
Properties:
Name Type Description
Speaker number Speaker
Headphone number Headphone
Bluetooth number Bluetooth device
Receiver number Receiver
ExternalUSB number External USB audio device
AirPlay number Apple AirPlay
Source:

(constant) ZegoCapturePipelineScaleMode :number

Capture pipeline scale mode.
Type:
  • number
Properties:
Name Type Description
Pre number Zoom immediately after acquisition, default
Post number Scaling while encoding
Source:

(constant) ZegoDataRecordState :number

Record state.
Type:
  • number
Properties:
Name Type Description
NoRecord number Unrecorded state, which is the state when a recording error occurs or before recording starts.
Recording number Recording in progress, in this state after successfully call [startRecordingCapturedData] function
Success number Record successs
Source:

(constant) ZegoDataRecordType :number

Record type.
Type:
  • number
Properties:
Name Type Description
Default number 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.
OnlyAudio number only record audio
OnlyVideo number only record video, Audio SDK and recording .aac format files are invalid.
AudioAndVideo number record audio and video. Express-Audio SDK and .aac format files are recorded only audio.
Source:

(constant) ZegoEngineState :number

engine state.
Type:
  • number
Properties:
Name Type Description
Start number The engine has started
Stop number The engine has stoped
Source:

(constant) ZegoLanguage :number

Language.
Type:
  • number
Properties:
Name Type Description
English number English
Chinese number Chinese
Source:

(constant) ZegoMediaPlayerAudioChannel :number

Audio channel.
Type:
  • number
Properties:
Name Type Description
Left number Audio channel left
Right number Audio channel right
All number Audio channel all
Source:

(constant) ZegoMediaPlayerNetworkEvent :number

Player network event.
Type:
  • number
Properties:
Name Type Description
BufferBegin number Network resources are not playing well, and start trying to cache data
BufferEnded number Network resources can be played smoothly
Source:

(constant) ZegoMediaPlayerState :number

Player state.
Type:
  • number
Properties:
Name Type Description
NoPlay number Not playing
Playing number Playing
Pausing number Pausing
PlayEnded number End of play
Source:

(constant) ZegoMixerInputContentType :number

Mix stream content type.
Type:
  • number
Properties:
Name Type Description
Audio number Mix stream for audio only
Video number Mix stream for both audio and video
VideoOnly number Mix stream for video only
Source:

(constant) ZegoNetworkMode :number

Network mode
Type:
  • number
Properties:
Name Type Description
Offline number Offline (No network)
Unknown number Unknown network mode
Ethernet number Wired Ethernet (LAN)
Wifi number Wi-Fi (WLAN)
Mode2G number 2G Network (GPRS/EDGE/CDMA1x/etc.)
Mode3G number 3G Network (WCDMA/HSDPA/EVDO/etc.)
Mode4G number 4G Network (LTE)
Mode5G number 5G Network (NR (NSA/SA))
Source:

(constant) ZegoNetworkSpeedTestType :number

network speed test type
Type:
  • number
Properties:
Name Type Description
Uplink number uplink
Downlink number downlink
Source:

(constant) ZegoPlayerMediaEvent :number

Media event when playing.
Type:
  • number
Properties:
Name Type Description
AudioBreakOccur number Audio stuck event when playing
AudioBreakResume number Audio stuck event recovery when playing
VideoBreakOccur number Video stuck event when playing
VideoBreakResume number Video stuck event recovery when playing
Source:

(constant) ZegoPlayerState :number

Playing stream status.
Type:
  • number
Properties:
Name Type Description
NoPlay number 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 and AppSign are incorrect, it will enter this state.
PlayRequesting number 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.
Playing number 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.
Source:

(constant) ZegoPlayerVideoLayer :number

Player video layer.
Type:
  • number
Properties:
Name Type Description
Auto number The layer to be played depends on the network status
Base number Play the base layer (small resolution)
BaseExtend number Play the extend layer (big resolution)
Source:

(constant) ZegoPublishChannel :number

Publish channel.
Type:
  • number
Properties:
Name Type Description
Main number Main publish channel, default publish channel.
Aux number Auxiliary publish channel
Third number The third publish channel
Fourth number The fourth publish channel
Source:

(constant) ZegoPublisherState :number

Publish stream status.
Type:
  • number
Properties:
Name Type Description
NoPublish number 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 and AppSign are incorrect, or if other users are already publishing the stream, there will be a failure and enter this state.
PublishRequesting number 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.
Publishing number 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.
Source:

(constant) ZegoRemoteDeviceState :number

Remote device status.
Type:
  • number
Properties:
Name Type Description
Open number Device on
GenericError number General device error
InvalidID number Invalid device ID
NoAuthorization number No permission
ZeroFPS number Captured frame rate is 0
InUseByOther number The device is occupied
Unplugged number The device is not plugged in or unplugged
RebootRequired number The system needs to be restarted
SystemMediaServicesLost number 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.
Disable number Capturing disabled
Mute number The remote device is muted
Interruption number The device is interrupted, such as a phone call interruption, etc.
InBackground number 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.
MultiForegroundApp number CDN server actively disconnected
BySystemPressure number The system is under high load pressure and may cause abnormal equipment.
NotSupport number The remote device is not supported to publish the device state.
Source:

(constant) ZegoReverbPreset :number

Reverberation preset value.
Type:
  • number
Properties:
Name Type Description
None number No Reverberation
SoftRoom number Soft room reverb effect
LargeRoom number Large room reverb effect
ConcertHall number Concert hall reverb effect
Valley number Valley reverb effect
RecordingStudio number Recording studio reverb effect
Basement number Basement reverb effect
KTV number KTV reverb effect
Popular number Popular reverb effect
Rock number Rock reverb effect
VocalConcert number Vocal concert reverb effect
GramoPhone number Gramophone reverb effect
Source:

(constant) ZegoRoomState :number

Room state.
Type:
  • number
Properties:
Name Type Description
Disconnected number 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 and AppSign are incorrect, or if the same user name is logged in elsewhere and the local end is KickOut, it will enter this state.
Connecting number 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.
Connected number 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.
Source:

(constant) ZegoScenario :number

Application scenario.
Type:
  • number
Properties:
Name Type Description
General number General scenario
Communication number Communication scenario
Live number Live scenario
Source:

(constant) ZegoSEIType :number

SEI type
Type:
  • number
Properties:
Name Type Description
ZegoDefined number 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.
UserUnregister number 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.
Source:

(constant) ZegoStreamQualityLevel :number

Stream quality level.
Type:
  • number
Properties:
Name Type Description
Excellent number Excellent
Good number Good
Medium number Normal
Bad number Bad
Die number Failed
Unknown number Unknown
Source:

(constant) ZegoStreamRelayCDNState :number

State of CDN relay.
Type:
  • number
Properties:
Name Type Description
NoRelay number The state indicates that there is no CDN relay
RelayRequesting number The CDN relay is being requested
Relaying number Entering this status indicates that the CDN relay has been successful
Source:

(constant) ZegoStreamRelayCDNUpdateReason :number

Reason for state of CDN relay changed.
Type:
  • number
Properties:
Name Type Description
None number No error
ServerError number Server error
HandshakeFailed number Handshake error
AccessPointError number Access point error
CreateStreamFailed number Stream create failure
BadName number Bad name
CDNServerDisconnected number CDN server actively disconnected
Disconnected number Active disconnect
MixStreamAllInputStreamClosed number All mixer input streams sessions closed
MixStreamAllInputStreamNoData number All mixer input streams have no data
MixStreamServerInternalError number Internal error of stream mixer server
Source:

(constant) ZegoStreamResourceMode :number

Stream Resource Mode
Type:
  • number
Properties:
Name Type Description
Default number 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.
OnlyCDN number Playing stream only from CDN.
OnlyL3 number Playing stream only from L3.
OnlyRTC number Playing stream only from RTC.
Source:

(constant) ZegoTrafficControlFocusOnMode :number

Factors that trigger traffic control
Type:
  • number
Properties:
Name Type Description
ZegoTrafficControlFounsOnLocalOnly number Focus only on the local network
ZegoTrafficControlFounsOnRemote number Pay attention to the local network, but also take into account the remote network, currently only effective in the 1v1 scenario
Source:

(constant) ZegoTrafficControlMinVideoBitrateMode :number

Video transmission mode when current bitrate is lower than the set minimum bitrate.
Type:
  • number
Properties:
Name Type Description
NoVideo number Stop video transmission when current bitrate is lower than the set minimum bitrate
UltraLowFPS number Video is sent at a very low frequency (no more than 2fps) which is lower than the set minimum bitrate
Source:

(constant) ZegoTrafficControlProperty :number

Traffic control property (bitmask enumeration).
Type:
  • number
Properties:
Name Type Description
Basic number Basic (Adaptive (reduce) video bitrate)
AdaptiveFPS number Adaptive (reduce) video FPS
AdaptiveResolution number Adaptive (reduce) video resolution
AdaptiveAudioBitrate number Adaptive (reduce) audio bitrate
Source:

(constant) ZegoUpdateType :number

Update type.
Type:
  • number
Properties:
Name Type Description
Add number Add
Delete number Delete
Source:

(constant) ZegoVideoBufferType :number

Video frame buffer type.
Type:
  • number
Properties:
Name Type Description
Unknown number Raw data type video frame
RawData number Raw data type video frame
EncodedData number Encoded data type video frame
GLTexture2D number Texture 2D type video frame
CVPixelBuffer number CVPixelBuffer type video frame
SurfaceTexture number Surface Texture type video frame
GLTextureExternalOES number GL_TEXTURE_EXTERNAL_OES type video frame
Source:

(constant) ZegoVideoCodecID :number

Video codec ID.
Type:
  • number
Properties:
Name Type Description
Default number Default (H.264)
SVC number Scalable Video Coding (H.264 SVC)
VP8 number VP8
H265 number H.265
Source:

(constant) ZegoVideoConfigPreset :number

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.
Type:
  • number
Properties:
Name Type Description
Preset180P number Set the resolution to 320x180, the default is 15 fps, the code rate is 300 kbps
Preset270P number Set the resolution to 480x270, the default is 15 fps, the code rate is 400 kbps
Preset360P number Set the resolution to 640x360, the default is 15 fps, the code rate is 600 kbps
Preset540P number Set the resolution to 960x540, the default is 15 fps, the code rate is 1200 kbps
Preset720P number Set the resolution to 1280x720, the default is 15 fps, the code rate is 1500 kbps
Preset1080P number Set the resolution to 1920x1080, the default is 15 fps, the code rate is 3000 kbps
Source:

(constant) ZegoVideoFlipMode :number

Video frame flip mode.
Type:
  • number
Properties:
Name Type Description
None number No flip
X number X-axis flip
Y number Y-axis flip
XY number X-Y-axis flip
Source:

(constant) ZegoVideoFrameFormat :number

Video frame format.
Type:
  • number
Properties:
Name Type Description
Unknown number Unknown format, will take platform default
I420 number I420 (YUV420Planar) format
NV12 number NV12 (YUV420SemiPlanar) format
NV21 number NV21 (YUV420SemiPlanar) format
BGRA32 number BGRA32 format
RGBA32 number RGBA32 format
ARGB32 number ARGB32 format
ABGR32 number ABGR32 format
I422 number I422 (YUV422Planar) format
Source:

(constant) ZegoVideoFrameFormatSeries :number

Video frame format series.
Type:
  • number
Properties:
Name Type Description
RGB number RGB series
YUV number YUV series
Source:

(constant) ZegoVideoMirrorMode :number

Mirror mode for previewing or playing the of the stream.
Type:
  • number
Properties:
Name Type Description
OnlyPreviewMirror number The mirror image only for previewing locally. This mode is used by default.
BothMirror number Both the video previewed locally and the far end playing the stream will see mirror image.
NoMirror number Both the video previewed locally and the far end playing the stream will not see mirror image.
OnlyPublishMirror number The mirror image only for far end playing the stream.
Source:

(constant) ZegoVideoStreamType :number

Video stream type
Type:
  • number
Properties:
Name Type Description
Default number The type to be played depends on the network status
Small number small resolution type
Big number big resolution type
Source:

(constant) ZegoViewMode :number

Video rendering fill mode.
Type:
  • number
Properties:
Name Type Description
AspectFit number The proportional scaling up, there may be black borders
AspectFill number The proportional zoom fills the entire View and may be partially cut
ScaleToFill number Fill the entire view, the image may be stretched
Source:

(constant) ZegoVoiceChangerPreset :number

Voice changer preset value.
Type:
  • number
Properties:
Name Type Description
None number No Voice changer
MenToChild number Male to child voice (loli voice effect)
MenToWomen number Male to female voice (kindergarten voice effect)
WomenToChild number Female to child voice
WomenToMen number Female to male voice
Foreigner number Foreigner voice effect
OptimusPrime number Autobot Optimus Prime voice effect
Android number Android robot voice effect
Ethereal number Ethereal voice effect
MaleMagnetic number Magnetic(Male) voice effect
FemaleFresh number Fresh(Female) voice effect
MajorC number Electronic effects in C major voice effect
MinorA number Electronic effects in A minor voice effect
HarmonicMinor number Electronic effects in harmonic minor voice effect
Source:

Type Definitions

ZegoAudioConfig

Audio configuration.
Type:
  • Object
Properties:
Name Type Description
bitrate number Audio bitrate in kbps, default is 48 kbps. The settings before and after publishing stream can be effective
channel ZegoAudioChannel Audio channel, default is Mono. The setting only take effect before publishing stream
codecID ZegoAudioCodecID codec ID, default is ZegoAudioCodecIDDefault. The setting only take effect before publishing stream
Source:

ZegoAudioEffectPlayConfig

AudioEffectPlayer play configuration.
Type:
  • Object
Properties:
Name Type Description
playCount number The number of play counts. When set to 0, it will play in an infinite loop until the user invoke [stop]. The default is 1, which means it will play only once.
isPublishOut boolean Whether to mix audio effects into the publishing stream, the default is false.
Source:

ZegoBarrageMessageInfo

Barrage message info.
Type:
  • Object
Properties:
Name Type Description
message string message content
messageID string message id
sendTime number Message send time, UNIX timestamp, in milliseconds.
fromUser ZegoUser Message sender.Please do not fill in sensitive user information in this field, including but not limited to mobile phone number, ID number, passport number, real name, etc.
Source:

ZegoBroadcastMessageInfo

Broadcast message info.
Type:
  • Object
Properties:
Name Type Description
message string message content
messageID number message id
sendTime number Message send time, UNIX timestamp, in milliseconds.
fromUser ZegoUser Message sender.Please do not fill in sensitive user information in this field, including but not limited to mobile phone number, ID number, passport number, real name, etc.
Source:

ZegoCDNConfig

CDN config object.
Type:
  • Object
Properties:
Name Type Description
url string CDN URL
authParam string Auth param of URL
Source:

ZegoDataRecordConfig

Record config.
Type:
  • Object
Properties:
Name Type Description
filePath string The path to save the recording file, absolute path, need to include the file name, the file name need to specify the suffix, currently supports .mp4/.flv/.aac format files, if multiple recording for the same path, will overwrite the file with the same name. The maximum length should be less than 1024 bytes.
recordType ZegoDataRecordType Type of recording media
Source:

ZegoDataRecordProgress

File recording progress.
Type:
  • Object
Properties:
Name Type Description
duration number Current recording duration in milliseconds
currentFileSize number Current recording file size in byte
Source:

ZegoDeviceInfo

Device Info.
Type:
  • Object
Properties:
Name Type Description
deviceID string Device ID
deviceName string Device name
Source:

ZegoEngineConfig

Advanced engine configuration.
Type:
  • Object
Properties:
Name Type Description
logConfig ZegoLogConfig Log configuration, if not set, use the default configuration. It must be set before calling [createEngine] to take effect. If it is set after [createEngine], it will take effect at the next [createEngine] after [destroyEngine].
advancedConfig map.<string, string> Other special function switches, if not set, no special function will be used by default. Please contact ZEGO technical support before use.
Source:

ZegoEngineProfile

Profile for create engine
Type:
  • Object
Properties:
Name Type Description
appID number Application ID issued by ZEGO for developers, please apply from the ZEGO Admin Console https://console-express.zego.im The value ranges from 0 to 4294967295.
appSign string Application signature for each AppID, please apply from the ZEGO Admin Console. Application signature is a 64 character string. Each character has a range of '0' ~ '9', 'a' ~ 'z'.
scenario ZegoScenario The application scenario. Developers can choose one of ZegoScenario based on the scenario of the app they are developing, and the engine will preset a more general setting for specific scenarios based on the set scenario. After setting specific scenarios, developers can still call specific functions to set specific parameters if they have customized parameter settings.
Source:

ZegoLogConfig

Log config.
Type:
  • Object
Properties:
Name Type Description
logPath string Log file save path
logSize number The maximum log file size (Bytes). The default maximum size is 5MB (5 * 1024 * 1024 Bytes)
Source:

ZegoMixerAudioConfig

Mix stream audio configuration.
Type:
  • Object
Properties:
Name Type Description
bitrate number Audio bitrate in kbps, default is 48 kbps, cannot be modified after starting a mixer task
channel ZegoAudioChannel Audio channel, default is Mono
codecID ZegoAudioCodecID codec ID, default is ZegoAudioCodecIDDefault
Source:

ZegoMixerInput

Mixer input.
Type:
  • Object
Properties:
Name Type Description
streamID string Stream ID, a string of up to 256 characters. You cannot include URL keywords, otherwise publishing stream and playing stream will fails. Only support numbers, English characters and '~', '!', '@', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '/', '\'.
contentType ZegoMixerInputContentType Mix stream content type
layout ZegoRect Stream layout. When the mixed stream is an audio stream (that is, the ContentType parameter is set to the audio mixed stream type), the layout field is not processed inside the SDK, and there is no need to pay attention to this parameter.
soundLevelID number If enable soundLevel in mix stream task, an unique soundLevelID is need for every stream
isAudioFocus boolean Whether the focus voice is enabled in the current input stream, the sound of this stream will be highlighted if enabled
Source:

ZegoMixerOutput

Mixer output object.
Type:
  • Object
Properties:
Name Type Description
target string Mix stream output target, URL or stream ID, if set to be URL format, only RTMP URL surpported, for example rtmp://xxxxxxxx
Source:

ZegoMixerTask

Mix stream task object.
Type:
  • Object
Properties:
Name Type Description
taskID string The task ID of the task
inputList Array.<ZegoMixerInput> The input list of the task
outputList Array.<ZegoMixerOutput> The output list of the task
videoConfig ZegoMixerVideoConfig The audio config of the task
audioConfig ZegoMixerAudioConfig The audio config of the task
watermark ZegoWatermark The watermark of the task
backgroundImageURL string The background image URL of the task
enableSoundLevel boolean Enable or disable sound level callback for the task. If enabled, then the remote player can get the soundLevel of every stream in the inputlist by [onMixerSoundLevelUpdate] callback.
advancedConfig map.<string, string> Set advanced configuration, such as specifying video encoding and others. If you need to use it, contact ZEGO technical support.
Source:

ZegoMixerVideoConfig

Mix stream video config object.
Type:
  • Object
Properties:
Name Type Description
width number Video resolution width
height number Video resolution height
fps number Video FPS, cannot be modified after starting a mixer task
bitrate number Video bitrate in kbps
Source:

ZegoNetworkSpeedTestConfig

Network speed test config
Type:
  • Object
Properties:
Name Type Description
testUplink boolean Test uplink or not
expectedUplinkBitrate number The unit is kbps. Recommended to use the bitrate in ZegoVideoConfig when call startPublishingStream to determine whether the network uplink environment is suitable.
testDownlink boolean Test downlink or not
expectedDownlinkBitrate number The unit is kbps. Recommended to use the bitrate in ZegoVideoConfig when call startPublishingStream to determine whether the network downlink environment is suitable.
Source:

ZegoNetworkSpeedTestQuality

network speed test quality
Type:
  • Object
Properties:
Name Type Description
connectCost number Time to connect to the server, in milliseconds. During the speed test, if the network connection is disconnected, it will automatically initiate a reconnection, and this variable will be updated accordingly.
rtt number rtt, in milliseconds
packetLostRate number packet lost rate. in percentage, 0.0 ~ 1.0
Source:

ZegoPerformanceStatus

System performance monitoring status
Type:
  • Object
Properties:
Name Type Description
cpuUsageApp number Current CPU usage of the app, value range [0, 1]
cpuUsageSystem number Current CPU usage of the system, value range [0, 1]
memoryUsageApp number Current memory usage of the app, value range [0, 1]
memoryUsageSystem number Current memory usage of the system, value range [0, 1]
memoryUsedApp number Current memory used of the app, in MB
Source:

ZegoPlayerConfig

Advanced player configuration.
Type:
  • Object
Properties:
Name Type Description
resourceMode ZegoStreamResourceMode Stream resource mode
cdnConfig ZegoCDNConfig The CDN configuration for playing stream. If set, the stream is play according to the URL instead of the streamID. After that, the streamID is only used as the ID of SDK internal callback.
videoLayer ZegoPlayerVideoLayer Set the video layer for playing the stream
Source:

ZegoPlayStreamQuality

Played stream quality information.
Type:
  • Object
Properties:
Name Type Description
videoRecvFPS number Video receiving frame rate. The unit of frame rate is f/s
videoDejitterFPS number Video dejitter frame rate. The unit of frame rate is f/s
videoDecodeFPS number Video decoding frame rate. The unit of frame rate is f/s
videoRenderFPS number Video rendering frame rate. The unit of frame rate is f/s
videoKBPS number Video bit rate in kbps
videoBreakRate number Video break rate, the unit is (number of breaks / every 10 seconds)
audioRecvFPS number Audio receiving frame rate. The unit of frame rate is f/s
audioDejitterFPS number Audio dejitter frame rate. The unit of frame rate is f/s
audioDecodeFPS number Audio decoding frame rate. The unit of frame rate is f/s
audioRenderFPS number Audio rendering frame rate. The unit of frame rate is f/s
audioKBPS number Audio bit rate in kbps
audioBreakRate number Audio break rate, the unit is (number of breaks / every 10 seconds)
rtt number Server to local delay, in milliseconds
packetLostRate number Packet loss rate, in percentage, 0.0 ~ 1.0
peerToPeerDelay number Delay from peer to peer, in milliseconds
peerToPeerPacketLostRate number Packet loss rate from peer to peer, in percentage, 0.0 ~ 1.0
level ZegoStreamQualityLevel Published stream quality level
delay number Delay after the data is received by the local end, in milliseconds
avTimestampDiff number The difference between the video timestamp and the audio timestamp, used to reflect the synchronization of audio and video, in milliseconds. This value is less than 0 means the number of milliseconds that the video leads the audio, greater than 0 means the number of milliseconds that the video lags the audio, and 0 means no difference. When the absolute value is less than 200, it can basically be regarded as synchronized audio and video, when the absolute value is greater than 200 for 10 consecutive seconds, it can be regarded as abnormal
isHardwareDecode boolean Whether to enable hardware decoding
videoCodecID ZegoVideoCodecID Video codec ID
totalRecvBytes number Total number of bytes received, including audio, video, SEI
audioRecvBytes number Number of audio bytes received
videoRecvBytes number Number of video bytes received
Source:

ZegoPublishStreamQuality

Published stream quality information.
Type:
  • Object
Properties:
Name Type Description
videoCaptureFPS number Video capture frame rate. The unit of frame rate is f/s
videoEncodeFPS number Video encoding frame rate. The unit of frame rate is f/s
videoSendFPS number Video transmission frame rate. The unit of frame rate is f/s
videoKBPS number Video bit rate in kbps
audioCaptureFPS number Audio capture frame rate. The unit of frame rate is f/s
audioSendFPS number Audio transmission frame rate. The unit of frame rate is f/s
audioKBPS number Audio bit rate in kbps
rtt number Local to server delay, in milliseconds
packetLostRate number Packet loss rate, in percentage, 0.0 ~ 1.0
level ZegoStreamQualityLevel Published stream quality level
isHardwareEncode boolean Whether to enable hardware encoding
videoCodecID ZegoVideoCodecID Video codec ID
totalSendBytes number Total number of bytes sent, including audio, video, SEI
audioSendBytes number Number of audio bytes sent
videoSendBytes number Number of video bytes sent
Source:

ZegoRect

View related coordinates.
Type:
  • Object
Properties:
Name Type Description
x number The horizontal offset from the top-left corner
y number The vertical offset from the top-left corner
width number The width of the rectangle
height number The height of the rectangle
Source:

ZegoReverbAdvancedParam

Audio reverberation advanced parameters.
Type:
  • Object
Properties:
Name Type Description
roomSize number Room size(%), in the range [0.0, 1.0], to control the size of the "room" in which the reverb is generated, the larger the room, the stronger the reverb.
reverberance number Echo(%), in the range [0.0, 100.0], to control the trailing length of the reverb.
damping number Reverb Damping(%), range [0.0, 100.0], controls the attenuation of the reverb, the higher the damping, the higher the attenuation.
wetOnly boolean only wet
wetGain number wet gain(dB), range [-20.0, 10.0]
dryGain number dry gain(dB), range [-20.0, 10.0]
toneLow number Tone Low. 100% by default
toneHigh number Tone High. 100% by default
preDelay number PreDelay(ms), range [0.0, 200.0]
stereoWidth number Stereo Width(%). 0% by default
Source:

ZegoReverbEchoParam

Audio reverberation echo parameters.
Type:
  • Object
Properties:
Name Type Description
inGain number Gain of input audio signal, in the range [0.0, 1.0]
outGain number Gain of output audio signal, in the range [0.0, 1.0]
numDelays number Number of echos, in the range [0, 7]
delay Array.<number> Respective delay of echo signal, in milliseconds, in the range [0, 5000] ms
decay Array.<number> Respective decay coefficient of echo signal, in the range [0.0, 1.0]
Source:

ZegoReverbParam

Audio reverberation parameters.
Type:
  • Object
Properties:
Name Type Description
roomSize number Room size, in the range [0.0, 1.0], to control the size of the "room" in which the reverb is generated, the larger the room, the stronger the reverb.
reverberance number Echo, in the range [0.0, 0.5], to control the trailing length of the reverb.
damping number Reverb Damping, range [0.0, 2.0], controls the attenuation of the reverb, the higher the damping, the higher the attenuation.
dryWetRatio number Dry/wet ratio, the range is greater than or equal to 0.0, to control the ratio between reverberation, direct sound and early reflections; dry part is set to 1 by default; the smaller the dry/wet ratio, the larger the wet ratio, the stronger the reverberation effect.
Source:

ZegoRoomConfig

Advanced room configuration.
Type:
  • Object
Properties:
Name Type Description
maxMemberCount number The maximum number of users in the room, Passing 0 means unlimited, the default is unlimited.
isUserStatusNotify boolean Whether to enable the user in and out of the room callback notification [onRoomUserUpdate], the default is off. If developers need to use ZEGO Room user notifications, make sure that each user who login sets this flag to true
token string The token issued by the developer's business server is used to ensure security. The generation rules are detailed in Room Login Authentication Description https://doc-en.zego.im/en/3881.html Default is empty string, that is, no authentication
Source:

ZegoRoomExtraInfo

Room extra information.
Type:
  • Object
Properties:
Name Type Description
key string The key of the room extra information.
value string The value of the room extra information.
updateUser ZegoUser The user who update the room extra information.Please do not fill in sensitive user information in this field, including but not limited to mobile phone number, ID number, passport number, real name, etc.
updateTime number Update time of the room extra information, UNIX timestamp, in milliseconds.
Source:

ZegoSEIConfig

SEI configuration
Type:
  • Object
Properties:
Name Type Description
type ZegoSEIType SEI type
Source:

ZegoStream

Stream object.
Type:
  • Object
Properties:
Name Type Description
user ZegoUser User object instance.Please do not fill in sensitive user information in this field, including but not limited to mobile phone number, ID number, passport number, real name, etc.
streamID string Stream ID, a string of up to 256 characters. You cannot include URL keywords, otherwise publishing stream and playing stream will fails. Only support numbers, English characters and '~', '!', '@', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '/', '\'.
extraInfo string Stream extra info
Source:

ZegoStreamRelayCDNInfo

Relay to CDN info.
Type:
  • Object
Properties:
Name Type Description
url string URL of publishing stream to CDN
state ZegoStreamRelayCDNState State of relaying to CDN
updateReason ZegoStreamRelayCDNUpdateReason Reason for relay state changed
stateTime number The timestamp when the state changed, UNIX timestamp, in milliseconds.
Source:

ZegoUser

User object.
Type:
  • Object
Properties:
Name Type Description
userID string User ID, a string with a maximum length of 64 bytes or less.Please do not fill in sensitive user information in this field, including but not limited to mobile phone number, ID number, passport number, real name, etc. Only support numbers, English characters and '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '/', '\'.
userName string User Name, a string with a maximum length of 256 bytes or less.Please do not fill in sensitive user information in this field, including but not limited to mobile phone number, ID number, passport number, real name, etc.
Source:

ZegoVideoConfig

Video config.
Type:
  • Object
Properties:
Name Type Description
captureWidth number Capture resolution width, control the width of camera image acquisition. SDK requires this member to be set to an even number. Only the camera is not started and the custom video capture is not used, the setting is effective. For performance reasons, the SDK scales the video frame to the encoding resolution after capturing from camera and before rendering to the preview view. Therefore, the resolution of the preview image is the encoding resolution. If you need the resolution of the preview image to be this value, Please call [setCapturePipelineScaleMode] first to change the capture pipeline scale mode to [Post]
captureHeight number Capture resolution height, control the height of camera image acquisition. SDK requires this member to be set to an even number. Only the camera is not started and the custom video capture is not used, the setting is effective. For performance reasons, the SDK scales the video frame to the encoding resolution after capturing from camera and before rendering to the preview view. Therefore, the resolution of the preview image is the encoding resolution. If you need the resolution of the preview image to be this value, Please call [setCapturePipelineScaleMode] first to change the capture pipeline scale mode to [Post]
encodeWidth number Encode resolution width, control the image width of the encoder when publishing stream. SDK requires this member to be set to an even number. The settings before and after publishing stream can be effective
encodeHeight number Encode resolution height, control the image height of the encoder when publishing stream. SDK requires this member to be set to an even number. The settings before and after publishing stream can be effective
fps number Frame rate, control the frame rate of the camera and the frame rate of the encoder. Only the camera is not started, the setting is effective
bitrate number Bit rate in kbps. The settings before and after publishing stream can be effective
codecID ZegoVideoCodecID The codec id to be used, the default value is [default]. Settings only take effect before publishing stream
Source:

ZegoView

View object.
Type:
  • Object
Properties:
Name Type Description
viewMode ZegoViewMode View mode, default is ZegoViewModeAspectFit
backgroundColor number Background color, the format is 0xRRGGBB, default is black, which is 0x000000
canvas canvas html canvas element
preserveDrawingBuffer boolean webgl context preserve drawing buffer
Source:

ZegoVoiceChangerParam

Voice changer parameter.
Type:
  • Object
Properties:
Name Type Description
pitch number Pitch parameter, value range [-8.0, 8.0], the larger the value, the sharper the sound, set it to 0.0 to turn off. Note that the voice changer effect is only valid for the captured sound.
Source:

ZegoWatermark

Watermark object.
Type:
  • Object
Properties:
Name Type Description
imageURL string Watermark image URL, only png or jpg format surpport.
layout ZegoRect Watermark image layout
Source: