zego-express-engine-electron-private 3.6.0-29708 → 3.7.0-30063

package/ZegoExpressCopyrightedMusic.js

@@ -77,11 +77,11 @@ class ZegoCopyrightedMusic extends EventEmitter {
    * Get lyrics in krc format.
    *
    * Available since: 2.13.0
-   * Description: Get lyrics in krc format, support parsing lyrics word by word.
+   * Description: Get verbatim lyrics, support parsing lyrics word by word.
    * Use case: Used to display lyrics word by word.
    * When to call: After initializing the copyrighted music success [initCopyrightedMusic].
    * @param {string} krcToken - The krcToken obtained by calling requestAccompaniment.
-   * @return {Promise<Object>} - Get krc format lyrics complete callback.
+   * @return {Promise<Object>} - Get verbatim lyrics complete callback.
    */
   getKrcLyricByToken(krcToken) {
     return this.nativeCopyrightedMusic.getKrcLyricByToken({ krcToken })
@@ -189,7 +189,7 @@ class ZegoCopyrightedMusic extends EventEmitter {
    * Available since: 2.15.0
    * Description: Start the scoring function.After starting scoring, the scoring result OnCurrentPitchValueUpdate callback will be received according to the set callback time interval.
    * Use case: Can be used to display the singing score on the view.
-   * When to call: After obtaining krc verbatim lyrics and playing the accompaniment resources of copyrighted music.
+   * When to call: After obtaining verbatim lyrics and playing the accompaniment resources of copyrighted music.
    * Restrictions: Only support use this api after [startPublishingStream].
    * @param {string} resourceID - the resource ID corresponding to the accompaniment or accompaniment clip.
    * @param {number} pitchValueInterval - the time interval of real-time pitch line callback, in milliseconds, the default is 50 milliseconds.

package/ZegoExpressDefines.js

@@ -2300,6 +2300,7 @@ const ZegoScreenCaptureSourceExceptionType = {
 /**
  * @typedef {Object} ZegoMixerImageInfo - Set the image information of a single input stream in the mux.
  * @property {string} url - 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.
+ * @property {number} displayMode - 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 is empty or not. Display image when the input stream is empty for 3 consecutive seconds. The default duration for determine a input stream is empty or not is 3 seconds. If you need change this setting, please contact ZEGO technical support. Display video content when the input stream has video data.
  */
 
 /**

package/ZegoExpressEngine.js

@@ -149,9 +149,9 @@ class ZegoExpressEngine extends EventEmitter {
    * Available since: 1.1.0
    * Description: By default, SDK creates and prints log files in the App's default directory. Each log file defaults to a maximum of 5MB. Three log files are written over and over in a circular fashion. When calling this function, SDK will auto package and upload the log files to the ZEGO server.
    * Use cases: Developers can provide a business “feedback” channel in the App. When users feedback problems, they can call this function to upload the local log information of SDK to help locate user problems.
-   * When to call: After [loginRoom] or [loginScene].
-   * Restrictions: If you call this interface repeatedly within 10 minutes, only the last call will take effect.
-   * Caution: After calling this interface to upload logs, if you call [destroyEngine] or exit the App too quickly, there may be a failure.It is recommended to wait a few seconds, and then call [destroyEngine] or exit the App after receiving the upload success callback.
+   * When to call: After [createEngine].
+   * Restrictions:  The frequency limit is once per minute.
+   * Caution: 1.After calling this interface to upload logs, if you call [destroyEngine] or exit the App too quickly, there may be a failure.It is recommended to wait a few seconds, and then call [destroyEngine] or exit the App after receiving the upload success callback. 2.If you want to call before [createEngine], use the [submitLog] interface.
    */
   uploadLog() {
     ZegoExpressEngineImpl.uploadLog()
@@ -453,6 +453,22 @@ class ZegoExpressEngine extends EventEmitter {
     ZegoExpressEngineImpl.setAudioConfig(config)
   }
 
+  /**
+   * Sets up the audio configurations for the specified publish channel.
+   *
+   * Available since: 1.3.4
+   * Description: You can set the combined value of the audio codec, bit rate, and audio channel through this function. If the preset value cannot meet the developer's scenario, the developer can set the parameters according to the business requirements.
+   * Default value: The default audio config refers to the default value of [ZegoAudioConfig].
+   * When to call: After the engine is created [createEngine], and before publishing [startPublishingStream].
+   * Restrictions: None.
+   * Related APIs: [getAudioConfig].
+   * @param {(ZegoAudioConfigPreset|ZegoAudioConfig)} config - Audio config.
+   * @param {ZegoPublishChannel} channel - Publish stream channel.
+   */
+  setAudioConfigWithChannel(config, channel = ZegoPublishChannel.Main) {
+    ZegoExpressEngineImpl.setAudioConfigWithChannel(config, channel)
+  }
+
   /**
    * Gets the current audio configurations.
    *
@@ -1623,7 +1639,7 @@ class ZegoExpressEngine extends EventEmitter {
   /**
    * Stop audio VAD stable state monitoring.
    *
-   * Available: since 2.14.0
+   * Available since: 2.14.0
    * Description: After calling this interface, the specified type of [onAudioVADStateUpdate] callback can no longer be received.
    * When to call: None.
    * Restrictions: None.

package/ZegoExpressEngineImpl.js

@@ -263,6 +263,10 @@ class ZegoExpressEngineImpl extends EventEmitter {
     this.ZegoNativeInstance.setAudioConfig({ config })
   }
 
+  setAudioConfigWithChannel(config, channel) {
+    this.ZegoNativeInstance.setAudioConfig({ config, channel })
+  }
+
   getAudioConfig() {
     return this.ZegoNativeInstance.getAudioConfig({})
   }

package/ZegoExpressErrorCode.js

@@ -857,7 +857,7 @@ const ZegoErrorCode = {
   /** Description: RTP timeout. <br>Cause: Not connected to the network. <br> Solutions: Please check if you can access the Internet properly. */
   UtilitiesNetworkToolRtpTimeoutError: 1015003,
 
-  /** Description: The server side ends the network speed test. <br>Cause: Network speed test time is too long. <br> Solutions: Please stop network speed test in 3 minutes. */
+  /** Description: The server side ends the network speed test. <br>Cause: Network speed test time is too long. <br> Solutions: Please stop network speed test in 30 seconds. */
   UtilitiesNetworkToolEngineDenied: 1015004,
 
   /** Description: Network speed test stopped. <br>Cause: Network speed test not stopped before publishing stream. <br> Solutions: Please stop network speed test(stopNetworkSpeedTest) before publishing stream. */

package/ZegoExpressScreenCaptureSource.js

@@ -109,6 +109,7 @@ class ZegoScreenCaptureSource extends EventEmitter {
    * Description: The callback triggered when a screen capture source exception occurred.
    * Trigger: This callback is triggered when an exception occurs after the screen start capture.
    * Caution: The callback does not actually take effect until call [setEventHandler] to set.
+   * Restrictions: Only available on Windows/macOS.
    * @property {object} result - param object
    * @property {ZegoScreenCaptureSourceExceptionType} result.exceptionType - Capture source exception type.
    */

package/package.json

@@ -11,6 +11,6 @@
         "node"
     ],
     "license": "ISC",
-    "version": "3.6.0-29708",
+    "version": "3.7.0-30063",
     "business_type": "video"
 }