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

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.

Whether to mix audio effects into the publishing stream, the default is false.

Sampling Rate

Audio channel, default is Mono

Media player instance index list.

Audio effect player instance index list.

Enable or disable mix captured system audio into publish stream.

Enable or disable mix SDK playout into publish stream.

Auto stream mixing task id, must be unique in a room.

Auto stream mixing task id.

The audio config of the auto mixer task.

The output list of the auto stream mixing task, items in the list are URL or stream ID, if the item set to be URL format, only RTMP URL surpported, for example rtmp://xxxxxxxx.

Enable or disable sound level callback for the task.If enabled, then the remote player can get the sound level of every stream in the inputlist by [onAutoMixerSoundLevelUpdate] callback.

Background process type.

Background color, the format is 0xRRGGBB, default is black, which is 0x000000

Background image URL. Support local file absolute path (file://xxx). The format supports png, jpg.

Background blur level.

message content

message id

Message send time, UNIX timestamp, in milliseconds.

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.

message content

message id

Message send time, UNIX timestamp, in milliseconds.

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.

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

User object instance, configure userID, userName. that the user ID set here needs to be consistent with the user ID set when logging in to the room, otherwise the request for the copyright music background service will fail.

the ID of the song.

Copyright music resource song copyright provider.

the ID of the song.

Copyright music resource song copyright provider.

The room ID, the single-room mode can not be passed, and the corresponding room ID must be passed in the multi-room mode. Indicates which room to get resources from.

the ID of the song.

Copyright music resource song copyright provider. Refer to the value of [ZegoCopyrightedMusicVendorID].

The room ID, the single-room mode can not be passed, and the corresponding room ID must be passed in the multi-room mode. Indicates which room to get resources from.

The resource type of music.

the ID of the song.

The resource type of music.

The resource quality type of music.

Copyright music resource song copyright provider.

the ID of the song.

The resource type of music. Refer to the value of [ZegoCopyrightedMusicResourceType].

The resource quality type of music. Refer to the value of [ZegoCopyrightedMusicResourceQualityType].

Copyright music resource song copyright provider. Refer to the value of [ZegoCopyrightedMusicVendorID].

the ID of the song.

VOD billing mode.

Copyright music resource song copyright provider.

The room ID, the single-room mode can not be passed, and the corresponding room ID must be passed in the multi-room mode. Indicate in which room to order song/accompaniment/accompaniment clip/accompaniment segment.

The master ID, which must be passed when the billing mode is billed by host. Indicate which homeowner to order song/accompaniment/accompaniment clip/accompaniment segment.

The scene ID, indicate the actual business. For details, please consult ZEGO technical support.

the ID of the song.

VOD billing mode.

Copyright music resource song copyright provider.

The room ID, the single-room mode can not be passed, and the corresponding room ID must be passed in the multi-room mode. Indicate in which room to order song/accompaniment/accompaniment clip/accompaniment segment.

The master ID, which must be passed when the billing mode is billed by host. Indicate which homeowner to order song/accompaniment/accompaniment clip/accompaniment segment.

The scene ID, indicate the actual business. For details, please consult ZEGO technical support.

The resource type of music. Refer to the value of [ZegoCopyrightedMusicResourceType].

Audio capture source type

Sampling rate, the sampling rate of the input data expected by the audio pre-processing module in App. If 0, the default is the SDK internal sampling rate.

Number of sound channels, the expected number of sound channels for input data of the audio pre-processing module in App. If 0, the default is the number of internal channels in the SDK

The number of samples required to encode a frame; if samples = 0, the SDK will use the internal sample number, and the SDK will pass the audio data to the external pre-processing module. If the samples! = 0 (the effective value of samples is between [160, 2048]), and the SDK will send audio data to the external preprocessing module that sets the length of sample number.

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.

Type of recording media

Current recording duration in milliseconds

Current recording file size in byte

The quality of current recording file

Device ID

Device name

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

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

the base64 data of the image (example# h5.img.setAttribute('src', "data

buffer width.

buffer height.

Border size, default value 4, the maximum value is 100.

Background color, the format is 0xRRGGBB, default is green, which is 0x00FF00

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

Video resolution width.

Video resolution height.

Video frame rate.

Audio bitrate in kbps, default is 48 kbps, cannot be modified after starting a mixer task

Audio channel, default is Mono

codec ID, default is ZegoAudioCodecIDDefault

The image path, if not empty, the image will be displayed, otherwise, the video will be displayed. JPG and PNG formats are supported. There are 2 ways to use it: 1. URI: Provide the picture to ZEGO technical support for configuration. After the configuration is complete, the picture URI will be provided, for example: preset-id://xxx.jpg. 2. URL: Only HTTP protocol is supported.

Image display mode. 0: Default. Use image to replace video content when url is not null. 1: Display image based on camera status. Display image when camera is turned off. Display video content when camera is turned on (no need to clear the url parameter). 2: Display image based on the input stream has video data or not. Display image when there is no video data in the input stream for 3 consecutive seconds. The default duration for judging that there is no video data is 3 seconds. If you need change this setting, please contact ZEGO technical support. Display video content when the input stream has video data.

Mix stream content type

Stream layout. When the mixed stream is an audio stream (that is, the ContentType parameter is set to the audio mixed stream type). Developers do not need to assign a value to this field, just use the SDK default.

If enable soundLevel in mix stream task, an unique soundLevelID is need for every stream

Input stream volume, valid range [0, 200], default is 100.

Whether the focus voice is enabled in the current input stream, the sound of this stream will be highlighted if enabled.

The direction of the audio. Valid direction is between 0 to 360. Set -1 means disable. Default value is -1. On web platforms, this property does not take effect.

Text watermark.

Video view render mode.

User image information.

Video frame corner radius, in px.

Set advanced configuration. Please contact ZEGO technical support. On web platforms, this property does not take effect.

Mix stream output target, URL or stream ID, if set to be URL format, only RTMP URL surpported, for example rtmp://xxxxxxxx, addresses with two identical mixed-stream outputs cannot be passed in.

Mix stream output video config. On web platforms, this property does not take effect.

Mix stream output video coding format, supporting H.264 and h.265 coding.

Mix stream output video bitrate in kbps. The default value is the bitrate configured in [ZegoMixerVideoConfig].

Mix stream video encode profile. Default value is [ZegoEncodeProfileDefault].

The video encoding delay of mixed stream output, Valid value range [0, 2000], in milliseconds. The default value is 0.

Enable high definition low bitrate. Default is false.

The task ID of the task

The input list of the task

The output list of the task

The video config of the task

The audio config of the task

The watermark of the task

Mix stream whiteboard

The background image URL of the task

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.

The stream mixing alignment mode

User data, the length of user data should not be more than 1000 bytes and must be utf8 encoded. After setting, the streaming party can obtain the SEI content by listening to the callback of [onPlayerRecvSEI]. Must be encoded for utf8.

Set advanced configuration, such as specifying video encoding and others. If you need to use it, contact ZEGO technical support.

Sets the lower limit of the interval range for the adaptive adjustment of the stream playing cache of the stream mixing server. In the real-time chorus KTV scenario, slight fluctuations in the network at the push end may cause the mixed stream to freeze. At this time, when the audience pulls the mixed stream, there is a high probability of the problem of freeze. By adjusting the lower limit of the interval range for the adaptive adjustment of the stream playing cache of the stream mixing server, it can optimize the freezing problem that occurs when playing mixing streams at the player end, but it will increase the delay. It is not set by default, that is, the server uses its own configuration values. It only takes effect for the new input stream setting, and does not take effect for the input stream that has already started mixing.Value Range: [0,10000], exceeding the maximum value will result in a failure of the stream mixing request. On web platforms, this property does not take effect.

Video resolution width

Video resolution height

Video FPS, cannot be modified after starting a mixer task

Video bitrate in kbps

Video quality, this value is valid when the video rate control mode parameter is set to constant quality. The valid value ranges from 0 to 51. The default value is 23. If you want better video quality, lower the quality value based on 23 to test the adjustment. If you want a smaller file size, test the adjustment by increasing the high quality value at the base of 23. Take the file size under the value x as an example. The file size under the value x + 6 is half the size of the file size under the value x, and the file size under the value x-6 is twice the size of the file size under the value x. On web platforms, this property does not take effect.

Video bitrate control mode. On web platforms, this property does not take effect.

Whiteboard ID.

Whiteboard aspect ratio(width), the default aspect ratio is 16:9.

Whiteboard aspect ratio(height), the default aspect ratio is 16:9.

Whether the whiteboard will load dynamic PPT files or not, default value is false.

Whiteboard layout.

Whiteboard z-order.

Whiteboard background color. Defaule is 0xF1F3F400 (gray). The color value corresponding to RGBA is 0xRRGGBBAA, and setting the transparency of the background color is currently not supported. The AA in 0xRRGGBBAA is 00. For example, select RGB as #87CEFA as the background color, this parameter passes 0x87CEFA00.F

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

Network timestamp after synchronization, 0 indicates not yet synchronized

The max deviation

The type of object segmentation.

Background config.

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]

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, 0.5], to control the trailing length of the reverb.

Reverb Damping, range [0.0, 2.0], controls the attenuation of the reverb, the higher the damping, the higher the attenuation.

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.

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.

SEI type

Target type for screen capture. (only for desktop)

The ID of the capture source.

Capture source name (in UTF8 encoding).

Thumbnail of the capture window.

The image content of the icon.

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.

Stream ID.

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

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

video width

video height

video data(rgba)

publish channel, only used for preview or publish

stream ID, only used for playing stream

View mode, default is ZegoViewModeAspectFit

Background color, the format is 0xRRGGBB, default is black, which is 0x000000

html canvas element

webgl context preserve drawing buffer

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

The path of the watermark image. Support local file absolute path (file://xxx). The format supports png, jpg. The maximum length is less than 512 bytes.

Watermark image layout