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

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.
@@ -1651,13 +1696,13 @@ export interface IRtcEngineEventHandler {
   /**
    * Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) leaves the channel.
    *
-   * There are two reasons for users to become offline:
-   *  Leave the channel: When a user/host leaves the channel, the user/host sends a goodbye message. When this message is received, the SDK determines that the user/host leaves the channel.
-   *  Drop offline: When no data packet of the user or host is received for a certain period of time (20 seconds for the communication profile, and more for the live broadcast profile), the SDK assumes that the user/host drops offline. A poor network connection may lead to false detections. It's recommended to use the Agora RTM SDK for reliable offline detection.
+   * There are generally two reasons for users to become offline:
+   *  Leave the channel: When a user/host leaves the channel, the user/host sends a goodbye message.
+   *  Drop offline: When no data packet of the user or host is received for a certain period of time (20 seconds for the communication profile, and more for the live broadcast profile), the SDK assumes that the user/host drops offline. A poor network connection may lead to false detections. It is recommended to use the Agora RTM SDK for reliable offline detection.
    *
    * @param connection The connection information. See RtcConnection.
    * @param remoteUid The ID of the user who leaves the channel or goes offline.
-   * @param reason Reasons why the user goes offline: UserOfflineReasonType.
+   * @param reason Reasons why a remote user (in the communication profile) or host (in the live streaming profile) goes offline. See UserOfflineReasonType.
    */
   onUserOffline?(
     connection: RtcConnection,
@@ -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.
@@ -1833,7 +1878,12 @@ export interface IRtcEngineEventHandler {
   ): void;
 
   /**
-   * @ignore
+   * Occurs when the state of virtual metronome changes.
+   *
+   * When the state of the virtual metronome changes, the SDK triggers this callback to report the current state of the virtual metronome. This callback indicates the state of the local audio stream and enables you to troubleshoot issues when audio exceptions occur.
+   *
+   * @param state For the current virtual metronome status, see RhythmPlayerStateType.
+   * @param errorCode For the error codes and error messages related to virtual metronome errors, see RhythmPlayerReason.
    */
   onRhythmPlayerStateChanged?(
     state: RhythmPlayerStateType,
@@ -2076,9 +2126,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 +2141,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 +2511,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 +2715,10 @@ export enum MaxMetadataSizeType {
  * Media metadata.
  */
 export class Metadata {
+  /**
+   * The channel name.
+   */
+  channelId?: string;
   /**
    * The user ID.
    *  For the recipient: The ID of the remote user who sent the Metadata.
@@ -2704,11 +2730,11 @@ export class Metadata {
    */
   size?: number;
   /**
-   * The buffer address of the sent or received Metadata.
+   * The buffer address of the received Metadata.
    */
   buffer?: Uint8Array;
   /**
-   * The timestamp (ms) of Metadata.
+   * The timestamp (ms) of when the Metadata is sent.
    */
   timeStampMs?: number;
 }
@@ -2902,8 +2928,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 +2992,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 +3046,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.
@@ -3032,11 +3054,11 @@ export abstract class 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 joinChannel(
@@ -3054,17 +3076,16 @@ export abstract class 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 updateChannelMediaOptions(options: ChannelMediaOptions): number;
 
   /**
    * 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 +3116,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 +3129,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
@@ -3138,9 +3153,6 @@ export abstract class IRtcEngine {
    * Starts an audio device loopback test.
    *
    * To test whether the user's local sending and receiving streams are normal, you can call this method to perform an audio and video call loop test, which tests whether the audio and video devices and the user's upstream and downstream networks are working properly. After starting the test, the user needs to make a sound or face the camera. The audio or video is output after about two seconds. If the audio playback is normal, the audio device and the user's upstream and downstream networks are working properly; if the video playback is normal, the video device and the user's upstream and downstream networks are working properly.
-   *  You can call this method either before or after joining a channel. When calling in a channel, make sure that no audio or video stream is being published.
-   *  After calling this method, call stopEchoTest to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
-   *  In live streaming scenarios, this method only applies to hosts.
    *
    * @param config The configuration of the audio and video call loop test. See EchoTestConfiguration.
    *
@@ -3153,6 +3165,8 @@ export abstract class IRtcEngine {
   /**
    * Stops the audio call test.
    *
+   * After calling startEchoTest, you must call this method to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
+   *
    * @returns
    * 0: Success.
    *  < 0: Failure.
@@ -3217,9 +3231,7 @@ export abstract class IRtcEngine {
   /**
    * Starts the last mile network probe test.
    *
-   * This method starts the last-mile network probe test before joining a channel to get the uplink and downlink last mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT). Once this method is enabled, the SDK returns the following callbacks: onLastmileQuality : The SDK triggers this callback within two seconds depending on the network conditions. This callback rates the network conditions and is more closely linked to the user experience. onLastmileProbeResult : The SDK triggers this callback within 30 seconds depending on the network conditions. This callback returns the real-time statistics of the network conditions and is more objective. This method must be called before joining the channel, and is used to judge and predict whether the current uplink network quality is good enough.
-   *  Do not call other methods before receiving the onLastmileQuality and onLastmileProbeResult callbacks. Otherwise, the callbacks may be interrupted.
-   *  A host should not call this method after joining a channel (when in a call).
+   * This method starts the last-mile network probe test before joining a channel to get the uplink and downlink last mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT).
    *
    * @param config The configurations of the last-mile network probe test. See LastmileProbeConfig.
    *
@@ -3257,9 +3269,6 @@ export abstract class IRtcEngine {
    * Sets the image enhancement options.
    *
    * Enables or disables image enhancement, and sets the options.
-   *  Call this method after calling enableVideo or startPreview.
-   *  This method relies on the image enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
-   *  This feature has high requirements on device performance. When calling this method, the SDK automatically checks the capabilities of the current device.
    *
    * @param enabled Whether to enable the image enhancement function: true : Enable the image enhancement function. false : (Default) Disable the image enhancement function.
    * @param options The image enhancement options. See BeautyOptions.
@@ -3277,6 +3286,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.
    *
@@ -3400,9 +3441,7 @@ export abstract class IRtcEngine {
   /**
    * Initializes the local video view.
    *
-   * This method initializes the video view of a local stream on the local device. It affects only the video view that the local user sees, not the published local video stream. Call this method to bind the local video stream to a video view (view) and to set the rendering and mirror modes of the video view. After initialization, call this method to set the local video and then join the channel. The local video still binds to the view after you leave the channel. To unbind the local video from the view, set the view parameter as null. In real-time interactive scenarios, if you need to simultaneously view multiple preview frames in the local video preview, and each frame is at a different observation position along the video link, you can repeatedly call this method to set different view s and set different observation positions for each view. For example, by setting the video source to the camera and then configuring two view s with position setting to PositionPostCapturerOrigin and PositionPostCapturer, you can simultaneously preview the raw, unprocessed video frame and the video frame that has undergone preprocessing (image enhancement effects, virtual background, watermark) in the local video preview.
-   *  You can call this method either before or after joining a channel.
-   *  If you want to stop rendering the view, set view to null and then call this method again to stop rendering and clear the rendering cache.
+   * This method initializes the video view of a local stream on the local device. It only affects the video seen by the local user and does not impact the publishing of the local video. Call this method to bind the local video stream to a video view (view) and to set the rendering and mirror modes of the video view. The binding remains valid after leaving the channel. To stop rendering or unbind the local video from the view, set view as null.
    *
    * @param canvas The local video view and settings. See VideoCanvas.
    *
@@ -3415,9 +3454,9 @@ export abstract class IRtcEngine {
   /**
    * Sets video application scenarios.
    *
-   * After successfully calling this method, the SDK will automatically enable the best practice strategies and adjust key performance metrics based on the specified scenario, to optimize the video experience. Ensure that you call this method before joining a channel.
+   * After successfully calling this method, the SDK will automatically enable the best practice strategies and adjust key performance metrics based on the specified scenario, to optimize the video experience. Call this method before joining a channel.
    *
-   * @param scenarioType The type of video application scenario. See VideoApplicationScenarioType. If set to ApplicationScenarioMeeting (1), the SDK automatically enables the following strategies:
+   * @param scenarioType The type of video application scenario. See VideoApplicationScenarioType. 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.
@@ -3430,7 +3469,7 @@ export abstract class IRtcEngine {
    *  If someone subscribes to the low-quality stream, the SDK enables the low-quality stream and resets it to the SimulcastStreamConfig configuration used in the most recent calling of setDualStreamMode. If no configuration has been set by the user previously, the following values are used:
    *  Resolution: 480 × 272
    *  Frame rate: 15 fps
-   *  Bitrate: 500 Kbps
+   *  Bitrate: 500 Kbps (2) is suitable for 1v1 video call scenarios. If set to (2), the SDK optimizes performance to achieve low latency and high video quality, enhancing image quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under poor network conditions.
    *
    * @returns
    * 0: Success.
@@ -3533,11 +3572,6 @@ export abstract class IRtcEngine {
    */
   abstract muteAllRemoteAudioStreams(mute: boolean): number;
 
-  /**
-   * @ignore
-   */
-  abstract setDefaultMuteAllRemoteAudioStreams(mute: boolean): number;
-
   /**
    * Stops or resumes subscribing to the audio stream of a specified user.
    *
@@ -3581,9 +3615,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.
@@ -3591,17 +3625,10 @@ export abstract class IRtcEngine {
    */
   abstract muteAllRemoteVideoStreams(mute: boolean): number;
 
-  /**
-   * @ignore
-   */
-  abstract setDefaultMuteAllRemoteVideoStreams(mute: boolean): number;
-
   /**
    * Sets the default video stream type to subscribe to.
    *
    * The SDK will dynamically adjust the size of the corresponding video stream based on the size of the video window to save bandwidth and computing resources. The default aspect ratio of the low-quality video stream is the same as that of the high-quality video stream. According to the current aspect ratio of the high-quality video stream, the system will automatically allocate the resolution, frame rate, and bitrate of the low-quality video stream. The SDK defaults to enabling low-quality video stream adaptive mode (AutoSimulcastStream) on the sending end, which means the sender does not actively send low-quality video stream. The receiver with the role of the host can initiate a low-quality video stream request by calling this method, and upon receiving the request, the sending end automatically starts sending the low-quality video stream.
-   *  Call this method before joining a channel. The SDK does not support changing the default subscribed video stream type after joining a channel.
-   *  If you call both this method and setRemoteVideoStreamType, the setting of setRemoteVideoStreamType takes effect.
    *
    * @param streamType The default video-stream type. See VideoStreamType.
    *
@@ -3630,7 +3657,7 @@ export abstract class IRtcEngine {
    *  You can call this method either before or after joining a channel.
    *  If the publisher has already called setDualStreamMode and set mode to DisableSimulcastStream (never send low-quality video stream), calling this method will not take effect, you should call setDualStreamMode again on the sending end and adjust the settings.
    *  Calling this method on the receiving end of the audience role will not take effect.
-   *  If you call both setRemoteVideoStreamType and setRemoteDefaultVideoStreamType, the settings in setRemoteVideoStreamType take effect.
+   *  If you call both this method and setRemoteDefaultVideoStreamType, the setting of this method takes effect.
    *
    * @param uid The user ID.
    * @param streamType The video stream type, see VideoStreamType.
@@ -3776,9 +3803,9 @@ export abstract class IRtcEngine {
   /**
    * Starts audio recording on the client and sets recording configurations.
    *
-   * The Agora SDK allows recording during a call. After successfully calling this method, you can record the audio of users in the channel and get an audio recording file. Supported formats of the recording file are as follows:
+   * The Agora SDK allows recording during a call. After successfully calling this method, you can record the audio of users in the channel and get an audio recording file. Supported formats of audio files are as follows:
    *  WAV: High-fidelity files with typically larger file sizes. For example, if the sample rate is 32,000 Hz, the file size for 10-minute recording is approximately 73 MB.
-   *  AAC: Low-fidelity files with typically smaller file sizes. For example, if the sample rate is 32,000 Hz and the recording quality is AudioRecordingQualityMedium, the file size for 10-minute recording is approximately 2 MB. Once the user leaves the channel, the recording automatically stops. Call this method after joining a channel.
+   *  AAC: Low-fidelity files with typically smaller file sizes. For example, if the sample rate is 32,000 Hz and the recording quality is AudioRecordingQualityMedium, the file size for 10-minute recording is approximately 2 MB. Once the user leaves the channel, the recording automatically stops.
    *
    * @param config Recording configurations. See AudioRecordingConfiguration.
    *
@@ -3812,10 +3839,12 @@ export abstract class IRtcEngine {
   abstract stopAudioRecording(): number;
 
   /**
-   * Creates a media player instance.
+   * Creates a media player object.
+   *
+   * Before calling any APIs in the IMediaPlayer class, you need to call this method to create an instance of the media player.
    *
    * @returns
-   * The IMediaPlayer instance, if the method call succeeds.
+   * An IMediaPlayer object, if the method call succeeds.
    *  An empty pointer, if the method call fails.
    */
   abstract createMediaPlayer(): IMediaPlayer;
@@ -3844,17 +3873,14 @@ export abstract class IRtcEngine {
   /**
    * Starts playing the music file.
    *
-   * This method mixes the specified local or online audio file with the audio from the microphone, or replaces the microphone's audio with the specified local or remote audio file. A successful method call triggers the onAudioMixingStateChanged (AudioMixingStatePlaying) callback. When the audio mixing file playback finishes, the SDK triggers the onAudioMixingStateChanged (AudioMixingStateStopped) callback on the local client.
-   *  You can call this method either before or after joining a channel. If you need to call startAudioMixing multiple times, ensure that the time interval between calling this method is more than 500 ms.
-   *  If the local music file does not exist, the SDK does not support the file format, or the the SDK cannot access the music file URL, the SDK reports 701.
-   *  For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
+   * For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support. If the local music file does not exist, the SDK does not support the file format, or the the SDK cannot access the music file URL, the SDK reports AudioMixingReasonCanNotOpen.
    *
    * @param filePath File path:
    *  Windows: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example : C:\music\audio.mp4.
    *  macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example: /var/mobile/Containers/Data/audio.mp4.
    * @param loopback Whether to only play music files on the local client: true : Only play music files on the local client so that only the local user can hear the music. false : Publish music files to remote clients so that both the local user and remote users can hear the music.
    * @param cycle The number of times the music file plays.
-   *  ≥ 0: The number of playback times. For example, 0 means that the SDK does not play the music file while 1 means that the SDK plays once.
+   *  >0: The number of times for playback. For example, 1 represents playing 1 time.
    *  -1: Play the audio file in an infinite loop.
    * @param startPos The playback position (ms) of the music file.
    *
@@ -3876,9 +3902,9 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Stops playing and mixing the music file.
+   * Stops playing the music file.
    *
-   * This method stops the audio mixing. Call this method when you are in a channel.
+   * After calling startAudioMixing to play a music file, you can call this method to stop the playing. If you only need to pause the playback, call pauseAudioMixing.
    *
    * @returns
    * 0: Success.
@@ -3889,7 +3915,7 @@ export abstract class IRtcEngine {
   /**
    * Pauses playing and mixing the music file.
    *
-   * Call this method after joining a channel.
+   * After calling startAudioMixing to play a music file, you can call this method to pause the playing. If you need to stop the playback, call stopAudioMixing.
    *
    * @returns
    * 0: Success.
@@ -3900,7 +3926,7 @@ export abstract class IRtcEngine {
   /**
    * Resumes playing and mixing the music file.
    *
-   * This method resumes playing and mixing the music file. Call this method when you are in a channel.
+   * After calling pauseAudioMixing to pause the playback, you can call this method to resume the playback.
    *
    * @returns
    * 0: Success.
@@ -3915,7 +3941,7 @@ export abstract class IRtcEngine {
    *  For the supported formats of audio files, see.
    *  You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged (AudioMixingStatePlaying) callback.
    *
-   * @param index The audio track you want to specify. The value range is [0, getAudioTrackCount ()].
+   * @param index The audio track you want to specify. The value should be greater than 0 and less than that of returned by getAudioTrackCount.
    *
    * @returns
    * 0: Success.
@@ -4050,7 +4076,7 @@ export abstract class IRtcEngine {
   /**
    * Sets the pitch of the local music file.
    *
-   * When a local music file is mixed with a local human voice, call this method to set the pitch of the local music file only. You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged (AudioMixingStatePlaying) callback.
+   * When a local music file is mixed with a local human voice, call this method to set the pitch of the local music file only.
    *
    * @param pitch Sets the pitch of the local music file by the chromatic scale. The default value is 0, which means keeping the original pitch. The value ranges from -12 to 12, and the pitch value between consecutive values is a chromatic value. The greater the absolute value of this parameter, the higher or lower the pitch of the local music file.
    *
@@ -4103,7 +4129,7 @@ export abstract class IRtcEngine {
   /**
    * Preloads a specified audio effect file into the memory.
    *
-   * To ensure smooth communication, It is recommended that you limit the size of the audio effect file. You can call this method to preload the audio effect before calling joinChannel. For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
+   * Ensure the size of all preloaded files does not exceed the limit. For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
    *
    * @param soundId The audio effect ID. The ID of each audio effect file is unique.
    * @param filePath File path:
@@ -4124,10 +4150,10 @@ export abstract class IRtcEngine {
   /**
    * Plays the specified local or online audio effect file.
    *
-   * If you use this method to play an online audio effect file, Agora recommends that you cache the online audio effect file to your local device, call preloadEffect to preload the cached audio effect file into memory, and then call this method to play the audio effect. Otherwise, you might encounter playback failures or no sound during playback due to loading timeouts or failures. To play multiple audio effect files at the same time, call this method multiple times with different soundId and filePath. To achieve the optimal user experience, Agora recommends that do not playing more than three audio files at the same time. After the playback of an audio effect file completes, the SDK triggers the onAudioEffectFinished callback.
+   * To play multiple audio effect files at the same time, call this method multiple times with different soundId and filePath. To achieve the optimal user experience, Agora recommends that you do not playing more than three audio files at the same time.
    *
    * @param soundId The audio effect ID. The ID of each audio effect file is unique. If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of soundId in preloadEffect.
-   * @param filePath The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example, C:\music\audio.mp4. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. See supported audio formats. If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of filePath in preloadEffect.
+   * @param filePath The file path. The SDK supports URLs and absolute path of local files. The absolute path needs to be accurate to the file name and extension. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of filePath in preloadEffect.
    * @param loopCount The number of times the audio effect loops.
    *  ≥ 0: The number of playback times. For example, 1 means looping one time, which means playing the audio effect two times in total.
    *  -1: Play the audio file in an infinite loop.
@@ -4241,6 +4267,8 @@ export abstract class IRtcEngine {
   /**
    * Resumes playing all audio effect files.
    *
+   * After you call pauseAllEffects to pause the playback, you can call this method to resume the playback.
+   *
    * @returns
    * 0: Success.
    *  < 0: Failure.
@@ -4250,6 +4278,8 @@ export abstract class IRtcEngine {
   /**
    * Stops playing a specified audio effect.
    *
+   * When you no longer need to play the audio effect, you can call this method to stop the playback. If you only need to pause the playback, call pauseEffect.
+   *
    * @param soundId The ID of the audio effect. Each audio effect has a unique ID.
    *
    * @returns
@@ -4261,6 +4291,8 @@ export abstract class IRtcEngine {
   /**
    * Stops playing all audio effects.
    *
+   * When you no longer need to play the audio effect, you can call this method to stop the playback. If you only need to pause the playback, call pauseAllEffects.
+   *
    * @returns
    * 0: Success.
    *  < 0: Failure.
@@ -4399,14 +4431,7 @@ export abstract class IRtcEngine {
   /**
    * Sets a preset voice beautifier effect.
    *
-   * Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting a voice beautifier effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios. To achieve better vocal effects, it is recommended that you call the following APIs before calling this method:
-   *  Call setAudioScenario to set the audio scenario to high-quality audio scenario, namely AudioScenarioGameStreaming (3).
-   *  Call setAudioProfile to set the profile parameter to AudioProfileMusicHighQuality (4) or AudioProfileMusicHighQualityStereo (5).
-   *  You can call this method either before or after joining a channel.
-   *  Do not set the profile parameter in setAudioProfile to AudioProfileSpeechStandard (1) or AudioProfileIot (6), or the method does not take effect.
-   *  This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
-   *  After calling setVoiceBeautifierPreset, Agora does not recommend calling the following methods, otherwise the effect set by setVoiceBeautifierPreset will be overwritten: setAudioEffectPreset setAudioEffectParameters setLocalVoicePitch setLocalVoiceEqualization setLocalVoiceReverb setVoiceBeautifierParameters setVoiceConversionPreset
-   *  This method relies on the voice beautifier dynamic library libagora_audio_beauty_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
+   * Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting a voice beautifier effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios.
    *
    * @param preset The preset voice beautifier effect options: VoiceBeautifierPreset.
    *
@@ -4468,6 +4493,7 @@ export abstract class IRtcEngine {
    *  You can call this method either before or after joining a channel.
    *  This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
    *  After calling setAudioEffectParameters, Agora does not recommend you to call the following methods, otherwise the effect set by setAudioEffectParameters will be overwritten: setAudioEffectPreset setVoiceBeautifierPreset setLocalVoicePitch setLocalVoiceEqualization setLocalVoiceReverb setVoiceBeautifierParameters setVoiceConversionPreset
+   *  This method relies on the voice beautifier dynamic library libagora_audio_beauty_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
    *
    * @param preset The options for SDK preset audio effects: RoomAcoustics3dVoice, 3D voice effect:
    *  You need to set the profile parameter in setAudioProfile to AudioProfileMusicStandardStereo (3) or AudioProfileMusicHighQualityStereo (5) before setting this enumerator; otherwise, the enumerator setting does not take effect.
@@ -4497,6 +4523,7 @@ export abstract class IRtcEngine {
    *  You can call this method either before or after joining a channel.
    *  This method has the best effect on human voice processing, and Agora does not recommend calling this method to process audio data containing music.
    *  After calling setVoiceBeautifierParameters, Agora does not recommend calling the following methods, otherwise the effect set by setVoiceBeautifierParameters will be overwritten: setAudioEffectPreset setAudioEffectParameters setVoiceBeautifierPreset setLocalVoicePitch setLocalVoiceEqualization setLocalVoiceReverb setVoiceConversionPreset
+   *  This method relies on the voice beautifier dynamic library libagora_audio_beauty_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
    *
    * @param preset The option for the preset audio effect: SINGING_BEAUTIFIER : The singing beautifier effect.
    * @param param1 The gender characteristics options for the singing voice: 1 : A male-sounding voice. 2 : A female-sounding voice.
@@ -4610,10 +4637,15 @@ export abstract class IRtcEngine {
    */
   abstract setHeadphoneEQParameters(lowGain: number, highGain: number): number;
 
+  /**
+   * @ignore
+   */
+  abstract enableVoiceAITuner(enabled: boolean, type: VoiceAiTunerType): number;
+
   /**
    * Sets the log file.
    *
-   * Deprecated: Use the mLogConfig parameter in initialize method instead. Specifies an SDK output log file. The log file records all log data for the SDK’s operation. Ensure that the directory for the log file exists and is writable. Ensure that you call initialize immediately after calling the IRtcEngine method, or the output log may not be complete.
+   * Deprecated: This method is deprecated. Use the logConfig parameter in RtcEngineContext to set the log file path. Specifies an SDK output log file. The log file records all log data for the SDK’s operation. Ensure that the directory for the log file exists and is writable. Ensure that you call initialize immediately after calling the IRtcEngine method, or the output log may not be complete.
    *
    * @param filePath The complete path of the log files. These log files are encoded in UTF-8.
    *
@@ -4686,10 +4718,7 @@ export abstract class IRtcEngine {
   /**
    * Updates the display mode of the local video view.
    *
-   * After initializing the local video view, you can call this method to update its rendering and mirror modes. It affects only the video view that the local user sees, not the published local video stream.
-   *  Ensure that you have called the setupLocalVideo method to initialize the local video view before calling this method.
-   *  During a call, you can call this method as many times as necessary to update the display mode of the local video view.
-   *  This method only takes effect on the primary camera (PrimaryCameraSource). In scenarios involving custom video capture or the use of alternative video sources, you need to use setupLocalVideo instead of this method.
+   * After initializing the local video view, you can call this method to update its rendering and mirror modes. It affects only the video view that the local user sees and does not impact the publishing of the local video.
    *
    * @param renderMode The local video display mode. See RenderModeType.
    * @param mirrorMode The mirror mode of the local video view. See VideoMirrorModeType. If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.
@@ -4781,6 +4810,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.
    *
@@ -4801,16 +4835,14 @@ export abstract class IRtcEngine {
   /**
    * Sets the format of the captured raw audio data.
    *
-   * Sets the audio format for the onRecordAudioFrame callback.
-   *  Ensure that you call this method before joining a channel.
-   *  The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method. Sample interval (sec) = samplePerCall /(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s).
+   * The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method. Sample interval (sec) = samplePerCall /(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onRecordAudioFrame callback according to the sampling interval.
    *
-   * @param sampleRate The sample rate returned in the SDK, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
-   * @param channel The number of channels returned by the SDK. You can set the value as 1 or 2:
+   * @param sampleRate The sample rate returned in the callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
+   * @param channel The number of audio channels. You can set the value as 1 or 2.
    *  1: Mono.
    *  2: Stereo.
    * @param mode The use mode of the audio frame. See RawAudioFrameOpModeType.
-   * @param samplesPerCall The number of data samples returned in the SDK, such as 1024 for the Media Push.
+   * @param samplesPerCall The number of data samples, such as 1024 for the Media Push.
    *
    * @returns
    * 0: Success.
@@ -4824,18 +4856,16 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Sets the audio data format for playback.
+   * Sets the format of the raw audio playback data.
    *
-   * Sets the data format for the onPlaybackAudioFrame callback.
-   *  Ensure that you call this method before joining a channel.
-   *  The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method. Sample interval (sec) = samplePerCall /(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onPlaybackAudioFrame callback according to the sampling interval.
+   * The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method. Sample interval (sec) = samplePerCall /(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onPlaybackAudioFrame callback according to the sampling interval.
    *
-   * @param sampleRate The sample rate returned in the onPlaybackAudioFrame callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
-   * @param channel The number of channels returned in the onPlaybackAudioFrame callback:
+   * @param sampleRate The sample rate returned in the callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
+   * @param channel The number of audio channels. You can set the value as 1 or 2.
    *  1: Mono.
    *  2: Stereo.
    * @param mode The use mode of the audio frame. See RawAudioFrameOpModeType.
-   * @param samplesPerCall The number of data samples returned in the onPlaybackAudioFrame callback, such as 1024 for the Media Push.
+   * @param samplesPerCall The number of data samples, such as 1024 for the Media Push.
    *
    * @returns
    * 0: Success.
@@ -4849,11 +4879,15 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Sets the audio data format reported by onMixedAudioFrame.
+   * Set the format of the raw audio data after mixing for audio capture and playback.
    *
-   * @param sampleRate The sample rate (Hz) of the audio data, which can be set as 8000, 16000, 32000, 44100, or 48000.
-   * @param channel The number of channels of the audio data, which can be set as 1(Mono) or 2(Stereo).
-   * @param samplesPerCall Sets the number of samples. In Media Push scenarios, set it as 1024.
+   * The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method. Sample interval (sec) = samplePerCall /(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onMixedAudioFrame callback according to the sampling interval.
+   *
+   * @param sampleRate The sample rate returned in the callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
+   * @param channel The number of audio channels. You can set the value as 1 or 2.
+   *  1: Mono.
+   *  2: Stereo.
+   * @param samplesPerCall The number of data samples, such as 1024 for the Media Push.
    *
    * @returns
    * 0: Success.
@@ -4891,10 +4925,14 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Sets the audio data format reported by onPlaybackAudioFrameBeforeMixing.
+   * Sets the format of the raw audio playback data before mixing.
    *
-   * @param sampleRate The sample rate (Hz) of the audio data, which can be set as 8000, 16000, 32000, 44100, or 48000.
-   * @param channel The number of channels of the audio data, which can be set as 1 (Mono) or 2 (Stereo).
+   * The SDK triggers the onPlaybackAudioFrameBeforeMixing callback according to the sampling interval.
+   *
+   * @param sampleRate The sample rate returned in the callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
+   * @param channel The number of audio channels. You can set the value as 1 or 2.
+   *  1: Mono.
+   *  2: Stereo.
    *
    * @returns
    * 0: Success.
@@ -4976,7 +5014,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 +5195,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 +5292,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 +5495,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 +5593,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.
@@ -5611,13 +5651,7 @@ export abstract class IRtcEngine {
   abstract stopScreenCapture(): number;
 
   /**
-   * Retrieves the call ID.
-   *
-   * 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. Call this method after joining a channel.
-   *
-   * @returns
-   * The current call ID, if the method succeeds.
-   *  An empty string, if the method call fails.
+   * @ignore
    */
   abstract getCallId(): string;
 
@@ -5826,8 +5860,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,45 +5899,10 @@ 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.
    *
-   * In scenarios requiring high security, Agora recommends calling this method to enable the built-in encryption before joining a channel. 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. If you enable the built-in encryption, you cannot use the Media Push function.
+   * 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 enabled Whether to enable built-in encryption: true : Enable the built-in encryption. false : (Default) Disable the built-in encryption.
    * @param config Built-in encryption configurations. See EncryptionConfig.
@@ -5922,8 +5919,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
@@ -5935,10 +5930,10 @@ export abstract class IRtcEngine {
   /**
    * Sends data stream messages.
    *
-   * Sends data stream messages to all users in a channel. The SDK has the following restrictions on this method:
-   *  Up to 30 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 6 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.
+   * After calling createDataStream, 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:
+   *  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. 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.
    *  Ensure that you call createDataStream to create a data channel before calling this method.
    *  In live streaming scenarios, this method only applies to hosts.
    *
@@ -6104,10 +6099,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 +6132,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.
@@ -6152,11 +6145,11 @@ export abstract class 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 joinChannelWithUserAccount(
@@ -6178,7 +6171,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 +6194,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 +6207,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.
    *
@@ -6243,7 +6235,6 @@ export abstract class 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 startOrUpdateChannelMediaRelay(
@@ -6258,6 +6249,7 @@ export abstract class IRtcEngine {
    * @returns
    * 0: Success.
    *  < 0: Failure.
+   *  -5: The method call was rejected. There is no ongoing channel media relay.
    */
   abstract stopChannelMediaRelay(): number;
 
@@ -6269,6 +6261,7 @@ export abstract class IRtcEngine {
    * @returns
    * 0: Success.
    *  < 0: Failure.
+   *  -5: The method call was rejected. There is no ongoing channel media relay.
    */
   abstract pauseAllChannelMediaRelay(): number;
 
@@ -6280,6 +6273,7 @@ export abstract class IRtcEngine {
    * @returns
    * 0: Success.
    *  < 0: Failure.
+   *  -5: The method call was rejected. There is no paused channel media relay.
    */
   abstract resumeAllChannelMediaRelay(): number;
 
@@ -6310,7 +6304,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.
@@ -6343,7 +6337,15 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * @ignore
+   * Enables the virtual metronome.
+   *
+   * In music education, physical education and other scenarios, teachers usually need to use a metronome so that students can practice with the correct beat. The meter is composed of a downbeat and upbeats. The first beat of each measure is called a downbeat, and the rest are called upbeats. In this method, you need to set the file path of the upbeat and downbeat, the number of beats per measure, the beat speed, and whether to send the sound of the metronome to remote users. After successfully calling this method, the SDK triggers the onRhythmPlayerStateChanged callback locally to report the status of the virtual metronome.
+   *  After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in AgoraRhythmPlayerConfig. For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
+   *  By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in ChannelMediaOptions as false.
+   *
+   * @param sound1 The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example, C:\music\audio.mp4. For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
+   * @param sound2 The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example, C:\music\audio.mp4. For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
+   * @param config The metronome configuration. See AgoraRhythmPlayerConfig.
    */
   abstract startRhythmPlayer(
     sound1: string,
@@ -6352,12 +6354,19 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * @ignore
+   * Disables the virtual metronome.
+   *
+   * After calling startRhythmPlayer, you can call this method to disable the virtual metronome.
    */
   abstract stopRhythmPlayer(): number;
 
   /**
-   * @ignore
+   * Configures the virtual metronome.
+   *
+   * After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning, and controls the playback duration of each file according to beatsPerMinute you set in AgoraRhythmPlayerConfig. For example, if you set beatsPerMinute as 60, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration.
+   *  By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in ChannelMediaOptions as false. After calling startRhythmPlayer, you can call this method to reconfigure the virtual metronome. After successfully calling this method, the SDK triggers the onRhythmPlayerStateChanged callback locally to report the status of the virtual metronome.
+   *
+   * @param config The metronome configuration. See AgoraRhythmPlayerConfig.
    */
   abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number;
 
@@ -6383,10 +6392,10 @@ export abstract class IRtcEngine {
   /**
    * Enables or disables video screenshot and upload.
    *
-   * 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.
+   * 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.
    *
    * @returns
    * 0: Success.
@@ -6555,9 +6564,7 @@ export abstract class IRtcEngine {
   /**
    * Enables audio and video frame instant rendering.
    *
-   * After successfully calling this method, the SDK enables the instant frame rendering mode, which can speed up the first frame rendering speed after the user joins the channel.
-   *  Once the instant rendering function is enabled, it can only be canceled by calling the release method to destroy the IRtcEngine object.
-   *  In this mode, the SDK uses Agora's custom encryption algorithm to shorten the time required to establish transmission links, and the security is reduced compared to the standard DTLS (Datagram Transport Layer Security). If the application scenario requires higher security standards, Agora recommends that you do not use this method.
+   * After successfully calling this method, the SDK enables the instant frame rendering mode, which can speed up the first frame rendering after the user joins the channel.
    *
    * @returns
    * 0: Success.
@@ -6737,7 +6744,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.
    */