Struct

Audio bitrate in kbps, default is 48 kbps. The settings before and after publishing stream can be effective

Audio channel, default is Mono. The setting only take effect before publishing stream

codec ID, default is ZegoAudioCodecIDDefault. The setting only take effect before publishing stream

Sampling Rate

Audio channel, default is Mono

CDN URL

Auth param of URL. Please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored (set to null or empty string).

URL supported protocols, candidate values are "tcp" and "quic". If there are more than one, separate them with English commas and try them in order. Please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored (set to null or empty string).

QUIC version。 If [protocol] has the QUIC protocol, this information needs to be filled in. If there are multiple version numbers, separate them with commas. Please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored (set to null or empty string).

customized httpdns service. This feature is only supported for playing stream currently.

QUIC establishes link mode. If the value is 1, quic 0 rtt is used preferentially to establish link. Otherwise, the link is established normally. If [protocol] has the QUIC protocol, this value takes effect.

custom param of URL. Please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored (set to null or empty string).

View object

View mode, default is ZegoViewModeAspectFit

Device ID

Device name

The whiten intensity parameter, the value range is [0,100], and the default is 50.

the rosy intensity parameter, value range [0,100], and the default is 50.

the smooth intensity parameter, value range [0,100], and the default is 50.

the sharpen intensity parameter, value range [0,100], and the default is 50.

Other special function switches, if not set, no special function will be used by default. Please contact ZEGO technical support before use.

Application ID issued by ZEGO for developers, please apply from the ZEGO Admin Console https://console.zegocloud.com The value ranges from 0 to 4294967295.

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'. AppSign 2.17.0 and later allows null or no transmission. If the token is passed empty or not passed, the token must be entered in the [ZegoRoomConfig] parameter for authentication when the [loginRoom] interface is called to login to the room.

The room scenario. the SDK will optimize the audio and video configuration for the specified scenario to achieve the best effect in this scenario. After specifying the scenario, you can call other APIs to adjusting the audio and video configuration. Differences between scenarios and how to choose a suitable scenario, please refer to https://docs.zegocloud.com/article/14940

Used to customize the storage path of the log file.

Used to customize the maximum log file size.

Log files count. Default is 3. Value range is [3, 20].

Used to specify the loading type of multimedia resources.

The progress at which the plaback started.

Common resource path.The absolute resource path or the URL of the network resource and cannot be nil or "". Android can set this path string with Uri.

The resource ID obtained from the copyrighted music module.

Online resource cache path, in utf8 encoding format.

The maximum length of online resource cache to be used, in bytes, with a minimum setting of 500K (500 * 1024). The default value is 0 - no limit, and try to cache the entire file.

Test uplink or not

The unit is kbps. Recommended to use the bitrate in ZegoVideoConfig when call startPublishingStream to determine whether the network uplink environment is suitable.

Test downlink or not

The unit is kbps. Recommended to use the bitrate in ZegoVideoConfig when call startPublishingStream to determine whether the network downlink environment is suitable.

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, in milliseconds

packet lost rate. in percentage, 0.0 ~ 1.0

network quality. excellent, good, medium and poor

Current CPU usage of the app, value range [0, 1]

Current CPU usage of the system, value range [0, 1]

Current memory usage of the app, value range [0, 1]

Current memory usage of the system, value range [0, 1]

Current memory used of the app, in MB

Video receiving frame rate. The unit of frame rate is f/s

Video dejitter frame rate. The unit of frame rate is f/s (Available since 1.17.0)

Video decoding frame rate. The unit of frame rate is f/s

Video rendering frame rate. The unit of frame rate is f/s

Video bit rate in kbps

Video break count, break count during the callback cycle (Available since 1.17.0)

Audio receiving frame rate. The unit of frame rate is f/s

Audio dejitter frame rate. The unit of frame rate is f/s (Available since 1.17.0)

Audio decoding frame rate. The unit of frame rate is f/s

Audio rendering frame rate. The unit of frame rate is f/s

Audio bit rate in kbps

Audio break count, break count during the callback cycle (Available since 1.17.0)

The audio quality of the playing stream determined by the audio MOS (Mean Opinion Score) measurement method, value range [-1, 5], where -1 means unknown, [0, 5] means valid score, the higher the score, the better the audio quality. For the subjective perception corresponding to the MOS value, please refer to https://docs.zegocloud.com/article/3720#4_4 (Available since 2.16.0)

Server to local delay, in milliseconds

Packet loss rate, in percentage, 0.0 ~ 1.0

Delay from peer to peer, in milliseconds

Packet loss rate from peer to peer, in percentage, 0.0 ~ 1.0

Published stream quality level

Delay after the data is received by the local end, in milliseconds

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 (Available since 1.19.0)

Whether to enable hardware decoding

Video codec ID (Available since 1.17.0)

Total number of bytes received, including audio, video, SEI

Number of audio bytes received

Number of video bytes received

Accumulated audio break count (Available since 2.9.0)

Accumulated audio break time, in milliseconds (Available since 2.9.0)

Accumulated audio break rate, in percentage, 0.0 ~ 100.0 (Available since 2.9.0)

Accumulated audio decode time, in milliseconds (Available since 2.9.0)

Accumulated video break count (Available since 2.9.0)

Accumulated video break time, in milliseconds (Available since 2.9.0)

Accumulated video break rate, in percentage, 0.0 ~ 1.0 (Available since 2.9.0)

Accumulated video decode time, in milliseconds (Available since 2.9.0)

Mute video (Available since 3.13.0)

Mute audio (Available since 3.13.0)

Stream resource mode.

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.

The Room ID. It only needs to be filled in the multi-room mode, which indicates which room this stream needs to be bound to. This parameter is ignored in single room mode.

The video encoding type of the stream, please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored.

The resource type of the source stream, please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored.

Preconfigured codec template ID, please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored.

Play resource switching strategy mode, the default is ZegoStreamResourceSwitchModeDefault

Play resource type when stop publish, the default is ZegoStreamResourceTypeDefault. This setting takes effect only if the user sets [resourceMode] to ZegoStreamResourceModeDefaut and [resourceSwitchMode] to ZegoStreamResourceSwitchModeDefault or ZegoStreamResourceSwitchModeSwitchToRTC.

Video capture frame rate. The unit of frame rate is f/s

Video encoding frame rate. The unit of frame rate is f/s

Video transmission frame rate. The unit of frame rate is f/s

Video bit rate in kbps

Audio capture frame rate. The unit of frame rate is f/s

Audio transmission frame rate. The unit of frame rate is f/s

Audio bit rate in kbps

Local to server delay, in milliseconds

Packet loss rate, in percentage, 0.0 ~ 1.0

Published stream quality level

Whether to enable hardware encoding

Video codec ID (Available since 1.17.0)

Total number of bytes sent, including audio, video, SEI

Number of audio bytes sent

Number of video bytes sent

The Room ID, It is not necessary to pass in single room mode, but the ID of the corresponding room must be passed in multi-room mode

Whether to synchronize the network time when pushing streams. 1 is synchronized with 0 is not synchronized. And must be used with setStreamAlignmentProperty. It is used to align multiple streams at the mixed stream service or streaming end, such as the chorus scene of KTV.

When pushing a flow, review the pattern of the flow. By default, no audit is performed. If you want to use this function, contact ZEGO technical support.

Inspect flag. If you want to use this function, contact ZEGO technical support.

The horizontal offset from the top-left corner

The vertical offset from the top-left corner

The width of the rectangle

The height of the rectangle

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.

Echo(%), in the range [0.0, 100.0], to control the trailing length of the reverb.

Reverb Damping(%), range [0.0, 100.0], controls the attenuation of the reverb, the higher the damping, the higher the attenuation.

only wet

wet gain(dB), range [-20.0, 10.0]

dry gain(dB), range [-20.0, 10.0]

Tone Low. 100% by default

Tone High. 100% by default

PreDelay(ms), range [0.0, 200.0]

Stereo Width(%). 0% by default

Gain of input audio signal, in the range [0.0, 1.0]

Gain of output audio signal, in the range [0.0, 1.0]

Number of echos, in the range [0, 7]

Respective delay of echo signal, in milliseconds, in the range [0, 5000] ms

Respective decay coefficient of echo signal, in the range [0.0, 1.0]

The horizontal offset from the top-left corner

The vertical offset from the top-left corner

The width of the rectangle

The height of the rectangle

ROI strength, currently supported value range is [0, 4], 0 is no effect, 4 is the strongest.

The maximum number of users in the room, Passing 0 means unlimited, the default is unlimited.

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

The token issued by the developer's business server is used to ensure security. For the generation rules, please refer to Using Token Authentication, the default is an empty string, that is, no authentication. In versions 2.17.0 and above, if appSign is not passed in when calling the [createEngine] API to create an engine, or if appSign is empty, this parameter must be set for authentication when logging in to a room.

The key of the room extra information.

The value of the room extra information.

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.

Update time of the room extra information, UNIX timestamp, in milliseconds.

Whether to capture video when screen capture. The default is true.

Whether to capture audio when screen capture. The default is true.

Set Microphone audio volume for ReplayKit. The range is 0 ~ 200. The default is 100. (only for iOS)

Set Application audio volume for ReplayKit. The range is 0 ~ 200. The default is 100. (only for iOS and Android)

Set the audio capture parameters during screen capture. (only for Android)

Set the crop rectangle during screen capture. The crop rectangle must be included in the rectangle of the original data, unit is pixel. (only for iOS/Android)

Set the capture orientation of the screen capture. The capture orientation will be fixed, ignoring the system returned orientation. (only for iOS/Android)

Set whether to mute the microphone of the extension process. The default is false. (only for iOS)

Set the audio device mode for the specified scene, the default is None. (only for iOS) s:

1. Only works when the audio main source is always a microphone;
2. Only works for [startScreenCapture] interface, [updateScreenCapture] does not take effect;
3. The audio device mode changes during screen capture may cause the audio output of the screen capture to be abnormal, which can be monitored through [onMobileScreenCaptureExceptionOccurred] callback, and if necessary, the screen capture needs to be restarted.;
4. After the screen capture is stopped, the audio device mode before the screen capture will be restored.

Monitoring time period of the sound level, in milliseconds, has a value range of [100, 3000]. Default is 100 ms.

Set whether the sound level callback includes the VAD detection result.

Sound level value.

Whether the stream corresponding to StreamID contains voice, 0 means noise, 1 means normal voice. This value is valid only when the [enableVAD] parameter in the [ZegoSoundLevelConfig] configuration is set to true when calling [startSoundLevelMonitor].

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.

Stream extra info

URL of publishing stream to CDN

State of relaying to CDN

Reason for relay state changed

The timestamp when the state changed, UNIX timestamp, in milliseconds.

User Name, a utf8 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.

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]

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]

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

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

Frame rate, control the frame rate of the camera and the frame rate of the encoder. Publishing stream set to 60 fps, playing stream to take effect need contact technical support

Bit rate in kbps. The settings before and after publishing stream can be effective. The SDK will automatically set the bit rate suitable for the scenario selected by the developer. If the bit rate manually set by the developer exceeds the reasonable range, the SDK will automatically process the bit rate according to the reasonable range. If you need to configure a high bit rate due to business needs, please contact ZEGO Business.

The codec id to be used, the default value is [default]. Settings only take effect before publishing stream

Pitch parameter, value range [-12.0, 12.0], the larger the value, the sharper the sound, set it to 0.0 to turn off. that on v2.18.0 and older version, the value range is [-8.0, 8.0].