agora-electron-sdk 4.5.0-dev.1 → 4.5.0-dev.2

package/CHANGELOG.md

@@ -1,6 +1,13 @@
 
 
-# [4.5.0-dev.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.4.0...v4.5.0-dev.1) (2024-11-06)
+# [4.5.0-dev.2](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.5.0...v4.5.0-dev.2) (2024-12-19)
+
+# [4.5.0](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.4.0...v4.5.0) (2024-12-10)
+
+
+### Features
+
+* support 4.5.0 ([#1228](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1228)) ([d1a6d9c](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/d1a6d9cc2aa361e7b96ad158debe791f4accc6a7)), closes [#1224](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1224)
 
 # [4.4.0](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.3.2...v4.4.0) (2024-08-29)
 

package/js/Private/AgoraBase.js

@@ -772,11 +772,11 @@ var OrientationMode;
 var DegradationPreference;
 (function (DegradationPreference) {
     /**
-     * @ignore
+     * 0: (Default) Automatic mode. The SDK will automatically select MaintainFramerate, MaintainBalanced or MaintainResolution based on the video scenario you set, in order to achieve the best overall quality of experience (QoE).
      */
     DegradationPreference[DegradationPreference["MaintainAuto"] = -1] = "MaintainAuto";
     /**
-     * 0: (Default) Prefers to reduce the video frame rate while maintaining video resolution during video encoding under limited bandwidth. This degradation preference is suitable for scenarios where video quality is prioritized.
+     * 0: Prefers to reduce the video frame rate while maintaining video resolution during video encoding under limited bandwidth. This degradation preference is suitable for scenarios where video quality is prioritized. Deprecated: This enumerator is deprecated. Use other enumerations instead.
      */
     DegradationPreference[DegradationPreference["MaintainQuality"] = 0] = "MaintainQuality";
     /**
@@ -1138,7 +1138,7 @@ exports.EncodedVideoFrameInfo = EncodedVideoFrameInfo;
 var CompressionPreference;
 (function (CompressionPreference) {
     /**
-     * @ignore
+     * -1: (Default) Automatic mode. The SDK will automatically select PreferLowLatency or PreferQuality based on the video scenario you set to achieve the best user experience.
      */
     CompressionPreference[CompressionPreference["PreferCompressionAuto"] = -1] = "PreferCompressionAuto";
     /**
@@ -1146,7 +1146,7 @@ var CompressionPreference;
      */
     CompressionPreference[CompressionPreference["PreferLowLatency"] = 0] = "PreferLowLatency";
     /**
-     * 1: (Default) High quality preference. The SDK compresses video frames while maintaining video quality. This preference is suitable for scenarios where video quality is prioritized.
+     * 1: High quality preference. The SDK compresses video frames while maintaining video quality. This preference is suitable for scenarios where video quality is prioritized.
      */
     CompressionPreference[CompressionPreference["PreferQuality"] = 1] = "PreferQuality";
 })(CompressionPreference = exports.CompressionPreference || (exports.CompressionPreference = {}));
@@ -1670,11 +1670,11 @@ var VideoApplicationScenarioType;
      */
     VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenarioMeeting"] = 1] = "ApplicationScenarioMeeting";
     /**
-     * ApplicationScenario1v1 (2) is suitable for 1v1 video call scenarios. To meet the requirements for low latency and high-quality video in this scenario, the SDK optimizes its strategies, improving performance in terms of video quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under weak network conditions. 2: 1v1 video call scenario.
+     * ApplicationScenario1v1 (2) This is applicable to the scenario. To meet the requirements for low latency and high-quality video in this scenario, the SDK optimizes its strategies, improving performance in terms of video quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under weak network conditions. 2: 1v1 video call scenario.
      */
     VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenario1v1"] = 2] = "ApplicationScenario1v1";
     /**
-     * @ignore
+     * ApplicationScenarioLiveshow (3) This is applicable to the scenario. In this scenario, fast video rendering and high image quality are crucial. The SDK implements several performance optimizations, including automatically enabling accelerated audio and video frame rendering to minimize first-frame latency (no need to call enableInstantMediaRendering), and B-frame encoding to achieve better image quality and bandwidth efficiency. The SDK also provides enhanced video quality and smooth playback, even in poor network conditions or on lower-end devices. 3. Live show scenario.
      */
     VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenarioLiveshow"] = 3] = "ApplicationScenarioLiveshow";
 })(VideoApplicationScenarioType = exports.VideoApplicationScenarioType || (exports.VideoApplicationScenarioType = {}));
@@ -1888,11 +1888,11 @@ var LocalVideoStreamReason;
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonDeviceNotFound"] = 8] = "LocalVideoStreamReasonDeviceNotFound";
     /**
-     * 9: (macOS only) The video capture device currently in use is disconnected (such as being unplugged).
+     * 9: The video capture device currently in use is disconnected (such as being unplugged).
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonDeviceDisconnected"] = 9] = "LocalVideoStreamReasonDeviceDisconnected";
     /**
-     * 10: (macOS and Windows only) The SDK cannot find the video device in the video device list. Check whether the ID of the video device is valid.
+     * 10: The SDK cannot find the video device in the video device list. Check whether the ID of the video device is valid.
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonDeviceInvalidId"] = 10] = "LocalVideoStreamReasonDeviceInvalidId";
     /**
@@ -1908,11 +1908,11 @@ var LocalVideoStreamReason;
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonDeviceSystemPressure"] = 101] = "LocalVideoStreamReasonDeviceSystemPressure";
     /**
-     * 11: (macOS and Windows only) The shared window is minimized when you call the startScreenCaptureByWindowId method to share a window. The SDK cannot share a minimized window. Please prompt the user to unminimize the shared window.
+     * 11: The shared window is minimized when you call the startScreenCaptureByWindowId method to share a window. The SDK cannot share a minimized window. Please prompt the user to unminimize the shared window.
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureWindowMinimized"] = 11] = "LocalVideoStreamReasonScreenCaptureWindowMinimized";
     /**
-     * 12: (macOS and Windows only) The error code indicates that a window shared by the window ID has been closed or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing. Common scenarios reporting this error code:
+     * 12: The error code indicates that a window shared by the window ID has been closed or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing. Common scenarios reporting this error code:
      *  The local user closes the shared window.
      *  The local user shows some slides in full-screen mode first, and then shares the windows of the slides. After the user exits full-screen mode, the SDK reports this error code.
      *  The local user watches a web video or reads a web document in full-screen mode first, and then shares the window of the web video or document. After the user exits full-screen mode, the SDK reports this error code.
@@ -1927,7 +1927,7 @@ var LocalVideoStreamReason;
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureWindowNotSupported"] = 20] = "LocalVideoStreamReasonScreenCaptureWindowNotSupported";
     /**
-     * 21: (Windows only) The screen has not captured any data available for window sharing.
+     * 21: (Windows and Android only) The currently captured window has no data.
      */
     LocalVideoStreamReason[LocalVideoStreamReason["LocalVideoStreamReasonScreenCaptureFailure"] = 21] = "LocalVideoStreamReasonScreenCaptureFailure";
     /**
@@ -2502,13 +2502,13 @@ var VideoTranscoderError;
     VideoTranscoderError[VideoTranscoderError["VtErrInternal"] = 20] = "VtErrInternal";
 })(VideoTranscoderError = exports.VideoTranscoderError || (exports.VideoTranscoderError = {}));
 /**
- * @ignore
+ * The source of the audio streams that are mixed locally.
  */
 class MixedAudioStream {
 }
 exports.MixedAudioStream = MixedAudioStream;
 /**
- * @ignore
+ * The configurations for mixing the lcoal audio.
  */
 class LocalAudioMixerConfiguration {
 }
@@ -2902,7 +2902,7 @@ class FaceShapeBeautyOptions {
 }
 exports.FaceShapeBeautyOptions = FaceShapeBeautyOptions;
 /**
- * @ignore
+ * Filter effect options.
  */
 class FilterEffectOptions {
 }
@@ -2956,7 +2956,7 @@ var VideoDenoiserMode;
     VideoDenoiserMode[VideoDenoiserMode["VideoDenoiserManual"] = 1] = "VideoDenoiserManual";
 })(VideoDenoiserMode = exports.VideoDenoiserMode || (exports.VideoDenoiserMode = {}));
 /**
- * The video noise reduction level.
+ * Video noise reduction level.
  */
 var VideoDenoiserLevel;
 (function (VideoDenoiserLevel) {
@@ -2965,7 +2965,7 @@ var VideoDenoiserLevel;
      */
     VideoDenoiserLevel[VideoDenoiserLevel["VideoDenoiserLevelHighQuality"] = 0] = "VideoDenoiserLevelHighQuality";
     /**
-     * 1: Promotes reducing performance consumption during video noise reduction. prioritizes reducing performance consumption over video noise reduction quality. The performance consumption is lower, and the video noise reduction speed is faster. To avoid a noticeable shadowing effect (shadows trailing behind moving objects) in the processed video, Agora recommends that you use this settinging when the camera is fixed.
+     * 1: Promotes reducing performance consumption during video noise reduction. It prioritizes reducing performance consumption over video noise reduction quality. The performance consumption is lower, and the video noise reduction speed is faster. To avoid a noticeable shadowing effect (shadows trailing behind moving objects) in the processed video, Agora recommends that you use this setting when the camera is fixed.
      */
     VideoDenoiserLevel[VideoDenoiserLevel["VideoDenoiserLevelFast"] = 1] = "VideoDenoiserLevelFast";
 })(VideoDenoiserLevel = exports.VideoDenoiserLevel || (exports.VideoDenoiserLevel = {}));

package/js/Private/AgoraMediaBase.js

@@ -91,24 +91,24 @@ var VideoSourceType;
     VideoSourceType[VideoSourceType["VideoSourceUnknown"] = 100] = "VideoSourceUnknown";
 })(VideoSourceType = exports.VideoSourceType || (exports.VideoSourceType = {}));
 /**
- * @ignore
+ * The audio source type.
  */
 var AudioSourceType;
 (function (AudioSourceType) {
     /**
-     * @ignore
+     * 0: (Default) Microphone.
      */
     AudioSourceType[AudioSourceType["AudioSourceMicrophone"] = 0] = "AudioSourceMicrophone";
     /**
-     * @ignore
+     * 1: Custom audio stream.
      */
     AudioSourceType[AudioSourceType["AudioSourceCustom"] = 1] = "AudioSourceCustom";
     /**
-     * @ignore
+     * 2: Media player.
      */
     AudioSourceType[AudioSourceType["AudioSourceMediaPlayer"] = 2] = "AudioSourceMediaPlayer";
     /**
-     * @ignore
+     * 3: System audio stream captured during screen sharing.
      */
     AudioSourceType[AudioSourceType["AudioSourceLoopbackRecording"] = 3] = "AudioSourceLoopbackRecording";
     /**
@@ -116,15 +116,15 @@ var AudioSourceType;
      */
     AudioSourceType[AudioSourceType["AudioSourceMixedStream"] = 4] = "AudioSourceMixedStream";
     /**
-     * @ignore
+     * 5: Audio stream from a specified remote user.
      */
     AudioSourceType[AudioSourceType["AudioSourceRemoteUser"] = 5] = "AudioSourceRemoteUser";
     /**
-     * @ignore
+     * 6: Mixed audio streams from all users in the current channel.
      */
     AudioSourceType[AudioSourceType["AudioSourceRemoteChannel"] = 6] = "AudioSourceRemoteChannel";
     /**
-     * @ignore
+     * 100: An unknown audio source.
      */
     AudioSourceType[AudioSourceType["AudioSourceUnknown"] = 100] = "AudioSourceUnknown";
 })(AudioSourceType = exports.AudioSourceType || (exports.AudioSourceType = {}));
@@ -442,11 +442,11 @@ var VideoPixelFormat;
 var RenderModeType;
 (function (RenderModeType) {
     /**
-     * 1: Hidden mode. Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). One dimension of the video may have clipped contents.
+     * 1: Hidden mode. The priority is to fill the window. Any excess video that does not match the window size will be cropped.
      */
     RenderModeType[RenderModeType["RenderModeHidden"] = 1] = "RenderModeHidden";
     /**
-     * 2: Fit mode. Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to disparity in the aspect ratio are filled with black.
+     * 2: Fit mode. The priority is to ensure that all video content is displayed. Any areas of the window that are not filled due to the mismatch between video size and window size will be filled with black.
      */
     RenderModeType[RenderModeType["RenderModeFit"] = 2] = "RenderModeFit";
     /**
@@ -713,28 +713,28 @@ class Hdr10MetadataInfo {
 }
 exports.Hdr10MetadataInfo = Hdr10MetadataInfo;
 /**
- * @ignore
+ * The relative position of alphaBuffer and video frames.
  */
 var AlphaStitchMode;
 (function (AlphaStitchMode) {
     /**
-     * @ignore
+     * 0: (Default) Only video frame, that is, alphaBuffer is not stitched with the video frame.
      */
     AlphaStitchMode[AlphaStitchMode["NoAlphaStitch"] = 0] = "NoAlphaStitch";
     /**
-     * @ignore
+     * 1: alphaBuffer is above the video frame.
      */
     AlphaStitchMode[AlphaStitchMode["AlphaStitchUp"] = 1] = "AlphaStitchUp";
     /**
-     * @ignore
+     * 2: alphaBuffer is below the video frame.
      */
     AlphaStitchMode[AlphaStitchMode["AlphaStitchBelow"] = 2] = "AlphaStitchBelow";
     /**
-     * @ignore
+     * 3: alphaBuffer is to the left of the video frame.
      */
     AlphaStitchMode[AlphaStitchMode["AlphaStitchLeft"] = 3] = "AlphaStitchLeft";
     /**
-     * @ignore
+     * 4: alphaBuffer is to the right of the video frame.
      */
     AlphaStitchMode[AlphaStitchMode["AlphaStitchRight"] = 4] = "AlphaStitchRight";
 })(AlphaStitchMode = exports.AlphaStitchMode || (exports.AlphaStitchMode = {}));
@@ -827,7 +827,7 @@ var VideoModulePosition;
     VideoModulePosition[VideoModulePosition["PositionPostCapturerOrigin"] = 8] = "PositionPostCapturerOrigin";
 })(VideoModulePosition = exports.VideoModulePosition || (exports.VideoModulePosition = {}));
 /**
- * @ignore
+ * The snapshot configuration.
  */
 class SnapshotConfig {
 }

package/js/Private/IAgoraRtcEngine.js

@@ -660,7 +660,7 @@ var MediaDeviceStateType;
      */
     MediaDeviceStateType[MediaDeviceStateType["MediaDeviceStateDisabled"] = 2] = "MediaDeviceStateDisabled";
     /**
-     * @ignore
+     * 3: The device is plugged in.
      */
     MediaDeviceStateType[MediaDeviceStateType["MediaDeviceStatePluggedIn"] = 3] = "MediaDeviceStatePluggedIn";
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agora-electron-sdk",
-  "version": "4.5.0-dev.1",
+  "version": "4.5.0-dev.2",
   "description": "agora-electron-sdk",
   "main": "js/AgoraSdk",
   "types": "types/AgoraSdk.d.ts",
@@ -142,9 +142,9 @@
     "yuv-canvas": "1.2.6"
   },
   "agora_electron": {
-    "iris_sdk_win": "https://download.agora.io/sdk/release/iris_4.5.0-dev.12_DCG_Windows_Video_Standalone_20241106_1153_560.zip",
-    "iris_sdk_mac": "https://download.agora.io/sdk/release/iris_4.5.0-dev.12_DCG_Mac_Video_Standalone_20241106_1153_521.zip",
-    "native_sdk_win": "https://download.agora.io/sdk/release/AgoraRtcEngine_windows_Preview_4.5.0-dev.12.zip",
-    "native_sdk_mac": "https://download.agora.io/sdk/release/AgoraRtcEngine_macOS_Preview_4.5.0-dev.12.zip"
+    "iris_sdk_win": "https://download.agora.io/sdk/release/iris_4.5.0-build.1_DCG_Windows_Video_Standalone_20241203_0322_577.zip",
+    "iris_sdk_mac": "https://download.agora.io/sdk/release/iris_4.5.0-build.1_DCG_Mac_Video_Standalone_20241203_0322_534.zip",
+    "native_sdk_win": "https://download.agora.io/sdk/release/Agora_Native_SDK_for_Windows_v4.5.0_FULL.zip",
+    "native_sdk_mac": "https://download.agora.io/sdk/release/Agora_Native_SDK_for_Mac_v4.5.0_FULL.zip"
   }
 }

package/scripts/downloadPrebuild.js

@@ -29,6 +29,8 @@ const getDownloadURL = () => {
   return downloadUrl;
 };
 
+// If native_stk_url is not defined in app/packaging.json,
+// it will be read from agora-electron-sdk/packaging.json
 const getNativeDownloadURL = () => {
   let downloadUrl = '';
   if (platform === 'win32') {
@@ -36,6 +38,21 @@ const getNativeDownloadURL = () => {
   } else if (platform === 'darwin') {
     downloadUrl = native_sdk_mac;
   }
+
+  if (!downloadUrl) {
+    const {
+      agora_electron: {
+        native_sdk_win,
+        native_sdk_mac,
+      }
+    } = require("../package.json");
+    if (platform === 'win32') {
+      downloadUrl = native_sdk_win;
+    } else if (platform === 'darwin') {
+      downloadUrl = native_sdk_mac;
+    }
+  }
+
   return downloadUrl;
 };
 

package/scripts/publishCN/common.sh

@@ -0,0 +1,19 @@
+# common.sh
+#!/bin/bash
+
+old_package_name='agora-electron-sdk'
+new_package_name='shengwang-electron-sdk'
+
+#./package.json
+old_name="\"name\": \"agora-electron-sdk\""
+new_name="\"name\": \"shengwang-electron-sdk\""
+
+old_description="\"description\": \"agora-electron-sdk\""
+new_description="\"description\": \"shengwang-electron-sdk\""
+
+old_yarn_link="yarn example link agora-electron-sdk"
+new_yarn_link="yarn example link shengwang-electron-sdk"
+
+# node_modules
+old_node_modules="node_modules/agora-electron-sdk"
+new_node_modules="node_modules/shengwang-electron-sdk"

package/scripts/publishCN/rewrite-dep.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+set -e
+MY_PATH=$(realpath $(dirname "$0"))
+PROJECT_ROOT=$(realpath ${MY_PATH}/../..)
+. ${PROJECT_ROOT}/scripts/publishCN/common.sh
+
+change_file=${PROJECT_ROOT}/package.json
+sed "s/${old_name}/${new_name}/g" ${change_file} >tmp && mv tmp ${change_file}
+sed "s/${old_description}/${new_description}/g" ${change_file} >tmp && mv tmp ${change_file}
+sed "s/${old_yarn_link}/${new_yarn_link}/g" ${change_file} >tmp && mv tmp ${change_file}
+
+change_file=${PROJECT_ROOT}/tsconfig.json
+sed "s/${old_package_name}/${new_package_name}/g" ${change_file} >tmp && mv tmp ${change_file}
+
+change_file=${PROJECT_ROOT}/.github/workflows/publish.yml
+sed "s/${old_package_name}/${new_package_name}/g" ${change_file} >tmp && mv tmp ${change_file}
+
+change_file=${PROJECT_ROOT}/ci/packager-mac.sh
+sed "s#${old_node_modules}#${new_node_modules}#g" ${change_file} >tmp && mv tmp ${change_file}
+
+change_file=${PROJECT_ROOT}/ci/packager-win.ps1
+sed "s#${old_node_modules}#${new_node_modules}#g" ${change_file} >tmp && mv tmp ${change_file}

package/scripts/publishCN/rewrite-example.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+set -e
+MY_PATH=$(realpath $(dirname "$0"))
+PROJECT_ROOT=$(realpath ${MY_PATH}/../..)
+. ${PROJECT_ROOT}/scripts/publishCN/common.sh
+
+change_dir="${PROJECT_ROOT}/example/src"
+
+find "$change_dir" -type f | while read -r file; do
+  sed -i.bak "s/${old_package_name}/${new_package_name}/g" "$file"
+  echo "Replaced in $file"
+done
+
+change_file=${PROJECT_ROOT}/example/package.json
+sed "s/${old_package_name}/${new_package_name}/g" ${change_file} >tmp && mv tmp ${change_file}
+
+change_file=${PROJECT_ROOT}/example/webpack.renderer.additions.js
+sed "s/${old_package_name}/${new_package_name}/g" ${change_file} >tmp && mv tmp ${change_file}
+
+find "$change_dir" -name "*.bak" -type f -delete
+
+echo "All replacements completed successfully, and backup files have been deleted."

package/scripts/zipBuild.js

@@ -4,8 +4,31 @@ const { exec } = require('shelljs');
 
 const logger = require('./logger');
 const { getOS } = require('./util');
+const fs = require('fs');
+
+
+const keepList = [
+  'AgoraRtcWrapper',
+  'agora_node_ext'
+];
+
+const filesMove = (src, dest, keepList) => {
+  fs.readdirSync(src).forEach(file => {
+    const filePath = path.join(src, file);
+    const shouldKeep = keepList.some(pattern => file.includes(pattern));
+    if (!shouldKeep) {
+      const destPath = path.join(dest, file);
+      fs.renameSync(filePath, destPath);
+    }
+  });
+};
 
 const zipBuild = async () => {
+  const temp_native = path.join(__dirname, '..', 'build', 'temp_native');
+  const build_release = path.join(__dirname, '..', 'build', 'Release');
+  fs.mkdirSync(temp_native);
+  filesMove(build_release, temp_native, keepList);
+
   const isMac = getOS() === 'mac';
   const fileListStr = ` build${path.sep}Release js types package.json`;
   const shellStr =
@@ -14,6 +37,8 @@ const zipBuild = async () => {
   if (code !== 0) {
     logger.error(stderr);
   }
+  filesMove(temp_native, build_release, []);
+  fs.rmdirSync(temp_native, { recursive: true });
 };
 
 module.exports = zipBuild;

package/ts/Private/AgoraBase.ts

@@ -772,11 +772,11 @@ export enum OrientationMode {
  */
 export enum DegradationPreference {
   /**
-   * @ignore
+   * 0: (Default) Automatic mode. The SDK will automatically select MaintainFramerate, MaintainBalanced or MaintainResolution based on the video scenario you set, in order to achieve the best overall quality of experience (QoE).
    */
   MaintainAuto = -1,
   /**
-   * 0: (Default) Prefers to reduce the video frame rate while maintaining video resolution during video encoding under limited bandwidth. This degradation preference is suitable for scenarios where video quality is prioritized.
+   * 0: Prefers to reduce the video frame rate while maintaining video resolution during video encoding under limited bandwidth. This degradation preference is suitable for scenarios where video quality is prioritized. Deprecated: This enumerator is deprecated. Use other enumerations instead.
    */
   MaintainQuality = 0,
   /**
@@ -1266,7 +1266,7 @@ export class EncodedVideoFrameInfo {
  */
 export enum CompressionPreference {
   /**
-   * @ignore
+   * -1: (Default) Automatic mode. The SDK will automatically select PreferLowLatency or PreferQuality based on the video scenario you set to achieve the best user experience.
    */
   PreferCompressionAuto = -1,
   /**
@@ -1274,7 +1274,7 @@ export enum CompressionPreference {
    */
   PreferLowLatency = 0,
   /**
-   * 1: (Default) High quality preference. The SDK compresses video frames while maintaining video quality. This preference is suitable for scenarios where video quality is prioritized.
+   * 1: High quality preference. The SDK compresses video frames while maintaining video quality. This preference is suitable for scenarios where video quality is prioritized.
    */
   PreferQuality = 1,
 }
@@ -2108,11 +2108,11 @@ export enum VideoApplicationScenarioType {
    */
   ApplicationScenarioMeeting = 1,
   /**
-   * ApplicationScenario1v1 (2) is suitable for 1v1 video call scenarios. To meet the requirements for low latency and high-quality video in this scenario, the SDK optimizes its strategies, improving performance in terms of video quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under weak network conditions. 2: 1v1 video call scenario.
+   * ApplicationScenario1v1 (2) This is applicable to the scenario. To meet the requirements for low latency and high-quality video in this scenario, the SDK optimizes its strategies, improving performance in terms of video quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under weak network conditions. 2: 1v1 video call scenario.
    */
   ApplicationScenario1v1 = 2,
   /**
-   * @ignore
+   * ApplicationScenarioLiveshow (3) This is applicable to the scenario. In this scenario, fast video rendering and high image quality are crucial. The SDK implements several performance optimizations, including automatically enabling accelerated audio and video frame rendering to minimize first-frame latency (no need to call enableInstantMediaRendering), and B-frame encoding to achieve better image quality and bandwidth efficiency. The SDK also provides enhanced video quality and smooth playback, even in poor network conditions or on lower-end devices. 3. Live show scenario.
    */
   ApplicationScenarioLiveshow = 3,
 }
@@ -2326,11 +2326,11 @@ export enum LocalVideoStreamReason {
    */
   LocalVideoStreamReasonDeviceNotFound = 8,
   /**
-   * 9: (macOS only) The video capture device currently in use is disconnected (such as being unplugged).
+   * 9: The video capture device currently in use is disconnected (such as being unplugged).
    */
   LocalVideoStreamReasonDeviceDisconnected = 9,
   /**
-   * 10: (macOS and Windows only) The SDK cannot find the video device in the video device list. Check whether the ID of the video device is valid.
+   * 10: The SDK cannot find the video device in the video device list. Check whether the ID of the video device is valid.
    */
   LocalVideoStreamReasonDeviceInvalidId = 10,
   /**
@@ -2346,11 +2346,11 @@ export enum LocalVideoStreamReason {
    */
   LocalVideoStreamReasonDeviceSystemPressure = 101,
   /**
-   * 11: (macOS and Windows only) The shared window is minimized when you call the startScreenCaptureByWindowId method to share a window. The SDK cannot share a minimized window. Please prompt the user to unminimize the shared window.
+   * 11: The shared window is minimized when you call the startScreenCaptureByWindowId method to share a window. The SDK cannot share a minimized window. Please prompt the user to unminimize the shared window.
    */
   LocalVideoStreamReasonScreenCaptureWindowMinimized = 11,
   /**
-   * 12: (macOS and Windows only) The error code indicates that a window shared by the window ID has been closed or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing. Common scenarios reporting this error code:
+   * 12: The error code indicates that a window shared by the window ID has been closed or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing. Common scenarios reporting this error code:
    *  The local user closes the shared window.
    *  The local user shows some slides in full-screen mode first, and then shares the windows of the slides. After the user exits full-screen mode, the SDK reports this error code.
    *  The local user watches a web video or reads a web document in full-screen mode first, and then shares the window of the web video or document. After the user exits full-screen mode, the SDK reports this error code.
@@ -2365,7 +2365,7 @@ export enum LocalVideoStreamReason {
    */
   LocalVideoStreamReasonScreenCaptureWindowNotSupported = 20,
   /**
-   * 21: (Windows only) The screen has not captured any data available for window sharing.
+   * 21: (Windows and Android only) The currently captured window has no data.
    */
   LocalVideoStreamReasonScreenCaptureFailure = 21,
   /**
@@ -3282,41 +3282,45 @@ export enum VideoTranscoderError {
 }
 
 /**
- * @ignore
+ * The source of the audio streams that are mixed locally.
  */
 export class MixedAudioStream {
   /**
-   * @ignore
+   * The type of the audio source. See AudioSourceType.
    */
   sourceType?: AudioSourceType;
   /**
-   * @ignore
+   * The user ID of the remote user. Set this parameter if the source type of the locally mixed audio steams is AudioSourceRemoteUser.
    */
   remoteUserUid?: number;
   /**
-   * @ignore
+   * The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
+   *  All lowercase English letters: a to z.
+   *  All uppercase English letters: A to Z.
+   *  All numeric characters: 0 to 9.
+   *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", "," Set this parameter if the source type of the locally mixed audio streams is AudioSourceRemoteChannel or AudioSourceRemoteUser.
    */
   channelId?: string;
   /**
-   * @ignore
+   * The audio track ID. Set this parameter to the custom audio track ID returned in createCustomAudioTrack. Set this parameter if the source type of the locally mixed audio steams is AudioSourceCustom.
    */
   trackId?: number;
 }
 
 /**
- * @ignore
+ * The configurations for mixing the lcoal audio.
  */
 export class LocalAudioMixerConfiguration {
   /**
-   * @ignore
+   * The number of the audio streams that are mixed locally.
    */
   streamCount?: number;
   /**
-   * @ignore
+   * The source of the audio streams that are mixed locally. See MixedAudioStream.
    */
   audioInputStreams?: MixedAudioStream[];
   /**
-   * @ignore
+   * Whether the mxied audio stream uses the timestamp of the audio frames captured by the local microphone. true : (Default) Yes. Set to this value if you want all locally captured audio streams synchronized. false : No. The SDK uses the timestamp of the audio frames at the time when they are mixed.
    */
   syncWithLocalMic?: boolean;
 }
@@ -3854,15 +3858,22 @@ export class FaceShapeBeautyOptions {
 }
 
 /**
- * @ignore
+ * Filter effect options.
  */
 export class FilterEffectOptions {
   /**
-   * @ignore
+   * The absolute path to the local cube map texture file, which can be used to customize the filter effect. The specified .cude file should strictly follow the Cube LUT Format Specification; otherwise, the filter options do not take effect. The following is a sample of the .cude file:
+   * LUT_3D_SIZE 32
+   * 0.0039215689 0 0.0039215682
+   * 0.0086021447 0.0037950677 0
+   * ...
+   * 0.0728652592 0.0039215689 0
+   *  The identifier LUT_3D_SIZE on the first line of the cube map file represents the size of the three-dimensional lookup table. The LUT size for filter effect can only be set to 32.
+   *  The SDK provides a built-in built_in_whiten_filter.cube file. You can pass the absolute path of this file to get the whitening filter effect.
    */
   path?: string;
   /**
-   * @ignore
+   * The intensity of the filter effect, with a range value of [0.0,1.0], in which 0.0 represents no filter effect. The default value is 0.5. The higher the value, the stronger the filter effect.
    */
   strength?: number;
 }
@@ -3924,7 +3935,7 @@ export enum VideoDenoiserMode {
 }
 
 /**
- * The video noise reduction level.
+ * Video noise reduction level.
  */
 export enum VideoDenoiserLevel {
   /**
@@ -3932,7 +3943,7 @@ export enum VideoDenoiserLevel {
    */
   VideoDenoiserLevelHighQuality = 0,
   /**
-   * 1: Promotes reducing performance consumption during video noise reduction. prioritizes reducing performance consumption over video noise reduction quality. The performance consumption is lower, and the video noise reduction speed is faster. To avoid a noticeable shadowing effect (shadows trailing behind moving objects) in the processed video, Agora recommends that you use this settinging when the camera is fixed.
+   * 1: Promotes reducing performance consumption during video noise reduction. It prioritizes reducing performance consumption over video noise reduction quality. The performance consumption is lower, and the video noise reduction speed is faster. To avoid a noticeable shadowing effect (shadows trailing behind moving objects) in the processed video, Agora recommends that you use this setting when the camera is fixed.
    */
   VideoDenoiserLevelFast = 1,
 }
@@ -4088,7 +4099,7 @@ export class AudioTrackConfig {
    */
   enableLocalPlayback?: boolean;
   /**
-   * @ignore
+   * Whether to enable audio processing module: true Enable the audio processing module to apply the Automatic Echo Cancellation (AEC), Automatic Noise Suppression (ANS), and Automatic Gain Control (AGC) effects. false : (Default) Do not enable the audio processing module. This parameter only takes effect on AudioTrackDirect in custom audio capturing.
    */
   enableAudioProcessing?: boolean;
 }
@@ -4790,7 +4801,7 @@ export class ChannelMediaRelayConfiguration {
   /**
    * The information of the target channel ChannelMediaInfo. It contains the following members: channelName : The name of the target channel. token : The token for joining the target channel. It is generated with the channelName and uid you set in destInfos.
    *  If you have not enabled the App Certificate, set this parameter as the default value null, which means the SDK applies the App ID.
-   *  If you have enabled the App Certificate, you must use the token generated with the channelName and uid. If the token of any target channel expires, the whole media relay stops; hence Agora recommends that you specify the same expiration time for the tokens of all the target channels. uid : The unique user ID to identify the relay stream in the target channel. The value ranges from 0 to (2 32 -1). To avoid user ID conflicts, this user ID must be different from any other user ID in the target channel. The default value is 0, which means the SDK generates a random user ID.
+   *  If you have enabled the App Certificate, you must use the token generated with the channelName and uid. If the token of any target channel expires, the whole media relay stops; hence Agora recommends that you specify the same expiration time for the tokens of all the target channels. uid : The unique user ID to identify the relay stream in the target channel. The value ranges from 0 to (2 32 -1). To avoid user ID conflicts, this user ID must be different from any other user ID in the target channel. The default value is 0, which means the SDK generates a random UID.
    */
   destInfos?: ChannelMediaInfo[];
   /**