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

package/ts/Private/IAgoraRtcEngine.ts

@@ -1338,8 +1338,6 @@ export interface IRtcEngineEventHandler {
   /**
    * Occurs when a user rejoins the channel.
    *
-   * When a user loses connection with the server because of network problems, the SDK automatically tries to reconnect and triggers this callback upon reconnection.
-   *
    * @param uid The ID of the user who rejoins the channel.
    * @param connection The connection information. See RtcConnection.
    * @param elapsed Time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.
@@ -1678,10 +1676,7 @@ export interface IRtcEngineEventHandler {
    * Occurs when a remote user (in the communication profile)/ host (in the live streaming profile) joins the channel.
    *
    * In a communication channel, this callback indicates that a remote user joins the channel. The SDK also triggers this callback to report the existing users in the channel when a user joins the channel.
-   *  In a live-broadcast channel, this callback indicates that a host joins the channel. The SDK also triggers this callback to report the existing hosts in the channel when a host joins the channel. Agora recommends limiting the number of hosts to 17. The SDK triggers this callback under one of the following circumstances:
-   *  A remote user/host joins the channel.
-   *  A remote user switches the user role to the host after joining the channel.
-   *  A remote user/host rejoins the channel after a network interruption.
+   *  In a live-broadcast channel, this callback indicates that a host joins the channel. The SDK also triggers this callback to report the existing hosts in the channel when a host joins the channel. Agora recommends limiting the number of hosts to 17.
    *
    * @param connection The connection information. See RtcConnection.
    * @param remoteUid The ID of the user or host who joins the channel.
@@ -1696,13 +1691,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,
@@ -1878,7 +1873,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,
@@ -2506,7 +2506,13 @@ export interface IRtcEngineEventHandler {
   ): void;
 
   /**
-   * @ignore
+   * The event callback of the extension.
+   *
+   * To listen for events while the extension is running, you need to register this callback.
+   *
+   * @param context The context information of the extension, see ExtensionContext.
+   * @param key The key of the extension.
+   * @param value The value of the extension key.
    */
   onExtensionEventWithContext?(
     context: ExtensionContext,
@@ -2515,17 +2521,31 @@ export interface IRtcEngineEventHandler {
   ): void;
 
   /**
-   * @ignore
+   * Occurrs when the extension is enabled.
+   *
+   * The callback is triggered after the extension is successfully enabled.
+   *
+   * @param context The context information of the extension, see ExtensionContext.
    */
   onExtensionStartedWithContext?(context: ExtensionContext): void;
 
   /**
-   * @ignore
+   * Occurs when the extension is disabled.
+   *
+   * The callback is triggered after the extension is successfully disabled.
+   *
+   * @param context The context information of the extension, see ExtensionContext.
    */
   onExtensionStoppedWithContext?(context: ExtensionContext): void;
 
   /**
-   * @ignore
+   * 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 context The context information of the extension, see ExtensionContext.
+   * @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.
    */
   onExtensionErrorWithContext?(
     context: ExtensionContext,
@@ -2711,7 +2731,7 @@ export enum MaxMetadataSizeType {
  */
 export class Metadata {
   /**
-   * @ignore
+   * The channel name.
    */
   channelId?: string;
   /**
@@ -2725,11 +2745,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;
 }
@@ -3003,7 +3023,33 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * @ignore
+   * Preloads a channel with token, channelId, and userAccount.
+   *
+   * When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host. If you join a preloaded channel, leave it and want to rejoin the same channel, you do not need to call this method unless the token for preloading the channel expires. Failing to preload a channel does not mean that you can't join a channel, nor will it increase the time of joining a channel.
+   *
+   * @param token The token generated on your server for authentication. When the token for preloading channels expires, you can update the token based on the number of channels you preload.
+   *  When preloading one channel, calling this method to pass in the new token.
+   *  When preloading more than one channels:
+   *  If you use a wildcard token for all preloaded channels, call updatePreloadChannelToken to update the token. When generating a wildcard token, ensure the user ID is not set as 0.
+   *  If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.
+   * @param channelId The channel name that you want to preload. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
+   *  All lowercase English letters: a to z.
+   *  All uppercase English letters: A to Z.
+   *  All numeric characters: 0 to 9.
+   *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
+   * @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.
+   *  The 26 uppercase English letters: A to Z.
+   *  All numeric characters: 0 to 9.
+   *  Space
+   *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
+   *
+   * @returns
+   * 0: Success.
+   *  < 0: Failure.
+   *  -2: The parameter is invalid. For example, the User Account is empty. You need to pass in a valid parameter and join the channel again.
+   *  -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
+   *  -102: The channel name is invalid. You need to pass in a valid channel name and join the channel again.
    */
   abstract preloadChannelWithUserAccount(
     token: string,
@@ -3029,14 +3075,12 @@ export abstract class IRtcEngine {
   /**
    * Joins a channel with media options.
    *
-   * This method enables users to join a channel. Users in the same channel can talk to each other, and multiple users in the same channel can start a group chat. Users with different App IDs cannot call each other. A successful call of this method triggers the following callbacks:
-   *  The local client: The onJoinChannelSuccess and onConnectionStateChanged callbacks.
-   *  The remote client: onUserJoined, if the user joining the channel is in the Communication profile or is a host in the Live-broadcasting profile. When the connection between the client and Agora's server is interrupted due to poor network conditions, the SDK tries reconnecting to the server. When the local client successfully rejoins the channel, the SDK triggers the onRejoinChannelSuccess callback on the local client.
-   *  This method allows users to join only one channel at a time.
-   *  Ensure that the app ID you use to generate the token is the same app ID that you pass in the initialize method; otherwise, you may fail to join the channel by token.
-   *  If you choose the Testing Mode (using an App ID for authentication) for your project and call this method to join a channel, you will automatically exit the channel after 24 hours.
+   * This method supports setting the media options when joining a channel, such as whether to publish audio and video streams within the channel. or whether to automatically subscribe to the audio and video streams of all remote users when joining a channel. By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To stop subscribing to other streams, set the options parameter or call the corresponding mute methods.
    *
-   * @param token The token generated on your server for authentication. If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel.
+   * @param token The token generated on your server for authentication.
+   *  (Recommended) If your project has enabled the security mode (using APP ID and Token for authentication), this parameter is required.
+   *  If you have only enabled the testing mode (using APP ID for authentication), this parameter is optional. You will automatically exit the channel 24 hours after successfully joining in.
+   *  If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel.
    * @param channelId The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
    *  All lowercase English letters: a to z.
    *  All uppercase English letters: A to Z.
@@ -3049,11 +3093,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 after calling startEchoTest to start a call loop test, you call this method to join the channel without calling stopEchoTest to stop the 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(
@@ -3071,9 +3115,9 @@ 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;
 
@@ -3148,9 +3192,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.
    *
@@ -3163,6 +3204,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.
@@ -3227,9 +3270,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.
    *
@@ -3267,9 +3308,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.
@@ -3428,7 +3466,7 @@ export abstract class IRtcEngine {
    * Initializes the video view of a remote user.
    *
    * This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view. You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the onUserJoined callback. To unbind the remote user from the view, set the view parameter to NULL. Once the remote user leaves the channel, the SDK unbinds the remote user.
-   *  If you use the Agora recording function, the recording client joins the channel as a placeholder client, triggering the onUserJoined callback. Do not bind the placeholder client to the app view because the placeholder client does not send any video streams. If your app does not recognize the placeholder client, bind the remote user to the view when the SDK triggers the onFirstRemoteVideoDecoded callback.
+   *  When using the recording service, the app does not need to bind a view, as it does not send a video stream. If your app does not recognize the recording service, bind the remote user to the view when the SDK triggers the onFirstRemoteVideoDecoded callback.
    *  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.
    *
    * @param canvas The remote video view and settings. See VideoCanvas.
@@ -3442,9 +3480,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.
    *
@@ -3457,9 +3493,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. 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.
@@ -3472,7 +3508,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 ApplicationScenario1v1 (2) is suitable for 1v1 video call scenarios. To meet the requirements for low latency and high-quality video in this scenario, the SDK optimizes its strategies, improving performance in terms of video quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under weak network conditions.
    *
    * @returns
    * 0: Success.
@@ -3575,11 +3611,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.
    *
@@ -3633,17 +3664,13 @@ 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.
+   * 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. Depending on the default behavior of the sender and the specific settings when calling setDualStreamMode, the scenarios for the receiver calling this method are as follows:
+   *  The SDK enables low-quality video stream adaptive mode (AutoSimulcastStream) on the sender side by default, meaning only the high-quality video stream is transmitted. Only the receiver with the role of the host can call this method to initiate a low-quality video stream request. Once the sender receives the request, it starts automatically sending the low-quality video stream. At this point, all users in the channel can call this method to switch to low-quality video stream subscription mode.
+   *  If the sender calls setDualStreamMode and sets mode to DisableSimulcastStream (never send low-quality video stream), then calling this method will have no effect.
+   *  If the sender calls setDualStreamMode and sets mode to EnableSimulcastStream (always send low-quality video stream), both the host and audience receivers can call this method to switch to low-quality video stream subscription mode.
    *
    * @param streamType The default video-stream type. See VideoStreamType.
    *
@@ -3668,11 +3695,12 @@ export abstract class IRtcEngine {
   /**
    * Sets the video stream type to subscribe to.
    *
-   * 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. 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.
+   * Depending on the default behavior of the sender and the specific settings when calling setDualStreamMode, the scenarios for the receiver calling this method are as follows:
+   *  The SDK enables low-quality video stream adaptive mode (AutoSimulcastStream) on the sender side by default, meaning only the high-quality video stream is transmitted. Only the receiver with the role of the host can call this method to initiate a low-quality video stream request. Once the sender receives the request, it starts automatically sending the low-quality video stream. At this point, all users in the channel can call this method to switch to low-quality video stream subscription mode.
+   *  If the sender calls setDualStreamMode and sets mode to DisableSimulcastStream (never send low-quality video stream), then calling this method will have no effect.
+   *  If the sender calls setDualStreamMode and sets mode to EnableSimulcastStream (always send low-quality video stream), both the host and audience receivers can call this method to switch to low-quality video stream subscription mode. 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.
    *  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.
@@ -3818,9 +3846,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.
    *
@@ -3854,10 +3882,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. If you need to create multiple instances, you can call this method multiple times.
    *
    * @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;
@@ -3886,17 +3916,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.
    *
@@ -3918,9 +3945,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.
@@ -3931,7 +3958,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.
@@ -3942,7 +3969,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.
@@ -3957,7 +3984,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.
@@ -3980,7 +4007,6 @@ export abstract class IRtcEngine {
    * Adjusts the volume during audio mixing.
    *
    * This method adjusts the audio mixing volume on both the local client and remote clients.
-   *  Call this method after startAudioMixing.
    *
    * @param volume Audio mixing volume. The value ranges between 0 and 100. The default value is 100, which means the original volume.
    *
@@ -3993,7 +4019,7 @@ export abstract class IRtcEngine {
   /**
    * Adjusts the volume of audio mixing for publishing.
    *
-   * This method adjusts the volume of audio mixing for publishing (sending to other users). Call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged (AudioMixingStatePlaying) callback.
+   * This method adjusts the volume of audio mixing for publishing (sending to other users).
    *
    * @param volume The volume of audio mixing for local playback. The value ranges between 0 and 100 (default). 100 represents the original volume.
    *
@@ -4017,8 +4043,6 @@ export abstract class IRtcEngine {
   /**
    * Adjusts the volume of audio mixing for local playback.
    *
-   * Call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged (AudioMixingStatePlaying) callback.
-   *
    * @param volume The volume of audio mixing for local playback. The value ranges between 0 and 100 (default). 100 represents the original volume.
    *
    * @returns
@@ -4030,7 +4054,7 @@ export abstract class IRtcEngine {
   /**
    * Retrieves the audio mixing volume for local playback.
    *
-   * This method helps troubleshoot audio volume‑related issues. You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged (AudioMixingStatePlaying) callback.
+   * You can call this method to get the local playback volume of the mixed audio file, which helps in troubleshooting volume‑related issues.
    *
    * @returns
    * ≥ 0: The audio mixing volume, if this method call succeeds. The value range is [0,100].
@@ -4041,7 +4065,7 @@ export abstract class IRtcEngine {
   /**
    * Retrieves the duration (ms) of the music file.
    *
-   * Retrieves the total duration (ms) of the audio. You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged (AudioMixingStatePlaying) callback.
+   * Retrieves the total duration (ms) of the audio.
    *
    * @returns
    * ≥ 0: The audio mixing duration, if this method call succeeds.
@@ -4064,7 +4088,7 @@ export abstract class IRtcEngine {
   /**
    * Sets the audio mixing position.
    *
-   * Call this method to set the playback position of the music file to a different starting position (the default plays from the beginning). You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged (AudioMixingStatePlaying) callback.
+   * Call this method to set the playback position of the music file to a different starting position (the default plays from the beginning).
    *
    * @param pos Integer. The playback position (ms).
    *
@@ -4077,9 +4101,7 @@ export abstract class IRtcEngine {
   /**
    * Sets the channel mode of the current audio file.
    *
-   * In a stereo music file, the left and right channels can store different audio data. According to your needs, you can set the channel mode to original mode, left channel mode, right channel mode, or mixed channel mode. For example, in the KTV scenario, the left channel of the music file stores the musical accompaniment, and the right channel stores the singing voice. If you only need to listen to the accompaniment, call this method to set the channel mode of the music file to left channel mode; if you need to listen to the accompaniment and the singing voice at the same time, call this method to set the channel mode to mixed channel mode.
-   *  You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged (AudioMixingStatePlaying) callback.
-   *  This method only applies to stereo audio files.
+   * In a stereo music file, the left and right channels can store different audio data. According to your needs, you can set the channel mode to original mode, left channel mode, right channel mode, or mixed channel mode.
    *
    * @param mode The channel mode. See AudioMixingDualMonoMode.
    *
@@ -4092,7 +4114,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.
    *
@@ -4132,8 +4154,6 @@ export abstract class IRtcEngine {
   /**
    * Sets the volume of the audio effects.
    *
-   * Call this method after playEffect.
-   *
    * @param volume The playback volume. The value range is [0, 100]. The default value is 100, which represents the original volume.
    *
    * @returns
@@ -4145,7 +4165,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:
@@ -4166,10 +4186,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.
@@ -4238,7 +4258,7 @@ export abstract class IRtcEngine {
   abstract getVolumeOfEffect(soundId: number): number;
 
   /**
-   * Sets the volume of a specified audio effect.
+   * Gets the volume of a specified audio effect file.
    *
    * @param soundId The ID of the audio effect. The ID of each audio effect file is unique.
    * @param volume The playback volume. The value range is [0, 100]. The default value is 100, which represents the original volume.
@@ -4283,6 +4303,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.
@@ -4292,6 +4314,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
@@ -4303,6 +4327,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.
@@ -4312,6 +4338,8 @@ export abstract class IRtcEngine {
   /**
    * Releases a specified preloaded audio effect from the memory.
    *
+   * After loading the audio effect file into memory using preloadEffect, if you need to release the audio effect file, call this method.
+   *
    * @param soundId The ID of the audio effect. Each audio effect has a unique ID.
    *
    * @returns
@@ -4441,14 +4469,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.
    *
@@ -4461,14 +4482,7 @@ export abstract class IRtcEngine {
   /**
    * Sets an SDK preset audio effect.
    *
-   * 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). Call this method to set an SDK preset audio effect for the local user who sends an audio stream. This audio effect does not change the gender characteristics of the original voice. After setting an audio effect, all users in the channel can hear the effect.
-   *  Do not set the profile parameter in setAudioProfile to AudioProfileSpeechStandard (1) or AudioProfileIot (6), or the method does not take effect.
-   *  You can call this method either before or after joining a channel.
-   *  If you call setAudioEffectPreset and set enumerators except for RoomAcoustics3dVoice or PitchCorrection, do not call setAudioEffectParameters; otherwise, setAudioEffectPreset is overridden.
-   *  After calling setAudioEffectPreset, Agora does not recommend you to call the following methods, otherwise the effect set by setAudioEffectPreset will be overwritten: 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.
+   * Call this method to set an SDK preset audio effect for the local user who sends an audio stream. This audio effect does not change the gender characteristics of the original voice. After setting an audio effect, all users in the channel can hear the effect.
    *
    * @param preset The options for SDK preset audio effects. See AudioEffectPreset.
    *
@@ -4481,14 +4495,7 @@ export abstract class IRtcEngine {
   /**
    * Sets a preset voice beautifier effect.
    *
-   * 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). Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting an audio effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios.
-   *  Do not set the profile parameter in setAudioProfile to AudioProfileSpeechStandard (1) or AudioProfileIot (6), or the method does not take effect.
-   *  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 setVoiceConversionPreset, Agora does not recommend you to call the following methods, otherwise the effect set by setVoiceConversionPreset will be overwritten: setAudioEffectPreset setAudioEffectParameters setVoiceBeautifierPreset setVoiceBeautifierParameters setLocalVoicePitch setLocalVoiceFormant setLocalVoiceEqualization setLocalVoiceReverb
-   *  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 changing effect for the local user who publishes an audio stream in a channel. After setting the voice changing effect, all users in the channel can hear the effect. You can set different voice changing effects for the user depending on different scenarios.
    *
    * @param preset The options for the preset voice beautifier effects: VoiceConversionPreset.
    *
@@ -4510,6 +4517,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.
@@ -4539,6 +4547,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.
@@ -4566,8 +4575,6 @@ export abstract class IRtcEngine {
   /**
    * Changes the voice pitch of the local speaker.
    *
-   * You can call this method either before or after joining a channel.
-   *
    * @param pitch The local voice pitch. The value range is [0.5,2.0]. The lower the value, the lower the pitch. The default value is 1.0 (no change to the pitch).
    *
    * @returns
@@ -4579,7 +4586,7 @@ export abstract class IRtcEngine {
   /**
    * Set the formant ratio to change the timbre of human voice.
    *
-   * Formant ratio affects the timbre of voice. The smaller the value, the deeper the sound will be, and the larger, the sharper. You can call this method to set the formant ratio of local audio to change the timbre of human voice. After you set the formant ratio, all users in the channel can hear the changed voice. If you want to change the timbre and pitch of voice at the same time, Agora recommends using this method together with setLocalVoicePitch. You can call this method either before or after joining a channel.
+   * Formant ratio affects the timbre of voice. The smaller the value, the deeper the sound will be, and the larger, the sharper. After you set the formant ratio, all users in the channel can hear the changed voice. If you want to change the timbre and pitch of voice at the same time, Agora recommends using this method together with setLocalVoicePitch.
    *
    * @param formantRatio The formant ratio. The value range is [-1.0, 1.0]. The default value is 0.0, which means do not change the timbre of the voice. Agora recommends setting this value within the range of [-0.4, 0.6]. Otherwise, the voice may be seriously distorted.
    *
@@ -4592,8 +4599,6 @@ export abstract class IRtcEngine {
   /**
    * Sets the local voice equalization effect.
    *
-   * You can call this method either before or after joining a channel.
-   *
    * @param bandFrequency The band frequency. The value ranges between 0 and 9; representing the respective 10-band center frequencies of the voice effects, including 31, 62, 125, 250, 500, 1k, 2k, 4k, 8k, and 16k Hz. See AudioEqualizationBandFrequency.
    * @param bandGain The gain of each band in dB. The value ranges between -15 and 15. The default value is 0.
    *
@@ -4653,14 +4658,23 @@ export abstract class IRtcEngine {
   abstract setHeadphoneEQParameters(lowGain: number, highGain: number): number;
 
   /**
-   * @ignore
+   * Enables or disables the voice AI tuner.
+   *
+   * The voice AI tuner supports enhancing sound quality and adjusting tone style.
+   *
+   * @param enabled Whether to enable the voice AI tuner: true : Enables the voice AI tuner. false : (Default) Disable the voice AI tuner.
+   * @param type Voice AI tuner sound types, see VoiceAiTunerType.
+   *
+   * @returns
+   * 0: Success.
+   *  < 0: Failure.
    */
   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. Set the log file path by configuring the context parameter when calling initialize. Specifies an SDK output log file. The log file records all log data for the SDK’s operation.
    *
    * @param filePath The complete path of the log files. These log files are encoded in UTF-8.
    *
@@ -4686,9 +4700,9 @@ export abstract class IRtcEngine {
   /**
    * Sets the output log level of the SDK.
    *
-   * Deprecated: This method is deprecated. Use RtcEngineContext instead to set the log output level. Choose a level to see the logs preceding that level.
+   * Deprecated: This method is deprecated. Set the log file level by configuring the context parameter when calling initialize. Choose a level to see the logs preceding that level.
    *
-   * @param level The log level: LogLevel.
+   * @param level The log level. See LogLevel.
    *
    * @returns
    * 0: Success.
@@ -4733,10 +4747,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.
@@ -4853,16 +4864,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.
@@ -4876,18 +4885,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.
@@ -4901,11 +4908,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.
@@ -4943,10 +4954,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.
@@ -5290,7 +5305,12 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * @ignore
+   * Sets the camera capture configuration.
+   *
+   * @param config The camera capture configuration. See CameraCapturerConfiguration.
+   *
+   * @returns
+   * < 0: Failure.
    */
   abstract setCameraCapturerConfiguration(
     config: CameraCapturerConfiguration
@@ -5665,13 +5685,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;
 
@@ -5922,7 +5936,7 @@ export abstract class IRtcEngine {
   /**
    * 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.
@@ -5950,11 +5964,11 @@ 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.
-   *  Ensure that you call createDataStream to create a data channel before calling this method.
+   * 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.
+   *  This method needs to be called after createDataStream and joining the channel.
    *  In live streaming scenarios, this method only applies to hosts.
    *
    * @param streamId The data stream ID. You can get the data stream ID by calling createDataStream.
@@ -6123,7 +6137,7 @@ export abstract class IRtcEngine {
    *  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.
+   *  To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a UID, then ensure all the other users use the UID 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.
    *
    * @param appId The App ID of your project on Agora Console.
    * @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 follow(89 in total):
@@ -6140,14 +6154,14 @@ export abstract class IRtcEngine {
   abstract registerLocalUserAccount(appId: string, userAccount: string): number;
 
   /**
-   * Joins the channel with a user account, and configures whether to automatically subscribe to audio or video streams after joining the channel.
+   * Join a channel using a user account and token, and set the media options.
    *
-   * 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.
-   *  If you choose the Testing Mode (using an App ID for authentication) for your project and call this method to join a channel, you will automatically exit the channel after 24 hours. This method allows a user to join the channel with the user account. After the user successfully joins the channel, the SDK triggers the following callbacks:
-   *  The local client: onLocalUserRegistered, onJoinChannelSuccess and onConnectionStateChanged callbacks.
-   *  The remote client: The onUserJoined callback, if the user is in the COMMUNICATION profile, and the onUserInfoUpdated callback if the user is a host in the LIVE_BROADCASTING profile. Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.
+   * Before calling this method, if you have not called registerLocalUserAccount to register a user account, when you call this method to join a channel, the SDK automatically creates a user account for you. Calling the registerLocalUserAccount method to register a user account, and then calling this method to join a channel can shorten the time it takes to enter the channel. Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billings. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods. To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a UID, then ensure all the other users use the UID 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.
    *
-   * @param token The token generated on your server for authentication. If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel.
+   * @param token The token generated on your server for authentication.
+   *  (Recommended) If your project has enabled the security mode (using APP ID and Token for authentication), this parameter is required.
+   *  If you have only enabled the testing mode (using APP ID for authentication), this parameter is optional. You will automatically exit the channel 24 hours after successfully joining in.
+   *  If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel.
    * @param channelId The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
    *  All lowercase English letters: a to z.
    *  All uppercase English letters: A to Z.
@@ -6165,11 +6179,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 after calling startEchoTest to start a call loop test, you call this method to join the channel without calling stopEchoTest to stop the 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(
@@ -6180,13 +6194,14 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Joins the channel with a user account, and configures whether to automatically subscribe to audio or video streams after joining the channel.
+   * Join a channel using a user account and token, and set the media options.
    *
-   * This method allows a user to join the channel with the user account. After the user successfully joins the channel, the SDK triggers the following callbacks:
-   *  The local client: onLocalUserRegistered, onJoinChannelSuccess and onConnectionStateChanged callbacks.
-   *  The remote client: The onUserJoined callback, if the user is in the COMMUNICATION profile, and the onUserInfoUpdated callback if the user is a host in the LIVE_BROADCASTING profile. Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods. 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.
+   * Before calling this method, if you have not called registerLocalUserAccount to register a user account, when you call this method to join a channel, the SDK automatically creates a user account for you. Calling the registerLocalUserAccount method to register a user account, and then calling this method to join a channel can shorten the time it takes to enter the channel. Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billings. If you want to stop subscribing to the media stream of other users, you can set the options parameter or call the corresponding mute method. To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a UID, then ensure all the other users use the UID 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.
    *
-   * @param token The token generated on your server for authentication. If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel.
+   * @param token The token generated on your server for authentication.
+   *  (Recommended) If your project has enabled the security mode (using APP ID and Token for authentication), this parameter is required.
+   *  If you have only enabled the testing mode (using APP ID for authentication), this parameter is optional. You will automatically exit the channel 24 hours after successfully joining in.
+   *  If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel.
    * @param channelId The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
    *  All lowercase English letters: a to z.
    *  All uppercase English letters: A to Z.
@@ -6203,6 +6218,13 @@ export abstract class IRtcEngine {
    * @returns
    * 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: 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 after calling startEchoTest to start a call loop test, you call this method to join the channel without calling stopEchoTest to stop the 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 joinChannelWithUserAccountEx(
     token: string,
@@ -6255,7 +6277,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(
@@ -6270,6 +6291,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;
 
@@ -6281,6 +6303,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;
 
@@ -6292,6 +6315,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;
 
@@ -6355,7 +6379,14 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * @ignore
+   * Enables 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 want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in ChannelMediaOptions as true.
+   *
+   * @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,
@@ -6364,22 +6395,27 @@ 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 calling startRhythmPlayer, you can call this method to reconfigure 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 want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in ChannelMediaOptions as true.
+   *
+   * @param config The metronome configuration. See AgoraRhythmPlayerConfig.
    */
   abstract configRhythmPlayer(config: AgoraRhythmPlayerConfig): number;
 
   /**
    * Takes a snapshot of a video stream.
    *
-   * This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path. The method is asynchronous, and the SDK has not taken the snapshot when the method call returns. After a successful method call, the SDK triggers the onSnapshotTaken callback to report whether the snapshot is successfully taken, as well as the details for that snapshot.
-   *  Call this method after joining a channel.
-   *  When used for local video snapshots, this method takes a snapshot for the video streams specified in ChannelMediaOptions.
-   *  If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.
+   * This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path.
    *
    * @param uid The user ID. Set uid as 0 if you want to take a snapshot of the local user's video.
    * @param filePath The local path (including filename extensions) of the snapshot. For example:
@@ -6395,10 +6431,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.
@@ -6490,7 +6526,7 @@ export abstract class IRtcEngine {
   /**
    * Sets whether to replace the current video feeds with images when publishing video streams.
    *
-   * Agora recommends that you call this method after joining a channel. When publishing video streams, you can call this method to replace the current video feeds with custom images. Once you enable this function, you can select images to replace the video feeds through the ImageTrackOptions parameter. If you disable this function, the remote users see the video feeds that you publish.
+   * When publishing video streams, you can call this method to replace the current video feeds with custom images. Once you enable this function, you can select images to replace the video feeds through the ImageTrackOptions parameter. If you disable this function, the remote users see the video feeds that you publish.
    *
    * @param enable Whether to replace the current video feeds with custom images: true : Replace the current video feeds with custom images. false : (Default) Do not replace the current video feeds with custom images.
    * @param options Image configurations. See ImageTrackOptions.
@@ -6567,9 +6603,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.
@@ -6823,131 +6857,131 @@ export enum MediaDeviceStateType {
 }
 
 /**
- * Video profile.
+ * @ignore
  */
 export enum VideoProfileType {
   /**
-   * 0: 160 × 120, frame rate 15 fps, bitrate 65 Kbps.
+   * @ignore
    */
   VideoProfileLandscape120p = 0,
   /**
-   * 2: 120 × 120, frame rate 15 fps, bitrate 50 Kbps.
+   * @ignore
    */
   VideoProfileLandscape120p3 = 2,
   /**
-   * 10: 320 × 180, frame rate 15 fps, bitrate 140 Kbps.
+   * @ignore
    */
   VideoProfileLandscape180p = 10,
   /**
-   * 12: 180 × 180, frame rate 15 fps, bitrate 100 Kbps.
+   * @ignore
    */
   VideoProfileLandscape180p3 = 12,
   /**
-   * 13: 240 × 180, frame rate 15 fps, bitrate 120 Kbps.
+   * @ignore
    */
   VideoProfileLandscape180p4 = 13,
   /**
-   * 20: 320 × 240, frame rate 15 fps, bitrate 200 Kbps.
+   * @ignore
    */
   VideoProfileLandscape240p = 20,
   /**
-   * 22: 240 × 240, frame rate 15 fps, bitrate 140 Kbps.
+   * @ignore
    */
   VideoProfileLandscape240p3 = 22,
   /**
-   * 23: 424 × 240, frame rate 15 fps, bitrate 220 Kbps.
+   * @ignore
    */
   VideoProfileLandscape240p4 = 23,
   /**
-   * 30: 640 × 360, frame rate 15 fps, bitrate 400 Kbps.
+   * @ignore
    */
   VideoProfileLandscape360p = 30,
   /**
-   * 32: 360 × 360, frame rate 15 fps, bitrate 260 Kbps.
+   * @ignore
    */
   VideoProfileLandscape360p3 = 32,
   /**
-   * 33: 640 × 360, frame rate 30 fps, bitrate 600 Kbps.
+   * @ignore
    */
   VideoProfileLandscape360p4 = 33,
   /**
-   * 35: 360 × 360, frame rate 30 fps, bitrate 400 Kbps.
+   * @ignore
    */
   VideoProfileLandscape360p6 = 35,
   /**
-   * 36: 480 × 360, frame rate 15 fps, bitrate 320 Kbps.
+   * @ignore
    */
   VideoProfileLandscape360p7 = 36,
   /**
-   * 37: 480 × 360, frame rate 30 fps, bitrate 490 Kbps.
+   * @ignore
    */
   VideoProfileLandscape360p8 = 37,
   /**
-   * 38: 640 × 360, frame rate 15 fps, bitrate 800 Kbps. This profile applies only to the live streaming channel profile.
+   * @ignore
    */
   VideoProfileLandscape360p9 = 38,
   /**
-   * 39: 640 × 360, frame rate 24 fps, bitrate 800 Kbps. This profile applies only to the live streaming channel profile.
+   * @ignore
    */
   VideoProfileLandscape360p10 = 39,
   /**
-   * 100: 640 × 360, frame rate 24 fps, bitrate 1000 Kbps. This profile applies only to the live streaming channel profile.
+   * @ignore
    */
   VideoProfileLandscape360p11 = 100,
   /**
-   * 40: 640 × 480, frame rate 15 fps, bitrate 500 Kbps.
+   * @ignore
    */
   VideoProfileLandscape480p = 40,
   /**
-   * 42: 480 × 480, frame rate 15 fps, bitrate 400 Kbps.
+   * @ignore
    */
   VideoProfileLandscape480p3 = 42,
   /**
-   * 43: 640 × 480, frame rate 30 fps, bitrate 750 Kbps.
+   * @ignore
    */
   VideoProfileLandscape480p4 = 43,
   /**
-   * 45: 480 × 480, frame rate 30 fps, bitrate 600 Kbps.
+   * @ignore
    */
   VideoProfileLandscape480p6 = 45,
   /**
-   * 47: 848 × 480, frame rate 15 fps, bitrate 610 Kbps.
+   * @ignore
    */
   VideoProfileLandscape480p8 = 47,
   /**
-   * 48: 848 × 480, frame rate 30 fps, bitrate 930 Kbps.
+   * @ignore
    */
   VideoProfileLandscape480p9 = 48,
   /**
-   * 49: 640 × 480, frame rate 10 fps, bitrate 400 Kbps.
+   * @ignore
    */
   VideoProfileLandscape480p10 = 49,
   /**
-   * 50: 1280 × 720, frame rate 15 fps, bitrate 1130 Kbps.
+   * @ignore
    */
   VideoProfileLandscape720p = 50,
   /**
-   * 52: 1280 × 720, frame rate 30 fps, bitrate 1710 Kbps.
+   * @ignore
    */
   VideoProfileLandscape720p3 = 52,
   /**
-   * 54: 960 × 720, frame rate 15 fps, bitrate 910 Kbps.
+   * @ignore
    */
   VideoProfileLandscape720p5 = 54,
   /**
-   * 55: 960 × 720, frame rate 30 fps, bitrate 1380 Kbps.
+   * @ignore
    */
   VideoProfileLandscape720p6 = 55,
   /**
-   * 60: 1920 × 1080, frame rate 15 fps, bitrate 2080 Kbps.
+   * @ignore
    */
   VideoProfileLandscape1080p = 60,
   /**
-   * 60: 1920 × 1080, frame rate 30 fps, bitrate 3150 Kbps.
+   * @ignore
    */
   VideoProfileLandscape1080p3 = 62,
   /**
-   * 64: 1920 × 1080, frame rate 60 fps, bitrate 4780 Kbps.
+   * @ignore
    */
   VideoProfileLandscape1080p5 = 64,
   /**
@@ -6967,127 +7001,127 @@ export enum VideoProfileType {
    */
   VideoProfileLandscape4k3 = 72,
   /**
-   * 1000: 120 × 160, frame rate 15 fps, bitrate 65 Kbps.
+   * @ignore
    */
   VideoProfilePortrait120p = 1000,
   /**
-   * 1002: 120 × 120, frame rate 15 fps, bitrate 50 Kbps.
+   * @ignore
    */
   VideoProfilePortrait120p3 = 1002,
   /**
-   * 1010: 180 × 320, frame rate 15 fps, bitrate 140 Kbps.
+   * @ignore
    */
   VideoProfilePortrait180p = 1010,
   /**
-   * 1012: 180 × 180, frame rate 15 fps, bitrate 100 Kbps.
+   * @ignore
    */
   VideoProfilePortrait180p3 = 1012,
   /**
-   * 1013: 180 × 240, frame rate 15 fps, bitrate 120 Kbps.
+   * @ignore
    */
   VideoProfilePortrait180p4 = 1013,
   /**
-   * 1020: 240 × 320, frame rate 15 fps, bitrate 200 Kbps.
+   * @ignore
    */
   VideoProfilePortrait240p = 1020,
   /**
-   * 1022: 240 × 240, frame rate 15 fps, bitrate 140 Kbps.
+   * @ignore
    */
   VideoProfilePortrait240p3 = 1022,
   /**
-   * 1023: 240 × 424, frame rate 15 fps, bitrate 220 Kbps.
+   * @ignore
    */
   VideoProfilePortrait240p4 = 1023,
   /**
-   * 1030: 360 × 640, frame rate 15 fps, bitrate 400 Kbps.
+   * @ignore
    */
   VideoProfilePortrait360p = 1030,
   /**
-   * 1032: 360 × 360, frame rate 15 fps, bitrate 260 Kbps.
+   * @ignore
    */
   VideoProfilePortrait360p3 = 1032,
   /**
-   * 1033: 360 × 640, frame rate 15 fps, bitrate 600 Kbps.
+   * @ignore
    */
   VideoProfilePortrait360p4 = 1033,
   /**
-   * 1035: 360 × 360, frame rate 30 fps, bitrate 400 Kbps.
+   * @ignore
    */
   VideoProfilePortrait360p6 = 1035,
   /**
-   * 1036: 360 × 480, frame rate 15 fps, bitrate 320 Kbps.
+   * @ignore
    */
   VideoProfilePortrait360p7 = 1036,
   /**
-   * 1037: 360 × 480, frame rate 30 fps, bitrate 490 Kbps.
+   * @ignore
    */
   VideoProfilePortrait360p8 = 1037,
   /**
-   * 1038: 360 × 640, frame rate 15 fps, bitrate 800 Kbps. This profile applies only to the live streaming channel profile.
+   * @ignore
    */
   VideoProfilePortrait360p9 = 1038,
   /**
-   * 1039: 360 × 640, frame rate 24 fps, bitrate 800 Kbps. This profile applies only to the live streaming channel profile.
+   * @ignore
    */
   VideoProfilePortrait360p10 = 1039,
   /**
-   * 1100: 360 × 640, frame rate 24 fps, bitrate 1000 Kbps. This profile applies only to the live streaming channel profile.
+   * @ignore
    */
   VideoProfilePortrait360p11 = 1100,
   /**
-   * 1040: 480 × 640, frame rate 15 fps, bitrate 500 Kbps.
+   * @ignore
    */
   VideoProfilePortrait480p = 1040,
   /**
-   * 1042: 480 × 480, frame rate 15 fps, bitrate 400 Kbps.
+   * @ignore
    */
   VideoProfilePortrait480p3 = 1042,
   /**
-   * 1043: 480 × 640, frame rate 30 fps, bitrate 750 Kbps.
+   * @ignore
    */
   VideoProfilePortrait480p4 = 1043,
   /**
-   * 1045: 480 × 480, frame rate 30 fps, bitrate 600 Kbps.
+   * @ignore
    */
   VideoProfilePortrait480p6 = 1045,
   /**
-   * 1047: 480 × 848, frame rate 15 fps, bitrate 610 Kbps.
+   * @ignore
    */
   VideoProfilePortrait480p8 = 1047,
   /**
-   * 1048: 480 × 848, frame rate 30 fps, bitrate 930 Kbps.
+   * @ignore
    */
   VideoProfilePortrait480p9 = 1048,
   /**
-   * 1049: 480 × 640, frame rate 10 fps, bitrate 400 Kbps.
+   * @ignore
    */
   VideoProfilePortrait480p10 = 1049,
   /**
-   * 1050: 720 × 1280, frame rate 15 fps, bitrate 1130 Kbps.
+   * @ignore
    */
   VideoProfilePortrait720p = 1050,
   /**
-   * 1052: 720 × 1280, frame rate 30 fps, bitrate 1710 Kbps.
+   * @ignore
    */
   VideoProfilePortrait720p3 = 1052,
   /**
-   * 1054: 720 × 960, frame rate 15 fps, bitrate 910 Kbps.
+   * @ignore
    */
   VideoProfilePortrait720p5 = 1054,
   /**
-   * 1055: 720 × 960, frame rate 30 fps, bitrate 1380 Kbps.
+   * @ignore
    */
   VideoProfilePortrait720p6 = 1055,
   /**
-   * 1060: 1080 × 1920, frame rate 15 fps, bitrate 2080 Kbps.
+   * @ignore
    */
   VideoProfilePortrait1080p = 1060,
   /**
-   * 1062: 1080 × 1920, frame rate 30 fps, bitrate 3150 Kbps.
+   * @ignore
    */
   VideoProfilePortrait1080p3 = 1062,
   /**
-   * 1064: 1080 × 1920, frame rate 60 fps, bitrate 4780 Kbps.
+   * @ignore
    */
   VideoProfilePortrait1080p5 = 1064,
   /**
@@ -7107,7 +7141,7 @@ export enum VideoProfileType {
    */
   VideoProfilePortrait4k3 = 1072,
   /**
-   * (Default) 640 × 360, frame rate 15 fps, bitrate 400 Kbps.
+   * @ignore
    */
   VideoProfileDefault = 30,
 }