agora-electron-sdk 4.3.1-dev.1 → 4.3.2

package/CHANGELOG.md

@@ -1,13 +1,23 @@
 
 
-## [4.3.1-dev.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.3.0...v4.3.1-dev.1) (2024-04-29)
+## [4.3.2](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.3.1...v4.3.2) (2024-06-06)
+
+
+### Bug Fixes
+
+* setup renderer may show rotate frame ([#1190](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1190)) ([ad6400c](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/ad6400c18f08f316984e75eb49a48c0795951f2e))
+
+
+### Features
+
+* support native 4.3.2 ([#1194](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1194)) ([d7a83e6](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/d7a83e6bc72651ababe01e448b662a6c39c154c5))
+
+## [4.3.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.3.0...v4.3.1) (2024-05-09)
 
 
 ### Features
 
-* allow unregister event handler by specific eventHandler ([87843c0](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/87843c04d0d291a4993539f4c96cb6408cf2ea3a))
-* bump example electron version to 22.0.0 ([a8256c0](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/a8256c0f985431de48b6a2faad6a932b64c34382))
-* support native 4.3.1 ([1526048](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/15260486de4ab4bc959a16071f81df7dcbbae989))
+* support native 4.3.1 ([#1168](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1168)) ([e78f864](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/e78f864045a6d68ac69585abbcd24cec328cd5ce)), closes [#1183](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1183) [#1181](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1181) [#1177](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1177)
 
 # [4.3.0](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.2.6...v4.3.0) (2024-02-28)
 

package/js/Private/AgoraBase.js

@@ -528,11 +528,11 @@ var UserOfflineReasonType;
 var InterfaceIdType;
 (function (InterfaceIdType) {
     /**
-     * The IAudioDeviceManager interface class.
+     * 1: The IAudioDeviceManager interface class.
      */
     InterfaceIdType[InterfaceIdType["AgoraIidAudioDeviceManager"] = 1] = "AgoraIidAudioDeviceManager";
     /**
-     * The IVideoDeviceManager interface class.
+     * 2: The IVideoDeviceManager interface class.
      */
     InterfaceIdType[InterfaceIdType["AgoraIidVideoDeviceManager"] = 2] = "AgoraIidVideoDeviceManager";
     /**
@@ -540,7 +540,7 @@ var InterfaceIdType;
      */
     InterfaceIdType[InterfaceIdType["AgoraIidParameterEngine"] = 3] = "AgoraIidParameterEngine";
     /**
-     * The IMediaEngine interface class.
+     * 4: The IMediaEngine interface class.
      */
     InterfaceIdType[InterfaceIdType["AgoraIidMediaEngine"] = 4] = "AgoraIidMediaEngine";
     /**
@@ -1183,7 +1183,7 @@ var VideoMirrorModeType;
     VideoMirrorModeType[VideoMirrorModeType["VideoMirrorModeDisabled"] = 2] = "VideoMirrorModeDisabled";
 })(VideoMirrorModeType = exports.VideoMirrorModeType || (exports.VideoMirrorModeType = {}));
 /**
- * The bit mask that indicates the device codec capability.
+ * The bit mask of the codec type.
  */
 var CodecCapMask;
 (function (CodecCapMask) {
@@ -1218,7 +1218,7 @@ var CodecCapLevels = /** @class */ (function () {
 }());
 exports.CodecCapLevels = CodecCapLevels;
 /**
- * The codec capability of the device.
+ * The codec capability of the SDK.
  */
 var CodecCapInfo = /** @class */ (function () {
     function CodecCapInfo() {
@@ -2497,11 +2497,11 @@ var ConnectionChangedReasonType;
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedInterrupted"] = 2] = "ConnectionChangedInterrupted";
     /**
-     * 3: The connection between the SDK and the Agora edge server is banned by the Agora edge server. This error occurs when the user is kicked out of the channel by the server.
+     * 3: The connection between the SDK and the Agora edge server is banned by the Agora edge server. For example, when a user is kicked out of the channel, this status will be returned.
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedBannedByServer"] = 3] = "ConnectionChangedBannedByServer";
     /**
-     * 4: The SDK fails to join the channel. When the SDK fails to join the channel for more than 20 minutes, this error occurs and the SDK stops reconnecting to the channel.
+     * 4: The SDK fails to join the channel. When the SDK fails to join the channel for more than 20 minutes, this code will be returned and the SDK stops reconnecting to the channel. You need to prompt the user to try to switch to another network and rejoin the channel.
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedJoinFailed"] = 4] = "ConnectionChangedJoinFailed";
     /**
@@ -2509,21 +2509,30 @@ var ConnectionChangedReasonType;
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedLeaveChannel"] = 5] = "ConnectionChangedLeaveChannel";
     /**
-     * 6: The connection failed because the App ID is not valid. Please rejoin the channel with a valid App ID.
+     * 6: The App ID is invalid. You need to rejoin the channel with a valid APP ID and make sure the App ID you are using is consistent with the one generated in the Agora Console.
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedInvalidAppId"] = 6] = "ConnectionChangedInvalidAppId";
     /**
-     * 7: The connection failed since channel name is not valid. Rejoin the channel with a valid channel name.
+     * 7: Invalid channel name. Rejoin the channel with a valid channel name. A valid channel name is a string of up to 64 bytes in length. 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.
+     *  Space
+     *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedInvalidChannelName"] = 7] = "ConnectionChangedInvalidChannelName";
     /**
-     * 8: The connection failed because the token is not valid. Possible reasons are as follows:
-     *  The App Certificate for the project is enabled in Agora Console, but you do not use a token when joining the channel. If you enable the App Certificate, you must use a token to join the channel.
+     * 8: Invalid token. Possible reasons are as follows:
+     *  The App Certificate for the project is enabled in Agora Console, but you do not pass in a token when joining a channel.
      *  The uid specified when calling joinChannel to join the channel is inconsistent with the uid passed in when generating the token.
+     *  The generated token and the token used to join the channel are not consistent. Ensure the following:
+     *  When your project enables App Certificate, you need to pass in a token to join a channel.
+     *  The user ID specified when generating the token is consistent with the user ID used when joining the channel.
+     *  The generated token is the same as the token passed in to join the channel.
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedInvalidToken"] = 8] = "ConnectionChangedInvalidToken";
     /**
-     * 9: The connection failed since token is expired.
+     * (9): The token currently being used has expired. You need to generate a new token on your server and rejoin the channel with the new token.
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedTokenExpired"] = 9] = "ConnectionChangedTokenExpired";
     /**
@@ -2541,7 +2550,7 @@ var ConnectionChangedReasonType;
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedRenewToken"] = 12] = "ConnectionChangedRenewToken";
     /**
-     * 13: The IP address of the client has changed, possibly because the network type, IP address, or port has been changed.
+     * (13): Client IP address changed. If you receive this code multiple times, You need to prompt the user to switch networks and try joining the channel again.
      */
     ConnectionChangedReasonType[ConnectionChangedReasonType["ConnectionChangedClientIpAddressChanged"] = 13] = "ConnectionChangedClientIpAddressChanged";
     /**

package/js/Private/IAgoraMusicContentCenter.js

@@ -15,9 +15,27 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IMusicContentCenter = exports.IMusicPlayer = exports.MusicContentCenterConfiguration = exports.MusicCollection = exports.Music = exports.ClimaxSegment = exports.MvProperty = exports.MusicChartCollection = exports.MusicCacheInfo = exports.MusicCacheStatusType = exports.MusicChartInfo = exports.MusicContentCenterStateReason = exports.PreloadState = void 0;
+exports.IMusicContentCenter = exports.IMusicPlayer = exports.MusicContentCenterConfiguration = exports.MusicCollection = exports.Music = exports.ClimaxSegment = exports.MvProperty = exports.MusicChartCollection = exports.MusicCacheInfo = exports.MusicCacheStatusType = exports.MusicChartInfo = exports.MusicContentCenterStateReason = exports.PreloadState = exports.MusicPlayMode = void 0;
 require("./extension/IAgoraMusicContentCenterExtension");
 var IAgoraMediaPlayer_1 = require("./IAgoraMediaPlayer");
+/**
+ * @ignore
+ */
+var MusicPlayMode;
+(function (MusicPlayMode) {
+    /**
+     * @ignore
+     */
+    MusicPlayMode[MusicPlayMode["KMusicPlayModeOriginal"] = 0] = "KMusicPlayModeOriginal";
+    /**
+     * @ignore
+     */
+    MusicPlayMode[MusicPlayMode["KMusicPlayModeAccompany"] = 1] = "KMusicPlayModeAccompany";
+    /**
+     * @ignore
+     */
+    MusicPlayMode[MusicPlayMode["KMusicPlayModeLeadSing"] = 2] = "KMusicPlayModeLeadSing";
+})(MusicPlayMode = exports.MusicPlayMode || (exports.MusicPlayMode = {}));
 /**
  * @ignore
  */

package/js/Private/impl/IAgoraMusicContentCenterImpl.js

@@ -144,6 +144,22 @@ var IMusicPlayerImpl = /** @class */ (function (_super) {
     function IMusicPlayerImpl() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    IMusicPlayerImpl.prototype.setPlayMode = function (mode) {
+        var apiType = this.getApiTypeFromSetPlayMode(mode);
+        var jsonParams = {
+            mode: mode,
+            toJSON: function () {
+                return {
+                    mode: mode,
+                };
+            },
+        };
+        var jsonResults = IrisApiEngine_1.callIrisApi.call(this, apiType, jsonParams);
+        return jsonResults.result;
+    };
+    IMusicPlayerImpl.prototype.getApiTypeFromSetPlayMode = function (mode) {
+        return 'MusicPlayer_setPlayMode_748bee0';
+    };
     IMusicPlayerImpl.prototype.openWithSongCode = function (songCode, startPos) {
         if (startPos === void 0) { startPos = 0; }
         var apiType = this.getApiTypeFromOpenWithSongCode(songCode, startPos);
@@ -243,6 +259,20 @@ var IMusicContentCenterImpl = /** @class */ (function () {
     IMusicContentCenterImpl.prototype.getApiTypeFromCreateMusicPlayer = function () {
         return 'MusicContentCenter_createMusicPlayer';
     };
+    IMusicContentCenterImpl.prototype.destroyMusicPlayer = function (musicPlayer) {
+        var apiType = this.getApiTypeFromDestroyMusicPlayer(musicPlayer);
+        var jsonParams = {
+            music_player: musicPlayer,
+            toJSON: function () {
+                return {};
+            },
+        };
+        var jsonResults = IrisApiEngine_1.callIrisApi.call(this, apiType, jsonParams);
+        return jsonResults.result;
+    };
+    IMusicContentCenterImpl.prototype.getApiTypeFromDestroyMusicPlayer = function (musicPlayer) {
+        return 'MusicContentCenter_destroyMusicPlayer_876d086';
+    };
     IMusicContentCenterImpl.prototype.getMusicCharts = function () {
         var apiType = this.getApiTypeFromGetMusicCharts();
         var jsonParams = {};
@@ -367,11 +397,11 @@ var IMusicContentCenterImpl = /** @class */ (function () {
         var apiType = this.getApiTypeFromGetLyric(songCode, lyricType);
         var jsonParams = {
             songCode: songCode,
-            LyricType: lyricType,
+            lyricType: lyricType,
             toJSON: function () {
                 return {
                     songCode: songCode,
-                    LyricType: lyricType,
+                    lyricType: lyricType,
                 };
             },
         };

package/js/Private/impl/IAgoraRtcEngineImpl.js

@@ -4979,7 +4979,7 @@ var IRtcEngineImpl = /** @class */ (function () {
         IrisApiEngine_1.callIrisApi.call(this, apiType, jsonParams);
     };
     IRtcEngineImpl.prototype.getApiTypeFromDestroyRendererByView = function (view) {
-        return '';
+        return 'RtcEngine_destroyRendererByView';
     };
     IRtcEngineImpl.prototype.destroyRendererByConfig = function (sourceType, channelId, uid) {
         if (uid === void 0) { uid = 0; }
@@ -5000,7 +5000,7 @@ var IRtcEngineImpl = /** @class */ (function () {
     };
     IRtcEngineImpl.prototype.getApiTypeFromDestroyRendererByConfig = function (sourceType, channelId, uid) {
         if (uid === void 0) { uid = 0; }
-        return '';
+        return 'RtcEngine_destroyRendererByConfig';
     };
     IRtcEngineImpl.prototype.unregisterAudioEncodedFrameObserver = function (observer) {
         var apiType = this.getApiTypeFromUnregisterAudioEncodedFrameObserver(observer);

package/js/Private/internal/MusicContentCenterInternal.js

@@ -111,6 +111,9 @@ var MusicPlayerInternal = /** @class */ (function (_super) {
         _this._musicPlayer = new _MusicPlayerInternal(mediaPlayerId);
         return _this;
     }
+    MusicPlayerInternal.prototype.setPlayMode = function (mode) {
+        return this._musicPlayer.setPlayMode(mode);
+    };
     MusicPlayerInternal.prototype.openWithSongCode = function (songCode, startPos) {
         return this._musicPlayer.openWithSongCode(songCode, startPos);
     };

package/js/Private/internal/RtcEngineExInternal.js

@@ -244,6 +244,11 @@ var RtcEngineExInternal = /** @class */ (function (_super) {
             ? 'RtcEngine_leaveChannel'
             : 'RtcEngine_leaveChannel_2c0e3aa';
     };
+    RtcEngineExInternal.prototype.getApiTypeFromLeaveChannelEx = function (connection, options) {
+        return options === undefined
+            ? 'RtcEngineEx_leaveChannelEx_c81e1a4'
+            : 'RtcEngineEx_leaveChannelEx_b03ee9a';
+    };
     RtcEngineExInternal.prototype.getApiTypeFromSetClientRole = function (role, options) {
         return options === undefined
             ? 'RtcEngine_setClientRole_3426fa6'

package/js/Renderer/IRenderer.js

@@ -20,6 +20,7 @@ var IRenderer = /** @class */ (function () {
         });
         this.parentElement.appendChild(this.container);
         this.canvas = document.createElement('canvas');
+        this.canvas.style.display = 'none';
         this.container.appendChild(this.canvas);
     };
     IRenderer.prototype.unbind = function () {
@@ -35,6 +36,14 @@ var IRenderer = /** @class */ (function () {
         this.container = undefined;
         this.parentElement = undefined;
     };
+    IRenderer.prototype.drawFrame = function (_videoFrame) {
+        if (!this.canvas)
+            return;
+        //@ts-ignore
+        if (!this.canvas.checkVisibility()) {
+            this.canvas.style.display = '';
+        }
+    };
     Object.defineProperty(IRenderer.prototype, "context", {
         get: function () {
             return this._context;

package/js/Renderer/WebGLRenderer/index.js

@@ -180,6 +180,7 @@ var WebGLRenderer = /** @class */ (function (_super) {
         this.gl.bindTexture(this.gl.TEXTURE_2D, this.vTexture);
         this.gl.texImage2D(this.gl.TEXTURE_2D, 0, this.gl.LUMINANCE, vStride, height / 2, 0, this.gl.LUMINANCE, this.gl.UNSIGNED_BYTE, vBuffer);
         this.gl.drawArrays(this.gl.TRIANGLES, 0, 6);
+        _super.prototype.drawFrame.call(this);
     };
     WebGLRenderer.prototype.rotateCanvas = function (_a) {
         var width = _a.width, height = _a.height, rotation = _a.rotation;

package/js/Renderer/YUVCanvasRenderer/index.js

@@ -52,6 +52,7 @@ var YUVCanvasRenderer = /** @class */ (function (_super) {
             bytes: vBuffer,
             stride: vStride,
         }));
+        _super.prototype.drawFrame.call(this);
     };
     YUVCanvasRenderer.prototype.rotateCanvas = function (_a) {
         var width = _a.width, height = _a.height, rotation = _a.rotation;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agora-electron-sdk",
-  "version": "4.3.1-dev.1",
+  "version": "4.3.2",
   "description": "agora-electron-sdk",
   "main": "js/AgoraSdk",
   "types": "types/AgoraSdk.d.ts",
@@ -136,9 +136,9 @@
     "yuv-canvas": "1.2.6"
   },
   "agora_electron": {
-    "iris_sdk_win": "https://download.agora.io/sdk/release/iris_4.3.1-build.1_DCG_Windows_Video_Standalone_20240428_0641_423.zip",
-    "iris_sdk_mac": "https://download.agora.io/sdk/release/iris_4.3.1-build.1_DCG_Mac_Video_Standalone_20240428_0641_389.zip",
-    "native_sdk_win": "https://download.agora.io/sdk/release/Agora_Native_SDK_for_Windows_rel.v4.3.1_24718_FULL_20240426_2154_300585.zip",
-    "native_sdk_mac": "https://download.agora.io/sdk/release/Agora_Native_SDK_for_Mac_rel.v4.3.1_20108_FULL_20240426_2208_300584.zip"
+    "iris_sdk_win": "https://download.agora.io/sdk/release/iris_4.3.2-build.1_DCG_Windows_Video_Standalone_20240604_0456_441.zip",
+    "iris_sdk_mac": "https://download.agora.io/sdk/release/iris_4.3.2-build.1_DCG_Mac_Video_Standalone_20240604_0500_404.zip",
+    "native_sdk_win": "https://download.agora.io/sdk/release/Agora_Native_SDK_for_Windows_v4.3.2_FULL.zip",
+    "native_sdk_mac": "https://download.agora.io/sdk/release/Agora_Native_SDK_for_Mac_v4.3.2_FULL.zip"
   }
 }

package/ts/Private/AgoraBase.ts

@@ -527,11 +527,11 @@ export enum UserOfflineReasonType {
  */
 export enum InterfaceIdType {
   /**
-   * The IAudioDeviceManager interface class.
+   * 1: The IAudioDeviceManager interface class.
    */
   AgoraIidAudioDeviceManager = 1,
   /**
-   * The IVideoDeviceManager interface class.
+   * 2: The IVideoDeviceManager interface class.
    */
   AgoraIidVideoDeviceManager = 2,
   /**
@@ -539,7 +539,7 @@ export enum InterfaceIdType {
    */
   AgoraIidParameterEngine = 3,
   /**
-   * The IMediaEngine interface class.
+   * 4: The IMediaEngine interface class.
    */
   AgoraIidMediaEngine = 4,
   /**
@@ -1295,7 +1295,7 @@ export enum VideoMirrorModeType {
 }
 
 /**
- * The bit mask that indicates the device codec capability.
+ * The bit mask of the codec type.
  */
 export enum CodecCapMask {
   /**
@@ -1335,7 +1335,7 @@ export class CodecCapLevels {
 }
 
 /**
- * The codec capability of the device.
+ * The codec capability of the SDK.
  */
 export class CodecCapInfo {
   /**
@@ -1343,11 +1343,11 @@ export class CodecCapInfo {
    */
   codecType?: VideoCodecType;
   /**
-   * The bit mask of the codec type. See CodecCapMask.
+   * Bit mask of the codec types in SDK. See CodecCapMask.
    */
   codecCapMask?: number;
   /**
-   * The level of the codec capability. See CodecCapLevels.
+   * Codec capability of the SDK. See CodecCapLevels.
    */
   codecLevels?: CodecCapLevels;
 }
@@ -1383,7 +1383,7 @@ export class VideoEncoderConfiguration {
    */
   frameRate?: number;
   /**
-   * The encoding bitrate (Kbps) of the video. This parameter does not need to be set; keeping the default value STANDARD_BITRATE is sufficient. The SDK automatically matches the most suitable bitrate based on the video resolution and frame rate you have set. For the correspondence between video resolution, frame rate, and bitrate, please refer to. STANDARD_BITRATE (0): (Recommended) Standard bitrate mode. COMPATIBLE_BITRATE (-1): Adaptive bitrate mode. In general, Agora suggests that you do not use this value.
+   * The encoding bitrate (Kbps) of the video. This parameter does not need to be set; keeping the default value STANDARD_BITRATE is sufficient. The SDK automatically matches the most suitable bitrate based on the video resolution and frame rate you have set. For the correspondence between video resolution and frame rate, see. STANDARD_BITRATE (0): (Recommended) Standard bitrate mode. COMPATIBLE_BITRATE (-1): Adaptive bitrate mode. In general, Agora suggests that you do not use this value.
    */
   bitrate?: number;
   /**
@@ -2423,10 +2423,6 @@ export class VideoTrackInfo {
    * @ignore
    */
   channelId?: string;
-  /**
-   * @ignore
-   */
-  streamType?: VideoStreamType;
   /**
    * @ignore
    */
@@ -2910,7 +2906,7 @@ export class LiveTranscoding {
    */
   height?: number;
   /**
-   * Bitrate of the output video stream for Media Push in Kbps. The default value is 400 Kbps. Set this member according to the table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range.
+   * The encoding bitrate (Kbps) of the video. This parameter does not need to be set; keeping the default value STANDARD_BITRATE is sufficient. The SDK automatically matches the most suitable bitrate based on the video resolution and frame rate you have set. For the correspondence between video resolution and frame rate, see.
    */
   videoBitrate?: number;
   /**
@@ -3201,11 +3197,11 @@ export enum ConnectionChangedReasonType {
    */
   ConnectionChangedInterrupted = 2,
   /**
-   * 3: The connection between the SDK and the Agora edge server is banned by the Agora edge server. This error occurs when the user is kicked out of the channel by the server.
+   * 3: The connection between the SDK and the Agora edge server is banned by the Agora edge server. For example, when a user is kicked out of the channel, this status will be returned.
    */
   ConnectionChangedBannedByServer = 3,
   /**
-   * 4: The SDK fails to join the channel. When the SDK fails to join the channel for more than 20 minutes, this error occurs and the SDK stops reconnecting to the channel.
+   * 4: The SDK fails to join the channel. When the SDK fails to join the channel for more than 20 minutes, this code will be returned and the SDK stops reconnecting to the channel. You need to prompt the user to try to switch to another network and rejoin the channel.
    */
   ConnectionChangedJoinFailed = 4,
   /**
@@ -3213,21 +3209,30 @@ export enum ConnectionChangedReasonType {
    */
   ConnectionChangedLeaveChannel = 5,
   /**
-   * 6: The connection failed because the App ID is not valid. Please rejoin the channel with a valid App ID.
+   * 6: The App ID is invalid. You need to rejoin the channel with a valid APP ID and make sure the App ID you are using is consistent with the one generated in the Agora Console.
    */
   ConnectionChangedInvalidAppId = 6,
   /**
-   * 7: The connection failed since channel name is not valid. Rejoin the channel with a valid channel name.
+   * 7: Invalid channel name. Rejoin the channel with a valid channel name. A valid channel name is a string of up to 64 bytes in length. 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.
+   *  Space
+   *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    */
   ConnectionChangedInvalidChannelName = 7,
   /**
-   * 8: The connection failed because the token is not valid. Possible reasons are as follows:
-   *  The App Certificate for the project is enabled in Agora Console, but you do not use a token when joining the channel. If you enable the App Certificate, you must use a token to join the channel.
+   * 8: Invalid token. Possible reasons are as follows:
+   *  The App Certificate for the project is enabled in Agora Console, but you do not pass in a token when joining a channel.
    *  The uid specified when calling joinChannel to join the channel is inconsistent with the uid passed in when generating the token.
+   *  The generated token and the token used to join the channel are not consistent. Ensure the following:
+   *  When your project enables App Certificate, you need to pass in a token to join a channel.
+   *  The user ID specified when generating the token is consistent with the user ID used when joining the channel.
+   *  The generated token is the same as the token passed in to join the channel.
    */
   ConnectionChangedInvalidToken = 8,
   /**
-   * 9: The connection failed since token is expired.
+   * (9): The token currently being used has expired. You need to generate a new token on your server and rejoin the channel with the new token.
    */
   ConnectionChangedTokenExpired = 9,
   /**
@@ -3245,7 +3250,7 @@ export enum ConnectionChangedReasonType {
    */
   ConnectionChangedRenewToken = 12,
   /**
-   * 13: The IP address of the client has changed, possibly because the network type, IP address, or port has been changed.
+   * (13): Client IP address changed. If you receive this code multiple times, You need to prompt the user to switch networks and try joining the channel again.
    */
   ConnectionChangedClientIpAddressChanged = 13,
   /**
@@ -4015,11 +4020,11 @@ export class ScreenCaptureParameters {
    */
   dimensions?: VideoDimensions;
   /**
-   * On Windows and macOS, this represents the video encoding frame rate (fps) of the shared screen stream. The frame rate (fps) of the shared region. The default value is 5. Agora does not recommend setting this to a value greater than 15.
+   * On Windows and macOS, this represents the video encoding frame rate (fps) of the screen sharing stream. The frame rate (fps) of the shared region. The default value is 5. Agora does not recommend setting this to a value greater than 15.
    */
   frameRate?: number;
   /**
-   * On Windows and macOS, this represents the video encoding bitrate of the shared screen stream. The bitrate (Kbps) of the shared region. The default value is 0 (the SDK works out a bitrate according to the dimensions of the current screen).
+   * On Windows and macOS, this represents the video encoding bitrate of the screen sharing stream. The bitrate (Kbps) of the shared region. The default value is 0 (the SDK works out a bitrate according to the dimensions of the current screen).
    */
   bitrate?: number;
   /**
@@ -4027,7 +4032,7 @@ export class ScreenCaptureParameters {
    */
   captureMouseCursor?: boolean;
   /**
-   * Whether to bring the window to the front when calling the startScreenCaptureByWindowId method to share it: true : Bring the window to the front. false : (Default) Do not bring the window to the front.
+   * Whether to bring the window to the front when calling the startScreenCaptureByWindowId method to share it: true : Bring the window to the front. false : (Default) Do not bring the window to the front. Due to macOS system limitations, when setting this member to bring the window to the front, if the current app has multiple windows, only the main window will be brought to the front.
    */
   windowFocus?: boolean;
   /**
@@ -4833,41 +4838,41 @@ export enum MediaTraceEvent {
  */
 export class VideoRenderingTracingInfo {
   /**
-   * The time interval from calling the startMediaRenderingTracing method to SDK triggering the onVideoRenderingTracingResult callback. The unit is milliseconds. Agora recommends you call startMediaRenderingTracing before joining a channel.
+   * The time interval (ms) from startMediaRenderingTracing to SDK triggering the onVideoRenderingTracingResult callback. Agora recommends you call startMediaRenderingTracing before joining a channel.
    */
   elapsedTime?: number;
   /**
-   * The time interval from calling startMediaRenderingTracing to calling joinChannel. The unit is milliseconds. A negative number means to call joinChannel after calling startMediaRenderingTracing.
+   * The time interval (ms) from startMediaRenderingTracing to joinChannel. A negative number indicates that startMediaRenderingTracing is called after calling joinChannel.
    */
   start2JoinChannel?: number;
   /**
-   * Time interval from calling joinChannel to successfully joining the channel. The unit is milliseconds.
+   * The time interval (ms) from or joinChannel to successfully joining the channel.
    */
   join2JoinSuccess?: number;
   /**
-   * If the local user calls startMediaRenderingTracing before successfully joining the channel, this value is the time interval from the local user successfully joining the channel to the remote user joining the channel. The unit is milliseconds.
-   *  If the local user calls startMediaRenderingTracing after successfully joining the channel, the value is the time interval from calling startMediaRenderingTracing to when the remote user joins the channel. The unit is milliseconds.
+   * If the local user calls startMediaRenderingTracing before successfully joining the channel, this value is the time interval (ms) from the local user successfully joining the channel to the remote user joining the channel.
+   *  If the local user calls startMediaRenderingTracing after successfully joining the channel, the value is the time interval (ms) from startMediaRenderingTracing to when the remote user joins the channel.
    *  If the local user calls startMediaRenderingTracing after the remote user joins the channel, the value is 0 and meaningless.
    *  In order to reduce the time of rendering the first frame for remote users, Agora recommends that the local user joins the channel when the remote user is in the channel to reduce this value.
    */
   joinSuccess2RemoteJoined?: number;
   /**
-   * If the local user calls startMediaRenderingTracing before the remote user joins the channel, this value is the time interval from when the remote user joins the channel to when the local user sets the remote view. The unit is milliseconds.
-   *  If the local user calls startMediaRenderingTracing after the remote user joins the channel, this value is the time interval from calling startMediaRenderingTracing to setting the remote view. The unit is milliseconds.
+   * If the local user calls startMediaRenderingTracing before the remote user joins the channel, this value is the time interval (ms) from when the remote user joins the channel to when the local user sets the remote view.
+   *  If the local user calls startMediaRenderingTracing after the remote user joins the channel, this value is the time interval (ms) from calling startMediaRenderingTracing to setting the remote view.
    *  If the local user calls startMediaRenderingTracing after setting the remote view, the value is 0 and has no effect.
    *  In order to reduce the time of rendering the first frame for remote users, Agora recommends that the local user sets the remote view before the remote user joins the channel, or sets the remote view immediately after the remote user joins the channel to reduce this value.
    */
   remoteJoined2SetView?: number;
   /**
-   * If the local user calls startMediaRenderingTracing before the remote user joins the channel, this value is the time interval from the remote user joining the channel to subscribing to the remote video stream. The unit is milliseconds.
-   *  If the local user calls startMediaRenderingTracing after the remote user joins the channel, this value is the time interval from calling startMediaRenderingTracing to subscribing to the remote video stream. The unit is milliseconds.
+   * If the local user calls startMediaRenderingTracing before the remote user joins the channel, this value is the time interval (ms) from the remote user joining the channel to subscribing to the remote video stream.
+   *  If the local user calls startMediaRenderingTracing after the remote user joins the channel, this value is the time interval (ms) from startMediaRenderingTracing to subscribing to the remote video stream.
    *  If the local user calls startMediaRenderingTracing after subscribing to the remote video stream, the value is 0 and has no effect.
    *  In order to reduce the time of rendering the first frame for remote users, Agora recommends that after the remote user joins the channel, the local user immediately subscribes to the remote video stream to reduce this value.
    */
   remoteJoined2UnmuteVideo?: number;
   /**
-   * If the local user calls startMediaRenderingTracing before the remote user joins the channel, this value is the time interval from when the remote user joins the channel to when the local user receives the remote video stream. The unit is milliseconds.
-   *  If the local user calls startMediaRenderingTracing after the remote user joins the channel, this value is the time interval from calling startMediaRenderingTracing to receiving the remote video stream. The unit is milliseconds.
+   * If the local user calls startMediaRenderingTracing before the remote user joins the channel, this value is the time interval (ms) from when the remote user joins the channel to when the local user receives the remote video stream.
+   *  If the local user calls startMediaRenderingTracing after the remote user joins the channel, this value is the time interval (ms) from startMediaRenderingTracing to receiving the remote video stream.
    *  If the local user calls startMediaRenderingTracing after receiving the remote video stream, the value is 0 and has no effect.
    *  In order to reduce the time of rendering the first frame for remote users, Agora recommends that the remote user publishes video streams immediately after joining the channel, and the local user immediately subscribes to remote video streams to reduce this value.
    */

package/ts/Private/AgoraMediaBase.ts

@@ -949,12 +949,12 @@ export interface IAudioFrameObserverBase {
  */
 export interface IAudioFrameObserver extends IAudioFrameObserverBase {
   /**
-   * Retrieves the audio frame of a specified user before mixing.
+   * Retrieves the audio frame before mixing of subscribed remote users.
    *
    * Due to framework limitations, this callback does not support sending processed audio data back to the SDK.
    *
    * @param channelId The channel ID.
-   * @param uid The user ID of the specified user.
+   * @param uid The ID of subscribed remote users.
    * @param audioFrame The raw audio data. See AudioFrame.
    */
   onPlaybackAudioFrameBeforeMixing?(
@@ -1066,7 +1066,7 @@ export interface IVideoFrameObserver {
    *
    * @param sourceType Video source types, including cameras, screens, or media player. See VideoSourceType.
    * @param videoFrame The video frame. See VideoFrame. The default value of the video frame data format obtained through this callback is as follows:
-   *  macOS: I420 or CVPixelBufferRef
+   *  macOS: I420
    *  Windows: YUV420
    */
   onCaptureVideoFrame?(
@@ -1078,12 +1078,13 @@ export interface IVideoFrameObserver {
    * Occurs each time the SDK receives a video frame before encoding.
    *
    * After you successfully register the video frame observer, the SDK triggers this callback each time it receives a video frame. In this callback, you can get the video data before encoding and then process the data according to your particular scenarios. After processing, you can send the processed video data back to the SDK in this callback.
+   *  It's recommended that you implement this callback through the C++ API.
    *  Due to framework limitations, this callback does not support sending processed video data back to the SDK.
    *  The video data that this callback gets has been preprocessed, with its content cropped and rotated, and the image enhanced.
    *
    * @param sourceType The type of the video source. See VideoSourceType.
    * @param videoFrame The video frame. See VideoFrame. The default value of the video frame data format obtained through this callback is as follows:
-   *  macOS: I420 or CVPixelBufferRef
+   *  macOS: I420
    *  Windows: YUV420
    */
   onPreEncodeVideoFrame?(
@@ -1101,12 +1102,13 @@ export interface IVideoFrameObserver {
    *
    * After you successfully register the video frame observer, the SDK triggers this callback each time it receives a video frame. In this callback, you can get the video data sent from the remote end before rendering, and then process it according to the particular scenarios.
    *  If the video data type you get is RGBA, the SDK does not support processing the data of the alpha channel.
+   *  It's recommended that you implement this callback through the C++ API.
    *  Due to framework limitations, this callback does not support sending processed video data back to the SDK.
    *
    * @param channelId The channel ID.
    * @param remoteUid The user ID of the remote user who sends the current video frame.
    * @param videoFrame The video frame. See VideoFrame. The default value of the video frame data format obtained through this callback is as follows:
-   *  macOS: I420 or CVPixelBufferRef
+   *  macOS: I420
    *  Windows: YUV420
    */
   onRenderVideoFrame?(
@@ -1236,7 +1238,7 @@ export class MediaRecorderConfiguration {
 /**
  * Facial information observer.
  *
- * You can call registerFaceInfoObserver to register or unregister the IFaceInfoObserver object.
+ * You can call registerFaceInfoObserver to register one IFaceInfoObserver observer.
  */
 export interface IFaceInfoObserver {
   /**