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

package/ts/Private/IAgoraRtcEngine.ts

@@ -33,6 +33,9 @@ import {
   EncryptionConfig,
   EncryptionErrorType,
   ErrorCodeType,
+  FaceShapeArea,
+  FaceShapeAreaOptions,
+  FaceShapeBeautyOptions,
   FocalLengthInfo,
   HeadphoneEqualizerPreset,
   IAudioEncodedFrameObserver,
@@ -68,6 +71,7 @@ import {
   ScreenScenarioType,
   SegmentationProperty,
   SenderOptions,
+  SimulcastConfig,
   SimulcastStreamConfig,
   SimulcastStreamMode,
   SpatialAudioParams,
@@ -84,6 +88,7 @@ import {
   VideoCodecType,
   VideoContentHint,
   VideoDenoiserOptions,
+  VideoDimensions,
   VideoEncoderConfiguration,
   VideoFormat,
   VideoLayout,
@@ -95,6 +100,7 @@ import {
   VideoSubscriptionOptions,
   VideoTranscoderError,
   VirtualBackgroundSource,
+  VoiceAiTunerType,
   VoiceBeautifierPreset,
   VoiceConversionPreset,
   WatermarkOptions,
@@ -105,6 +111,7 @@ import {
 import {
   ContentInspectConfig,
   ContentInspectResult,
+  ExtensionContext,
   IAudioSpectrumObserver,
   MediaSourceType,
   RawAudioFrameOpModeType,
@@ -358,6 +365,30 @@ export enum StreamFallbackOptions {
    * @ignore
    */
   StreamFallbackOptionAudioOnly = 2,
+  /**
+   * @ignore
+   */
+  StreamFallbackOptionVideoStreamLayer1 = 3,
+  /**
+   * @ignore
+   */
+  StreamFallbackOptionVideoStreamLayer2 = 4,
+  /**
+   * @ignore
+   */
+  StreamFallbackOptionVideoStreamLayer3 = 5,
+  /**
+   * @ignore
+   */
+  StreamFallbackOptionVideoStreamLayer4 = 6,
+  /**
+   * @ignore
+   */
+  StreamFallbackOptionVideoStreamLayer5 = 7,
+  /**
+   * @ignore
+   */
+  StreamFallbackOptionVideoStreamLayer6 = 8,
 }
 
 /**
@@ -472,6 +503,10 @@ export class LocalVideoStats {
    *  1: Hardware encoding is applied for acceleration.
    */
   hwEncoderAccelerating?: number;
+  /**
+   * @ignore
+   */
+  simulcastDimensions?: VideoDimensions[];
 }
 
 /**
@@ -584,6 +619,10 @@ export class RemoteVideoStats {
    * The bitrate (Kbps) of the remote video received since the last count.
    */
   receivedBitrate?: number;
+  /**
+   * @ignore
+   */
+  decoderInputFrameRate?: number;
   /**
    * The frame rate (fps) of decoding the remote video.
    */
@@ -1206,6 +1245,10 @@ export class ChannelMediaOptions {
    * Whether the audio stream being published is filtered according to the volume algorithm: true : The audio stream is filtered. If the audio stream filter is not enabled, this setting does not takes effect. false : The audio stream is not filtered. If you need to enable this function, contact.
    */
   isAudioFilterable?: boolean;
+  /**
+   * @ignore
+   */
+  parameters?: string;
 }
 
 /**
@@ -1383,10 +1426,10 @@ export interface IRtcEngineEventHandler {
   /**
    * Occurs when a user leaves a channel.
    *
-   * This callback notifies the app that the user leaves the channel by calling leaveChannel. From this callback, the app can get information such as the call duration and statistics.
+   * You can obtain information such as the total duration of a call, and the data traffic that the SDK transmits and receives.
    *
    * @param connection The connection information. See RtcConnection.
-   * @param stats The statistics of the call. See RtcStats.
+   * @param stats Call statistics. See RtcStats.
    */
   onLeaveChannel?(connection: RtcConnection, stats: RtcStats): void;
 
@@ -1460,7 +1503,7 @@ export interface IRtcEngineEventHandler {
   /**
    * Reports the last mile network quality of each user in the channel.
    *
-   * This callback reports the last mile network conditions of each user in the channel. Last mile refers to the connection between the local device and Agora's edge server. The SDK triggers this callback once every two seconds. If a channel includes multiple users, the SDK triggers this callback as many times. txQuality is Unknown when the user is not sending a stream; rxQuality is Unknown when the user is not receiving a stream.
+   * This callback reports the last mile network conditions of each user in the channel. Last mile refers to the connection between the local device and Agora's edge server. The SDK triggers this callback once every two seconds. If a channel includes multiple users, the SDK triggers this callback as many times. This callback provides feedback on network quality through sending and receiving broadcast packets within the channel. Excessive broadcast packets can lead to broadcast storms. To prevent broadcast storms from causing a large amount of data transmission within the channel, this callback supports feedback on the network quality of up to 4 remote hosts simultaneously by default. txQuality is Unknown when the user is not sending a stream; rxQuality is Unknown when the user is not receiving a stream.
    *
    * @param connection The connection information. See RtcConnection.
    * @param remoteUid The user ID. The network quality of the user with this user ID is reported. If the uid is 0, the local network quality is reported.
@@ -1615,6 +1658,8 @@ export interface IRtcEngineEventHandler {
   /**
    * Occurs when the renderer receives the first frame of the remote video.
    *
+   * This callback is only triggered when the video frame is rendered by the SDK; it will not be triggered if the user employs custom video rendering.You need to implement this independently using methods outside the SDK.
+   *
    * @param connection The connection information. See RtcConnection.
    * @param remoteUid The user ID of the remote user sending the video stream.
    * @param width The width (px) of the video stream.
@@ -1762,7 +1807,7 @@ export interface IRtcEngineEventHandler {
    * @param connection The connection information. See RtcConnection.
    * @param stats The statistics of the local video stream. See LocalVideoStats.
    */
-  onLocalVideoStats?(source: VideoSourceType, stats: LocalVideoStats): void;
+  onLocalVideoStats?(connection: RtcConnection, stats: LocalVideoStats): void;
 
   /**
    * Reports the statistics of the video stream sent by each remote users.
@@ -2076,9 +2121,7 @@ export interface IRtcEngineEventHandler {
   ): void;
 
   /**
-   * Occurs when the user role switches during the interactive live streaming.
-   *
-   * The SDK triggers this callback when the local user switches their user role by calling setClientRole after joining the channel.
+   * Occurs when the user role or the audience latency level changes.
    *
    * @param connection The connection information. See RtcConnection.
    * @param oldRole Role that the user switches from: ClientRoleType.
@@ -2093,9 +2136,9 @@ export interface IRtcEngineEventHandler {
   ): void;
 
   /**
-   * Occurs when the user role switching fails in the interactive live streaming.
+   * Occurs when switching a user role fails.
    *
-   * In the live broadcasting channel profile, when the local user calls setClientRole to switch the user role after joining the channel but the switch fails, the SDK triggers this callback to report the reason for the failure and the current user role.
+   * This callback informs you about the reason for failing to switching and your current user role.
    *
    * @param connection The connection information. See RtcConnection.
    * @param reason The reason for a user role switch failure. See ClientRoleChangeFailedReason.
@@ -2463,55 +2506,29 @@ export interface IRtcEngineEventHandler {
   ): void;
 
   /**
-   * The event callback of the extension.
-   *
-   * To listen for events while the extension is running, you need to register this callback.
-   *
-   * @param provider The name of the extension provider.
-   * @param extension The name of the extension.
-   * @param key The key of the extension.
-   * @param value The value of the extension key.
+   * @ignore
    */
-  onExtensionEvent?(
-    provider: string,
-    extension: string,
+  onExtensionEventWithContext?(
+    context: ExtensionContext,
     key: string,
     value: string
   ): void;
 
   /**
-   * Occurs when the extension is enabled.
-   *
-   * The extension triggers this callback after it is successfully enabled.
-   *
-   * @param provider The name of the extension provider.
-   * @param extension The name of the extension.
+   * @ignore
    */
-  onExtensionStarted?(provider: string, extension: string): void;
+  onExtensionStartedWithContext?(context: ExtensionContext): void;
 
   /**
-   * Occurs when the extension is disabled.
-   *
-   * The extension triggers this callback after it is successfully destroyed.
-   *
-   * @param provider The name of the extension provider.
-   * @param extension The name of the extension.
+   * @ignore
    */
-  onExtensionStopped?(provider: string, extension: string): void;
+  onExtensionStoppedWithContext?(context: ExtensionContext): void;
 
   /**
-   * Occurs when the extension runs incorrectly.
-   *
-   * In case of extension enabling failure or runtime errors, the extension triggers this callback and reports the error code along with the reasons.
-   *
-   * @param provider The name of the extension provider.
-   * @param extension The name of the extension.
-   * @param error Error code. For details, see the extension documentation provided by the extension provider.
-   * @param message Reason. For details, see the extension documentation provided by the extension provider.
+   * @ignore
    */
-  onExtensionError?(
-    provider: string,
-    extension: string,
+  onExtensionErrorWithContext?(
+    context: ExtensionContext,
     error: number,
     message: string
   ): void;
@@ -2693,6 +2710,10 @@ export enum MaxMetadataSizeType {
  * Media metadata.
  */
 export class Metadata {
+  /**
+   * @ignore
+   */
+  channelId?: string;
   /**
    * The user ID.
    *  For the recipient: The ID of the remote user who sent the Metadata.
@@ -2902,8 +2923,6 @@ export abstract class IRtcEngine {
    * Creates and initializes IRtcEngine.
    *
    * All called methods provided by the IRtcEngine class are executed asynchronously. Agora recommends calling these methods in the same thread.
-   *  Before calling other APIs, you must call createAgoraRtcEngine and initialize to create and initialize the IRtcEngine object.
-   *  The SDK supports creating only one IRtcEngine instance for an app.
    *
    * @param context Configurations for the IRtcEngine instance. See RtcEngineContext.
    *
@@ -2968,7 +2987,6 @@ export abstract class IRtcEngine {
    *  All lowercase English letters: a to z.
    *  All uppercase English letters: A to Z.
    *  All numeric characters: 0 to 9.
-   *  Space
    *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    * @param uid The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 2 32 -1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and onJoinChannelSuccess returns it in the callback. Your application must record and maintain the returned user ID, because the SDK does not do so.
    *
@@ -3023,7 +3041,6 @@ export abstract class IRtcEngine {
    *  All lowercase English letters: a to z.
    *  All uppercase English letters: A to Z.
    *  All numeric characters: 0 to 9.
-   *  Space
    *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    * @param uid The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 2 32 -1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and onJoinChannelSuccess returns it in the callback. Your application must record and maintain the returned user ID, because the SDK does not do so.
    * @param options The channel media options. See ChannelMediaOptions.
@@ -3063,8 +3080,7 @@ export abstract class IRtcEngine {
   /**
    * Sets channel options and leaves the channel.
    *
-   * If you call release immediately after calling this method, the SDK does not trigger the onLeaveChannel callback.
-   *  If you have called joinChannelEx to join multiple channels, calling this method will leave the channels when calling joinChannel and joinChannelEx at the same time. This method will release all resources related to the session, leave the channel, that is, hang up or exit the call. This method can be called whether or not a call is currently in progress. After joining the channel, you must call this method or to end the call, otherwise, the next call cannot be started. This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After actually leaving the channel, the local user triggers the onLeaveChannel callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the onUserOffline callback.
+   * After calling this method, the SDK terminates the audio and video interaction, leaves the current channel, and releases all resources related to the session. After joining the channel, you must call this method to end the call; otherwise, the next call cannot be started. If you have called joinChannelEx to join multiple channels, calling this method will leave all the channels you joined. This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.
    *
    * @param options The options for leaving the channel. See LeaveChannelOptions.
    *
@@ -3095,15 +3111,12 @@ export abstract class IRtcEngine {
   /**
    * Sets the channel profile.
    *
-   * After initializing the SDK, the default channel profile is the live streaming profile. You can call this method to set the channel profile. The Agora SDK differentiates channel profiles and applies optimization algorithms accordingly. For example, it prioritizes smoothness and low latency for a video call and prioritizes video quality for interactive live video streaming.
-   *  To ensure the quality of real-time communication, Agora recommends that all users in a channel use the same channel profile.
-   *  This method must be called and set before joinChannel, and cannot be set again after joining the channel.
-   *  The default video encoding bitrate are different in different channel profiles. See setVideoEncoderConfiguration.
+   * You can call this method to set the channel profile. The SDK adopts different optimization strategies for different channel profiles. For example, in a live streaming scenario, the SDK prioritizes video quality. After initializing the SDK, the default channel profile is the live streaming profile.
    *
    * @param profile The channel profile. See ChannelProfileType.
    *
    * @returns
-   * 0(ERR_OK): Success.
+   * 0: Success.
    *  < 0: Failure.
    *  -2: The parameter is invalid.
    *  -7: The SDK is not initialized.
@@ -3111,14 +3124,11 @@ export abstract class IRtcEngine {
   abstract setChannelProfile(profile: ChannelProfileType): number;
 
   /**
-   * Sets the user role and level in an interactive live streaming channel.
+   * Set the user role and the audience latency level in a live streaming scenario.
    *
-   * In the interactive live streaming profile, the SDK sets the user role as audience by default. You can call this method to set the user role as host. You can call this method either before or after joining a channel. If you call this method to set the user's role as the host before joining the channel and set the local video property through the setupLocalVideo method, the local video preview is automatically enabled when the user joins the channel. If you call this method to switch the user role after joining a channel, the SDK automatically does the following:
-   *  Calls muteLocalAudioStream and muteLocalVideoStream to change the publishing state.
-   *  Triggers onClientRoleChanged on the local client.
-   *  Triggers onUserJoined or onUserOffline on the remote client. This method applies to the interactive live streaming profile (the profile parameter of setChannelProfile is set as ChannelProfileLiveBroadcasting) only.
+   * By default,the SDK sets the user role as audience. You can call this method to set the user role as host. The user role (roles) determines the users' permissions at the SDK level, including whether they can publish audio and video streams in a channel.
    *
-   * @param role The user role in the interactive live streaming. See ClientRoleType.
+   * @param role The user role. See ClientRoleType. If you set the user role as an audience member, you cannot publish audio and video streams in the channel. If you want to publish media streams in a channel during live streaming, ensure you set the user role as broadcaster.
    * @param options The detailed options of a user, including the user level. See ClientRoleOptions.
    *
    * @returns
@@ -3277,6 +3287,38 @@ export abstract class IRtcEngine {
     type?: MediaSourceType
   ): number;
 
+  /**
+   * @ignore
+   */
+  abstract setFaceShapeBeautyOptions(
+    enabled: boolean,
+    options: FaceShapeBeautyOptions,
+    type?: MediaSourceType
+  ): number;
+
+  /**
+   * @ignore
+   */
+  abstract setFaceShapeAreaOptions(
+    options: FaceShapeAreaOptions,
+    type?: MediaSourceType
+  ): number;
+
+  /**
+   * @ignore
+   */
+  abstract getFaceShapeBeautyOptions(
+    type?: MediaSourceType
+  ): FaceShapeBeautyOptions;
+
+  /**
+   * @ignore
+   */
+  abstract getFaceShapeAreaOptions(
+    shapeArea: FaceShapeArea,
+    type?: MediaSourceType
+  ): FaceShapeAreaOptions;
+
   /**
    * Sets low-light enhancement.
    *
@@ -3581,9 +3623,9 @@ export abstract class IRtcEngine {
   /**
    * Stops or resumes subscribing to the video streams of all remote users.
    *
-   * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users. By default, the SDK subscribes to the video streams of all remote users when joining a channel. To modify this behavior, you can set autoSubscribeVideo to false when calling joinChannel to join the channel, which will cancel the subscription to the video streams of all users upon joining the channel.
+   * After successfully calling this method, the local user stops or resumes subscribing to the video streams of all remote users, including all subsequent users. By default, the SDK subscribes to the video streams of all remote users when joining a channel. To modify this behavior, you can set autoSubscribeVideo to false when calling joinChannel to join the channel, which will cancel the subscription to the video streams of all users upon joining the channel.
    *
-   * @param mute Whether to stop subscribing to the video streams of all remote users. true : Stop subscribing to the video streams of all remote users. false : (Default) Subscribe to the audio streams of all remote users by default.
+   * @param mute Whether to stop subscribing to the video streams of all remote users. true : Stop subscribing to the video streams of all remote users. false : (Default) Subscribe to the video streams of all remote users by default.
    *
    * @returns
    * 0: Success.
@@ -4610,6 +4652,11 @@ export abstract class IRtcEngine {
    */
   abstract setHeadphoneEQParameters(lowGain: number, highGain: number): number;
 
+  /**
+   * @ignore
+   */
+  abstract enableVoiceAITuner(enabled: boolean, type: VoiceAiTunerType): number;
+
   /**
    * Sets the log file.
    *
@@ -4781,6 +4828,11 @@ export abstract class IRtcEngine {
     streamConfig?: SimulcastStreamConfig
   ): number;
 
+  /**
+   * @ignore
+   */
+  abstract setSimulcastConfig(simulcastConfig: SimulcastConfig): number;
+
   /**
    * Sets whether to enable the local playback of external audio source.
    *
@@ -4976,7 +5028,11 @@ export abstract class IRtcEngine {
   /**
    * Whether to mute the recording signal.
    *
-   * @param mute true : The media file is muted. false : (Default) Do not mute the recording signal. If you have already called adjustRecordingSignalVolume to adjust the volume, then when you call this method and set it to true, the SDK will record the current volume and mute it. To restore the previous volume, call this method again and set it to false.
+   * If you have already called adjustRecordingSignalVolume to adjust the recording signal volume, when you call this method and set it to true, the SDK behaves as follows:
+   *  Records the adjusted volume.
+   *  Mutes the recording signal. When you call this method again and set it to false, the recording signal volume will be restored to the volume recorded by the SDK before muting.
+   *
+   * @param mute true : Mute the recording signal. false : (Default) Do not mute the recording signal.
    *
    * @returns
    * 0: Success.
@@ -5153,8 +5209,6 @@ export abstract class IRtcEngine {
    * Enables in-ear monitoring.
    *
    * This method enables or disables in-ear monitoring.
-   *  Users must use earphones (wired or Bluetooth) to hear the in-ear monitoring effect.
-   *  You can call this method either before or after joining a channel.
    *
    * @param enabled Enables or disables in-ear monitoring. true : Enables in-ear monitoring. false : (Default) Disables in-ear monitoring.
    * @param includeAudioFilters The audio filter types of in-ear monitoring. See EarMonitoringFilterType.
@@ -5252,7 +5306,7 @@ export abstract class IRtcEngine {
    *
    * @returns
    * If the method call is successful, the video track ID is returned as the unique identifier of the video track.
-   *  If the method call fails, a negative value is returned.
+   *  If the method call fails, 0xffffffff is returned.
    */
   abstract createCustomVideoTrack(): number;
 
@@ -5455,7 +5509,7 @@ export abstract class IRtcEngine {
    *
    * @param displayId The display ID of the screen to be shared. For the Windows platform, if you need to simultaneously share two screens (main screen and secondary screen), you can set displayId to -1 when calling this method.
    * @param regionRect (Optional) Sets the relative location of the region to the screen. Pass in nil to share the entire screen.
-   * @param captureParams Screen sharing configurations. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters.
+   * @param captureParams Screen sharing configurations. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters. The video properties of the screen sharing stream only need to be set through this parameter, and are unrelated to setVideoEncoderConfiguration.
    *
    * @returns
    * 0: Success.
@@ -5553,7 +5607,7 @@ export abstract class IRtcEngine {
    *
    * Call this method after starting screen sharing or window sharing.
    *
-   * @param captureParams The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters.
+   * @param captureParams The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters. The video properties of the screen sharing stream only need to be set through this parameter, and are unrelated to setVideoEncoderConfiguration.
    *
    * @returns
    * 0: Success.
@@ -5826,8 +5880,6 @@ export abstract class IRtcEngine {
   /**
    * Gets the current connection state of the SDK.
    *
-   * You can call this method either before or after joining a channel.
-   *
    * @returns
    * The current connection state. See ConnectionStateType.
    */
@@ -5867,41 +5919,6 @@ export abstract class IRtcEngine {
     userPriority: PriorityType
   ): number;
 
-  /**
-   * Sets the built-in encryption mode.
-   *
-   * Deprecated: Use enableEncryption instead. The SDK supports built-in encryption schemes, AES-128-GCM is supported by default. Call this method to use other encryption modes. All users in the same channel must use the same encryption mode and secret. Refer to the information related to the AES encryption algorithm on the differences between the encryption modes. Before calling this method, please call setEncryptionSecret to enable the built-in encryption function.
-   *
-   * @param encryptionMode The following encryption modes:
-   *  " aes-128-xts ": 128-bit AES encryption, XTS mode.
-   *  " aes-128-ecb ": 128-bit AES encryption, ECB mode.
-   *  " aes-256-xts ": 256-bit AES encryption, XTS mode.
-   *  " sm4-128-ecb ": 128-bit SM4 encryption, ECB mode.
-   *  " aes-128-gcm ": 128-bit AES encryption, GCM mode.
-   *  " aes-256-gcm ": 256-bit AES encryption, GCM mode.
-   *  "": When this parameter is set as null, the encryption mode is set as " aes-128-gcm " by default.
-   *
-   * @returns
-   * 0: Success.
-   *  < 0: Failure.
-   */
-  abstract setEncryptionMode(encryptionMode: string): number;
-
-  /**
-   * Enables built-in encryption with an encryption password before users join a channel.
-   *
-   * Deprecated: Use enableEncryption instead. Before joining the channel, you need to call this method to set the secret parameter to enable the built-in encryption. All users in the same channel should use the same secret. The secret is automatically cleared once a user leaves the channel. If you do not specify the secret or secret is set as null, the built-in encryption is disabled.
-   *  Do not use this method for Media Push.
-   *  For optimal transmission, ensure that the encrypted data size does not exceed the original data size + 16 bytes. 16 bytes is the maximum padding size for AES encryption.
-   *
-   * @param secret The encryption password.
-   *
-   * @returns
-   * 0: Success.
-   *  < 0: Failure.
-   */
-  abstract setEncryptionSecret(secret: string): number;
-
   /**
    * Enables or disables the built-in encryption.
    *
@@ -5922,8 +5939,6 @@ export abstract class IRtcEngine {
   /**
    * Creates a data stream.
    *
-   * Creates a data stream. Each user can create up to five data streams in a single channel.
-   *
    * @param config The configurations for the data stream. See DataStreamConfig.
    *
    * @returns
@@ -6104,10 +6119,9 @@ export abstract class IRtcEngine {
   /**
    * Registers a user account.
    *
-   * Once registered, the user account can be used to identify the local user when the user joins the channel. After the registration is successful, the user account can identify the identity of the local user, and the user can use it to join the channel. After the user successfully registers a user account, the SDK triggers the onLocalUserRegistered callback on the local client, reporting the user ID and account of the local user. This method is optional. To join a channel with a user account, you can choose either of the following ways:
-   *  Call registerLocalUserAccount to create a user account, and then call joinChannelWithUserAccount to join the channel.
-   *  Call the joinChannelWithUserAccount method to join the channel. The difference between the two ways is that the time elapsed between calling the registerLocalUserAccount method and joining the channel is shorter than directly calling joinChannelWithUserAccount.
-   *  Ensure that you set the userAccount parameter; otherwise, this method does not take effect.
+   * Once registered, the user account can be used to identify the local user when the user joins the channel. After the registration is successful, the user account can identify the identity of the local user, and the user can use it to join the channel. This method is optional. If you want to join a channel using a user account, you can choose one of the following methods:
+   *  Call the registerLocalUserAccount method to register a user account, and then call the joinChannelWithUserAccount method to join a channel, which can shorten the time it takes to enter the channel.
+   *  Call the joinChannelWithUserAccount method to join a channel.
    *  Ensure that the userAccount is unique in the channel.
    *  To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type.
    *
@@ -6138,7 +6152,6 @@ export abstract class IRtcEngine {
    *  All lowercase English letters: a to z.
    *  All uppercase English letters: A to Z.
    *  All numeric characters: 0 to 9.
-   *  Space
    *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    * @param userAccount The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as null. Supported characters are as follows(89 in total):
    *  The 26 lowercase English letters: a to z.
@@ -6178,7 +6191,6 @@ export abstract class IRtcEngine {
    *  All lowercase English letters: a to z.
    *  All uppercase English letters: A to Z.
    *  All numeric characters: 0 to 9.
-   *  Space
    *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    * @param userAccount The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as null. Supported characters are as follows(89 in total):
    *  The 26 lowercase English letters: a to z.
@@ -6202,7 +6214,7 @@ export abstract class IRtcEngine {
   /**
    * Gets the user information by passing in the user account.
    *
-   * After a remote user joins the channel, the SDK gets the user ID and account of the remote user, caches them in a mapping table object, and triggers the onUserInfoUpdated callback on the local client. After receiving the callback, you can call this method to get the user account of the remote user from the UserInfo object by passing in the user ID.
+   * After a remote user joins the channel, the SDK gets the UID and user account of the remote user, caches them in a mapping table object, and triggers the onUserInfoUpdated callback on the local client. After receiving the callback, you can call this method and pass in the user account to get the UID of the remote user from the UserInfo object.
    *
    * @param userAccount The user account.
    *
@@ -6215,7 +6227,7 @@ export abstract class IRtcEngine {
   /**
    * Gets the user information by passing in the user ID.
    *
-   * After a remote user joins the channel, the SDK gets the user ID and account of the remote user, caches them in a mapping table object, and triggers the onUserInfoUpdated callback on the local client. After receiving the callback, you can call this method to get the user account of the remote user from the UserInfo object by passing in the user ID.
+   * After a remote user joins the channel, the SDK gets the UID and user account of the remote user, caches them in a mapping table object, and triggers the onUserInfoUpdated callback on the local client. After receiving the callback, you can call this method and passi in the UID.to get the user account of the specified user from the UserInfo object.
    *
    * @param uid The user ID.
    *
@@ -6310,7 +6322,7 @@ export abstract class IRtcEngine {
   /**
    * Starts pushing media streams to the CDN directly.
    *
-   * Aogra does not support pushing media streams to one URL repeatedly. Media options Agora does not support setting the value of publishCameraTrack and publishCustomVideoTrack as true, or the value of publishMicrophoneTrack and publishCustomAudioTrack as true at the same time. When choosing media setting options (DirectCdnStreamingMediaOptions), you can refer to the following examples: If you want to push audio and video streams published by the host to the CDN, the media setting options should be set as follows: publishCustomAudioTrack is set as true and call the pushAudioFrame method publishCustomVideoTrack is set as true and call the pushVideoFrame method publishCameraTrack is set as false (the default value) publishMicrophoneTrack is set as false (the default value) As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in DirectCdnStreamingMediaOptions as true and call pushAudioFrame to push audio streams. Agora only supports pushing one audio and video streams or one audio streams to CDN.
+   * Aogra does not support pushing media streams to one URL repeatedly. Media options Agora does not support setting the value of publishCameraTrack and publishCustomVideoTrack as true, or the value of publishMicrophoneTrack and publishCustomAudioTrack as true at the same time. When choosing media setting options (DirectCdnStreamingMediaOptions), you can refer to the following examples: If you want to push audio and video streams captured by the host from a custom source, the media setting options should be set as follows: publishCustomAudioTrack is set as true and call the pushAudioFrame method publishCustomVideoTrack is set as true and call the pushVideoFrame method publishCameraTrack is set as false (the default value) publishMicrophoneTrack is set as false (the default value) As of v4.2.0, Agora SDK supports audio-only live streaming. You can set publishCustomAudioTrack or publishMicrophoneTrack in DirectCdnStreamingMediaOptions as true and call pushAudioFrame to push audio streams. Agora only supports pushing one audio and video streams or one audio streams to CDN.
    *
    * @param eventHandler See onDirectCdnStreamingStateChanged and onDirectCdnStreamingStats.
    * @param publishUrl The CDN live streaming URL.
@@ -6737,7 +6749,6 @@ export abstract class IRtcEngine {
    *  All lowercase English letters: a to z.
    *  All uppercase English letters: A to Z.
    *  All numeric characters: 0 to 9.
-   *  Space
    *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    * @param uid The user ID of the remote user.
    */

package/ts/Private/IAgoraRtcEngineEx.ts

@@ -5,6 +5,7 @@ import {
   DataStreamConfig,
   EncryptionConfig,
   LiveTranscoding,
+  SimulcastConfig,
   SimulcastStreamConfig,
   SimulcastStreamMode,
   SpatialAudioParams,
@@ -77,9 +78,9 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Sets channel options and leaves the channel.
    *
-   * This method lets the user leave the channel, for example, by hanging up or exiting the call. After calling joinChannelEx to join the channel, this method must be called to end the call before starting the next call. This method can be called whether or not a call is currently in progress. This method releases all resources related to the session. This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the onLeaveChannel callback. After actually leaving the channel, the local user triggers the onLeaveChannel callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the onUserOffline callback.
-   *  If you call release immediately after calling this method, the SDK does not trigger the onLeaveChannel callback.
-   *  If you want to leave the channels that you joined by calling joinChannel and joinChannelEx, call the leaveChannel method.
+   * After calling this method, the SDK terminates the audio and video interaction, leaves the current channel, and releases all resources related to the session. After calling joinChannelEx to join a channel, you must call this method to end the call, otherwise, the next call cannot be started.
+   *  This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.
+   *  If you call leaveChannel, you will leave all the channels you have joined by calling joinChannel or joinChannelEx.
    *
    * @param connection The connection information. See RtcConnection.
    * @param options The options for leaving the channel. See LeaveChannelOptions. This parameter only supports the stopMicrophoneRecording member in the LeaveChannelOptions settings; setting other members does not take effect.
@@ -259,9 +260,9 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Stops or resumes subscribing to the video streams of all remote users.
    *
-   * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.
+   * After successfully calling this method, the local user stops or resumes subscribing to the video streams of all remote users, including all subsequent users.
    *
-   * @param mute Whether to stop subscribing to the video streams of all remote users. true : Stop subscribing to the video streams of all remote users. false : (Default) Subscribe to the audio streams of all remote users by default.
+   * @param mute Whether to stop subscribing to the video streams of all remote users. true : Stop subscribing to the video streams of all remote users. false : (Default) Subscribe to the video streams of all remote users by default.
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
@@ -507,8 +508,6 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Gets the current connection state of the SDK.
    *
-   * You can call this method either before or after joining a channel.
-   *
    * @param connection The connection information. See RtcConnection.
    *
    * @returns
@@ -538,8 +537,6 @@ export abstract class IRtcEngineEx extends IRtcEngine {
   /**
    * Creates a data stream.
    *
-   * Creates a data stream. Each user can create up to five data streams in a single channel.
-   *
    * @param config The configurations for the data stream. See DataStreamConfig.
    * @param connection The connection information. See RtcConnection.
    *
@@ -855,6 +852,14 @@ export abstract class IRtcEngineEx extends IRtcEngine {
     connection: RtcConnection
   ): number;
 
+  /**
+   * @ignore
+   */
+  abstract setSimulcastConfigEx(
+    simulcastConfig: SimulcastConfig,
+    connection: RtcConnection
+  ): number;
+
   /**
    * @ignore
    */