agora-electron-sdk 4.2.2-dev.6 → 4.2.2-dev.7

package/CHANGELOG.md

@@ -1,19 +1,19 @@
 
 
-## [4.2.2-dev.6](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.2.1...v4.2.2-dev.6) (2023-07-31)
+## [4.2.2-dev.7](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.2.2...v4.2.2-dev.7) (2023-08-04)
+
+## [4.2.2](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.2.1...v4.2.2) (2023-08-01)
 
 
 ### Bug Fixes
 
-* CSD-57577 ex callback issue ([#1032](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1032)) ([82b53ac](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/82b53ac89ee8d4c18ce2fe3608d176d1b4140103))
 * CSD-57615 render mode not working on software renderer ([1097ebc](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/1097ebcdf21cb6f5c66821174e8f46ec470976db))
 * CSD-57699 removeEventListener `webglcontextlost` while unbind ([2a280c8](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/2a280c87242fe3abecb61bc23ffb0996029d6fec))
-* CSD-58183 getScreenCaptureSources memory leak ([0bc9ee6](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/0bc9ee6700a52979fa2c1d72cb3b738d5786f8a8))
-* getApiTypeFromPreload ([d79444d](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/d79444d169abaa08b5361cad382fa8e03e7fdf5b))
-* getApiTypeFromPreloadChannelWithUserAccount ([426f1d8](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/426f1d8073647321b7290b5495c7cacc65ae77a7))
-* jira NMS-13855 ([04baa1e](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/04baa1edf4acc900a7c2e0e9798b613c367ed9e5))
-* NMS-14097 app css issue ([8e1a2cc](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/8e1a2cccf93ff5a908f437dfc8e8c582051968d7))
-* some error ([4e74203](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/4e7420350c516e7b940c9e7a9ca3b9571c587239))
+
+
+### Features
+
+* support native 4.2.2 ([#1033](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1033)) ([f151e69](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/f151e69abf22286eb5fbec3bcee8f703188c7515))
 
 ## [4.2.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.2.0...v4.2.1) (2023-06-30)
 

package/js/Private/AgoraBase.js

@@ -1737,6 +1737,18 @@ var LocalVideoStreamError;
      * @ignore
      */
     LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorScreenCaptureNoPermission"] = 22] = "LocalVideoStreamErrorScreenCaptureNoPermission";
+    /**
+     * @ignore
+     */
+    LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorScreenCapturePaused"] = 23] = "LocalVideoStreamErrorScreenCapturePaused";
+    /**
+     * @ignore
+     */
+    LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorScreenCaptureResumed"] = 24] = "LocalVideoStreamErrorScreenCaptureResumed";
+    /**
+     * @ignore
+     */
+    LocalVideoStreamError[LocalVideoStreamError["LocalVideoStreamErrorScreenCaptureWindowRecoverFromMinimized"] = 25] = "LocalVideoStreamErrorScreenCaptureWindowRecoverFromMinimized";
 })(LocalVideoStreamError = exports.LocalVideoStreamError || (exports.LocalVideoStreamError = {}));
 /**
  * Remote audio states.
@@ -2447,6 +2459,10 @@ var ConnectionChangedReasonType;
      * @ignore
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedLicenseValidationFailure"] = 21] = "ConnectionChangedLicenseValidationFailure";
+    /**
+     * @ignore
+     */
+    ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedCertificationVeryfyFailure"] = 22] = "ConnectionChangedCertificationVeryfyFailure";
 })(ConnectionChangedReasonType = exports.ConnectionChangedReasonType || (exports.ConnectionChangedReasonType = {}));
 /**
  * The reason for a user role switch failure.
@@ -2776,11 +2792,11 @@ var AudioTrackType;
      */
     AudioTrackType[AudioTrackType["AudioTrackInvalid"] = -1] = "AudioTrackInvalid";
     /**
-     * 0: Mixable audio tracks. You can publish multiple mixable audio tracks in one channel, and SDK will automatically mix these tracks into one. The latency of mixable audio tracks is higher than that of direct audio tracks.
+     * 0: Mixable audio tracks. This type of audio track supports mixing with other audio streams (such as audio streams captured by microphone) and playing locally or publishing to channels after mixing. The latency of mixable audio tracks is higher than that of direct audio tracks.
      */
     AudioTrackType[AudioTrackType["AudioTrackMixable"] = 0] = "AudioTrackMixable";
     /**
-     * 1: Direct audio tracks. When creating multiple audio tracks of this type, each direct audio track can only be published in one channel and cannot be mixed with others. The latency of direct audio tracks is lower than that of mixable audio tracks.
+     * 1: Direct audio tracks. This type of audio track will replace the audio streams captured by the microphone and does not support mixing with other audio streams. The latency of direct audio tracks is lower than that of mixable audio tracks. If AudioTrackDirect is specified for this parameter, you must set publishMicrophoneTrack to false in ChannelMediaOptions when calling joinChannel to join the channel; otherwise, joining the channel fails and returns the error code -2.
      */
     AudioTrackType[AudioTrackType["AudioTrackDirect"] = 1] = "AudioTrackDirect";
 })(AudioTrackType = exports.AudioTrackType || (exports.AudioTrackType = {}));

package/js/Private/AgoraMediaBase.js

@@ -381,6 +381,10 @@ var VideoPixelFormat;
      * 16: The format is I422.
      */
     VideoPixelFormat[VideoPixelFormat["VideoPixelI422"] = 16] = "VideoPixelI422";
+    /**
+     * @ignore
+     */
+    VideoPixelFormat[VideoPixelFormat["VideoTextureId3d11texture2d"] = 17] = "VideoTextureId3d11texture2d";
 })(VideoPixelFormat = exports.VideoPixelFormat || (exports.VideoPixelFormat = {}));
 /**
  * Video display modes.

package/js/Private/IAgoraRtcEngine.js

@@ -451,7 +451,7 @@ exports.ImageTrackOptions = ImageTrackOptions;
 /**
  * The channel media options.
  *
- * Agora supports publishing multiple audio streams and one video stream at the same time and in the same RtcConnection. For example, publishMicrophoneTrack, publishAudioTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as true at the same time, but only one of publishCameraTrack, publishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as true. Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
+ * Agora supports publishing multiple audio streams and one video stream at the same time and in the same RtcConnection. For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as true at the same time, but only one of publishCameraTrack, publishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as true. Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
  */
 var ChannelMediaOptions = /** @class */ (function () {
     function ChannelMediaOptions() {

package/js/Private/internal/IrisApiEngine.js

@@ -235,6 +235,15 @@ exports.EVENT_PROCESSORS = {
         handlers: function () { return MusicContentCenterInternal_1.MusicContentCenterInternal._event_handlers; },
     },
 };
+// some events are not needed, so ignore them
+function isIgnoredEvent(event, data) {
+    if (event === 'onLocalVideoStats' && 'connection' in data) {
+        return true;
+    }
+    else {
+        return false;
+    }
+}
 function handleEvent() {
     var _a, _b;
     var _c = [];
@@ -268,6 +277,9 @@ function handleEvent() {
     if (_event.endsWith('Ex')) {
         _event = _event.replace(/Ex$/g, '');
     }
+    if (isIgnoredEvent(_event, _data)) {
+        return false;
+    }
     var _buffers = buffers;
     if (processor.preprocess) {
         processor.preprocess(_event, _data, _buffers);
@@ -282,6 +294,7 @@ function handleEvent() {
         });
     }
     emitEvent(_event, processor, _data);
+    return true;
 }
 /**
  * @internal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agora-electron-sdk",
-  "version": "4.2.2-dev.6",
+  "version": "4.2.2-dev.7",
   "description": "agora-electron-sdk",
   "main": "js/AgoraSdk",
   "types": "types/AgoraSdk.d.ts",
@@ -134,7 +134,7 @@
     "yuv-canvas": "1.2.6"
   },
   "agora_electron": {
-    "iris_sdk_win": "https://download.agora.io/sdk/release/iris_4.2.2-dev.6_DCG_Windows_Video_20230704_0337.zip",
-    "iris_sdk_mac": "https://download.agora.io/sdk/release/iris_4.2.2-dev.6_DCG_Mac_Video_20230704_0337.zip"
+    "iris_sdk_win": "https://download.agora.io/sdk/release/iris_4.2.2-custom.3_DCG_Windows_Video_20230804_0633.zip",
+    "iris_sdk_mac": "https://download.agora.io/sdk/release/iris_4.2.2-build.1_DCG_Mac_Video_20230727_1159.zip"
   }
 }

package/ts/Private/AgoraBase.ts

@@ -2081,6 +2081,18 @@ export enum LocalVideoStreamError {
    * @ignore
    */
   LocalVideoStreamErrorScreenCaptureNoPermission = 22,
+  /**
+   * @ignore
+   */
+  LocalVideoStreamErrorScreenCapturePaused = 23,
+  /**
+   * @ignore
+   */
+  LocalVideoStreamErrorScreenCaptureResumed = 24,
+  /**
+   * @ignore
+   */
+  LocalVideoStreamErrorScreenCaptureWindowRecoverFromMinimized = 25,
 }
 
 /**
@@ -3126,6 +3138,10 @@ export enum ConnectionChangedReasonType {
    * @ignore
    */
   ConnectionChangedLicenseValidationFailure = 21,
+  /**
+   * @ignore
+   */
+  ConnectionChangedCertificationVeryfyFailure = 22,
 }
 
 /**
@@ -3558,11 +3574,11 @@ export enum AudioTrackType {
    */
   AudioTrackInvalid = -1,
   /**
-   * 0: Mixable audio tracks. You can publish multiple mixable audio tracks in one channel, and SDK will automatically mix these tracks into one. The latency of mixable audio tracks is higher than that of direct audio tracks.
+   * 0: Mixable audio tracks. This type of audio track supports mixing with other audio streams (such as audio streams captured by microphone) and playing locally or publishing to channels after mixing. The latency of mixable audio tracks is higher than that of direct audio tracks.
    */
   AudioTrackMixable = 0,
   /**
-   * 1: Direct audio tracks. When creating multiple audio tracks of this type, each direct audio track can only be published in one channel and cannot be mixed with others. The latency of direct audio tracks is lower than that of mixable audio tracks.
+   * 1: Direct audio tracks. This type of audio track will replace the audio streams captured by the microphone and does not support mixing with other audio streams. The latency of direct audio tracks is lower than that of mixable audio tracks. If AudioTrackDirect is specified for this parameter, you must set publishMicrophoneTrack to false in ChannelMediaOptions when calling joinChannel to join the channel; otherwise, joining the channel fails and returns the error code -2.
    */
   AudioTrackDirect = 1,
 }
@@ -3824,9 +3840,9 @@ export enum HeadphoneEqualizerPreset {
  */
 export class ScreenCaptureParameters {
   /**
-   * The video encoding resolution of the shared screen stream. See VideoDimensions. The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. If the screen dimensions are different from the value of this parameter, Agora applies the following strategies for encoding. Suppose
+   * The video encoding resolution of the shared screen stream. See VideoDimensions. The default value is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. If the screen dimensions are different from the value of this parameter, Agora applies the following strategies for encoding. Suppose is set to 1920 × 1080:
    *  If the value of the screen dimensions is lower than that of dimensions, for example, 1000 × 1000 pixels, the SDK uses the screen dimensions, that is, 1000 × 1000 pixels, for encoding.
-   *  If the value of the screen dimensions is higher than that of dimensions, for example, 2000 × 1500, the SDK uses the maximum value under
+   *  If the value of the screen dimensions is higher than that of dimensions, for example, 2000 × 1500, the SDK uses the maximum value under with the aspect ratio of the screen dimension (4:3) for encoding, that is, 1440 × 1080.
    */
   dimensions?: VideoDimensions;
   /**

package/ts/Private/AgoraMediaBase.ts

@@ -433,6 +433,10 @@ export enum VideoPixelFormat {
    * 16: The format is I422.
    */
   VideoPixelI422 = 16,
+  /**
+   * @ignore
+   */
+  VideoTextureId3d11texture2d = 17,
 }
 
 /**
@@ -575,6 +579,14 @@ export class ExternalVideoFrame {
    * @ignore
    */
   alphaBuffer?: Uint8Array;
+  /**
+   * @ignore
+   */
+  d3d11_texture_2d?: any;
+  /**
+   * @ignore
+   */
+  texture_slice_index?: number;
 }
 
 /**
@@ -643,6 +655,10 @@ export class VideoFrame {
    * This parameter only applies to video data in Texture format. Texture ID.
    */
   textureId?: number;
+  /**
+   * @ignore
+   */
+  d3d11Texture2d?: any;
   /**
    * This parameter only applies to video data in Texture format. Incoming 4 × 4 transformational matrix. The typical value is a unit matrix.
    */

package/ts/Private/IAgoraMediaEngine.ts

@@ -151,12 +151,11 @@ export abstract class IMediaEngine {
   /**
    * Sets the external audio source parameters.
    *
-   * Call this method before joining a channel.
+   * Deprecated: This method is deprecated, use createCustomAudioTrack instead. Call this method before joining a channel.
    *
    * @param enabled Whether to enable the external audio source: true : Enable the external audio source. false : (Default) Disable the external audio source.
    * @param sampleRate The sample rate (Hz) of the external audio source which can be set as 8000, 16000, 32000, 44100, or 48000.
    * @param channels The number of channels of the external audio source, which can be set as 1 (Mono) or 2 (Stereo).
-   * @param sourceNumber The number of external audio sources. The value of this parameter should be larger than 0. The SDK creates a corresponding number of custom audio tracks based on this parameter value and names the audio tracks starting from 0. In ChannelMediaOptions, you can set publishCustomAudioSourceId to the audio track ID you want to publish.
    * @param localPlayback Whether to play the external audio source: true : Play the external audio source. false : (Default) Do not play the external source.
    * @param publish Whether to publish audio to the remote users: true : (Default) Publish audio to the remote users. false : Do not publish audio to the remote users.
    *
@@ -173,14 +172,14 @@ export abstract class IMediaEngine {
   ): number;
 
   /**
-   * Creates a customized audio track.
+   * Creates a custom audio track.
    *
-   * When you need to publish multiple custom captured audios in the channel, you can refer to the following steps:
+   * To publish a custom audio source to multiple channels, see the following steps:
    *  Call this method to create a custom audio track and get the audio track ID.
    *  In ChannelMediaOptions of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to true.
-   *  If you call pushAudioFrame trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.
+   *  If you call pushAudioFrame, and specify trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.
    *
-   * @param trackType The type of the custom audio track. See AudioTrackType.
+   * @param trackType The type of the custom audio track. See AudioTrackType. If AudioTrackDirect is specified for this parameter, you must set publishMicrophoneTrack to false in ChannelMediaOptions when calling joinChannel to join the channel; otherwise, joining the channel fails and returns the error code -2.
    * @param config The configuration of the custom audio track. See AudioTrackConfig.
    *
    * @returns

package/ts/Private/IAgoraRtcEngine.ts

@@ -888,7 +888,7 @@ export class ScreenCaptureConfiguration {
    */
   params?: ScreenCaptureParameters;
   /**
-   * Rectangle. If you do not set this parameter, the SDK shares the whole screen. If the region you set exceeds the boundary of the screen, only the region within in the screen is shared. If you set width or height in Rectangle as 0, the whole screen is shared.
+   * The relative position of the shared region to the whole screen. See Rectangle. If you do not set this parameter, the SDK shares the whole screen. If the region you set exceeds the boundary of the screen, only the region within in the screen is shared. If you set width or height in Rectangle as 0, the whole screen is shared.
    */
   regionRect?: Rectangle;
 }
@@ -970,11 +970,11 @@ export class ScreenCaptureSourceInfo {
    */
   sourceName?: string;
   /**
-   * The image content of the thumbnail. See ThumbImageBuffer
+   * The image content of the thumbnail. See ThumbImageBuffer.
    */
   thumbImage?: ThumbImageBuffer;
   /**
-   * The image content of the icon. See ThumbImageBuffer
+   * The image content of the icon. See ThumbImageBuffer.
    */
   iconImage?: ThumbImageBuffer;
   /**
@@ -1038,7 +1038,7 @@ export class ImageTrackOptions {
 /**
  * The channel media options.
  *
- * Agora supports publishing multiple audio streams and one video stream at the same time and in the same RtcConnection. For example, publishMicrophoneTrack, publishAudioTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as true at the same time, but only one of publishCameraTrack, publishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as true. Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
+ * Agora supports publishing multiple audio streams and one video stream at the same time and in the same RtcConnection. For example, publishMicrophoneTrack, publishCustomAudioTrack, and publishMediaPlayerAudioTrack can be set as true at the same time, but only one of publishCameraTrack, publishScreenTrack, publishCustomVideoTrack, or publishEncodedVideoTrack can be set as true. Agora recommends that you set member parameter values yourself according to your business scenario, otherwise the SDK will automatically assign values to member parameters.
  */
 export class ChannelMediaOptions {
   /**
@@ -1154,7 +1154,7 @@ export class ChannelMediaOptions {
    */
   mediaPlayerAudioDelayMs?: number;
   /**
-   * (Optional) The token generated on your server for authentication. See
+   * (Optional) The token generated on your server for authentication.
    *  This parameter takes effect only when calling updateChannelMediaOptions or updateChannelMediaOptionsEx.
    *  Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the initialize method for initializing the RTC engine, and those used by the joinChannel and joinChannelEx methods for joining the channel.
    */
@@ -1592,7 +1592,7 @@ export interface IRtcEngineEventHandler {
   ): void;
 
   /**
-   * Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) leaves the channel.
+   * Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) joins the channel.
    *
    * In a communication channel, this callback indicates that a remote user joins the channel. The SDK also triggers this callback to report the existing users in the channel when a user joins the channel.
    *  In a live-broadcast channel, this callback indicates that a host joins the channel. The SDK also triggers this callback to report the existing hosts in the channel when a host joins the channel. Agora recommends limiting the number of hosts to 17. The SDK triggers this callback under one of the following circumstances:
@@ -1878,7 +1878,7 @@ export interface IRtcEngineEventHandler {
    *
    * When the token expires during a call, the SDK triggers this callback to remind the app to renew the token. When receiving this callback, you need to generate a new token on your token server and you can renew your token through one of the following ways:
    *  Call renewToken to pass in the new token.
-   *  Call to leave the current channel and then pass in the new token when you call joinChannel to join a channel.
+   *  Call leaveChannel to leave the current channel and then pass in the new token when you call joinChannel to join a channel.
    *
    * @param connection The connection information. See RtcConnection.
    */
@@ -2051,7 +2051,7 @@ export interface IRtcEngineEventHandler {
   /**
    * Occurs when the user role switching fails in the interactive live streaming.
    *
-   * In the live broadcasting channel profile, when the local user calls to switch the user role after joining the channel but the switch fails, the SDK triggers this callback to report the reason for the failure and the current user role.
+   * In the live broadcasting channel profile, when the local user calls setClientRole to switch the user role after joining the channel but the switch fails, the SDK triggers this callback to report the reason for the failure and the current user role.
    *
    * @param connection The connection information. See RtcConnection.
    * @param reason The reason for a user role switch failure. See ClientRoleChangeFailedReason.
@@ -2888,7 +2888,7 @@ export abstract class IRtcEngine {
   abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number };
 
   /**
-   * Preloads a channel with token, channelId uid
+   * Preloads a channel with token, channelId, and uid.
    *
    * When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host. As it may take a while for the SDK to preload a channel, Agora recommends that you call this method as soon as possible after obtaining the channel name and user ID to join a channel.
    *  When calling this method, ensure you set the user role as audience and do not set the audio scenario as AudioScenarioChorus, otherwise, this method does not take effect.
@@ -2922,7 +2922,7 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Preloads a channel with token, channelId userAccount.
+   * Preloads a channel with token, channelId, and userAccount.
    *
    * When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host. As it may take a while for the SDK to preload a channel, Agora recommends that you call this method as soon as possible after obtaining the channel name and user ID to join a channel. If you join a preloaded channel, leave it and want to rejoin the same channel, you do not need to call this method unless the token for preloading the channel expires.
    *  Failing to preload a channel does not mean that you can't join a channel, nor will it increase the time of joining a channel.
@@ -3130,13 +3130,13 @@ export abstract class IRtcEngine {
    *
    * In scenarios where there are existing cameras to capture video, Agora recommends that you use the following steps to capture and publish video with multiple cameras:
    *  Call this method to enable multi-channel camera capture.
-   *  Call to start the local video preview.
+   *  Call startPreview to start the local video preview.
    *  Call startCameraCapture, and set sourceType to start video capture with the second camera.
    *  Call joinChannelEx, and set publishSecondaryCameraTrack to true to publish the video stream captured by the second camera in the channel. If you want to disable multi-channel camera capture, use the following steps:
    *  Call stopCameraCapture.
-   *  Call this method with enabled set to false. You can call this method before and after to enable multi-camera capture:
-   *  If it is enabled before, the local video preview shows the image captured by the two cameras at the same time.
-   *  If it is enabled after, the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal. When using this function, ensure that the system version is 13.0 or later. The minimum iOS device types that support multi-camera capture are as follows:
+   *  Call this method with enabled set to false. You can call this method before and after startPreview to enable multi-camera capture:
+   *  If it is enabled before startPreview, the local video preview shows the image captured by the two cameras at the same time.
+   *  If it is enabled after startPreview, the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal. When using this function, ensure that the system version is 13.0 or later. The minimum iOS device types that support multi-camera capture are as follows:
    *  iPhone XR
    *  iPhone XS
    *  iPhone XS Max
@@ -3257,12 +3257,14 @@ export abstract class IRtcEngine {
    * Sets the image enhancement options.
    *
    * Enables or disables image enhancement, and sets the options.
-   *  Call this method before calling enableVideo or.
+   *  Call this method before calling enableVideo or startPreview.
    *  This method relies on the video enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
    *
    * @param enabled Whether to enable the image enhancement function: true : Enable the image enhancement function. false : (Default) Disable the image enhancement function.
    * @param options The image enhancement options. See BeautyOptions.
-   * @param type The type of the video source, see MediaSourceType.
+   * @param type Type of media source. See MediaSourceType. In this method, this parameter supports only the following two settings:
+   *  The default value is UnknownMediaSource.
+   *  If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.
    *
    * @returns
    * 0: Success.
@@ -3352,7 +3354,7 @@ export abstract class IRtcEngine {
   /**
    * Enables/Disables the virtual background.
    *
-   * The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background. Call this method before calling enableVideo or.
+   * The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background. Call this method before calling enableVideo or startPreview.
    *  This feature requires high performance devices. Agora recommends that you implement it on devices equipped with the following chips:
    *  Devices with an i5 CPU and better
    *  Agora recommends that you use this feature in scenarios that meet the following conditions:
@@ -3621,7 +3623,7 @@ export abstract class IRtcEngine {
   /**
    * Sets the stream type of the remote video.
    *
-   * Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamMode (false), the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate. By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream. The SDK enables the low-quality video stream auto mode on the sender by default (not actively sending low-quality video streams). The host at the receiving end can call this method to initiate a low-quality video stream stream request on the receiving end, and the sender automatically switches to the low-quality video stream mode after receiving the request. You can call this method either before or after joining a channel. If you call both setRemoteVideoStreamType and setRemoteDefaultVideoStreamType, the setting of setRemoteVideoStreamType takes effect.
+   * Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamMode (false), the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate. By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream. By default, the SDK enables the low-quality video stream auto mode on the sending end (it does not actively send the low-quality video stream). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling this method (the call to this method by the audience receiver does not take effect). After receiving the application, the sending end automatically switches to the low-quality video stream mode. You can call this method either before or after joining a channel. If you call both setRemoteVideoStreamType and setRemoteDefaultVideoStreamType, the setting of setRemoteVideoStreamType takes effect.
    *
    * @param uid The user ID.
    * @param streamType The video stream type: VideoStreamType.
@@ -3662,7 +3664,7 @@ export abstract class IRtcEngine {
   /**
    * Sets the default stream type of subscrption for remote video streams.
    *
-   * The SDK enables the low-quality video stream auto mode on the sender by default (not actively sending low-quality video streams). The host at the receiving end can call this method to initiate a low-quality video stream stream request on the receiving end, and the sender automatically switches to the low-quality video stream mode after receiving the request. Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamMode (false), the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate. By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream.
+   * By default, the SDK enables the low-quality video stream auto mode on the sending end (it does not actively send the low-quality video stream). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling this method (the call to this method by the audience receiver does not take effect). After receiving the application, the sending end automatically switches to the low-quality video stream mode. Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamMode (false), the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate. By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream.
    *  Call this method before joining a channel. The SDK does not support changing the default subscribed video stream type after joining a channel.
    *  If you call both this method and setRemoteVideoStreamType, the SDK applies the settings in the setRemoteVideoStreamType method.
    *
@@ -4740,10 +4742,12 @@ export abstract class IRtcEngine {
   /**
    * Sets dual-stream mode configuration on the sender, and sets the low-quality video stream.
    *
-   * The difference and connection between this method and is as follows:
-   *  When calling this method and setting mode to DisableSimulcastStream, it has the same effect as (false).
-   *  When calling this method and setting mode to EnableSimulcastStream, it has the same effect as (true).
-   *  Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence. The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to AutoSimulcastStream. If you want to modify this behavior, you can call this method and modify the mode to DisableSimulcastStream (never send low-quality video streams) or EnableSimulcastStream (always send low-quality video streams).
+   * The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling setRemoteVideoStreamType. After receiving the application, the sending end automatically switches to the low-quality video stream mode.
+   *  If you want to modify this behavior, you can call this method and modify the mode to DisableSimulcastStream (never send low-quality video streams) or EnableSimulcastStream (always send low-quality video streams).
+   *  If you want to restore the default behavior after making changes, you can call this method again with mode set to AutoSimulcastStream. The difference and connection between this method and is as follows:
+   *  When calling this method and setting mode to DisableSimulcastStream, it has the same effect as calling and setting enabled to false.
+   *  When calling this method and setting mode to EnableSimulcastStream, it has the same effect as calling and setting enabled to true.
+   *  Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
    *
    * @param mode The mode in which the video stream is sent. See SimulcastStreamMode.
    * @param streamConfig The configuration of the low-quality video stream. See SimulcastStreamConfig. When setting mode to DisableSimulcastStream, setting streamConfig will not take effect.
@@ -5168,7 +5172,9 @@ export abstract class IRtcEngine {
    * @param extension The name of the extension.
    * @param key The key of the extension.
    * @param value The value of the extension key.
-   * @param type The type of the video source, see MediaSourceType.
+   * @param type Type of media source. See MediaSourceType. In this method, this parameter supports only the following two settings:
+   *  The default value is UnknownMediaSource.
+   *  If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.
    *
    * @returns
    * 0: Success.
@@ -5419,7 +5425,7 @@ export abstract class IRtcEngine {
    *  Call this method after joining a channel, and then call updateChannelMediaOptions and set publishScreenTrack or publishSecondaryScreenTrack to true to start screen sharing. Deprecated: This method is deprecated. Use startScreenCaptureByDisplayId instead. Agora strongly recommends using startScreenCaptureByDisplayId if you need to start screen sharing on a device connected to another display. This method shares a screen or part of the screen. You need to specify the area of the screen to be shared. This method applies to Windows only.
    *
    * @param screenRect Sets the relative location of the screen to the virtual screen.
-   * @param regionRect Rectangle. If the specified region overruns the screen, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen.
+   * @param regionRect Sets the relative location of the region to the screen. If you do not set this parameter, the SDK shares the whole screen. See Rectangle. If the specified region overruns the screen, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen.
    * @param captureParams The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters.
    *
    * @returns
@@ -5506,7 +5512,7 @@ export abstract class IRtcEngine {
    *
    * Call this method after starting screen sharing or window sharing.
    *
-   * @param captureParams The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters
+   * @param captureParams The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters.
    *
    * @returns
    * 0: Success.
@@ -5710,7 +5716,7 @@ export abstract class IRtcEngine {
    *  If you need to mix locally captured video streams, the SDK supports the following capture combinations:
    *  On the Windows platform, it supports up to 4 video streams captured by cameras + 4 screen sharing streams.
    *  On the macOS platform, it supports up to 4 video streams captured by cameras + 1 screen sharing stream.
-   *  If you need to mix the locally collected video streams, you need to call this method after startCameraCapture or startScreenCaptureBySourceType
+   *  If you need to mix the locally collected video streams, you need to call this method after startCameraCapture or startScreenCaptureBySourceType.
    *  If you want to publish the mixed video stream to the channel, you need to set publishTranscodedVideoTrack in ChannelMediaOptions to true when calling joinChannel or updateChannelMediaOptions.
    *
    * @param config Configuration of the local video mixing, see LocalTranscoderConfiguration.
@@ -5728,7 +5734,7 @@ export abstract class IRtcEngine {
   /**
    * Updates the local video mixing configuration.
    *
-   * After calling startLocalVideoTranscoder, call this method if you want to update the local video mixing configuration. If you want to update the video source type used for local video mixing, such as adding a second camera or screen to capture video, you need to call this method after startCameraCapture or startScreenCaptureBySourceType
+   * After calling startLocalVideoTranscoder, call this method if you want to update the local video mixing configuration. If you want to update the video source type used for local video mixing, such as adding a second camera or screen to capture video, you need to call this method after startCameraCapture or startScreenCaptureBySourceType.
    *
    * @param config Configuration of the local video mixing, see LocalTranscoderConfiguration.
    *
@@ -5778,6 +5784,7 @@ export abstract class IRtcEngine {
    * Sets the rotation angle of the captured video.
    *
    * This method applies to Windows only.
+   *  You must call this method after enableVideo. The setting result will take effect after the camera is successfully turned on, that is, after the SDK triggers the onLocalVideoStateChanged callback and returns the local video state as LocalVideoStreamStateCapturing (1).
    *  When the video capture device does not have the gravity sensing function, you can call this method to manually adjust the rotation angle of the captured video.
    *
    * @param type The video source type. See VideoSourceType.
@@ -6067,7 +6074,7 @@ export abstract class IRtcEngine {
    * You can call this method to enable AI noise suppression function. Once enabled, the SDK automatically detects and reduces stationary and non-stationary noise from your audio on the premise of ensuring the quality of human voice. Stationary noise refers to noise signal with constant average statistical properties and negligibly small fluctuations of level within the period of observation. Common sources of stationary noises are:
    *  Television;
    *  Air conditioner;
-   *  Machinery, etc. Non-stationary noise refers to noise signal with huge fluctuations of level within the period of observation. Common sources of non-stationary noises are:
+   *  Machinery, etc. Non-stationary noise refers to noise signal with huge fluctuations of level within the period of observation; common sources of non-stationary noises are:
    *  Thunder;
    *  Explosion;
    *  Cracking, etc.
@@ -6389,7 +6396,7 @@ export abstract class IRtcEngine {
    *
    * This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path. The method is asynchronous, and the SDK has not taken the snapshot when the method call returns. After a successful method call, the SDK triggers the onSnapshotTaken callback to report whether the snapshot is successfully taken, as well as the details for that snapshot.
    *  Call this method after joining a channel.
-   *  This method takes a snapshot of the published video stream specified in ChannelMediaOptions.
+   *  When used for local video snapshots, this method takes a snapshot for the video streams specified in ChannelMediaOptions.
    *  If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.
    *
    * @param uid The user ID. Set uid as 0 if you want to take a snapshot of the local user's video.
@@ -6409,7 +6416,7 @@ export abstract class IRtcEngine {
    * When video screenshot and upload function is enabled, the SDK takes screenshots and upload videos sent by local users based on the type and frequency of the module you set in ContentInspectConfig. After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service. Before calling this method, ensure that the video screenshot upload service has been activated. Before calling this method, ensure that Video content moderation service has been activated.
    *  This method relies on the video screenshot and upload dynamic library libagora_content_inspect_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
    *
-   * @param enabled Whether to enable video screenshot and upload true : Enables video screenshot and upload. false : Disables video screenshot and upload.
+   * @param enabled Whether to enable video screenshot and upload : true : Enables video screenshot and upload. false : Disables video screenshot and upload.
    * @param config Configuration of video screenshot and upload. See ContentInspectConfig.
    *
    * @returns
@@ -6422,9 +6429,9 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Adjusts the volume of the custom external audio source when it is published in the channel.
+   * Adjusts the volume of the custom audio track played remotely.
    *
-   * Ensure you have called the createCustomAudioTrack method to create an external audio track before calling this method. If you want to change the volume of the audio to be published, you need to call this method again.
+   * Ensure you have called the createCustomAudioTrack method to create a custom audio track before calling this method. If you want to change the volume of the audio to be published, you need to call this method again.
    *
    * @param trackId The audio track ID. Set this parameter to the custom audio track ID returned in createCustomAudioTrack.
    * @param volume The volume of the audio source. The value can range from 0 to 100. 0 means mute; 100 means the original volume.

package/ts/Private/IAgoraRtcEngineEx.ts

@@ -78,7 +78,7 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    *
    * This method lets the user leave the channel, for example, by hanging up or exiting the call. After calling joinChannelEx to join the channel, this method must be called to end the call before starting the next call. This method can be called whether or not a call is currently in progress. This method releases all resources related to the session. This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the onLeaveChannel callback. After actually leaving the channel, the local user triggers the onLeaveChannel callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the onUserOffline callback.
    *  If you call release immediately after calling this method, the SDK does not trigger the onLeaveChannel callback.
-   *  Calling leaveChannel will leave the channels when calling joinChannel and joinChannelEx at the same time.
+   *  Calling leaveChannel will leave the channels joined by calling joinChannel and joinChannelEx.
    *
    * @param connection The connection information. See RtcConnection.
    * @param options The options for leaving the channel. See LeaveChannelOptions. This parameter only supports the stopMicrophoneRecording member in the LeaveChannelOptions settings; setting other members does not take effect.
@@ -522,7 +522,7 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Creates a data stream.
    *
-   * Creates a data stream. Each user can create up to five data streams in a single channel. Compared with createDataStreamEx, this method does not support data reliability. If a data packet is not received five seconds after it was sent, the SDK directly discards the data.
+   * Creates a data stream. Each user can create up to five data streams in a single channel.
    *
    * @param config The configurations for the data stream. See DataStreamConfig.
    * @param connection The connection information. See RtcConnection.
@@ -899,7 +899,7 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    *
    * The method is asynchronous, and the SDK has not taken the snapshot when the method call returns. After a successful method call, the SDK triggers the onSnapshotTaken callback to report whether the snapshot is successfully taken, as well as the details for that snapshot. This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path.
    *  Call this method after the joinChannelEx method.
-   *  This method takes a snapshot of the published video stream specified in ChannelMediaOptions.
+   *  When used for local video snapshots, this method takes a snapshot for the video streams specified in ChannelMediaOptions.
    *  If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.
    *
    * @param connection The connection information. See RtcConnection.

package/ts/Private/IAgoraSpatialAudio.ts

@@ -207,7 +207,7 @@ export abstract class IBaseSpatialAudioEngine {
    *  If the user or media player is in the same sound insulation area, it is not affected by SpatialAudioZone, and the sound attenuation effect is determined by the attenuation parameter in setPlayerAttenuation or setRemoteAudioAttenuation. If you do not call setPlayerAttenuation or setRemoteAudioAttenuation, the default sound attenuation coefficient of the SDK is 0.5, which simulates the attenuation of the sound in the real environment.
    *  If the sound source and the receiver belong to two sound insulation areas, the receiver cannot hear the sound source. If this method is called multiple times, the last sound insulation area set takes effect.
    *
-   * @param zones Sound insulation area settings. See SpatialAudioZone.
+   * @param zones Sound insulation area settings. See SpatialAudioZone. On the Windows platform, it is necessary to ensure that the number of members in the zones array is equal to the value of zoneCount; otherwise, it may cause a crash.
    * @param zoneCount The number of sound insulation areas.
    *
    * @returns