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

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 
 
+# [4.4.0-dev.2](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.3.2...v4.4.0-dev.2) (2024-08-22)
+
+
+### Features
+
+* **example:** add call quality monitoring in JoinChannelAudio and JoinChannelVideo ([42b4593](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/42b459338df8a06a8d14cf765d25c5e8cbdc836f))
+
+
+### Reverts
+
+* Revert "chore: optimize" ([49423ec](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/49423ec648392be27862afd8358b8b5fbaa5b127))
+
 ## [4.3.2](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.3.1...v4.3.2) (2024-06-06)
 
 

package/js/AgoraSdk.js

@@ -51,7 +51,7 @@ exports.createAgoraRtcEngine = createAgoraRtcEngine;
 /**
  * Gets one IMediaPlayerCacheManager instance.
  *
- * When you successfully call this method, the SDK returns a media player cache manager instance. The cache manager is a singleton pattern. Therefore, multiple calls to this method returns the same instance. Make sure the IRtcEngine is initialized before you call this method.
+ * Before calling any APIs in the IMediaPlayerCacheManager class, you need to call this method to get a cache manager instance of a media player.
  *
  * @returns
  * The IMediaPlayerCacheManager instance.

package/js/Private/AgoraBase.js

@@ -239,7 +239,7 @@ var ErrorCodeType;
     ErrorCodeType[ErrorCodeType["ErrNetDown"] = 14] = "ErrNetDown";
     /**
      * 17: The request to join the channel is rejected. Possible reasons include the following:
-     *  The user is already in the channel. Agora recommends that you use the onConnectionStateChanged callback to determine whether the user exists in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected (1) state.
+     *  The user is already in the channel. Agora recommends that you use the onConnectionStateChanged callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected (1) state.
      *  After calling startEchoTest for the call test, the user tries to join the channel without calling stopEchoTest to end the current test. To join a channel, the call test must be ended by calling stopEchoTest.
      */
     ErrorCodeType[ErrorCodeType["ErrJoinChannelRejected"] = 17] = "ErrJoinChannelRejected";
@@ -1525,7 +1525,7 @@ var AudioScenarioType;
      */
     AudioScenarioType[AudioScenarioType["AudioScenarioGameStreaming"] = 3] = "AudioScenarioGameStreaming";
     /**
-     * 5: Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. For example, education scenarios. In this scenario, audience members receive a pop-up window to request permission of using microphones.
+     * 5: Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. For example, education scenarios.
      */
     AudioScenarioType[AudioScenarioType["AudioScenarioChatroom"] = 5] = "AudioScenarioChatroom";
     /**
@@ -1597,7 +1597,7 @@ var VideoApplicationScenarioType;
      */
     VideoApplicationScenarioType[VideoApplicationScenarioType["ApplicationScenarioGeneral"] = 0] = "ApplicationScenarioGeneral";
     /**
-     * If set to ApplicationScenarioMeeting (1), the SDK automatically enables the following strategies:
+     * ApplicationScenarioMeeting (1) is suitable for meeting scenarios. If set to ApplicationScenarioMeeting (1), the SDK automatically enables the following strategies:
      *  In meeting scenarios where low-quality video streams are required to have a high bitrate, the SDK automatically enables multiple technologies used to deal with network congestions, to enhance the performance of the low-quality streams and to ensure the smooth reception by subscribers.
      *  The SDK monitors the number of subscribers to the high-quality video stream in real time and dynamically adjusts its configuration based on the number of subscribers.
      *  If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth.
@@ -2601,7 +2601,7 @@ var ConnectionChangedReasonType;
 var ClientRoleChangeFailedReason;
 (function (ClientRoleChangeFailedReason) {
     /**
-     * 1: The number of hosts in the channel is already at the upper limit. This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
+     * 1: The number of hosts in the channel exceeds the limit. This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
      */
     ClientRoleChangeFailedReason[ClientRoleChangeFailedReason["ClientRoleChangeFailedTooManyBroadcasters"] = 1] = "ClientRoleChangeFailedTooManyBroadcasters";
     /**
@@ -2609,11 +2609,11 @@ var ClientRoleChangeFailedReason;
      */
     ClientRoleChangeFailedReason[ClientRoleChangeFailedReason["ClientRoleChangeFailedNotAuthorized"] = 2] = "ClientRoleChangeFailedNotAuthorized";
     /**
-     * 3: The request is timed out. Agora recommends you prompt the user to check the network connection and try to switch their user role again.
+     * 3: The request is timed out. Agora recommends you prompt the user to check the network connection and try to switch their user role again. Deprecated: This enumerator is deprecated since v4.4.0 and is not recommended for use.
      */
     ClientRoleChangeFailedReason[ClientRoleChangeFailedReason["ClientRoleChangeFailedRequestTimeOut"] = 3] = "ClientRoleChangeFailedRequestTimeOut";
     /**
-     * 4: The SDK connection fails. You can use reason reported in the onConnectionStateChanged callback to troubleshoot the failure.
+     * 4: The SDK is disconnected from the Agora edge server. You can troubleshoot the failure through the reason reported by onConnectionStateChanged. Deprecated: This enumerator is deprecated since v4.4.0 and is not recommended for use.
      */
     ClientRoleChangeFailedReason[ClientRoleChangeFailedReason["ClientRoleChangeFailedConnectionFailed"] = 4] = "ClientRoleChangeFailedConnectionFailed";
 })(ClientRoleChangeFailedReason = exports.ClientRoleChangeFailedReason || (exports.ClientRoleChangeFailedReason = {}));
@@ -2913,7 +2913,7 @@ exports.ColorEnhanceOptions = ColorEnhanceOptions;
 var BackgroundSourceType;
 (function (BackgroundSourceType) {
     /**
-     * 0: Process the background as alpha information without replacement, only separating the portrait and the background. After setting this value, you can call startLocalVideoTranscoder to implement the picture-in-picture effect.
+     * 0: Process the background as alpha data without replacement, only separating the portrait and the background. After setting this value, you can call startLocalVideoTranscoder to implement the picture-in-picture effect.
      */
     BackgroundSourceType[BackgroundSourceType["BackgroundNone"] = 0] = "BackgroundNone";
     /**

package/js/Private/AgoraMediaBase.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RecorderInfo = exports.MediaRecorderConfiguration = exports.RecorderReasonCode = exports.RecorderState = exports.MediaRecorderStreamType = exports.MediaRecorderContainerFormat = exports.ExternalVideoSourceType = exports.VideoFrameProcessMode = exports.UserAudioSpectrumInfo = exports.AudioSpectrumData = exports.AudioParams = exports.AudioFramePosition = exports.AudioFrame = exports.AudioFrameType = exports.VideoModulePosition = exports.MediaPlayerSourceType = exports.VideoFrame = exports.ExternalVideoFrame = exports.VideoBufferType = exports.EglContextType = exports.Hdr10MetadataInfo = exports.ColorSpace = exports.TransferID = exports.MatrixID = exports.RangeID = exports.PrimaryID = exports.IVideoFrameMetaInfo = exports.MetaInfoKey = exports.CameraVideoSourceType = exports.RenderModeType = exports.VideoPixelFormat = exports.AudioDualMonoMode = exports.AudioPcmFrame = exports.AudioEncodedFrameInfo = exports.PacketOptions = exports.ContentInspectConfig = exports.ContentInspectModule = exports.ContentInspectType = exports.ContentInspectResult = exports.MediaSourceType = exports.RawAudioFrameOpModeType = exports.AudioParameters = exports.BytesPerSample = exports.AudioRoute = exports.VideoSourceType = exports.ExtensionContext = void 0;
+exports.RecorderInfo = exports.MediaRecorderConfiguration = exports.RecorderReasonCode = exports.RecorderState = exports.MediaRecorderStreamType = exports.MediaRecorderContainerFormat = exports.ExternalVideoSourceType = exports.VideoFrameProcessMode = exports.UserAudioSpectrumInfo = exports.AudioSpectrumData = exports.AudioParams = exports.AudioFramePosition = exports.AudioFrame = exports.AudioFrameType = exports.VideoModulePosition = exports.MediaPlayerSourceType = exports.VideoFrame = exports.ExternalVideoFrame = exports.VideoBufferType = exports.EglContextType = exports.AlphaStitchMode = exports.Hdr10MetadataInfo = exports.ColorSpace = exports.TransferID = exports.MatrixID = exports.RangeID = exports.PrimaryID = exports.IVideoFrameMetaInfo = exports.MetaInfoKey = exports.CameraVideoSourceType = exports.RenderModeType = exports.VideoPixelFormat = exports.AudioDualMonoMode = exports.AudioPcmFrame = exports.AudioEncodedFrameInfo = exports.PacketOptions = exports.ContentInspectConfig = exports.ContentInspectModule = exports.ContentInspectType = exports.ContentInspectResult = exports.MediaSourceType = exports.RawAudioFrameOpModeType = exports.AudioParameters = exports.BytesPerSample = exports.AudioRoute = exports.VideoSourceType = exports.ExtensionContext = void 0;
 require("./extension/AgoraMediaBaseExtension");
 /**
  * @ignore
@@ -281,13 +281,13 @@ var ContentInspectType;
     ContentInspectType[ContentInspectType["ContentInspectImageModeration"] = 3] = "ContentInspectImageModeration";
 })(ContentInspectType = exports.ContentInspectType || (exports.ContentInspectType = {}));
 /**
- * A ContentInspectModule structure used to configure the frequency of video screenshot and upload.
+ * ContentInspectModule A structure used to configure the frequency of video screenshot and upload.
  */
 class ContentInspectModule {
 }
 exports.ContentInspectModule = ContentInspectModule;
 /**
- * Configuration of video screenshot and upload.
+ * Screenshot and upload configuration.
  */
 class ContentInspectConfig {
 }
@@ -674,6 +674,32 @@ exports.ColorSpace = ColorSpace;
 class Hdr10MetadataInfo {
 }
 exports.Hdr10MetadataInfo = Hdr10MetadataInfo;
+/**
+ * @ignore
+ */
+var AlphaStitchMode;
+(function (AlphaStitchMode) {
+    /**
+     * @ignore
+     */
+    AlphaStitchMode[AlphaStitchMode["NoAlphaStitch"] = 0] = "NoAlphaStitch";
+    /**
+     * @ignore
+     */
+    AlphaStitchMode[AlphaStitchMode["AlphaStitchUp"] = 1] = "AlphaStitchUp";
+    /**
+     * @ignore
+     */
+    AlphaStitchMode[AlphaStitchMode["AlphaStitchBelow"] = 2] = "AlphaStitchBelow";
+    /**
+     * @ignore
+     */
+    AlphaStitchMode[AlphaStitchMode["AlphaStitchLeft"] = 3] = "AlphaStitchLeft";
+    /**
+     * @ignore
+     */
+    AlphaStitchMode[AlphaStitchMode["AlphaStitchRight"] = 4] = "AlphaStitchRight";
+})(AlphaStitchMode = exports.AlphaStitchMode || (exports.AlphaStitchMode = {}));
 /**
  * @ignore
  */

package/js/Private/IAgoraLog.js

@@ -31,6 +31,10 @@ var LogLevel;
      * @ignore
      */
     LogLevel[LogLevel["LogLevelApiCall"] = 16] = "LogLevelApiCall";
+    /**
+     * @ignore
+     */
+    LogLevel[LogLevel["LogLevelDebug"] = 32] = "LogLevelDebug";
 })(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
 /**
  * The output log level of the SDK.

package/js/Private/IAgoraRhythmPlayer.js

@@ -3,54 +3,54 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AgoraRhythmPlayerConfig = exports.RhythmPlayerReason = exports.RhythmPlayerStateType = void 0;
 require("./extension/IAgoraRhythmPlayerExtension");
 /**
- * @ignore
+ * Virtual metronome state.
  */
 var RhythmPlayerStateType;
 (function (RhythmPlayerStateType) {
     /**
-     * @ignore
+     * (810): The virtual metronome is not enabled or disabled already.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateIdle"] = 810] = "RhythmPlayerStateIdle";
     /**
-     * @ignore
+     * 811: Opening the beat files.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateOpening"] = 811] = "RhythmPlayerStateOpening";
     /**
-     * @ignore
+     * 812: Decoding the beat files.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateDecoding"] = 812] = "RhythmPlayerStateDecoding";
     /**
-     * @ignore
+     * 813: The beat files are playing.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStatePlaying"] = 813] = "RhythmPlayerStatePlaying";
     /**
-     * @ignore
+     * 814: Failed to start virtual metronome. You can use the reported errorCode to troubleshoot the cause of the error, or you can try to start the virtual metronome again.
      */
     RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateFailed"] = 814] = "RhythmPlayerStateFailed";
 })(RhythmPlayerStateType = exports.RhythmPlayerStateType || (exports.RhythmPlayerStateType = {}));
 /**
- * @ignore
+ * Virtual Metronome error message.
  */
 var RhythmPlayerReason;
 (function (RhythmPlayerReason) {
     /**
-     * @ignore
+     * (0): The beat files are played normally without errors.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonOk"] = 0] = "RhythmPlayerReasonOk";
     /**
-     * @ignore
+     * 1: A general error; no specific reason.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonFailed"] = 1] = "RhythmPlayerReasonFailed";
     /**
-     * @ignore
+     * 801: There is an error when opening the beat files.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonCanNotOpen"] = 801] = "RhythmPlayerReasonCanNotOpen";
     /**
-     * @ignore
+     * 802: There is an error when playing the beat files.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonCanNotPlay"] = 802] = "RhythmPlayerReasonCanNotPlay";
     /**
-     * @ignore
+     * (803): The duration of the beat file exceeds the limit. The maximum duration is 1.2 seconds.
      */
     RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonFileOverDurationLimit"] = 803] = "RhythmPlayerReasonFileOverDurationLimit";
 })(RhythmPlayerReason = exports.RhythmPlayerReason || (exports.RhythmPlayerReason = {}));

package/js/Private/impl/IAgoraRtcEngineImpl.js

@@ -1315,22 +1315,6 @@ class IRtcEngineImpl {
     getApiTypeFromMuteAllRemoteAudioStreams(mute) {
         return 'RtcEngine_muteAllRemoteAudioStreams_5039d15';
     }
-    setDefaultMuteAllRemoteAudioStreams(mute) {
-        const apiType = this.getApiTypeFromSetDefaultMuteAllRemoteAudioStreams(mute);
-        const jsonParams = {
-            mute: mute,
-            toJSON: () => {
-                return {
-                    mute: mute,
-                };
-            },
-        };
-        const jsonResults = IrisApiEngine_1.callIrisApi.call(this, apiType, jsonParams);
-        return jsonResults.result;
-    }
-    getApiTypeFromSetDefaultMuteAllRemoteAudioStreams(mute) {
-        return 'RtcEngine_setDefaultMuteAllRemoteAudioStreams_5039d15';
-    }
     muteRemoteAudioStream(uid, mute) {
         const apiType = this.getApiTypeFromMuteRemoteAudioStream(uid, mute);
         const jsonParams = {
@@ -1397,22 +1381,6 @@ class IRtcEngineImpl {
     getApiTypeFromMuteAllRemoteVideoStreams(mute) {
         return 'RtcEngine_muteAllRemoteVideoStreams_5039d15';
     }
-    setDefaultMuteAllRemoteVideoStreams(mute) {
-        const apiType = this.getApiTypeFromSetDefaultMuteAllRemoteVideoStreams(mute);
-        const jsonParams = {
-            mute: mute,
-            toJSON: () => {
-                return {
-                    mute: mute,
-                };
-            },
-        };
-        const jsonResults = IrisApiEngine_1.callIrisApi.call(this, apiType, jsonParams);
-        return jsonResults.result;
-    }
-    getApiTypeFromSetDefaultMuteAllRemoteVideoStreams(mute) {
-        return 'RtcEngine_setDefaultMuteAllRemoteVideoStreams_5039d15';
-    }
     setRemoteDefaultVideoStreamType(streamType) {
         const apiType = this.getApiTypeFromSetRemoteDefaultVideoStreamType(streamType);
         const jsonParams = {

package/js/Private/internal/RtcEngineExInternal.js

@@ -5,8 +5,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RtcEngineExInternal = void 0;
 const ts_interface_checker_1 = require("ts-interface-checker");
-const RendererManager_1 = require("../../Renderer/RendererManager");
 const Utils_1 = require("../../Utils");
+let RendererManager;
+if (typeof window !== 'undefined') {
+    RendererManager = require('../../Renderer/RendererManager').RendererManager;
+}
+else {
+    RendererManager = undefined;
+}
 const AgoraBase_1 = require("../AgoraBase");
 const AgoraMediaBase_1 = require("../AgoraMediaBase");
 const IAgoraRtcEngineExImpl_1 = require("../impl/IAgoraRtcEngineExImpl");
@@ -37,8 +43,8 @@ class RtcEngineExInternal extends IAgoraRtcEngineExImpl_1.IRtcEngineExImpl {
         if (Utils_1.AgoraEnv.webEnvReady) {
             // @ts-ignore
             window.AgoraEnv = Utils_1.AgoraEnv;
-            if (Utils_1.AgoraEnv.AgoraRendererManager === undefined) {
-                Utils_1.AgoraEnv.AgoraRendererManager = new RendererManager_1.RendererManager();
+            if (Utils_1.AgoraEnv.AgoraRendererManager === undefined && RendererManager) {
+                Utils_1.AgoraEnv.AgoraRendererManager = new RendererManager();
             }
         }
         const ret = super.initialize(context);

package/js/Renderer/AgoraView.js

@@ -6,12 +6,14 @@ const Utils_1 = require("../Utils");
 const VIDEO_SOURCE_TYPE_STRING = 'video-source-type';
 const UID_STRING = 'uid';
 const CHANNEL_ID_STRING = 'channel-id';
+const POSITION_STRING = 'position';
 const RENDERER_CONTENT_MODE_STRING = 'renderer-content-mode';
 const RENDERER_MIRROR_STRING = 'renderer-mirror';
 const observedAttributes = [
     VIDEO_SOURCE_TYPE_STRING,
     UID_STRING,
     CHANNEL_ID_STRING,
+    POSITION_STRING,
     RENDERER_CONTENT_MODE_STRING,
     RENDERER_MIRROR_STRING,
 ];
@@ -54,6 +56,21 @@ class AgoraView extends HTMLElement {
             this.removeAttribute(CHANNEL_ID_STRING);
         }
     }
+    get position() {
+        const number = Number(this.getAttribute(POSITION_STRING));
+        return isNaN(number)
+            ? AgoraMediaBase_1.VideoModulePosition.PositionPreEncoder |
+                AgoraMediaBase_1.VideoModulePosition.PositionPreRenderer
+            : number;
+    }
+    set position(val) {
+        if (val) {
+            this.setAttribute(POSITION_STRING, String(val));
+        }
+        else {
+            this.removeAttribute(POSITION_STRING);
+        }
+    }
     get renderMode() {
         const number = Number(this.getAttribute(RENDERER_CONTENT_MODE_STRING) ||
             AgoraMediaBase_1.RenderModeType.RenderModeFit);
@@ -82,12 +99,13 @@ class AgoraView extends HTMLElement {
         super();
         this.isConnectedCallback = false;
         this.initializeRender = () => {
-            const { channelId, uid, sourceType, renderMode, renderMirror } = this;
+            const { channelId, uid, sourceType, position, renderMode, renderMirror } = this;
             Utils_1.AgoraEnv.AgoraRendererManager?.addOrRemoveRenderer({
                 sourceType,
                 view: this,
                 uid,
                 channelId,
+                position,
                 renderMode,
                 mirrorMode: renderMirror
                     ? AgoraBase_1.VideoMirrorModeType.VideoMirrorModeEnabled
@@ -96,9 +114,10 @@ class AgoraView extends HTMLElement {
             });
         };
         this.destroyRender = () => {
-            const { channelId, uid, sourceType } = this;
+            const { channelId, uid, sourceType, position } = this;
             Utils_1.AgoraEnv.AgoraRendererManager?.removeRendererFromCache({
                 channelId,
+                position,
                 uid,
                 sourceType,
                 view: this,

package/js/Renderer/IRendererManager.js

@@ -48,7 +48,7 @@ class IRendererManager {
         this.clearRendererCache();
     }
     precheckRendererContext(context) {
-        let { sourceType, uid, channelId, mediaPlayerId, renderMode = this.defaultRenderMode, mirrorMode = this.defaultMirrorMode, } = context;
+        let { sourceType, uid, channelId, position, mediaPlayerId, renderMode = this.defaultRenderMode, mirrorMode = this.defaultMirrorMode, } = context;
         switch (sourceType) {
             case AgoraMediaBase_1.VideoSourceType.VideoSourceRemote:
                 if (uid === undefined) {
@@ -73,7 +73,20 @@ class IRendererManager {
                 uid = 0;
                 break;
         }
-        return { ...context, sourceType, uid, channelId, renderMode, mirrorMode };
+        if (!position) {
+            position =
+                AgoraMediaBase_1.VideoModulePosition.PositionPreEncoder |
+                    AgoraMediaBase_1.VideoModulePosition.PositionPreRenderer;
+        }
+        return {
+            ...context,
+            position,
+            sourceType,
+            uid,
+            channelId,
+            renderMode,
+            mirrorMode,
+        };
     }
     addOrRemoveRenderer(context) {
         // To be compatible with the old API

package/js/Renderer/RendererCache.js

@@ -7,7 +7,7 @@ function generateRendererCacheKey({ channelId, uid, sourceType, }) {
 }
 exports.generateRendererCacheKey = generateRendererCacheKey;
 class RendererCache {
-    constructor({ channelId, uid, sourceType }) {
+    constructor({ channelId, uid, sourceType, position }) {
         this._renderers = [];
         this._videoFrame = {
             yBuffer: Buffer.alloc(0),
@@ -20,7 +20,7 @@ class RendererCache {
             vStride: 0,
             rotation: 0,
         };
-        this._context = { channelId, uid, sourceType };
+        this._context = { channelId, uid, sourceType, position };
         this._enabled = false;
     }
     get key() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agora-electron-sdk",
-  "version": "4.4.0-dev.1",
+  "version": "4.4.0-dev.2",
   "description": "agora-electron-sdk",
   "main": "js/AgoraSdk",
   "types": "types/AgoraSdk.d.ts",
@@ -91,7 +91,11 @@
     "node": ">= 14.0.0"
   },
   "jest": {
+    "setupFilesAfterEnv": [
+      "<rootDir>/ts/__tests__/setup.ts"
+    ],
     "modulePathIgnorePatterns": [
+      "<rootDir>/ts/__tests__/setup.ts",
       "<rootDir>/example/node_modules",
       "<rootDir>/js/",
       "<rootDir>/types/"
@@ -138,9 +142,9 @@
     "yuv-canvas": "1.2.6"
   },
   "agora_electron": {
-    "iris_sdk_win": "https://download.agora.io/sdk/release/iris_4.4.0-dev.4_DCG_Windows_Video_Standalone_20240624_0313_450.zip",
-    "iris_sdk_mac": "https://download.agora.io/sdk/release/iris_4.4.0-dev.4_DCG_Mac_Video_Standalone_20240624_0313_413.zip",
-    "native_sdk_win": "https://download.agora.io/sdk/release/AgoraRtcEngine_windows_Preview_4.4.0-dev.4.zip",
-    "native_sdk_mac": "https://download.agora.io/sdk/release/AgoraRtcEngine_macOS_Preview_4.4.0-dev.4.zip"
+    "iris_sdk_win": "https://download.agora.io/sdk/release/iris_4.4.0-build.4_DCG_Windows_Video_Standalone_20240819_0514_498.zip",
+    "iris_sdk_mac": "https://download.agora.io/sdk/release/iris_4.4.0-build.4_DCG_Mac_Video_Standalone_20240819_0517_464.zip",
+    "native_sdk_win": "https://download.agora.io/sdk/release/Agora_Native_SDK_for_Windows_v4.4.0_FULL.zip",
+    "native_sdk_mac": "https://download.agora.io/sdk/release/Agora_Native_SDK_for_Mac_v4.4.0_FULL.zip"
   }
 }

package/scripts/downloadPrebuild.js

@@ -8,11 +8,17 @@ const getConfig = require('./getConfig');
 const logger = require('./logger');
 const { getOS } = require('./util');
 
-const { platform, arch, no_symbol, native_sdk_mac, native_sdk_win } =
-  getConfig();
+const {
+  platform,
+  packageVersion,
+  arch,
+  no_symbol,
+  native_sdk_mac,
+  native_sdk_win,
+} = getConfig();
 
 const workspaceDir = `${path.join(__dirname, '..')}`;
-const packageVersion = '4.3.2';
+
 const normalizePath = (filePath) => filePath.split(path.sep).join('/');
 
 const getDownloadURL = () => {

package/ts/AgoraSdk.ts

@@ -40,7 +40,7 @@ export function createAgoraRtcEngine(options?: AgoraEnvOptions): IRtcEngineEx {
 /**
  * Gets one IMediaPlayerCacheManager instance.
  *
- * When you successfully call this method, the SDK returns a media player cache manager instance. The cache manager is a singleton pattern. Therefore, multiple calls to this method returns the same instance. Make sure the IRtcEngine is initialized before you call this method.
+ * Before calling any APIs in the IMediaPlayerCacheManager class, you need to call this method to get a cache manager instance of a media player.
  *
  * @returns
  * The IMediaPlayerCacheManager instance.

package/ts/Private/AgoraBase.ts

@@ -238,7 +238,7 @@ export enum ErrorCodeType {
   ErrNetDown = 14,
   /**
    * 17: The request to join the channel is rejected. Possible reasons include the following:
-   *  The user is already in the channel. Agora recommends that you use the onConnectionStateChanged callback to determine whether the user exists in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected (1) state.
+   *  The user is already in the channel. Agora recommends that you use the onConnectionStateChanged callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected (1) state.
    *  After calling startEchoTest for the call test, the user tries to join the channel without calling stopEchoTest to end the current test. To join a channel, the call test must be ended by calling stopEchoTest.
    */
   ErrJoinChannelRejected = 17,
@@ -1300,6 +1300,10 @@ export class AdvanceOptions {
    * Compression preference for video encoding. See CompressionPreference.
    */
   compressionPreference?: CompressionPreference;
+  /**
+   * Whether to encode and send the Alpha data present in the video frame to the remote end: true : Encode and send Alpha data. false : (Default) Do not encode and send Alpha data.
+   */
+  encodeAlpha?: boolean;
 }
 
 /**
@@ -1437,7 +1441,7 @@ export class VideoEncoderConfiguration {
    */
   orientationMode?: OrientationMode;
   /**
-   * Video degradation preference under limited bandwidth. See DegradationPreference.
+   * Video degradation preference under limited bandwidth. See DegradationPreference. When this parameter is set to MaintainFramerate (1) or MaintainBalanced (2), orientationMode needs to be set to OrientationModeAdaptive (0) at the same time, otherwise the setting will not take effect.
    */
   degradationPreference?: DegradationPreference;
   /**
@@ -1946,7 +1950,7 @@ export enum AudioScenarioType {
    */
   AudioScenarioGameStreaming = 3,
   /**
-   * 5: Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. For example, education scenarios. In this scenario, audience members receive a pop-up window to request permission of using microphones.
+   * 5: Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. For example, education scenarios.
    */
   AudioScenarioChatroom = 5,
   /**
@@ -2030,7 +2034,7 @@ export enum VideoApplicationScenarioType {
    */
   ApplicationScenarioGeneral = 0,
   /**
-   * If set to ApplicationScenarioMeeting (1), the SDK automatically enables the following strategies:
+   * ApplicationScenarioMeeting (1) is suitable for meeting scenarios. If set to ApplicationScenarioMeeting (1), the SDK automatically enables the following strategies:
    *  In meeting scenarios where low-quality video streams are required to have a high bitrate, the SDK automatically enables multiple technologies used to deal with network congestions, to enhance the performance of the low-quality streams and to ensure the smooth reception by subscribers.
    *  The SDK monitors the number of subscribers to the high-quality video stream in real time and dynamically adjusts its configuration based on the number of subscribers.
    *  If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth.
@@ -3419,7 +3423,7 @@ export enum ConnectionChangedReasonType {
  */
 export enum ClientRoleChangeFailedReason {
   /**
-   * 1: The number of hosts in the channel is already at the upper limit. This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
+   * 1: The number of hosts in the channel exceeds the limit. This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
    */
   ClientRoleChangeFailedTooManyBroadcasters = 1,
   /**
@@ -3427,11 +3431,11 @@ export enum ClientRoleChangeFailedReason {
    */
   ClientRoleChangeFailedNotAuthorized = 2,
   /**
-   * 3: The request is timed out. Agora recommends you prompt the user to check the network connection and try to switch their user role again.
+   * 3: The request is timed out. Agora recommends you prompt the user to check the network connection and try to switch their user role again. Deprecated: This enumerator is deprecated since v4.4.0 and is not recommended for use.
    */
   ClientRoleChangeFailedRequestTimeOut = 3,
   /**
-   * 4: The SDK connection fails. You can use reason reported in the onConnectionStateChanged callback to troubleshoot the failure.
+   * 4: The SDK is disconnected from the Agora edge server. You can troubleshoot the failure through the reason reported by onConnectionStateChanged. Deprecated: This enumerator is deprecated since v4.4.0 and is not recommended for use.
    */
   ClientRoleChangeFailedConnectionFailed = 4,
 }
@@ -3593,7 +3597,7 @@ export class VideoCanvas {
    */
   cropArea?: Rectangle;
   /**
-   * (Optional) Whether the receiver enables alpha mask rendering: true : The receiver enables alpha mask rendering. false : (Default) The receiver disables alpha mask rendering. Alpha mask rendering can create images with transparent effects and extract portraits from videos. When used in combination with other methods, you can implement effects such as portrait-in-picture and watermarking.
+   * (Optional) Whether to enable alpha mask rendering: true : Enable alpha mask rendering. false : (Default) Disable alpha mask rendering. Alpha mask rendering can create images with transparent effects and extract portraits from videos. When used in combination with other methods, you can implement effects such as portrait-in-picture and watermarking.
    *  The receiver can render alpha channel information only when the sender enables alpha transmission.
    *  To enable alpha transmission,.
    */
@@ -3857,7 +3861,7 @@ export class ColorEnhanceOptions {
  */
 export enum BackgroundSourceType {
   /**
-   * 0: Process the background as alpha information without replacement, only separating the portrait and the background. After setting this value, you can call startLocalVideoTranscoder to implement the picture-in-picture effect.
+   * 0: Process the background as alpha data without replacement, only separating the portrait and the background. After setting this value, you can call startLocalVideoTranscoder to implement the picture-in-picture effect.
    */
   BackgroundNone = 0,
   /**