Class

• Use cases: When you need to play short sound effects, such as applause, cheers, etc., you can use this interface to achieve.
• When to call /Trigger: Callable after [createAudioEffectPlayer].

Related interfaces: Stop playing the sound effect Interface [stop].

• Caution:

1. The same sound effect ID cannot be played repeatedly until the [onEnd] callback is triggered before the sound effect of the sound effect ID is played.
2. Pausing the audio interface [pause] will not end the audio playback and will not trigger the [onEnd] callback.

• When to call /Trigger: The specified [audioEffectID] is already [start] .

Related interfaces: Ending playing a sound effect will trigger the [onEnd] callback method of the start playing sound effect interface [start].

• Caution: none.

• When to call /Trigger: The specified [audioEffectID] has been [started].

Related interfaces: Start playing audio interface [start] , resume playing interface [resume].

• When to call /Trigger: The specified [audioEffectID] is in the [pause] state.

Related interfaces: Start playing audio interface [start] , pause playing interface [pause].

• Use cases: Adjust the volume of the playing sound effect.
• When to call /Trigger: Callable after [createAudioEffectPlayer].

• When to call /Trigger: It must be called after loading the resource, otherwise the return value is 0.

Related interfaces: Start playing the audio interface [start] and load the audio interface [loadAudioEffect].

• When to call /Trigger: The sound effect needs to have been played via [start], otherwise the return value is 0.

Related interfaces: Start playing the audio interface [start] .

• Trigger: The specified [audioEffectID] has been [started] and has not finished playing.

Related interfaces: Start playing the audio interface [start] .

• When to call: After the engine instance calls the login room [loginRoom].
• Caution: Real user information must be passed in, otherwise song resources cannot be obtained for playback. 2. The user ID and user name set when initializing copyrighted music need to be consistent with the user ID and user name set when logging into the room.

• Use cases: Used to get a list of songs.

• When to call: After initializing copyrighted music [initCopyrightedMusic] successfully.

• Use cases: Obtain copyrighted songs for local playback and sharing.

• When to call: After initializing copyrighted music [initCopyrightedMusic].

• Caution: This interface triggers billing. Each resource has a unique resource ID.

• Related APIs: After a user in the room calls this interface to obtain a music resource successfully, other users in the room can call the [getSharedResource] interface to obtain the music resource once for free.

• Use cases: Obtain copyrighted songs for local playback and sharing.

• When to call: After initializing copyrighted music [initCopyrightedMusic].

• Caution: Each resource has a unique resource ID.

• Related APIs: After a user in the room calls the [requestResource] interface to obtain a music resource successfully, other users in the room can call this interface to obtain the music resource once for free.

• Use cases: Used to display lyrics line by line.
• When to call: After initializing copyrighted music [initCopyrightedMusic] successfully.

• Use cases: Used to display lyrics verbatim.
• Caution: After initializing copyrighted music [initCopyrightedMusic] successfully.

• Use cases: After obtaining the copyright song or accompaniment authorization, use this interface to load the corresponding song or accompaniment resource.
• When to call: After calling the get resource interface [requestResource] or [getSharedResource] to get the resourceID successfully.
• Caution: Loading songs or accompaniment resources is affected by the network.

• Use cases: Used for caching of songs.
• When to call /Trigger: After creating copyrighted music [createCopyrightedMusic].

• Use cases: Can be used to display singing scores on views.
• When to call: It can be called after getting the verbatim lyrics of krc and playing the accompaniment resource of copyright music.

Cautions: The H5 player playing the accompaniment must start playing to call this interface to start scoring, otherwise there may be a problem that the scoring is not aligned with the progress of the song.

Related interfaces: stopScore End scoring interface, used to end the scoring task. Only one scoring task can be performed at a time, and the current task needs to be completed before the next one can be performed.

• Use cases: When grading is in progress, this interface can be called to end grading.
• When to call: Callable while scoring is in progress.

Related interfaces: Start scoring interface startScore .

• Use cases: Called when a pause is required during singing.
• When to call: Callable while scoring is in progress.

Related interfaces: Resume scoring interface resumeScore .

• Use cases: During the singing process, it is necessary to resume singing and scoring after a break.
• When to call: After calling start scoring interface startScore and suspending scoring.

Related interfaces: Pause scoring interface pauseScore.

• Use cases: I sang part of this scoring task but want to start over and re-score.
• When to call: After calling the scoring interface startScore.

• Use cases: Can be used to display the score of each sentence on the view.
• When to call: It can be called after playing the copyright accompaniment or climax clip and starting to score.

• Use cases: Can be used to display the average rating on the view.
• When to call: It can be called after playing the copyright accompaniment or climax clip and starting to score.

• Use cases: Can be used to display the total score on the view.
• When to call: It can be called after playing the copyright accompaniment or climax clip and starting to score.

• Use cases: Can be used to display full marks on views.
• When to call: It can be called after playing the copyright accompaniment or climax clip and starting to score.

• Use cases: Can be used to display standard pitch lines on a view.
• When to call: It can be called after calling requestResource to request the corresponding copyright accompaniment or climax clip.

Cautions: Only accompaniment or climax clip assets have pitchlines.

• Use cases: Can be used to display the pitch buoy position on the view.
• When to call: It can be called after playing the copyright accompaniment or climax clip and starting to score.

• Default value: When this function is not called, the scoring difficulty level defaults to 4, the lowest level of difficulty.
• When to call: After the call to initialize copyright music is successful, call [startScore] before starting scoring.

• When to call: Must be set before calling [createEngine] to take effect, otherwise it will fail.

• Use cases: Used when special configuration operations are required for the SDK engine, please consult ZEGO technical support for details.
• When to call: Must be set before calling new to take effect, otherwise it will fail.

• When to call /Trigger: After initializing the ZegoExpressEngine instance.

• Default value: Both the local log and upload level are info.
• When to call: before initialization.

Usage restriction: None, but it is recommended to call it only once in the entire life cycle.

Unless there is a clear special requirement, please do not call this interface to change the default configuration.

• Related callbacks: None

Related interface: The difference from setLogConfig is that it can be called before initializing the instance.

• When to call: Called before initialization.

Usage restriction: This interface cannot be called to modify the configuration after initializing the instance to avoid unexpected errors.

• When to call: Called before initialization.

Usage restriction: 1. This interface cannot be called to modify the configuration after initializing the instance to avoid unexpected errors. 2. It cannot be used together with setCloudProxyConfiguration.

• Use cases: When you need to combine multiple video streams and pictures of local users into one video stream, such as online education, remote conferences, live broadcasts, etc., you can use the broadcast station to achieve this.
• Caution:

1. Each broadcast station object can only output one mixed stream.
2. Mobile terminal is not supported yet.

• Use cases: When a user has a problem, he can click to upload the offline log saved in the browser by the SDK to the ZEGO background, so that ZEGO technical staff can help and troubleshoot user problems.
• When to call: After logging into the room.
• Caution: none.
• Related APIs: none.
• Related callbacks: none.

• When to call: after initialization.

s: None.

• Related callbacks: None.

• Use cases: This function is suitable for modifying the settings of various audio and video business scenarios, such as 1v1 audio and video call scenarios and show live broadcast scenarios; this function can be used to switch scenarios under the premise of the same engine instance.
• Default value: none
• When to call /Trigger: It must be set before calling [loginRoom], and it will be generated in [createStream] called later, and it will not be generated for the stream that has already been created.
• Caution: 1.Users in the same room recommend using the same room scene for best results. 2.Setting the scene will affect the audio and video configurations such as audio and video bit rate, frame rate, resolution, encoding type, 3A, ear return, etc. If developers have special needs, they can call other various APIs to set the above configuration after setting the room scene. 3.Calling this function will overwrite the scene specified when [new ZegoExpressEngine] was called or the scene set by the previous call to this function.

• Default value: no default value.

• When to call: the last API called by the same engine instance.

  After destroying the engine, the instantiated object should be cleared in time, and other interfaces of the engine object should not be called, otherwise unexpected problems may occur.

• When to call: Called before initiating push or pull streaming.

• When to call: After initialization.

• Default value: none
• When to call: After initialization, it is called before the flow is created.

Restrictions on use: None

1. The real support depends not only on the browser, but also on the system, so there is a low probability of inaccurate monitoring.
2. When you choose to check the camera or microphone capability, the browser will prompt a pop-up box to ask for permission to allow the device.
3. In the case of using only play stream but not publish stream, you don't need to check the device capability, only need to check "webRTC", "H264" or "VP8". Example: const result = await zg.checkSystemRequirements("webRTC").

Scope of influence: None

• Related callbacks: None

Related interface: None

• Platform differences: None

• When to call: after registration, before exiting the room.
• Default value: none

Restrictions on use: None

When there are multiple events of the same type, they will all be deleted.

Scope of influence: None

• Related callbacks: None

Related interface: None

• Platform differences: None

• Use cases: When performing multi-terminal behavior synchronization, it is necessary to obtain the synchronization network time to calibrate the current time.
• When to call: After initializing a ZegoExpresEngine instance.

• Use cases: Used to enable functions such as camera capture or screen sharing.
• Default value: The default is the camera capture stream, and the default is the high-definition format.
• When to call: It can be called after initializing and calling the interface checkSystemRequirements to check that the returned result is supported.
• Caution: 1. The understanding of the video width and height is different between the mobile terminal and the PC terminal. The two are exactly the opposite. The same resolution is horizontal screen on the PC terminal and vertical screen on the mobile terminal.

2. The interface must be called under the secure domain name (https, localhost, 127.0.0.1).
3. When pushing a third-party stream, the input corresponding to the <video> tag must be loaded successfully (oncanplay callback of media tag) before calling this interface.
4. Set the start bitrate parameter startBitrate to "target" (supported by chrome kernel only), the bitrate will increase rapidly when streaming, and if the network is poor, freezes or screens may occur, so it is recommended to use the default slow increase method.
5. If there is a need to temporarily open and close the audio or video, it is recommended to push the audio and video stream first, and then set the enable corresponding to the unnecessary audio or video track to false, and to turn on the audio or video track after pushing the stream, you can call replaceTrack interface.
6. When the screen sharing setting source.screen.audio is true (only supported by windows), only the system sound will be pushed, not the microphone sound.
7. Although the API supports setting the resolution, many devices do not support custom resolutions. It is recommended to use several resolutions preset by the parameter source.camera.videoQuality or source.screen.videoQuality.
8. camera.channelCount and custom.channelCount are only supported by chrome kernel browser.

• Related callbacks: Publishing stream quality callback The content of the quality message of publishQualityUpdate will be related to the setting parameters; the media stream will be automatically destroyed when the screen sharing interrupt callback screenSharingEnded is triggered.
• Related APIs: Destroy the created media stream interface destroyStream and start pushing the stream interface startPublishingStream.

• Use cases: Used to enable functions such as camera capture or screen sharing.
• Default value: The default is the camera capture stream, and the default is the high-definition format.
• When to call: It can be called after initializing and calling the interface checkSystemRequirements to check that the returned result is supported.
• Caution: 1. The understanding of the video width and height is different between the mobile terminal and the PC terminal. The two are exactly the opposite. The same resolution is horizontal screen on the PC terminal and vertical screen on the mobile terminal.

2. The interface must be called under the secure domain name (https, localhost, 127.0.0.1).
3. When pushing a third-party stream, the input corresponding to the <video> tag must be loaded successfully (oncanplay callback of media tag) before calling this interface.
4. Set the start bitrate parameter startBitrate to "target" (supported by chrome kernel only), the bitrate will increase rapidly when streaming, and if the network is poor, freezes or screens may occur, so it is recommended to use the default slow increase method.
5. If there is a need to temporarily open and close the audio or video, it is recommended to push the audio and video stream first, and then Then call [mutePublishStreamVideo] to open and close the video, [mutePublishStreamAudio] to open and close the audio. If you want to update the capture audio or video track after pushing the stream, you can call [start Capture Camera], [startCapture Microphone] and other capture APIs on the ZegoLocalStream instance, and combine it with [updatePublishingStream] to update the audio and video in the push stream.
6. When the screen sharing setting source.screen.audio is true (only supported by windows), only the system sound will be pushed, not the microphone sound.
7. Although the API supports setting the resolution, many devices do not support custom resolutions. It is recommended to use several resolutions preset by the parameter source.camera.video.quality or source.screen.video.quality.
8. camera.audio.channelCount and custom.audio.channelCount are only supported by chrome kernel browser.

• Related callbacks: Publishing stream quality callback The content of the quality message of publishQualityUpdate will be related to the setting parameters; the media stream will be automatically destroyed when the screen sharing interrupt callback screenSharingEnded is triggered.
• Related APIs: Destroy the created media stream interface destroyStream and start pushing the stream interface startPublishingStream.

• Use cases: Call [createZegoStream] to create a ZegoLocalStream instance object. After [startPublishingStream] successfully pushes the stream, you need to update the audio and video being pushed by the ZegoLocalStream instance.

• Caution: ZegoLocalStream is required to successfully capture audio and video streams for update.

• Use cases: Obtain the quality parameters such as the resolution, frame rate, and bit rate of the current push stream.
• When to call: [startPublishingStream] After the push stream is successful.
• Related APIs: Publishing stream quality callback [publishQualityUpdate].

• Default value: None

Timing of calling: After the stream is the stream is collected successfully.

Restrictions on use: None

1. The stream has an audio.
2. It is only valid for RTC streams or L3 streams, and cannot operate CDN pull streams.
3. Chrome browser support 85 above.
4. Due to browser limitations, data callbacks are only available after interaction with the page.

Scope of influence: None

• Related callbacks: None

Related interface: None

• Platform differences: None

• Default value: None
• When to call: it can only be called after the stream is created.

Restrictions on use: None

In the process of streaming, destroying the streaming will cause the streaming to be interrupted. Please stop the streaming before destroying the streaming, otherwise the peer screen will be stuck.

Scope of influence: None

• Related callbacks: None

Related interface: create push stream data source createStream.

• Platform differences: None

• Default value: None
• When to call: it can only be called after the stream is created.

Restrictions on use: None

Only valid for local capture streams generated by createStream.

Scope of influence: None

• Related callbacks: None

Related interface: create push stream data source createStream.

• Platform differences: None

• Default value: None
• When to call: it can only be called after the stream is created.

Restrictions on use: None

Only valid for local capture streams generated by createStream.

Scope of influence: None

• Related callbacks: None

Related interface: create push stream data source createStream.

• Platform differences: None

• Default value: publishOption.videoCodec uses H.264 to push streaming by default. If you have special needs, you can choose VP8. For more scenarios, please consult ZEGO's pre-sales engineers.
• When to call: After the stream is successfully created.
• Related callbacks: Push quality callback PublishQualityUpdate, the thrill state callback PublisherstateUpdate (can be judged by this interface to determine if the stream is successful).

Related interface: End the stream by calling the interface StoppublishingStream.

• Default value: None

Timing of calling: after successful push.

Restrictions on use: None

Stopping streaming will not cause the rendered <video> screen to be paused. Developers need to destroy the <video> by themselves.

Scope of influence: None

• Related callbacks: push stream quality callback publishQualityUpdate, push stream state callback publisherStateUpdate.

Related interface: startPublishingStream.

• Platform differences: None

• Use cases: Generally used in scenes such as synchronizing music lyrics or precise video layout, you can choose to send SEI.
• When to call: After starting to push the stream [startPublishingStream].
• Caution: 1. Supported browsers: Chrome 86 and above, Firefox 117 and above, Safari 15.4 and above, Android WeChat browser.

2. Since the SEI information follows the video frame, there may be frame loss due to network problems, so the SEI information may also be lost. In order to solve this situation, it should be sent several times within the restricted frequency.
3. SEI has high performance requirements, and simultaneous SEI operation on multiple streams may have an impact

• Related APIs: After the pusher sends the SEI, the puller can obtain the SEI content by monitoring the callback of [on] event "PlayerRecvSEI".
• Related callbacks: none.

• Default value: The default video capture resolution is 640 * 480, frame rate is 15, and bitrate is 800 kbps.

Timing of calling: After calling the interface createStream or createZegoStream to create a stream successfully. 2.15.0 and earlier versions can call this interface only after the stream is pushed successfully.

Restrictions on use: None

The modified localStream must be obtained by calling the createStream or createZegoStream method of the SDK.

Scope of influence: None

• Related callbacks: push stream quality callback publishQualityUpdate.

Related interface: None

• Platform differences: None

• Default value: None

Timing of calling: After calling the interface createStream or createZegoStream to create a stream successfully. 2.15.0 and earlier versions can call this interface only after the stream is pushed successfully.

Restrictions on use: None

The modified localStream must be obtained by calling the createStream or createZegoStream method of the SDK.

Scope of influence: None

• Related callbacks: push stream quality callback publishQualityUpdate.

Related interface: None

• Platform differences: None

• Default value: None

Timing of calling: This interface can be called only after the flow is successfully created.

Restrictions on use: None

The localStream to be replaced must be obtained by calling the createStream method of the SDK.

Scope of influence: None

• Related callbacks: None

Related interface: None

• Platform differences: None

• Default value: None

Timing of calling: This interface can be called only after the flow is successfully created.

Restrictions on use: None

The localStream to be replaced must be obtained by calling the createStream method of the SDK.

Scope of influence: None

Related interface: removeTrack

• Default value: None
• When to call: After the flow is successfully created.

Restrictions on use: None

This interface can only be called after the stream is successfully created. After mixing, it is only valid for the collected audio tracks. Please use the setMixingAudioVolume interface to adjust the volume of the mixing part.

Scope of influence: None

• Related callbacks: None

Related interface: None

• Platform differences: None

• When to call: After the flow is successfully created.
• Caution: This API can only be called after the stream is created successfully. The higher the static image resolution, the more performance is consumed. Therefore, it is recommended to select the required image size according to the required streaming resolution.

• Default value: None

Timing of calling: after successful push.

Restrictions on use: None

Only strings are supported.

Scope of influence: None

• Related callbacks: Users who log in to the room for the first time can obtain additional stream information through roomStreamUpdate, and users who have already pulled streams in the room can obtain updated stream additional information through the stream additional information update callback streamExtraInfoUpdate.

Related interface: None

• Platform differences: None

• When to call: after the stream is created successfully.
• Caution:

1. The premise of opening/closing the streaming screen is that the media stream must be a camera stream.
2. If the track is replaced through the [replaceTrack] or [addTrack] interface, it is not supported to call this interface to stop the camera capture, and you can call the [MediaStreamTrack.stop] method to stop the camera capture.

Usage restrictions: Closing or opening the camera on hardware is a time-consuming operation, and there is a certain performance overhead when users operate frequently. It is generally recommended to use [mutePublishStreamVideo].

• Related callbacks: Calling the stop camera interface will trigger the camera status callback [remoteCameraStatusUpdate] of the corresponding stream on the streaming end.
• Related APIs: Turn on/off the sending stream video data interface [mutePublishStreamVideo] The response is faster and does not affect the video capture state.

• Default value: None

Timing of calling: after successful push.

Restrictions on use: None

It is recommended to use the server-side dynamic retweet CDN to add the retweet CDN address API instead of the client API. This interface call may fail. If it returns a success, it only means that the instant server is notified of success, and it cannot be judged whether the instant server retweets the CDN successfully.

Scope of influence: None

• Related callbacks: None

Related interface: Notify the instant server to stop forwarding the stream to CDN removePublishCdnUrl.

• Platform differences: None

• Default value: None
• When to call: After the retweet is successful

Restrictions on use: None

It is recommended to use the server-side dynamic retweet CDN to add the retweet CDN address API instead of the client API. This interface call may fail. If it returns a success, it only means that the instant server is notified of success, and it cannot be judged whether the instant server retweets the CDN successfully.

Scope of influence: None

• Related callbacks: None

Related interface: notify the instant server to push the stream to CDN addPublishCdnUrl.

• Platform differences: None

• When to call: After the flow is successfully created.

  The prerequisite for opening/closing the stream screen is that the original stream must have a video track, and the stream cannot be pure audio when it is created.

• Related callbacks: pull streaming camera status callback remoteCameraStatusUpdate.

Related interface: Turn on/off the streaming sound mutePublishStreamAudio that is being pushed.

• When to call: After the flow is successfully created.

1. The premise of turning on/off streaming sound is that the original stream must have an audio track, and it cannot be pure video when creating the stream.
2. This interface will turn off all streaming sounds, including microphones, mixed-stream background music and other sounds, while muteMicrophone will only turn off the microphone sounds.

• Related callbacks: pull streaming microphone status callback remoteMicStatusUpdate.

Related interface: Close/open the streaming video mutePublishStreamVideo that is being pushed; close/open the microphone sound interface muteMicrophone.

• Use cases: Portrait beautify on the camera screen.
• When to call: After calling the interface createStream or createZegoStream to obtain the media stream.
• Caution: 1. The beauty effect is bound to the corresponding MediaStream, and the beauty effect of the active stream will not be changed when useVideoDevice and replaceTrack are called.

2. The beautification process takes up resources and consumes performance. When you do not need to use the beautification, you need to call setEffectsBeauty(localStream,false) to close it in time.
3. When calling destroyStream to destroy the stream, the SDK will close the beautifying effect. In other cases, the SDK will not actively close the beautifying process, and you need to call setEffectsBeauty(localStream,false) to close it.
4. The browser of the mobile device does not support enabling beauty.
5. Function setEffectsBeauty is asynchronous. You cannot start streaming during the opening process. If you need to enable beauty before publishing stream, you need to wait for the beauty interface to complete asynchronously before calling the startPublishingStream interface.

• Related callbacks: none.

• Use cases: The environment on the streaming end is dark, or the frame rate set by the camera is high, which causes the picture to be dark, and the subject cannot be displayed or recognized normally.
• Default value: close.
• When to call: After calling createstream or createZegoStream to create the preview stream.
• Caution: The interface compatibility is the same as setEffectsBeauty, but not compatible with mobile browsers.

• When to call: The settings can only take effect before pushing the stream. If the settings are set after the stream is pushed, it can take effect when the stream is restarted after the push is stopped.
• Caution: Since the hard-coding support of a small number of devices is not particularly good, the SDK uses the software coding method by default. If the developer finds that the device heats up when the audio and video streams are pushed to a larger resolution when testing some models, consider calling this function to enable hard coding.

• Use cases: After the SDK is created and initialized, the compatible operation of device plugging and unplugging.

• Use cases: Replace the real background with a custom image.
• Default value: None.
• When to call /Trigger: After new ZegoExpressEngine.

1. Currently only supports the use of the PC terminal, the mobile terminal is not currently supported.

• Use cases: Blur the real scene around the user.
• Default value: None
• When to call /Trigger: After calling the interface the initBackgroundModule successfully and calling the interface createStream or createZegoStream to create a stream successfully.

1. Currently only supports the use of the PC terminal, the mobile terminal is not currently supported;

• Use cases: Process virtual background for streaming
• Default value: None
• When to call /Trigger: After calling the interface initBackgroundModule and calling the interface createStream to create a stream successfully.

1. Currently only supports the use of the PC terminal, the mobile terminal is not currently supported;
2. Before use, you need to call the ZegoExpressEngine.use method to import the virtual background module.

• Use cases: Process transparent background for streaming
• Default value: None
• When to call /Trigger: After calling the interface initBackgroundModule and calling the interface createStream or createZegoStream to create a stream successfully.

1. Currently only supports the use of the PC terminal, the mobile terminal is not currently supported;
2. Before use, you need to call the ZegoExpressEngine.use method to import the virtual background module.

• Use cases: Perform background processing on the pushed stream.
• Default value: None
• When to call /Trigger: When to call /Trigger: After calling the interface createStream or createZegoStream to create a stream successfully.

1. Currently only supports the use of the PC terminal, the mobile terminal is not currently supported;

• Use cases: Switch voice changer reduction before or during streaming.
• Default value: None
• When to call /Trigger: After calling the interface createStream or createZegoStream to create a stream successfully.

1. Currently only supports voice changer reduction for a specific stream, and does not support simultaneous noise reduction for multiple streams; 2.The pitch parameter voiceParam has a value range of [-12.0, 12.0]. The larger the value, the sharper the sound. Setting it to 0.0 will turn off the voice changer.

• Use cases: Switch voice changer reduction before or during streaming.
• Default value: None
• When to call /Trigger: After calling the interface createStream or createZegoStream to create a stream successfully.

1. Currently only supports voice changer reduction for a specific stream, and does not support simultaneous noise reduction for multiple streams;

• Use cases: It is often used in live broadcast, chat room and KTV and other scenarios.
• Default value: None
• When to call /Trigger: After calling the interface createStream or createZegoStream to create a stream successfully.

1. Currently, only one specific stream is supported for audio mixing, and simultaneous reverberation for multiple streams is not supported.
2. The effect of using this function and [setVoiceChangerPreset] at the same time may be different from the expected effect. If you need to use it at the same time, it is recommended to enable the voice changer first, and then enable the reverberation.

• Use cases: It is often used in live broadcast, chat room and KTV and other scenarios.
• Default value: None
• When to call: After calling the interface createStream or createZegoStream to create a stream successfully.

1. Currently, only one specific stream is supported for audio mixing, and simultaneous reverberation for multiple streams is not supported.
2. It is necessary to call [createStream] or [createZegoStream] to set the parameters of the two-channel virtual stereo to take effect.
3. The effects of the virtual stereo and reverb functions conflict, and the effects may not meet expectations, so do not use them in combination.
4. The virtual stereo function is not supported on Mac Safari and mobile device browsers.

• Use cases: Switch AI noise reduction before or during streaming.
• Default value: None
• When to call /Trigger: After calling the interface createStream or createZegoStream to create a stream successfully.

1. Currently using the AI noise reduction function requires a special editing package for technical support;
2. Currently only supports the use of the PC terminal, the mobile terminal is not currently supported;
3. Currently only supports AI noise reduction for a specific stream, and does not support simultaneous noise reduction for multiple streams;

• Use cases: Switch AI noise reduction before or during streaming.
• Default value: None
• When to call /Trigger: After calling the interface createStream or createZegoStream to create a stream successfully.

1. Currently using the [setAiDenoiseMode] requires a special editing package for technical support;
2. Currently only supports the use of the PC terminal, the mobile terminal is not currently supported;

• Default value: If this interface is not adjusted, the default is not aligned.
• When to call: After the push is successful.

Related interface: Start the mixing interface startMixerTask. After the mixing task turns on the precise alignment function, the aligned streams will be aligned.

• Default value: None

Timing of calling: After the stream is successfully pulled.

Restrictions on use: None

The player will not be destroyed after the streaming is stopped, and the player must be destroyed by the developer.

Scope of influence: None

• Related callbacks: pull stream quality callback playQualityUpdate, pull stream state callback playerStateUpdate.

Related interface: start streaming startPlayingStream.

• Platform differences: None

• Default value: None

Timing of calling: After the stream is successfully pulled.

Restrictions on use: None

1. The premise of stopping or resuming the video stream is that the original stream must have a video track, and the stream cannot be pure audio.
2. It is only valid for RTC streams or L3 streams, and cannot operate CDN pull streams.

Scope of influence: None

• Related callbacks: None

Related interface: Stop or resume pulling the audio stream mutePlayStreamAudio.

• Platform differences: None

• Default value: None

Timing of calling: After the stream is pulled successfully or the stream is collected successfully.

Restrictions on use: None

1. The stream has an audio.
2. It is only valid for RTC streams or L3 streams, and cannot operate CDN pull streams.
3. Chrome browser support 85 above.
4. Due to browser limitations, data callbacks are only available after interaction with the page.

Scope of influence: None

• Related callbacks: None

Related interface: None

• Platform differences: None

• Default value: None

Timing of calling: After the stream is successfully pulled.

Restrictions on use: None

None

Scope of influence: None

• Related callbacks: None

Related interface: None

• Platform differences: None

• Default value: None

Timing of calling: After the stream is successfully pulled.

Restrictions on use: None

1. The prerequisite for stopping or resuming the audio stream is that the original stream must have an audio track, and the stream cannot be pure video.
2. It is only valid for RTC streams or L3 streams, and cannot operate CDN pull streams.

Scope of influence: None

• Related callbacks: None

Related interface: Stop or resume pulling the video stream mutePlayStreamVideo.

• Platform differences: None

• Use cases: Obtain the quality parameters such as the resolution, frame rate, and bit rate of the current playing stream.
• When to call: [startPlayingStream] After the push stream is successful.
• Related APIs: Pull streaming quality callback [playQualityUpdate].

• Use cases: You need to play media streaming images such as camera and screen sharing on the interface.
• When to call /Trigger: You need to call the interface createstream to obtain the media stream object as an input parameter.
• Caution: Only one instance object of the media stream player component can be created corresponding to each media stream object.

• Use cases: The pulled remote media streaming screen needs to be displayed on the page.
• When to call /Trigger: You need to call the interface [startPlayingStream] to get the media stream object as an input parameter.
• Caution: Only one instance object of the media stream player component can be created corresponding to each media stream object.

• Use cases: It is often used in voice chat room scenarios when the client needs to initiate an automatic streaming task.
• When to call: After creating the engine, if the target room has been created, you can call this function to start automatic streaming in the target room.
• Caution: Before starting the next automatic stream mixing task in the same room, please call the [stopAutoMixerTask] function to end the previous automatic stream mixing task first, so as to avoid the situation where the audience is still pulling the output stream of the previous automatic stream mixing task when a host has started the next automatic stream mixing task to mix with other hosts. If the user does not actively end the current automatic stream mixing task, the task will automatically end after the room no longer exists or the input stream does not exist for 90 seconds.

Security reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.

• Related APIs: You can call the [stopAutoMixerTask] function to stop the automatic stream mixing task.

• Use cases: It is usually used in the scenario where multiple anchors are connected to the PK. The audio and video streams of multiple anchors are mixed into one stream, and the audience only needs to pull this stream.
• When to call: After calling the interface startPublishingStream to publish the streams successfully.
• Caution: The corresponding AppID enables the muxing function; the mixed stream must exist on the ZEGO server.

Security reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.

• Related APIs: Use the interface stopMixerTask to stop server-side mixing. Failure to stop the mixing function in time will affect billing.

• Use cases: It is often used in voice chat room scenarios when the client needs to initiate an automatic streaming task.
• When to call: After calling the interface startAutoMixerTask and mixing successfully.

Security reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.

• Related APIs: startAutoMixerTask

• Use cases: It is usually used in the scenario where multiple anchors are connected to the microphone PK, and the muxing is stopped after the use of the muxing screen is finished.
• When to call: After calling the interface startMixerTask and mixing successfully.
• Caution: You must initiate a stop muxing when you close the page, to avoid abnormally closing the muxing without stopping, which will affect the billing; if the muxing stream stops pushing, you need to do the muxing process again, otherwise the peer screen will be stuck.

Security reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.

• Related APIs: startMixerTask

• Use cases: 1. Set the background of mixed flow picture; 2. Video coding conversion to be compatible with the playback of some browsers.
• When to call: It must be called before startMixerTask is used to take effect and stream is successfully published.

Security reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.

• Related APIs: startMixerTask

• Use cases: usually used for background music and sound effects.
• When to call: After calling the interface createStream or createZegoStream to create a stream successfully. 2.15.0 and earlier versions can call this interface only after the stream is pushed successfully.
• Caution: - You need to make sure that the HTMLMediaElement loads properly. For example, to avoid cross-domain resource load failure, set the property crossOrigin = 'anonymous' on HTMLMediaElement
• Since version 86 of the Chrome browser, the local audio tag is set to mute, and the mixed background sound cannot be heard on the streaming end.
• Affected by the Safari browser policy, if the audio tag is set to mute, it will automatically pause after playback and multiple audios cannot be mixed too.

Security reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.

• Impacts on other APIs: Most interfaces can be called after logging in to the room.
• Related APIs: You can call the interface stopMixingAudio to stop mixing.

• Use cases: Usually used to control the pause of background music and sound effects.
• When to call: After calling startMixingAudio. After version 2.16.0, the preview stage operation mixing is supported.
• Caution: It is checked that "customCapture" is false through the capability check interface checkSystemRequirements, that is, the browser does not support obtaining the MediaStream of the media element, and this interface cannot be used.

Security reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.

• Impacts on other APIs: Most interfaces can be called after logging in to the room.
• Related APIs: startMixingAudio

• Use cases: Usually used to adjust the volume of background music or sound effects.
• When to call: After calling startMixingAudio. 2.16.0 and later versions support the preview stage to manipulate mixes.
• Caution: Since version 86 of the Chrome browser, the local audio tag is set to mute, and there is no sound in the mixed audio at playing stream end.

Security reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.

• Impacts on other APIs: Most interfaces can be called after logging in to the room.
• Related APIs: startMixingAudio

• When to call: After initializing a ZegoExpresEngine instance.

Cautions:

1. In order to enhance the on-site sound experience, we recommend configuring dual channel encoding. Developers can achieve this configuration by setting the parameter [ZegoCaptureMicrophone. channelCount] to 2 when using the [startCaptureMicrophone] interface. If dual channel encoding is not configured, the performance of certain songs may be significantly reduced, as the effects of the left and right channels may cancel out each other when synthesizing a single channel, resulting in less noticeable effects.
2. This interface can only be effective for one h5 player. When the effect is turned on for a new audio tag, the effect will be turned off for other h5 players that have the effect turned on.

• When to call: After initializing a ZegoExpresEngine instance.

Cautions: If the audio change setAudioChangerParam interface is used at the same time as the enableLiveAudioEffect interface, this interface takes effect for only one h5 player. When the new audio tag is enabled or setAudioChangerParam and enableLiveAudioEffect are passed to different h5 players, the h5 player whose effects are enabled first will be disabled. That is, the setAudioChangerParam and enableLiveAudioEffect cannot take effect on multiple audio devices.

• Use cases: When you need to play short sound effects, such as applause, cheers, etc., you can use the sound effect player to achieve.
• When to call /Trigger: You need to call the interface createstream or createZegoStream to obtain the media stream object as an input parameter.
• Caution:

1. Only one valid player instance object can be created corresponding to each media stream object.
2. In version 2.15.0, you need to complete the push stream before you can operate the player corresponding to the stream. Version 2.16.0 and later supports the audio player that operates the stream before pushing the stream.

• Use cases: In the scenario of frequently playing the same sound effect, the SDK provides the function of preloading the sound effect file into the memory in order to reduce the waste of network and performance resources of repeatedly reading and decoding the file.
• When to call /Trigger: Callable after [createAudioEffectPlayer].

Related interfaces: Play audio effect interface [ZegoAudioEffectPlayer.start], release audio interface [unloadEffect].

• Caution:

1. Online audio files need to comply with the Same-origin policy.
2. The following audio formats are supported: MP3, AAC and other audio formats supported by the browser.

• Use cases: After the sound effect is used up, related resources can be released through this interface.
• When to call /Trigger: Callable after [loadAudioEffect].

Related interfaces: Load the audio interface [loadAudioEffect] .

• Caution: none.

• Default value: None
• When to call: after initialization, before creating a stream.

Restrictions on use: None

1. This interface needs to be called under the secure domain name (https, localhost, 127.0.0.1).
2. Before calling this interface, you need to obtain device permissions. You can call checkSystemRequirements("camera") to authorize camera permissions, and call checkSystemRequirements("microphone") to authorize camera permissions.
3. If the interface cannot be completely trusted, it is necessary to downgrade the situation where the device information cannot be obtained, for example: prompting the customer to change the browser.
4. Some platform browsers (such as: Safari, iOS) may obtain an empty device name. It is recommended to call this interface again to obtain the correct device name.
5. After the page is refreshed, the device ID may change and needs to be obtained again.
6. Some browsers can obtain the device ID only after calling the createStream interface to obtain permission.
7. safari does not support getting speaker information.

Scope of influence: None

• Related callbacks: None

Related interfaces: createStream, useAudioDevice, useVideoDevice.

• Platform differences: None

• Default value: None
• When to call: after initialization, before creating a stream.

Restrictions on use: None

1. Due to the browser's security and privacy protection, the page needs to call this interface in a secure environment (https, localhost, 127.0.0.1). See Privacy and security.
2. If the page device permission is not granted, calling this method will temporarily open the camera to trigger the browser's camera device permission application. On browsers such as Chrome 81+, Firefox, Safari, etc., accurate device information cannot be obtained without media device permissions.

Scope of influence: None

• Related callbacks: None

Related interfaces: createStream, useVideoDevice, createZegoStream.

• Platform differences: None

• Default value: None
• When to call: after initialization, before creating a stream.

Restrictions on use: None

1. Due to the browser's security and privacy protection, the page needs to call this interface in a secure environment (https, localhost, 127.0.0.1). See Privacy and security.
2. If the page device permission is not granted, calling this method will temporarily turn on the microphone to trigger the browser's request for the microphone device permission. On browsers such as Chrome 81+, Firefox, Safari, etc., accurate device information cannot be obtained without media device permissions.
3. In Windows Chrome, there will be a microphone device whose deviceID is 'communications'. This microphone is an encapsulation made by Chrome based on a real microphone. The microphone will be limited by Windows' sound communication configuration. Avoid using the device for business purposes.

Scope of influence: None

• Related callbacks: None

Related interfaces: createStream,createZegoStream, useAudioDevice.

• Platform differences: None

• Default value: None
• When to call: after initialization, before creating a stream.

Restrictions on use: None

1. Due to the browser's security and privacy protection, the page needs to call this interface in a secure environment (https, localhost, 127.0.0.1). See Privacy and security.
2. When the page device permission is not granted, calling this method will temporarily turn on the microphone to trigger the browser's speaker device permission request. On browsers such as Chrome 81+, Firefox, Safari, etc., accurate device information cannot be obtained without media device permissions.
3. Safari does not support getting speaker information.

Scope of influence: None

• Related callbacks: None

Related interfaces: Specifies the audio output device interface [useAudioOutputDevice].

• Platform differences: None

• Default value: None

Timing of calling: After the stream is created successfully, and the stream type must be the camera type to collect the stream.

Restrictions on use: None

If the camera switch fails, the original stream will be retained and an error will be returned.

Scope of influence: None

• Related callbacks: None

Related interface: None

• Platform differences: None

• Default value: None

Timing of calling: After the stream is created successfully, and the stream type must be the camera type to collect the stream.

Restrictions on use: None

If the camera switch fails, the original stream will be retained and an error will be returned.

Scope of influence: None

• Related callbacks: None

Related interface: switch the microphone useAudioDevice.

• Platform differences: None

• Default value: None

Timing of calling: After the stream is created successfully, and the stream type must be the camera type to collect the stream.

Restrictions on use: None

If you fail to switch the microphone, the original stream will be retained and an error will be returned.

Scope of influence: None

• Related callbacks: None

Related interface: switch the microphone useVideoDevice.

• Platform differences: None

• When to call: after using [getSpeakers] to get the list of audio output devices.

caution: This interface is currently only supported by the Chrome browser.

Related interface: Get the speaker list interface [getSpeakers].

• Default value: None
• When to call: After initializing the instance.

Restrictions on use: None

None

Scope of influence: None

Related callback: soundLevelUpdate callback.

Related interface: None

• Platform differences: None

• Use cases: Used to determine whether the host’s own microphone is turned on.
• When to call /Trigger: After calling loginRoom interface to log in the room successfully
• Related APIs: Call muteMicrophone to turn the microphone sound interface off / on.

• When to call: After initializing the instance.

  The premise of whether to mute the microphone is that the original stream must have an audio track, and it cannot be pure video when creating the stream.

Related interface: Call isMicrophoneMuted interface to get microphone mute status; Call the mutePublishStreamAudio interface to turn off / on the sound being pushed.

• Platform differences: None

• Use cases: Often used in shooting games and meta-universe game scenes, users can use the range voice-related functions through the created range voice instance objects.
• When to call /Trigger: Called after creating the ZegoExpressEngine instance and before calling the interface loginRoom to log in to the room.
• Caution: Use range voice function can no longer use startPublishingStream, startPlayingStream these push-pull stream interfaces and related callbacks.

• Use cases: it is often used in remote control scenarios. Users can use real-time sequential data related functions through the created real-time sequential data instance object.
• When to call /Trigger: call after creating ZegoExpressEngine instance.

• Use cases: it is often used in remote control scenarios. Users can use real-time sequential data related functions through the created real-time sequential data instance object.
• When to call /Trigger: call after creating ZegoExpressEngine instance and createRealTimeSequentialDataManager.

• Use cases: Often used in online KTV chorus scenarios, users can use related functions by creating copyrighted music instance objects.
• When to call /Trigger: After initializing the engine instance.
• Caution: The SDK only supports creating one instance, calling this function multiple times returns the same object.

• When to call /Trigger: After initializing the engine instance.

• Use cases: super small class scenario for cross room continuous learning and online education
• Default value: multiple rooms mode is not turned on by default
• When to call: you need to call it before you first log in to the room after initializing SDK.
• Related APIs: loginRoom, logoutRoom, startPublishingStream

• Default value: Both the local log and upload level are info.
• When to call: After initialization, it is called before any other interfaces.

Usage restriction: None, but it is recommended to call it only once in the entire life cycle.

Unless there is a clear special requirement, please do not call this interface to change the default configuration.

• Related callbacks: None

Related interface: None

• Default value: The default value of the test environment is “true”, which can be turned off manually.
• When to call: After initialization, call immediately.

Restrictions on use: None

It is recommended to keep the default behavior and try not to use this interface.

Scope of influence: All SDK internal errors will be prompted by a pop-up, interrupting the entire process.

• Related callbacks: None

Related interface: None

• Platform differences: None

• Default value: None

Call timing: It can be called at any timing after initialization.

Restrictions on use: None

None

Scope of influence: None

• Related callbacks: None

Related interface: None

• Platform differences: None

• Use cases: Log in to the room to obtain interface permissions for audio, video or message interaction with other users.

Calling time: after initialization and token acquisition.

Cautions:

1. Token is the key to log in to the room and needs to be implemented by the developer. To ensure security, the token must be generated on the developer's own server.
2. The default is single room mode, the same user (ie UserID) cannot log in to two and more rooms at the same time.
3. If you want to monitor the changes of other users in the room, the "userUpdate" parameter under the config object must be set to "true".
4. If the room does not exist, loginRoom will create and log in the room.

Privacy protection statement: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.

Scope of influence: Most interfaces can be called after logging in to the room.

Related callback: Room status callback roomstatechanged, please use roomstateupdate before 2.16.0

Related interface: You can call the logoutRoom interface to exit the room.

• Use cases: Convenient to realize the switch between different rooms, such as switching from live room to 1v1 room.

Calling time: After successfully logging into the room.

Cautions:

1. Token is the key to log into the toRoomID room, which needs to be implemented by the developer. In order to ensure security, the token must be generated on the developer's own server side.
2. fromRoomID must be the logged in room ID, and toRoomID must be the logged in room ID, If the room does not exist, a new room will be created.
3. Switching room will stop all push and pull streams in the current room, but will not stop the preview. If you want to stop the preview, you can call destroyStream to destroy the preview stream.
4. If CDN manual retweet is set, it will not stop automatically when switching rooms, and the user needs to manually stop CDN retweet.

Privacy protection statement: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.

Scope of influence: Most interfaces can be called after logging in to the room.

Related callback: Room status callback roomstatechanged, please use roomstateupdate before 2.16.0

Related interface: You can call the logoutRoom interface to exit the room.

• Default value: None

Timing of calling: After logging in to the room successfully.

Restrictions on use: None

None

Scope of influence: Most of the interfaces can no longer be called after exiting the room.

Related callback: Room status callback roomstatechanged, please use roomstateupdate before 2.16.0.

Related interface: call loginRoom interface login number room.

• Platform differences: None

• Default value: none

Calling time: After logging in to the room, actively change the user's permissions in the room; After logging in to the room, the token is about to expire and the callback is received;

Restrictions on use: None

The token is the key to log in to the room. This needs to be implemented by the customer. To ensure security, the token must be generated on the server.

Scope of influence: the expiration time contained in the token, the tokenWillExpire callback will be triggered 30s before the expiration

Related callback: the room token is about to expire, the callback tokenWillExpire

Related interface: none

• Platform differences: None

• Default value: None

Timing of calling: after successfully logging in to the room.

Usage restriction: For the usage restriction of this interface, please refer to https://doc-en.zego.im/article/7616 or contact ZEGO technical support.

At present, only one key-value pair is allowed to be set in the room additional message, and the maximum length of key is 10 bytes, and the maximum length of value is 100 bytes.

Security reminder: Please do not fill in sensitive user information in this interface, including but not limited to mobile phone number, ID number, passport number, real name, etc.

Scope of influence: Most interfaces can be called after logging in to the room.

Related callback: roomExtraInfoUpdate callback for room additional information.

Related interface: None

• Platform differences: None

• Use cases: users in the room send barrage messages to interact.
• When to call: After calling the interface loginRoom to log in to the room successfully.
• Related callbacks: Users in the room can receive messages through the room barrage message notification callback IMRecvBarrageMessage.

• Use cases: Users in the room send messages to chat and interact, for example, the chat room.
• When to call: After calling the interface loginRoom to log in to the room successfully.
• Impacts on other APIs: Most interfaces can be called after logging in to the room.

Related callback: Users in other rooms can receive messages through the broadcast message notification callback IMRecvBroadcastMessage.

• Use cases: Chat with individual users privately.
• When to call: after successfully logging in to the room.
• Impacts on other APIs: Most interfaces can be called after logging in to the room.
• Related callbacks: Users in the room can receive messages by listening to the custom command signaling callback IMRecvCustomCommand.

• Use cases: Generally used for remote control signaling or message sending between users.
• When to call: after successfully logging in to the room.
• Impacts on other APIs: Most interfaces can be called after logging in to the room.
• Related callbacks: When sending a message, Mode is specified for ZegoRoomTransparentMessageModeOnlyClient or ZegoRoomTransparentMessageModeClientAndServer can pass [recvRoomTransparentMessage] received sends the message content.

• Use cases:

• Required:

• Default value:

• Recommended value:

• Value range:

• Caution:

• Privacy reminder:

• Platform differences:

• Use cases: After initializing the player plug-in, if the SDK does not log in to the room, the player plug-in needs to be authenticated.
• When to call /Trigger: Called after the player is instantiated and before other interfaces are used.

• Use cases: After the player initializes and specifies the CDN resource, it starts playing the CDN resource.
• When to call /Trigger: Called after the player is instantiated and authenticated.

• Use cases: When playing CDN resources, pause the playback.
• Caution: When pausing playback, in order to synchronize with the latest CDN live broadcast progress as much as possible, the player will drop frames during the pause process.
• When to call /Trigger: Called after the player starts pulling CDN resources.

• Use cases: Such as CDN resource exceptions and other scenarios, used when CDN resources need to be re-pulled.
• When to call /Trigger: Called after the player pulls CDN resources.

• Use cases: After the player starts playing CDN resources, it stops playing the resources.
• When to call /Trigger: Called after the player is instantiated and authenticated.