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

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

@@ -986,6 +986,25 @@ const ZegoStreamResourceMode = {
   CDNPlus: 4,
 }
 
+/**
+ * Stream Switch Resource Mode
+ * @enum {number}
+ */
+const ZegoStreamResourceSwitchMode = {
+  /**
+   * @description Default mode. The SDK will automatically select the streaming resource according to the parameters set by the player config and the ready-made background configuration.
+   */
+  Default: 0,
+  /**
+   * @description Auto switch to RTC resource when publishing.
+   */
+  SwitchToRTC: 1,
+  /**
+   * @description Keep using original resource when publishing, not switch to RTC resource.
+   */
+  KeepOriginal: 2,
+}
+
 /**
  * Update type.
  * @enum {number}
@@ -1380,6 +1399,10 @@ const ZegoVideoBufferType = {
    * @description GL_TEXTURE_EXTERNAL_OES type video frame
    */
   GLTextureExternalOES: 6,
+  /**
+   * @description Texture 2D and raw data type video frame
+   */
+  GLTexture2DAndRawData: 7,
 }
 
 /**
@@ -2200,6 +2223,7 @@ const ZegoScreenCaptureSourceExceptionType = {
  * @property {ZegoVideoCodecID} videoCodecID - The video encoding type of the stream, please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored.
  * @property {ZegoResourceType} sourceResourceType - The resource type of the source stream, please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored.
  * @property {number} codecTemplateID - Preconfigured codec template ID, please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored.
+ * @property {ZegoStreamResourceSwitchMode} resourceSwitchMode - Play resource switching strategy mode, the default is ZegoStreamResourceSwitchModeDefault
  */
 
 /**
@@ -2300,6 +2324,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.
  */
 
 /**
@@ -2526,6 +2551,7 @@ module.exports = {
   ZegoPlayerMediaEvent,
   ZegoResourceType,
   ZegoStreamResourceMode,
+  ZegoStreamResourceSwitchMode,
   ZegoUpdateType,
   ZegoStreamRelayCDNState,
   ZegoStreamRelayCDNUpdateReason,

package/ZegoExpressEngine.js

@@ -17,7 +17,7 @@ class ZegoExpressEngine extends EventEmitter {
    * Description: Create ZegoExpressEngine singleton object and initialize SDK.
    * When to call: The engine needs to be created before calling other functions.
    * Restrictions: None.
-   * Caution: The SDK only supports the creation of one instance of ZegoExpressEngine. Multiple calls to this function return the same object.
+   * Caution: The SDK only supports the creation of one instance of ZegoExpressEngine. If you need call [createEngine] multiple times, you need call [destroyEngine] before you call the next [createEngine]. Otherwise it will return the instance which created by [createEngine] you called last time.
    * @param {ZegoEngineProfile} profile - The basic configuration information is used to create the engine.
    * @return {Promise<Object>} - The result notification callback of create engine.
    */
@@ -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()
@@ -199,7 +199,6 @@ class ZegoExpressEngine extends EventEmitter {
    *   2. SDK supports startPlayingStream audio and video streams from different rooms under the same appID, that is, startPlayingStream audio and video streams across rooms. Since ZegoExpressEngine's room related callback notifications are based on the same room, when developers want to startPlayingStream streams across rooms, developers need to maintain related messages and signaling notifications by themselves.
    *   3. It is strongly recommended that userID corresponds to the user ID of the business APP, that is, a userID and a real user are fixed and unique, and should not be passed to the SDK in a random userID. Because the unique and fixed userID allows ZEGO technicians to quickly locate online problems.
    *   4. After the first login failure due to network reasons or the room is disconnected, the default time of SDK reconnection is 20min.
-   *   5. After the user has successfully logged in to the room, if the application exits abnormally, after restarting the application, the developer needs to call the logoutRoom interface to log out of the room, and then call the loginRoom interface to log in to the room again.
    * Privacy 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 callbacks:
    *   1. When the user starts to log in to the room, the room is successfully logged in, or the room fails to log in, the [onRoomStateChanged] (Not supported before 2.18.0, please use [onRoomStateUpdate]) callback will be triggered to notify the developer of the status of the current user connected to the room.
@@ -453,6 +452,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.
    *
@@ -1291,7 +1306,7 @@ class ZegoExpressEngine extends EventEmitter {
   /**
    * Chooses to use the specified audio device.
    *
-   * Available since: 1.0.0
+   * Available since: 1.1.0
    * Description: Chooses to use the specified audio device.
    * When to call: After creating the engine [createEngine] and before call [startPublishingStream] or [startPlayingStream].
    * Restrictions: Only supports Windows / macOS / Linux
@@ -1361,7 +1376,12 @@ class ZegoExpressEngine extends EventEmitter {
   /**
    * Turn on audio device volume monitoring.
    *
-   * Only for Windows / macOS / Linux
+   * Available since: 1.1.0
+   * Description: Starts the audio device volume monitor. When the volume of the device changes, the changed volume will be called back via [onAudioDeviceVolumeChanged].
+   * Caution: Currently, only one audio output device and one audio input device are supported to be monitored at the same time. When this API is called multiple times and the same device type is set, the device ID set to this API during the last call will be overwritten.
+   * When to call: After creating the engine via [createEngine].
+   * Platform differences: Only supports Windows and macOS.
+   * Related APIs: When you no longer need to monitor the device volume, please call [stopAudioDeviceVolumeMonitor] to stop monitoring.
    * @param {ZegoAudioDeviceType} deviceType - Audio device type
    * @param {string} deviceID - ID of a device obtained by [getAudioDeviceList]
    */
@@ -1372,7 +1392,10 @@ class ZegoExpressEngine extends EventEmitter {
   /**
    * Turn off audio device volume monitoring. Only for Windows/macOS.
    *
-   * Only for Windows / macOS / Linux
+   * Available since: 1.1.0
+   * Description: Stops the audio device volume monitor.
+   * When to call: After creating the engine via [createEngine], and when you no longer need to monitor the device volume.
+   * Platform differences: Only supports Windows and macOS.
    * @param {ZegoAudioDeviceType} deviceType - Audio device type
    * @param {string} deviceID - ID of a device obtained by [getAudioDeviceList]
    */
@@ -1591,7 +1614,7 @@ class ZegoExpressEngine extends EventEmitter {
   /**
    * Enable or disable mix SDK playout to stream publishing.
    *
-   * Available since: 1.0.0
+   * Available since: 1.1.0
    * Description: Enable mix SDK playout sounds into the stream publishing.
    * Use cases: Users need to mix the sound of SDK playout into stream publishing. For example, when the class scene, the teacher and student Co-hosting, and the teacher can mix the play streaming sound into the publish streaming.
    * Default value: Default is disable.
@@ -1623,7 +1646,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.
@@ -2014,7 +2037,7 @@ class ZegoExpressEngine extends EventEmitter {
    * Available since: 1.20.0
    * Description: This function supports uplink/downlink network speed test when the network can be connected.
    * Use cases: This function can be used to detect whether the network environment is suitable for pushing/pulling streams with specified bitrates.
-   * When to call: It needs to be called after [loginRoom], and before [startPublishingStream]. If you call [startPublishingStream] while speed testing, the speed test will automatically stop.
+   * When to call: It needs to be called after [createEngine], and before [startPublishingStream]. If you call [startPublishingStream] while speed testing, the speed test will automatically stop.
    * Restrictions: The default maximum allowable test time for a single network speed test is 30 seconds.
    * Caution: Developers can register [onNetworkSpeedTestQualityUpdate] callback to get the speed test result, which will be triggered every 3 seconds. If an error occurs during the speed test process, [onNetworkSpeedTestError] callback will be triggered. If this function is repeatedly called multiple times, the last functioh call's configuration will be used.
    * Related APIs: Call [stopNetworkSpeedTest] to stop network speed test.
@@ -2759,10 +2782,9 @@ class ZegoExpressEngine extends EventEmitter {
    * @event ZegoExpressEngine#onAudioDeviceVolumeChanged
    * @desc The callback triggered when there is a change of the volume for the audio devices.
    *
-   * Available since: 1.0.0
-   * Description: This callback is used to receive audio device volume change events.
-   * When to trigger: The callback triggered when there is a change of the volume fo the audio devices.
-   * Restrictions: None
+   * Available since: 1.1.0
+   * Description: Audio device volume change event callback.
+   * When to trigger: After calling the [startAudioDeviceVolumeMonitor] function to start the device volume monitor, and the volume of the monitored audio device changes.
    * Platform differences: Only supports Windows and macOS.
    * @property {object} result - param object
    * @property {ZegoAudioDeviceType} result.deviceType - Audio device type
@@ -2774,7 +2796,7 @@ class ZegoExpressEngine extends EventEmitter {
    * @event ZegoExpressEngine#onVideoDeviceStateChanged
    * @desc The callback triggered when there is a change to video devices (i.e. new device added or existing device deleted).
    *
-   * Available since: 1.0.0
+   * Available since: 1.1.0
    * Description: By listening to this callback, users can update the video capture using a specific device when necessary.
    * When to trigger: This callback is triggered when a video device is added or removed from the system.
    * 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-30160",
     "business_type": "video"
 }