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

package/ts/Private/IAgoraRtcEngineEx.ts

@@ -62,11 +62,11 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * 0: Success.
    *  < 0: Failure.
    *  -2: The parameter is invalid. For example, the token is invalid, the uid parameter is not set to an integer, or the value of a member in ChannelMediaOptions is invalid. You need to pass in a valid parameter and join the channel again.
-   *  -3: Failes to initialize the IRtcEngine object. You need to reinitialize the IRtcEngine object.
+   *  -3: Fails to initialize the IRtcEngine object. You need to reinitialize the IRtcEngine object.
    *  -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
-   *  -8: The internal state of the IRtcEngine object is wrong. The typical cause is that you call this method to join the channel without calling startEchoTest to stop the test after calling stopEchoTest to start a call loop test. You need to call stopEchoTest before calling this method.
-   *  -17: The request to join the channel is rejected. The typical cause is that the user is 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.
-   *  -102: The channel name is invalid. You need to pass in a valid channelname in channelId to rejoin the channel.
+   *  -8: The internal state of the IRtcEngine object is wrong. The typical cause is that you call this method to join the channel without calling stopEchoTest to stop the test after calling startEchoTest to start a call loop test. You need to call stopEchoTest before calling this method.
+   *  -17: The request to join the channel is rejected. The typical cause is that 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.
+   *  -102: The channel name is invalid. You need to pass in a valid channel name in channelId to rejoin the channel.
    *  -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.
    */
   abstract joinChannelEx(
@@ -103,9 +103,9 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * @returns
    * 0: Success.
    *  < 0: Failure.
-   *  -2: The value of a member in the ChannelMediaOptions structure is invalid. For example, the token or the user ID is invalid. You need to fill in a valid parameter.
+   *  -2: The value of a member in ChannelMediaOptions is invalid. For example, the token or the user ID is invalid. You need to fill in a valid parameter.
    *  -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
-   *  -8: The internal state of the IRtcEngine object is wrong. The possible reason is that the user is not in the channel. Agora recommends that you use the onConnectionStateChanged callback to determine whether the user exists in the channel. If you receive the ConnectionStateDisconnected (1) or ConnectionStateFailed (5) state, the user is not in the channel. You need to call joinChannel to join a channel before calling this method.
+   *  -8: The internal state of the IRtcEngine object is wrong. The possible reason is that the user is not in the channel. Agora recommends that you use the onConnectionStateChanged callback to see whether the user is in the channel. If you receive the ConnectionStateDisconnected (1) or ConnectionStateFailed (5) state, the user is not in the channel. You need to call joinChannel to join a channel before calling this method.
    */
   abstract updateChannelMediaOptionsEx(
     options: ChannelMediaOptions,
@@ -132,7 +132,8 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Initializes the video view of a remote user.
    *
-   * This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view. The application specifies the uid of the remote video in the VideoCanvas method before the remote user joins the channel. If the remote uid is unknown to the application, set it after the application receives the onUserJoined callback. If the Video Recording function is enabled, the Video Recording Service joins the channel as a dummy client, causing other clients to also receive the onUserJoined callback. Do not bind the dummy client to the application view because the dummy client does not send any video streams. To unbind the remote user from the view, set the view parameter to NULL. Once the remote user leaves the channel, the SDK unbinds the remote user. To update the rendering or mirror mode of the remote video view during a call, use the setRemoteRenderModeEx method.
+   * This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view. The application specifies the uid of the remote video in the VideoCanvas method before the remote user joins the channel. If the remote uid is unknown to the application, set it after the application receives the onUserJoined callback. If the Video Recording function is enabled, the Video Recording Service joins the channel as a dummy client, causing other clients to also receive the onUserJoined callback. Do not bind the dummy client to the application view because the dummy client does not send any video streams. To unbind the remote user from the view, set the view parameter to NULL. Once the remote user leaves the channel, the SDK unbinds the remote user.
+   *  To update the rendering or mirror mode of the remote video view during a call, use the setRemoteRenderModeEx method.
    *
    * @param canvas The remote video view settings. See VideoCanvas.
    * @param connection The connection information. See RtcConnection.
@@ -518,7 +519,7 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Enables or disables the built-in encryption.
    *
-   * All users in the same channel must use the same encryption mode and encryption key. After the user leaves the channel, the SDK automatically disables the built-in encryption. To enable the built-in encryption, call this method before the user joins the channel again. In scenarios requiring high security, Agora recommends calling this method to enable the built-in encryption before joining a channel.
+   * After the user leaves the channel, the SDK automatically disables the built-in encryption. To enable the built-in encryption, call this method before the user joins the channel again.
    *
    * @param connection The connection information. See RtcConnection.
    * @param enabled Whether to enable built-in encryption: true : Enable the built-in encryption. false : (Default) Disable the built-in encryption.
@@ -552,10 +553,10 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Sends data stream messages.
    *
-   * After calling createDataStreamEx, you can call this method to send data stream messages to all users in the channel. The SDK has the following restrictions on this method:
-   *  Up to 60 packets can be sent per second in a channel with each packet having a maximum size of 1 KB.
-   *  Each client can send up to 30 KB of data per second.
-   *  Each user can have up to five data streams simultaneously. A successful method call triggers the onStreamMessage callback on the remote client, from which the remote user gets the stream message. A failed method call triggers the onStreamMessageError callback on the remote client.
+   * A successful method call triggers the onStreamMessage callback on the remote client, from which the remote user gets the stream message. A failed method call triggers the onStreamMessageError callback on the remote client. The SDK has the following restrictions on this method:
+   *  Each user can have up to five data streams simultaneously.
+   *  Up to 60 packets can be sent per second in a data stream with each packet having a maximum size of 1 KB.
+   *  Up to 30 KB of data can be sent per second in a data stream. After calling createDataStreamEx, you can call this method to send data stream messages to all users in the channel.
    *  Ensure that you call createDataStreamEx to create a data channel before calling this method.
    *  This method applies only to the COMMUNICATION profile or to the hosts in the LIVE_BROADCASTING profile. If an audience in the LIVE_BROADCASTING profile calls this method, the audience may be switched to a host.
    *
@@ -747,7 +748,6 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    *  < 0: Failure.
    *  -1: A general error occurs (no specified reason).
    *  -2: The parameter is invalid.
-   *  -7: The method call was rejected. It may be because the SDK has not been initialized successfully, or the user role is not a host.
    *  -8: Internal state error. Probably because the user is not a broadcaster.
    */
   abstract startOrUpdateChannelMediaRelayEx(
@@ -765,6 +765,7 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * @returns
    * 0: Success.
    *  < 0: Failure.
+   *  -5: The method call was rejected. There is no ongoing channel media relay.
    */
   abstract stopChannelMediaRelayEx(connection: RtcConnection): number;
 
@@ -778,6 +779,7 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * @returns
    * 0: Success.
    *  < 0: Failure.
+   *  -5: The method call was rejected. There is no ongoing channel media relay.
    */
   abstract pauseAllChannelMediaRelayEx(connection: RtcConnection): number;
 
@@ -791,6 +793,7 @@ export abstract class IRtcEngineEx extends IRtcEngine {
    * @returns
    * 0: Success.
    *  < 0: Failure.
+   *  -5: The method call was rejected. There is no paused channel media relay.
    */
   abstract resumeAllChannelMediaRelayEx(connection: RtcConnection): number;
 
@@ -897,10 +900,10 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Enables or disables video screenshot and upload.
    *
-   * This method can take screenshots for multiple video streams and upload them. When video screenshot and upload function is enabled, the SDK takes screenshots and uploads videos sent by local users based on the type and frequency of the module you set in ContentInspectConfig. After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service. Before calling this method, ensure that you have contacted to activate the video screenshot upload service.
+   * This method can take screenshots for multiple video streams and upload them. When video screenshot and upload function is enabled, the SDK takes screenshots and uploads videos sent by local users based on the type and frequency of the module you set in ContentInspectConfig. After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.
    *
-   * @param enabled Whether to enable video screenshot and upload : true : Enables video screenshot and upload. false : Disables video screenshot and upload.
-   * @param config Configuration of video screenshot and upload. See ContentInspectConfig. When the video moderation module is set to video moderation via Agora self-developed extension(ContentInspectSupervision), the video screenshot and upload dynamic library libagora_content_inspect_extension.dll is required. Deleting this library disables the screenshot and upload feature.
+   * @param enabled Whether to enalbe video screenshot and upload: true : Enables video screenshot and upload. false : Disables video screenshot and upload.
+   * @param config Screenshot and upload configuration. See ContentInspectConfig. When the video moderation module is set to video moderation via Agora self-developed extension(ContentInspectSupervision), the video screenshot and upload dynamic library libagora_content_inspect_extension.dll is required. Deleting this library disables the screenshot and upload feature.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
@@ -938,7 +941,7 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Gets the call ID with the connection ID.
    *
-   * Call this method after joining a channel. When a user joins a channel on a client, a callId is generated to identify the call from the client. You can call this method to get the callId parameter, and pass it in when calling methods such as rate and complain.
+   * When a user joins a channel on a client, a callId is generated to identify the call from the client. You can call this method to get the callId parameter, and pass it in when calling methods such as rate and complain.
    *
    * @param connection The connection information. See RtcConnection.
    *

package/ts/Private/IAudioDeviceManager.ts

@@ -193,7 +193,7 @@ export abstract class IAudioDeviceManager {
   /**
    * Starts the audio playback device test.
    *
-   * This method tests whether the audio device for local playback works properly. Once a user starts the test, the SDK plays an audio file specified by the user. If the user can hear the audio, the playback device works properly. After calling this method, the SDK triggers the onAudioVolumeIndication callback every 100 ms, reporting uid = 1 and the volume information of the playback device. The difference between this method and the startEchoTest method is that the former checks if the local audio playback device is working properly, while the latter can check the audio and video devices and network conditions. Ensure that you call this method before joining a channel. After the test is completed, call stopPlaybackDeviceTest to stop the test before joining a channel.
+   * This method tests whether the audio device for local playback works properly. Once a user starts the test, the SDK plays an audio file specified by the user. If the user can hear the audio, the playback device works properly. After calling this method, the SDK triggers the onAudioVolumeIndication callback every 100 ms, reporting uid = 1 and the volume information of the playback device. The difference between this method and the startEchoTest method is that the former checks if the local audio playback device is working properly, while the latter can check the audio and video devices and network conditions. Call this method before joining a channel. After the test is completed, call stopPlaybackDeviceTest to stop the test before joining a channel.
    *
    * @param testAudioFilePath The path of the audio file. The data format is string in UTF-8.
    *  Supported file formats: wav, mp3, m4a, and aac.
@@ -208,7 +208,7 @@ export abstract class IAudioDeviceManager {
   /**
    * Stops the audio playback device test.
    *
-   * This method stops the audio playback device test. You must call this method to stop the test after calling the startPlaybackDeviceTest method. Ensure that you call this method before joining a channel.
+   * This method stops the audio playback device test. You must call this method to stop the test after calling the startPlaybackDeviceTest method. Call this method before joining a channel.
    *
    * @returns
    * 0: Success.
@@ -219,7 +219,7 @@ export abstract class IAudioDeviceManager {
   /**
    * Starts the audio capturing device test.
    *
-   * This method tests whether the audio capturing device works properly. After calling this method, the SDK triggers the onAudioVolumeIndication callback at the time interval set in this method, which reports uid = 0 and the volume information of the capturing device. The difference between this method and the startEchoTest method is that the former checks if the local audio capturing device is working properly, while the latter can check the audio and video devices and network conditions. Ensure that you call this method before joining a channel. After the test is completed, call stopRecordingDeviceTest to stop the test before joining a channel.
+   * This method tests whether the audio capturing device works properly. After calling this method, the SDK triggers the onAudioVolumeIndication callback at the time interval set in this method, which reports uid = 0 and the volume information of the capturing device. The difference between this method and the startEchoTest method is that the former checks if the local audio capturing device is working properly, while the latter can check the audio and video devices and network conditions. Call this method before joining a channel. After the test is completed, call stopRecordingDeviceTest to stop the test before joining a channel.
    *
    * @param indicationInterval The interval (ms) for triggering the onAudioVolumeIndication callback. This value should be set to greater than 10, otherwise, you will not receive the onAudioVolumeIndication callback and the SDK returns the error code -2. Agora recommends that you set this value to 100.
    *
@@ -233,7 +233,7 @@ export abstract class IAudioDeviceManager {
   /**
    * Stops the audio capturing device test.
    *
-   * This method stops the audio capturing device test. You must call this method to stop the test after calling the startRecordingDeviceTest method. Ensure that you call this method before joining a channel.
+   * This method stops the audio capturing device test. You must call this method to stop the test after calling the startRecordingDeviceTest method. Call this method before joining a channel.
    *
    * @returns
    * 0: Success.

package/ts/Private/impl/IAgoraRtcEngineImpl.ts

@@ -2071,27 +2071,6 @@ export class IRtcEngineImpl implements IRtcEngine {
     return 'RtcEngine_muteAllRemoteAudioStreams_5039d15';
   }
 
-  setDefaultMuteAllRemoteAudioStreams(mute: boolean): number {
-    const apiType =
-      this.getApiTypeFromSetDefaultMuteAllRemoteAudioStreams(mute);
-    const jsonParams = {
-      mute: mute,
-      toJSON: () => {
-        return {
-          mute: mute,
-        };
-      },
-    };
-    const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
-  }
-
-  protected getApiTypeFromSetDefaultMuteAllRemoteAudioStreams(
-    mute: boolean
-  ): string {
-    return 'RtcEngine_setDefaultMuteAllRemoteAudioStreams_5039d15';
-  }
-
   muteRemoteAudioStream(uid: number, mute: boolean): number {
     const apiType = this.getApiTypeFromMuteRemoteAudioStream(uid, mute);
     const jsonParams = {
@@ -2169,27 +2148,6 @@ export class IRtcEngineImpl implements IRtcEngine {
     return 'RtcEngine_muteAllRemoteVideoStreams_5039d15';
   }
 
-  setDefaultMuteAllRemoteVideoStreams(mute: boolean): number {
-    const apiType =
-      this.getApiTypeFromSetDefaultMuteAllRemoteVideoStreams(mute);
-    const jsonParams = {
-      mute: mute,
-      toJSON: () => {
-        return {
-          mute: mute,
-        };
-      },
-    };
-    const jsonResults = callIrisApi.call(this, apiType, jsonParams);
-    return jsonResults.result;
-  }
-
-  protected getApiTypeFromSetDefaultMuteAllRemoteVideoStreams(
-    mute: boolean
-  ): string {
-    return 'RtcEngine_setDefaultMuteAllRemoteVideoStreams_5039d15';
-  }
-
   setRemoteDefaultVideoStreamType(streamType: VideoStreamType): number {
     const apiType =
       this.getApiTypeFromSetRemoteDefaultVideoStreamType(streamType);

package/ts/Private/internal/RtcEngineExInternal.ts

@@ -1,7 +1,12 @@
 import { createCheckers } from 'ts-interface-checker';
 
-import { RendererManager } from '../../Renderer/RendererManager';
 import { AgoraEnv, logError, parseIntPtr2Number } from '../../Utils';
+let RendererManager: any;
+if (typeof window !== 'undefined') {
+  RendererManager = require('../../Renderer/RendererManager').RendererManager;
+} else {
+  RendererManager = undefined;
+}
 import {
   AudioEncodedFrameObserverConfig,
   ClientRoleOptions,
@@ -90,7 +95,7 @@ export class RtcEngineExInternal extends IRtcEngineExImpl {
     if (AgoraEnv.webEnvReady) {
       // @ts-ignore
       window.AgoraEnv = AgoraEnv;
-      if (AgoraEnv.AgoraRendererManager === undefined) {
+      if (AgoraEnv.AgoraRendererManager === undefined && RendererManager) {
         AgoraEnv.AgoraRendererManager = new RendererManager();
       }
     }

package/ts/Renderer/AgoraView.ts

@@ -1,10 +1,15 @@
 import { VideoMirrorModeType, VideoViewSetupMode } from '../Private/AgoraBase';
-import { RenderModeType, VideoSourceType } from '../Private/AgoraMediaBase';
+import {
+  RenderModeType,
+  VideoModulePosition,
+  VideoSourceType,
+} from '../Private/AgoraMediaBase';
 import { AgoraEnv } from '../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';
 
@@ -12,6 +17,7 @@ const observedAttributes = [
   VIDEO_SOURCE_TYPE_STRING,
   UID_STRING,
   CHANNEL_ID_STRING,
+  POSITION_STRING,
   RENDERER_CONTENT_MODE_STRING,
   RENDERER_MIRROR_STRING,
 ];
@@ -19,7 +25,7 @@ const observedAttributes = [
 declare global {
   /**
    * Attributes of the Agora custom element.
-   * You can use this custom element as follows:<agora-view video-source-type="{VideoSourceType.VideoSourceCamera}" channel-id="" uid="{0}"></agora-view>
+   * You can use this custom element as follows:<agora-view video-source-type="{VideoSourceType.VideoSourceCamera}" channel-id="" uid="{0}" position="{VideoModulePosition.PositionPreRenderer}"></agora-view>
    */
   interface AgoraView {
     /**
@@ -39,6 +45,10 @@ declare global {
      * "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
      */
     'channel-id': string;
+    /**
+     * The frame position of the video observer.
+     */
+    'position': VideoModulePosition;
     /**
      * The video display mode.
      */
@@ -109,6 +119,22 @@ export default class AgoraView extends HTMLElement {
     }
   }
 
+  get position(): VideoModulePosition {
+    const number = Number(this.getAttribute(POSITION_STRING));
+    return isNaN(number)
+      ? VideoModulePosition.PositionPreEncoder |
+          VideoModulePosition.PositionPreRenderer
+      : number;
+  }
+
+  set position(val) {
+    if (val) {
+      this.setAttribute(POSITION_STRING, String(val));
+    } else {
+      this.removeAttribute(POSITION_STRING);
+    }
+  }
+
   get renderMode(): RenderModeType {
     const number = Number(
       this.getAttribute(RENDERER_CONTENT_MODE_STRING) ||
@@ -142,12 +168,14 @@ export default class AgoraView extends HTMLElement {
   }
 
   initializeRender = () => {
-    const { channelId, uid, sourceType, renderMode, renderMirror } = this;
+    const { channelId, uid, sourceType, position, renderMode, renderMirror } =
+      this;
     AgoraEnv.AgoraRendererManager?.addOrRemoveRenderer({
       sourceType,
       view: this,
       uid,
       channelId,
+      position,
       renderMode,
       mirrorMode: renderMirror
         ? VideoMirrorModeType.VideoMirrorModeEnabled
@@ -157,9 +185,10 @@ export default class AgoraView extends HTMLElement {
   };
 
   destroyRender = () => {
-    const { channelId, uid, sourceType } = this;
+    const { channelId, uid, sourceType, position } = this;
     AgoraEnv.AgoraRendererManager?.removeRendererFromCache({
       channelId,
+      position,
       uid,
       sourceType,
       view: this,

package/ts/Renderer/IRendererManager.ts

@@ -1,5 +1,9 @@
 import { VideoMirrorModeType, VideoViewSetupMode } from '../Private/AgoraBase';
-import { RenderModeType, VideoSourceType } from '../Private/AgoraMediaBase';
+import {
+  RenderModeType,
+  VideoModulePosition,
+  VideoSourceType,
+} from '../Private/AgoraMediaBase';
 import { RendererContext, RendererType } from '../Types';
 import { logDebug } from '../Utils';
 
@@ -86,6 +90,7 @@ export abstract class IRendererManager {
       sourceType,
       uid,
       channelId,
+      position,
       mediaPlayerId,
       renderMode = this.defaultRenderMode,
       mirrorMode = this.defaultMirrorMode,
@@ -114,7 +119,20 @@ export abstract class IRendererManager {
         uid = 0;
         break;
     }
-    return { ...context, sourceType, uid, channelId, renderMode, mirrorMode };
+    if (!position) {
+      position =
+        VideoModulePosition.PositionPreEncoder |
+        VideoModulePosition.PositionPreRenderer;
+    }
+    return {
+      ...context,
+      position,
+      sourceType,
+      uid,
+      channelId,
+      renderMode,
+      mirrorMode,
+    };
   }
 
   public addOrRemoveRenderer(

package/ts/Renderer/RendererCache.ts

@@ -18,7 +18,7 @@ export class RendererCache {
   private _context: RendererCacheContext;
   private _enabled: boolean;
 
-  constructor({ channelId, uid, sourceType }: RendererContext) {
+  constructor({ channelId, uid, sourceType, position }: RendererContext) {
     this._renderers = [];
     this._videoFrame = {
       yBuffer: Buffer.alloc(0),
@@ -31,7 +31,7 @@ export class RendererCache {
       vStride: 0,
       rotation: 0,
     };
-    this._context = { channelId, uid, sourceType };
+    this._context = { channelId, uid, sourceType, position };
     this._enabled = false;
   }
 

package/ts/Types.ts

@@ -55,7 +55,7 @@ export type RendererContext = VideoCanvas & RtcConnection;
 
 export type RendererCacheContext = Pick<
   RendererContext,
-  'channelId' | 'uid' | 'sourceType'
+  'channelId' | 'uid' | 'sourceType' | 'position'
 >;
 
 /**

package/types/AgoraSdk.d.ts

@@ -30,7 +30,7 @@ export declare function createAgoraRtcEngine(options?: AgoraEnvOptions): IRtcEng
 /**
  * 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/types/Private/AgoraBase.d.ts

@@ -231,7 +231,7 @@ export declare 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,
@@ -1259,6 +1259,10 @@ export declare 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;
 }
 /**
  * Video mirror mode.
@@ -1389,7 +1393,7 @@ export declare 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;
     /**
@@ -1879,7 +1883,7 @@ export declare 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,
     /**
@@ -1959,7 +1963,7 @@ export declare 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.
@@ -3309,7 +3313,7 @@ export declare enum ConnectionChangedReasonType {
  */
 export declare 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,
     /**
@@ -3317,11 +3321,11 @@ export declare 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
 }
@@ -3477,7 +3481,7 @@ export declare 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,.
      */
@@ -3727,7 +3731,7 @@ export declare class ColorEnhanceOptions {
  */
 export declare 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,
     /**