agora-electron-sdk 4.1.1-rc.1 → 4.2.0-dev.13

package/ts/Private/IAgoraRtcEngine.ts

@@ -1,118 +1,125 @@
 import './extension/IAgoraRtcEngineExtension';
 import {
-  QualityAdaptIndication,
-  VideoCodecType,
-  CaptureBrightnessLevelType,
-  VideoStreamType,
-  AudioSampleRateType,
-  VideoFormat,
-  Rectangle,
-  ScreenCaptureParameters,
-  VideoMirrorModeType,
-  ClientRoleType,
   AudienceLatencyLevelType,
+  AudioAinsMode,
+  AudioEffectPreset,
+  AudioEncodedFrameObserverConfig,
+  AudioProfileType,
+  AudioRecordingConfiguration,
+  AudioSampleRateType,
+  AudioScenarioType,
+  AudioSessionOperationRestriction,
+  AudioVolumeInfo,
+  BeautyOptions,
+  CaptureBrightnessLevelType,
+  ChannelMediaRelayConfiguration,
+  ChannelMediaRelayError,
+  ChannelMediaRelayEvent,
+  ChannelMediaRelayState,
   ChannelProfileType,
+  ClientRoleChangeFailedReason,
+  ClientRoleOptions,
+  ClientRoleType,
+  CodecCapInfo,
+  ColorEnhanceOptions,
+  ConnectionChangedReasonType,
+  ConnectionStateType,
+  DataStreamConfig,
+  DeviceInfo,
+  DownlinkNetworkInfo,
+  EarMonitoringFilterType,
+  EchoTestConfiguration,
+  EncryptionConfig,
+  EncryptionErrorType,
   ErrorCodeType,
-  QualityType,
+  HeadphoneEqualizerPreset,
+  IAudioEncodedFrameObserver,
+  LastmileProbeConfig,
   LastmileProbeResult,
-  AudioVolumeInfo,
-  RtcStats,
-  UplinkNetworkInfo,
-  DownlinkNetworkInfo,
-  VideoSourceType,
-  LocalVideoStreamState,
-  LocalVideoStreamError,
-  RemoteVideoState,
-  RemoteVideoStateReason,
-  UserOfflineReasonType,
-  LocalAudioStats,
-  RemoteAudioStats,
   LicenseErrorType,
-  LocalAudioStreamState,
+  LiveTranscoding,
+  LocalAudioStats,
   LocalAudioStreamError,
+  LocalAudioStreamState,
+  LocalTranscoderConfiguration,
+  LocalVideoStreamError,
+  LocalVideoStreamState,
+  LowlightEnhanceOptions,
+  MediaTraceEvent,
+  NetworkType,
+  PermissionType,
+  QualityAdaptIndication,
+  QualityType,
+  RecorderStreamInfo,
+  Rectangle,
   RemoteAudioState,
   RemoteAudioStateReason,
-  ClientRoleOptions,
-  ClientRoleChangeFailedReason,
-  RtmpStreamPublishState,
+  RemoteVideoState,
+  RemoteVideoStateReason,
+  RtcStats,
   RtmpStreamPublishErrorType,
+  RtmpStreamPublishState,
   RtmpStreamingEvent,
-  ChannelMediaRelayState,
-  ChannelMediaRelayError,
-  ChannelMediaRelayEvent,
-  ConnectionStateType,
-  ConnectionChangedReasonType,
-  WlaccMessageReason,
-  WlaccSuggestAction,
-  WlAccStats,
-  NetworkType,
-  EncryptionErrorType,
-  PermissionType,
-  UserInfo,
-  UploadErrorReason,
-  StreamSubscribeState,
+  ScreenCaptureParameters,
+  ScreenCaptureParameters2,
+  ScreenScenarioType,
+  SegmentationProperty,
+  SenderOptions,
+  SimulcastStreamConfig,
+  SimulcastStreamMode,
+  SpatialAudioParams,
   StreamPublishState,
-  MediaTraceEvent,
-  VideoRenderingTracingInfo,
-  AudioScenarioType,
+  StreamSubscribeState,
   ThreadPriorityType,
-  LastmileProbeConfig,
-  VideoEncoderConfiguration,
-  BeautyOptions,
-  LowlightEnhanceOptions,
-  VideoDenoiserOptions,
-  ColorEnhanceOptions,
-  VirtualBackgroundSource,
-  SegmentationProperty,
+  TranscodingVideoStream,
+  UplinkNetworkInfo,
+  UploadErrorReason,
+  UserInfo,
+  UserOfflineReasonType,
+  VideoApplicationScenarioType,
   VideoCanvas,
-  AudioProfileType,
+  VideoCodecType,
+  VideoContentHint,
+  VideoDenoiserOptions,
+  VideoEncoderConfiguration,
+  VideoFormat,
+  VideoMirrorModeType,
+  VideoOrientation,
+  VideoRenderingTracingInfo,
+  VideoStreamType,
   VideoSubscriptionOptions,
-  AudioRecordingConfiguration,
-  AudioEncodedFrameObserverConfig,
-  IAudioEncodedFrameObserver,
-  SpatialAudioParams,
+  VideoTranscoderError,
+  VirtualBackgroundSource,
   VoiceBeautifierPreset,
-  AudioEffectPreset,
   VoiceConversionPreset,
-  HeadphoneEqualizerPreset,
-  SimulcastStreamConfig,
-  SimulcastStreamMode,
-  EarMonitoringFilterType,
-  SenderOptions,
-  AudioSessionOperationRestriction,
-  DeviceInfo,
-  VideoContentHint,
-  ScreenScenarioType,
-  ScreenCaptureParameters2,
-  LiveTranscoding,
-  LocalTranscoderConfiguration,
-  VideoOrientation,
-  EncryptionConfig,
-  DataStreamConfig,
   WatermarkOptions,
-  ChannelMediaRelayConfiguration,
+  WlAccStats,
+  WlaccMessageReason,
+  WlaccSuggestAction,
 } from './AgoraBase';
 import {
-  RenderModeType,
+  ContentInspectConfig,
   ContentInspectResult,
+  IAudioSpectrumObserver,
   MediaSourceType,
   RawAudioFrameOpModeType,
-  IAudioSpectrumObserver,
-  ContentInspectConfig,
+  RenderModeType,
+  VideoSourceType,
 } from './AgoraMediaBase';
-import { RtcConnection } from './IAgoraRtcEngineEx';
-import {
-  RhythmPlayerStateType,
-  RhythmPlayerErrorType,
-  AgoraRhythmPlayerConfig,
-} from './IAgoraRhythmPlayer';
 import { LogConfig, LogFilterType, LogLevel } from './IAgoraLog';
-import { IMediaPlayer } from './IAgoraMediaPlayer';
 import { AudioMixingDualMonoMode, IMediaEngine } from './IAgoraMediaEngine';
-import { IAudioDeviceManager } from './IAudioDeviceManager';
-import { IMusicContentCenter } from './IAgoraMusicContentCenter';
+import { IMediaPlayer } from './IAgoraMediaPlayer';
 import { IMediaRecorder } from './IAgoraMediaRecorder';
+import { IMusicContentCenter } from './IAgoraMusicContentCenter';
+import {
+  AgoraRhythmPlayerConfig,
+  RhythmPlayerErrorType,
+  RhythmPlayerStateType,
+} from './IAgoraRhythmPlayer';
+import { RtcConnection } from './IAgoraRtcEngineEx';
 import { ILocalSpatialAudioEngine } from './IAgoraSpatialAudio';
+import { IAudioDeviceManager } from './IAudioDeviceManager';
+
 /**
  * Media device types.
  */
@@ -141,6 +148,14 @@ export enum MediaDeviceType {
    * @ignore
    */
   AudioApplicationPlayoutDevice = 4,
+  /**
+   * @ignore
+   */
+  AudioVirtualPlayoutDevice = 5,
+  /**
+   * @ignore
+   */
+  AudioVirtualRecordingDevice = 6,
 }
 
 /**
@@ -451,6 +466,84 @@ export class LocalVideoStats {
   hwEncoderAccelerating?: number;
 }
 
+/**
+ * Audio statistics of the remote user.
+ */
+export class RemoteAudioStats {
+  /**
+   * The user ID of the remote user.
+   */
+  uid?: number;
+  /**
+   * The quality of the audio stream sent by the user. See QualityType .
+   */
+  quality?: number;
+  /**
+   * The network delay (ms) from the sender to the receiver.
+   */
+  networkTransportDelay?: number;
+  /**
+   * The network delay (ms) from the audio receiver to the jitter buffer.When the receiving end is an audience member and audienceLatencyLevel of ClientRoleOptions is 1, this parameter does not take effect.
+   */
+  jitterBufferDelay?: number;
+  /**
+   * The frame loss rate (%) of the remote audio stream in the reported interval.
+   */
+  audioLossRate?: number;
+  /**
+   * The number of audio channels.
+   */
+  numChannels?: number;
+  /**
+   * The sampling rate of the received audio stream in the reported interval.
+   */
+  receivedSampleRate?: number;
+  /**
+   * The average bitrate (Kbps) of the received audio stream in the reported interval.
+   */
+  receivedBitrate?: number;
+  /**
+   * The total freeze time (ms) of the remote audio stream after the remote user joins the channel. In a session, audio freeze occurs when the audio frame loss rate reaches 4%.
+   */
+  totalFrozenTime?: number;
+  /**
+   * The total audio freeze time as a percentage (%) of the total time when the audio is available. The audio is considered available when the remote user neither stops sending the audio stream nor disables the audio module after joining the channel.
+   */
+  frozenRate?: number;
+  /**
+   * The quality of the remote audio stream in the reported interval. The quality is determined by the Agora real-time audio MOS (Mean Opinion Score) measurement method. The return value range is [0, 500]. Dividing the return value by 100 gets the MOS score, which ranges from 0 to 5. The higher the score, the better the audio quality.The subjective perception of audio quality corresponding to the Agora real-time audio MOS scores is as follows:MOS scorePerception of audio qualityGreater than 4Excellent. The audio sounds clear and smooth.From 3.5 to 4Good. The audio has some perceptible impairment but still sounds clear.From 3 to 3.5Fair. The audio freezes occasionally and requires attentive listening.From 2.5 to 3Poor. The audio sounds choppy and requires considerable effort to understand.From 2 to 2.5Bad. The audio has occasional noise. Consecutive audio dropouts occur, resulting in some information loss. The users can communicate only with difficulty.Less than 2Very bad. The audio has persistent noise. Consecutive audio dropouts are frequent, resulting in severe information loss. Communication is nearly impossible.
+   */
+  mosValue?: number;
+  /**
+   * @ignore
+   */
+  frozenRateByCustomPlcCount?: number;
+  /**
+   * @ignore
+   */
+  plcCount?: number;
+  /**
+   * The total active time (ms) between the start of the audio call and the callback of the remote user.The active time refers to the total duration of the remote user without the mute state.
+   */
+  totalActiveTime?: number;
+  /**
+   * The total duration (ms) of the remote audio stream.
+   */
+  publishDuration?: number;
+  /**
+   * The Quality of Experience (QoE) of the local user when receiving a remote audio stream. See ExperienceQualityType .
+   */
+  qoeQuality?: number;
+  /**
+   * Reasons why the QoE of the local user when receiving a remote audio stream is poor. See ExperiencePoorReason .
+   */
+  qualityChangedReason?: number;
+  /**
+   * @ignore
+   */
+  rxAudioBytes?: number;
+}
+
 /**
  * Statistics of the remote video stream.
  */
@@ -463,6 +556,10 @@ export class RemoteVideoStats {
    * Deprecated:In scenarios where audio and video are synchronized, you can get the video delay data from networkTransportDelay and jitterBufferDelay in RemoteAudioStats .The video delay (ms).
    */
   delay?: number;
+  /**
+   * @ignore
+   */
+  e2eDelay?: number;
   /**
    * The width (pixels) of the video.
    */
@@ -519,6 +616,10 @@ export class RemoteVideoStats {
    * @ignore
    */
   mosValue?: number;
+  /**
+   * @ignore
+   */
+  rxVideoBytes?: number;
 }
 
 /**
@@ -704,16 +805,6 @@ export class PublisherConfiguration {
   extraInfo?: string;
 }
 
-/**
- * @ignore
- */
-export class AudioTrackConfig {
-  /**
-   * @ignore
-   */
-  enableLocalPlayback?: boolean;
-}
-
 /**
  * The camera direction.
  */
@@ -763,7 +854,7 @@ export class CameraCapturerConfiguration {
    */
   format?: VideoFormat;
   /**
-   * Whether to follow the video aspect ratio set in setVideoEncoderConfiguration :true: (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in onCaptureVideoFrame and onPreEncodeVideoFrame .false: Do not follow the set video aspect ratio. The SDK does not change the aspect ratio of the captured video frame.
+   * Whether to follow the video aspect ratio set in setVideoEncoderConfiguration :true: (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in onCaptureVideoFrame and onPreEncodeVideoFrame .false: Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
    */
   followEncodeDimensionRatio?: boolean;
 }
@@ -897,10 +988,18 @@ export class ScreenCaptureSourceInfo {
    * @ignore
    */
   isOccluded?: boolean;
+  /**
+   * @ignore
+   */
+  position?: Rectangle;
   /**
    * (For Windows only) Whether the window is minimized:true: The window is minimized.false: The window is not minimized.
    */
   minimizeWindow?: boolean;
+  /**
+   * @ignore
+   */
+  sourceDisplayId?: any;
 }
 
 /**
@@ -941,7 +1040,7 @@ export class ChannelMediaOptions {
    */
   publishCameraTrack?: boolean;
   /**
-   *
+   * @ignore
    */
   publishSecondaryCameraTrack?: boolean;
   /**
@@ -968,22 +1067,10 @@ export class ChannelMediaOptions {
    * Whether to publish the audio captured from a custom source:true: Publish the audio captured from the custom source.false: (Default) Do not publish the audio captured from the custom source.
    */
   publishCustomAudioTrack?: boolean;
-  /**
-   * The ID of the custom audio source to publish. The default value is 0.If you have set sourceNumber in setExternalAudioSource to a value greater than 1, the SDK creates the corresponding number of custom audio tracks and assigns an ID to each audio track, starting from 0.
-   */
-  publishCustomAudioSourceId?: number;
-  /**
-   * Whether to enable AEC when publishing the audio captured from a custom source:true: Enable AEC when publishing the audio captured from the custom source.false: (Default) Do not enable AEC when publishing the audio captured from the custom source.
-   */
-  publishCustomAudioTrackEnableAec?: boolean;
-  /**
-   * @ignore
-   */
-  publishDirectCustomAudioTrack?: boolean;
   /**
    * @ignore
    */
-  publishCustomAudioTrackAec?: boolean;
+  publishCustomAudioTrackId?: number;
   /**
    * Whether to publish the video captured from a custom source:true: Publish the video captured from the custom source.false: (Default) Do not publish the video captured from the custom source.
    */
@@ -1001,9 +1088,9 @@ export class ChannelMediaOptions {
    */
   publishMediaPlayerVideoTrack?: boolean;
   /**
-   * Whether to publish the local transcoded video:true: Publish the local transcoded video.false: (Default) Do not publish the local transcoded video.
+   * @ignore
    */
-  publishTrancodedVideoTrack?: boolean;
+  publishTranscodedVideoTrack?: boolean;
   /**
    * Whether to automatically subscribe to all remote audio streams when the user joins a channel:true: (Default) Automatically subscribe to all remote audio streams.false: Do not automatically subscribe to any remote audio streams.
    */
@@ -1026,10 +1113,12 @@ export class ChannelMediaOptions {
   clientRoleType?: ClientRoleType;
   /**
    * The latency level of an audience member in interactive live streaming. See AudienceLatencyLevelType .
+   *
    */
   audienceLatencyLevel?: AudienceLatencyLevelType;
   /**
    * The default video-stream type. See VideoStreamType .
+   *
    */
   defaultVideoStreamType?: VideoStreamType;
   /**
@@ -1045,7 +1134,7 @@ export class ChannelMediaOptions {
    */
   mediaPlayerAudioDelayMs?: number;
   /**
-   * (Optional) The token generated on your server for authentication. See This parameter takes effect only when calling updateChannelMediaOptions or updateChannelMediaOptionsEx .Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the initialize method for initializing the RTC engine, and those used by the joinChannel [2/2] and joinChannelEx methods for joining the channel.
+   * (Optional) The token generated on your server for authentication. See This parameter takes effect only when calling updateChannelMediaOptions or updateChannelMediaOptionsEx .Ensure that the App ID, channel name, and user name used for creating the token are the same as those used by the initialize method for initializing the RTC engine, and those used by the joinChannel and joinChannelEx methods for joining the channel.
    */
   token?: string;
   /**
@@ -1108,6 +1197,14 @@ export enum ProxyType {
    * 4: Automatic mode. In this mode, the SDK attempts a direct connection to SD-RTN™ and automatically switches to TCP/TLS 443 if the attempt fails.
    */
   TcpProxyAutoFallbackType = 4,
+  /**
+   * @ignore
+   */
+  HttpProxyType = 5,
+  /**
+   * @ignore
+   */
+  HttpsProxyType = 6,
 }
 
 /**
@@ -1203,36 +1300,28 @@ export interface IRtcEngineEventHandler {
    * This callback notifies the application that a user joins a specified channel.
    *
    * @param connection The connection information. See RtcConnection .
-   *
-   * @param elapsed The time elapsed (ms) from the local user calling joinChannel [2/2] until the SDK triggers this callback.
+   * @param elapsed The time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.
    */
   onJoinChannelSuccess?(connection: RtcConnection, elapsed: number): void;
 
   /**
-   * 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 channel The channel name.
-   *
-   * @param uid The ID of the user who rejoins the channel.
+   * Occurs when a user joins a channel.
+   * This callback notifies the application that a user joins a specified channel.
    *
-   * @param elapsed Time elapsed (ms) from the local user calling the joinChannel [1/2] or joinChannel [2/2] method until this callback is triggered.
+   * @param connection The connection information. See RtcConnection .
+   * @param elapsed The time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.
    */
   onRejoinChannelSuccess?(connection: RtcConnection, elapsed: number): void;
 
   /**
    * Reports the proxy connection state.
-   * You can use this callback to listen for the state of the SDK connecting to a proxy. For example, when a user calls setCloudProxy and joins a channel successfully, the SDK triggers this callback to report the user ID, the proxy type connected, and the time elapsed fromthe user calling joinChannel [1/2] until this callback is triggered.
+   * You can use this callback to listen for the state of the SDK connecting to a proxy. For example, when a user calls setCloudProxy and joins a channel successfully, the SDK triggers this callback to report the user ID, the proxy type connected, and the time elapsed fromthe user calling joinChannel until this callback is triggered.
    *
    * @param channel The channel name.
-   *
    * @param uid The user ID.
-   *
    * @param proxyType The proxy type connected. See CloudProxyType .
-   *
    * @param localProxyIp Reserved for future use.
-   *
-   * @param elapsed The time elapsed (ms) from the user calling joinChannel [1/2] until this callback is triggered.
+   * @param elapsed The time elapsed (ms) from the user calling joinChannel until this callback is triggered.
    */
   onProxyConnected?(
     channel: string,
@@ -1247,7 +1336,6 @@ export interface IRtcEngineEventHandler {
    * This callback indicates that an error (concerning network or media) occurs during SDK runtime. In most cases, the SDK cannot fix the issue and resume running. The SDK requires the application to take action or informs the user about the issue.
    *
    * @param err Error code. See ErrorCodeType .
-   *
    * @param msg The error message.
    */
   onError?(err: ErrorCodeType, msg: string): void;
@@ -1257,21 +1345,9 @@ export interface IRtcEngineEventHandler {
    * Deprecated:Please use onRemoteAudioStats instead.The SDK triggers this callback once every two seconds to report the audio quality of each remote user/host sending an audio stream. If a channel has multiple users/hosts sending audio streams, the SDK triggers this callback as many times.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param remoteUid The user ID of the remote user sending the audio stream.
-   *
-   * @param quality Audio quality of the user.
-   *  QualityUnknown(0): The quality is unknown.
-   *  QualityExcellent(1): The quality is excellent.
-   *  QualityGood(2): The network quality seems excellent, but the bitrate can be slightly lower than excellent.
-   *  QualityPoor(3): Users can feel the communication is slightly impaired.
-   *  QualityBad(4): Users cannot communicate smoothly.
-   *  QualityVbad(5): The quality is so bad that users can barely communicate.
-   *  QualityDown(6): The network is down, and users cannot communicate at all.
-   *  See QualityType .
-   *
+   * @param quality Audio quality of the user. QualityUnknown(0): The quality is unknown.QualityExcellent(1): The quality is excellent.QualityGood(2): The network quality seems excellent, but the bitrate can be slightly lower than excellent.QualityPoor(3): Users can feel the communication is slightly impaired.QualityBad(4): Users cannot communicate smoothly.QualityVbad(5): The quality is so bad that users can barely communicate.QualityDown(6): The network is down, and users cannot communicate at all.See QualityType .
    * @param delay The network delay (ms) from the sender to the receiver, including the delay caused by audio sampling pre-processing, network transmission, and network jitter buffering.
-   *
    * @param lost The packet loss rate (%) of the audio packet sent from the remote user.
    */
   onAudioQuality?(
@@ -1292,15 +1368,12 @@ export interface IRtcEngineEventHandler {
 
   /**
    * Reports the volume information of users.
-   * By default, this callback is disabled. You can enable it by calling enableAudioVolumeIndication . Once this callback is enabled and users send streams in the channel, the SDK triggers the onAudioVolumeIndication callback according to the time interval set in enableAudioVolumeIndication. The SDK triggers two independent onAudioVolumeIndication callbacks simultaneously, which separately report the volume information of the local user who sends a stream and the remote users (up to three) whose instantaneous volume is the highest.Once this callback is enabled, if the local user calls the muteLocalAudioStream method for mute, the SDK continues to report the volume indication of the local user.20 seconds after a remote user whose volume is one of the three highest in the channel stops publishing the audio stream, the callback excludes this user's information; 20 seconds after all remote users stop publishing audio streams, the SDK stops triggering the callback for remote users.
+   * By default, this callback is disabled. You can enable it by calling enableAudioVolumeIndication . Once this callback is enabled and users send streams in the channel, the SDK triggers the onAudioVolumeIndication callback according to the time interval set in enableAudioVolumeIndication. The SDK triggers two independent onAudioVolumeIndication callbacks simultaneously, which separately report the volume information of the local user who sends a stream and the remote users (up to three) whose instantaneous volume is the highest.Once this callback is enabled, if the local user calls the muteLocalAudioStream method for muting, the SDK continues to report the volume indication of the local user. In the callbacks triggered, the volume information about the local user is 0 If a remote user whose volume is one of the three highest in the channel stops publishing the audio stream for 20 seconds, the callback excludes this user's information; if all remote users stop publishing audio streams for 20 seconds, the SDK stops triggering the callback for remote users.
    *
    * @param connection The connection information. See RtcConnection .
-   *
-   * @param speakers The volume information of the users. See AudioVolumeInfo . An empty speakers array in the callback indicates that no remote user is in the channel or sending a stream at the moment.
-   *
+   * @param speakers The volume information of the users, see AudioVolumeInfo . An empty speakers array in the callback indicates that no remote user is in the channel or is sending a stream.
    * @param speakerNumber The total number of users.In the callback for the local user, if the local user is sending streams, the value of speakerNumber is 1.In the callback for remote users, the value range of speakerNumber is [0,3]. If the number of remote users who send streams is greater than or equal to three, the value of speakerNumber is 3.
-   *
-   * @param totalVolume The volume of the speaker. The value ranges between 0 (lowest volume) and 255 (highest volume).In the callback for the local user, totalVolume is the volume of the local user who sends a stream.In the callback for remote users, totalVolume is the sum of the volume of the remote users (up to three) whose instantaneous volume are the highest.
+   * @param totalVolume The volume of the speaker. The value range is [0,255].In the callback for the local user, totalVolume is the volume of the local user who sends a stream.In the callback for remote users, totalVolume is the sum of the volume of all remote users (up to three) whose instantaneous volume is the highest.
    */
   onAudioVolumeIndication?(
     connection: RtcConnection,
@@ -1314,7 +1387,6 @@ export interface IRtcEngineEventHandler {
    * This callback notifies the app that the user leaves the channel by calling leaveChannel . From this callback, the app can get information such as the call duration and quality statistics.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param stats The statistics of the call. See RtcStats .
    */
   onLeaveChannel?(connection: RtcConnection, stats: RtcStats): void;
@@ -1324,29 +1396,30 @@ export interface IRtcEngineEventHandler {
    * The SDK triggers this callback once every two seconds after the user joins the channel.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param stats Statistics of the RTC engine. See RtcStats .
+   *
    */
   onRtcStats?(connection: RtcConnection, stats: RtcStats): void;
 
   /**
-   * Occurs when the audio device state changes.
-   * This callback notifies the application that the system's audio device state is changed. For example, a headset is unplugged from the device.This method is for Windows and macOS only.
-   *
-   * @param deviceState Media device states.
+   * Occurs when the video device state changes.
+   * This callback reports the change of system video devices, such as being unplugged or removed. On a Windows device with an external camera for video capturing, the video disables once the external camera is unplugged.This callback is for Windows and macOS only.
    *
    * @param deviceId The device ID.
-   *
-   * @param deviceType The device type. See MediaDeviceType .
+   * @param deviceType Media device types. See MediaDeviceType .
+   * @param deviceState Media device states.
    */
   onAudioDeviceStateChanged?(
     deviceId: string,
     deviceType: MediaDeviceType,
-    deviceState: number
+    deviceState: MediaDeviceStateType
   ): void;
 
   /**
-   * @ignore
+   * Reports current playback progress.
+   * When playing media files, the SDK triggers this callback every one second to report current playback progress.
+   *
+   * @param position The playback position (ms) of media files.
    */
   onAudioMixingPositionChanged?(position: number): void;
 
@@ -1369,15 +1442,13 @@ export interface IRtcEngineEventHandler {
    * This callback reports the change of system video devices, such as being unplugged or removed. On a Windows device with an external camera for video capturing, the video disables once the external camera is unplugged.This callback is for Windows and macOS only.
    *
    * @param deviceId The device ID.
-   *
    * @param deviceType Media device types. See MediaDeviceType .
-   *
    * @param deviceState Media device states.
    */
   onVideoDeviceStateChanged?(
     deviceId: string,
     deviceType: MediaDeviceType,
-    deviceState: number
+    deviceState: MediaDeviceStateType
   ): void;
 
   /**
@@ -1385,11 +1456,8 @@ export interface IRtcEngineEventHandler {
    * This callback reports the last mile network conditions of each user in the channel. Last mile refers to the connection between the local device and Agora's edge server.The SDK triggers this callback once every two seconds. If a channel includes multiple users, the SDK triggers this callback as many times.txQuality is Unknown when the user is not sending a stream; rxQuality is Unknown when the user is not receiving a stream.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param remoteUid The user ID. The network quality of the user with this user ID is reported.
-   *
    * @param txQuality Uplink network quality rating of the user in terms of the transmission bit rate, packet loss rate, average RTT (Round-Trip Time) and jitter of the uplink network. This parameter is a quality rating helping you understand how well the current uplink network conditions can support the selected video encoder configuration. For example, a 1000 Kbps uplink network may be adequate for video frames with a resolution of 640 × 480 and a frame rate of 15 fps in the LIVE_BROADCASTING profile, but may be inadequate for resolutions higher than 1280 × 720. QualityUnknown(0): The quality is unknown.QualityExcellent(1): The quality is excellent.QualityGood(2): The network quality seems excellent, but the bitrate can be slightly lower than excellent.QualityPoor(3): Users can feel the communication is slightly impaired.QualityBad(4): Users cannot communicate smoothly.QualityVbad(5): The quality is so bad that users can barely communicate.QualityDown(6): The network is down, and users cannot communicate at all.See QualityType .
-   *
    * @param rxQuality Downlink network quality rating of the user in terms of packet loss rate, average RTT, and jitter of the downlink network. QualityUnknown(0): The quality is unknown.QualityExcellent(1): The quality is excellent.QualityGood(2): The network quality seems excellent, but the bitrate can be slightly lower than excellent.QualityPoor(3): Users can feel the communication is slightly impaired.QualityBad(4): Users cannot communicate smoothly.QualityVbad(5): The quality is so bad that users can barely communicate.QualityDown(6): The network is down, and users cannot communicate at all.See QualityType .
    */
   onNetworkQuality?(
@@ -1400,7 +1468,13 @@ export interface IRtcEngineEventHandler {
   ): void;
 
   /**
-   * @ignore
+   * Stops recording the local audio and video.
+   * After calling startRecording , if you want to stop the recording, you must call this method; otherwise, the generated recording files may not be playable.
+   *
+   * @param connection The connection information. See RtcConnection .
+   *
+   * @returns
+   * 0: Success.< 0: Failure.-7: The method is called before IRtcEngine is initialized.
    */
   onIntraRequestReceived?(connection: RtcConnection): void;
 
@@ -1413,7 +1487,10 @@ export interface IRtcEngineEventHandler {
   onUplinkNetworkInfoUpdated?(info: UplinkNetworkInfo): void;
 
   /**
-   * @ignore
+   * Occurs when the uplink network information changes.
+   * The SDK triggers this callback when the uplink network information changes.This callback only applies to scenarios where you push externally encoded video data in H.264 format to the SDK.
+   *
+   * @param info The uplink network information. See UplinkNetworkInfo .
    */
   onDownlinkNetworkInfoUpdated?(info: DownlinkNetworkInfo): void;
 
@@ -1430,31 +1507,24 @@ export interface IRtcEngineEventHandler {
    * The SDK triggers this callback when the first local video frame is displayed on the local video view.
    *
    * @param source The capture type of the custom video source. See VideoSourceType .
-   *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param width The width (px) of the first local video frame.
-   *
    * @param height The height (px) of the first local video frame.
-   *
-   * @param elapsed Time elapsed (ms) from the local user calling joinChannel [2/2] until the SDK triggers this callback. If you call startPreview before calling joinChannel [2/2], then this parameter is the time elapsed from calling the startPreview method until the SDK triggers this callback.
+   * @param elapsed Time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback. If you call startPreview before calling joinChannel, then this parameter is the time elapsed from calling the startPreview method until the SDK triggers this callback.
    */
   onFirstLocalVideoFrame?(
-    connection: RtcConnection,
+    source: VideoSourceType,
     width: number,
     height: number,
     elapsed: number
   ): void;
 
   /**
-   * Occurs when the first video frame is published.
-   * The SDK triggers this callback under one of the following circumstances:The local client enables the video module and calls joinChannel [2/2] successfully.The local client calls muteLocalVideoStream (true) and muteLocalVideoStream(false) in sequence.The local client calls disableVideo and enableVideo in sequence.
-   *
-   * @param source The capture type of the custom video source. See VideoSourceType .
+   * Occurs when a user joins a channel.
+   * This callback notifies the application that a user joins a specified channel.
    *
    * @param connection The connection information. See RtcConnection .
-   *
-   * @param elapsed Time elapsed (ms) from the local user calling joinChannel [2/2] until the SDK triggers this callback.
+   * @param elapsed The time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.
    */
   onFirstLocalVideoFramePublished?(
     connection: RtcConnection,
@@ -1466,14 +1536,10 @@ export interface IRtcEngineEventHandler {
    * The SDK triggers this callback under one of the following circumstances:The remote user joins the channel and sends the video stream.The remote user stops sending the video stream and re-sends it after 15 seconds. Reasons for such an interruption include:The remote user leaves the channel.The remote user drops offline.The remote user calls muteLocalVideoStream to stop sending the video stream.The remote user calls disableVideo to disable video.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param remoteUid The ID of the remote user sending the video stream.
-   *
    * @param width The width (px) of the video stream.
-   *
    * @param height The height (px) of the video stream.
-   *
-   * @param elapsed The time elapsed (ms) from the local user calling joinChannel [2/2] until the SDK triggers this callback.
+   * @param elapsed The time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.
    */
   onFirstRemoteVideoDecoded?(
     connection: RtcConnection,
@@ -1487,15 +1553,10 @@ export interface IRtcEngineEventHandler {
    * Occurs when the video size or rotation of a specified user changes.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param sourceType The capture type of the custom video source. See VideoSourceType .
-   *
    * @param uid The ID of the user whose video size or rotation changes. (The uid for the local user is 0. The video is the local user's video preview).
-   *
    * @param width The width (pixels) of the video stream.
-   *
    * @param height The height (pixels) of the video stream.
-   *
    * @param rotation The rotation information. The value range is [0,360).
    */
   onVideoSizeChanged?(
@@ -1512,9 +1573,7 @@ export interface IRtcEngineEventHandler {
    * When the state of the local video stream changes (including the state of the video capture and encoding), the SDK triggers this callback to report the current state. This callback indicates the state of the local video stream, including camera capturing and video encoding, and allows you to troubleshoot issues when exceptions occur.The SDK triggers the onLocalVideoStateChanged callback with the state code of LocalVideoStreamStateFailed and error code of LocalVideoStreamErrorCaptureFailure in the following situations:The camera starts normally, but does not output video frames for four consecutive seconds.When the camera outputs the captured video frames, if the video frames are the same for 15 consecutive frames, the SDK triggers the onLocalVideoStateChanged callback with the state code of LocalVideoStreamStateCapturing and error code of LocalVideoStreamErrorCaptureFailure. Note that the video frame duplication detection is only available for video frames with a resolution greater than 200 × 200, a frame rate greater than or equal to 10 fps, and a bitrate less than 20 Kbps.For some device models, the SDK does not trigger this callback when the state of the local video changes while the local video capturing device is in use, so you have to make your own timeout judgment.
    *
    * @param source The capture type of the custom video source. See VideoSourceType .
-   *
    * @param state The state of the local video, see LocalVideoStreamState .
-   *
    * @param error The detailed error information, see LocalVideoStreamError .
    */
   onLocalVideoStateChanged?(
@@ -1528,14 +1587,10 @@ export interface IRtcEngineEventHandler {
    * This callback does not work properly when the number of users (in the communication profile) or hosts (in the live streaming channel) in a channel exceeds 17.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param remoteUid The ID of the remote user whose video state changes.
-   *
    * @param state The state of the remote video, see RemoteVideoState .
-   *
    * @param reason The reason for the remote video state change, see RemoteVideoStateReason .
-   *
-   * @param elapsed Time elapsed (ms) from the local user calling the joinChannel [2/2] method until the SDK triggers this callback.
+   * @param elapsed Time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback.
    */
   onRemoteVideoStateChanged?(
     connection: RtcConnection,
@@ -1546,17 +1601,14 @@ export interface IRtcEngineEventHandler {
   ): void;
 
   /**
-   * Occurs when the renderer receives the first frame of the remote video.
-   *
-   * @param remoteUid The ID of the remote user sending the video stream.
+   * Occurs when the first remote video frame is received and decoded.
+   * The SDK triggers this callback under one of the following circumstances:The remote user joins the channel and sends the video stream.The remote user stops sending the video stream and re-sends it after 15 seconds. Reasons for such an interruption include:The remote user leaves the channel.The remote user drops offline.The remote user calls muteLocalVideoStream to stop sending the video stream.The remote user calls disableVideo to disable video.
    *
    * @param connection The connection information. See RtcConnection .
-   *
+   * @param remoteUid The ID of the remote user sending the video stream.
    * @param width The width (px) of the video stream.
-   *
    * @param height The height (px) of the video stream.
-   *
-   * @param elapsed The time elapsed (ms) from the local user calling joinChannel [2/2] until the SDK triggers this callback.
+   * @param elapsed The time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.
    */
   onFirstRemoteVideoFrame?(
     connection: RtcConnection,
@@ -1568,13 +1620,11 @@ export interface IRtcEngineEventHandler {
 
   /**
    * Occurs when a remote user (COMMUNICATION)/ host (LIVE_BROADCASTING) 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 by calling the joinChannel [2/2] method.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 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 by calling the joinChannel method.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.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param remoteUid The ID of the user or host who joins the channel.
-   *
-   * @param elapsed Time delay (ms) from the local user calling joinChannel [2/2] until this callback is triggered.
+   * @param elapsed Time delay (ms) from the local user calling joinChannel until this callback is triggered.
    */
   onUserJoined?(
     connection: RtcConnection,
@@ -1587,9 +1637,7 @@ export interface IRtcEngineEventHandler {
    * 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.
    *
    * @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 .
    */
   onUserOffline?(
@@ -1603,9 +1651,7 @@ export interface IRtcEngineEventHandler {
    * The SDK triggers this callback when the remote user stops or resumes sending the audio stream by calling the muteLocalAudioStream method.This callback does not work properly when the number of users (in the communication profile) or hosts (in the live streaming channel) in a channel exceeds 17.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param remoteUid The user ID.
-   *
    * @param muted Whether the remote user's audio stream is muted:true: User's audio stream is muted.false: User's audio stream is unmuted.
    */
   onUserMuteAudio?(
@@ -1619,9 +1665,7 @@ export interface IRtcEngineEventHandler {
    * When a remote user calls muteLocalVideoStream to stop or resume publishing the video stream, the SDK triggers this callback to report to the local user the state of the streams published by the remote user.This callback can be inaccurate when the number of users (in the communication profile) or hosts (in the live streaming profile) in a channel exceeds 17.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param remoteUid The user ID of the remote user.
-   *
    * @param muted Whether the remote user stops publishing the video stream:true: The remote user stops publishing the video stream.false: The remote user resumes publishing the video stream.
    */
   onUserMuteVideo?(
@@ -1635,9 +1679,7 @@ export interface IRtcEngineEventHandler {
    * Once the video module is disabled, the user can only use a voice call. The user cannot send or receive any video.The SDK triggers this callback when a remote user enables or disables the video module by calling the enableVideo or disableVideo method.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param remoteUid The user ID of the remote user.
-   *
    * @param enabled true: The video module is enabled.false: The video module is disabled.
    */
   onUserEnableVideo?(
@@ -1660,9 +1702,7 @@ export interface IRtcEngineEventHandler {
    * The SDK triggers this callback when the remote user resumes or stops capturing the video stream by calling the enableLocalVideo method.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param remoteUid The user ID of the remote user.
-   *
    * @param enabled Whether the specified remote user enables/disables the local video capturing function:true: Enable. Other users in the channel can see the video of this remote user.false: Disable. Other users in the channel can no longer receive the video stream from this remote user, while this remote user can still receive the video streams from other users.
    */
   onUserEnableLocalVideo?(
@@ -1671,24 +1711,11 @@ export interface IRtcEngineEventHandler {
     enabled: boolean
   ): void;
 
-  /**
-   * Occurs when a method is executed by the SDK.
-   * Deprecated:Deprecated as of v4.1.0. This method can neither accurately characterize the specific API method nor represent the execution result of the API.Agora recommends getting the results of the API implementation through relevant channels and media callbacks. For example, after calling the enableLocalAudio method to enable the microphone, the status of the microphone is returned in the onLocalAudioStateChanged callback.
-   *
-   * @param err The error code returned by the SDK when the method call fails. If the SDK returns 0, then the method call is successful.
-   *
-   * @param api The method executed by the SDK.
-   *
-   * @param result The result of the method call.
-   */
-  onApiCallExecuted?(err: ErrorCodeType, api: string, result: string): void;
-
   /**
    * Reports the statistics of the local audio stream.
    * The SDK triggers this callback once every two seconds.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param stats Local audio statistics. See LocalAudioStats .
    */
   onLocalAudioStats?(connection: RtcConnection, stats: LocalAudioStats): void;
@@ -1698,20 +1725,16 @@ export interface IRtcEngineEventHandler {
    * The SDK triggers this callback once every two seconds. If a channel includes multiple users, the SDK triggers this callback as many times.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param stats Statistics of the received remote audio stream. See RemoteAudioStats .
    */
   onRemoteAudioStats?(connection: RtcConnection, stats: RemoteAudioStats): void;
 
   /**
-   * Reports the statistics of the local video stream.
-   * The SDK triggers this callback once every two seconds to report the statistics of the local video stream.
-   *
-   * @param source The capture type of the custom video source. See VideoSourceType .
+   * Reports the statistics of the video stream sent by each remote users.
+   * Reports the statistics of the video stream from the remote users. The SDK triggers this callback once every two seconds for each remote user. If a channel has multiple users/hosts sending video streams, the SDK triggers this callback as many times.
    *
    * @param connection The connection information. See RtcConnection .
-   *
-   * @param stats The statistics of the local video stream. See LocalVideoStats .
+   * @param stats Statistics of the remote video stream.
    */
   onLocalVideoStats?(connection: RtcConnection, stats: LocalVideoStats): void;
 
@@ -1720,7 +1743,6 @@ export interface IRtcEngineEventHandler {
    * Reports the statistics of the video stream from the remote users. The SDK triggers this callback once every two seconds for each remote user. If a channel has multiple users/hosts sending video streams, the SDK triggers this callback as many times.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param stats Statistics of the remote video stream.
    */
   onRemoteVideoStats?(connection: RtcConnection, stats: RemoteVideoStats): void;
@@ -1773,7 +1795,6 @@ export interface IRtcEngineEventHandler {
    * This callback occurs when the playback state of the music file changes, and reports the current state and error code.
    *
    * @param state The playback state of the music file. See AudioMixingStateType .
-   *
    * @param reason Error code. See AudioMixingReasonType .
    */
   onAudioMixingStateChanged?(
@@ -1791,7 +1812,7 @@ export interface IRtcEngineEventHandler {
 
   /**
    * Occurs when the SDK cannot reconnect to Agora's edge server 10 seconds after its connection to the server is interrupted.
-   * The SDK triggers this callback when it cannot connect to the server 10 seconds after calling the joinChannel [2/2] method, regardless of whether it is in the channel. If the SDK fails to rejoin the channel within 20 minutes after disconnecting, the SDK will stop trying to reconnect.
+   * The SDK triggers this callback when it cannot connect to the server 10 seconds after calling the joinChannel method, regardless of whether it is in the channel. If the SDK fails to rejoin the channel within 20 minutes after disconnecting, the SDK will stop trying to reconnect.
    *
    * @param connection The connection information. See RtcConnection .
    */
@@ -1818,15 +1839,10 @@ export interface IRtcEngineEventHandler {
    * The SDK triggers this callback when the local user receives the stream message that the remote user sends by calling the sendStreamMessage method.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param remoteUid The ID of the remote user sending the message.
-   *
    * @param streamId The stream ID of the received message.
-   *
    * @param data received data.
-   *
    * @param length The data length (byte).
-   *
    * @param sentTs The time when the data stream is sent.
    */
   onStreamMessage?(
@@ -1843,15 +1859,10 @@ export interface IRtcEngineEventHandler {
    * The SDK triggers this callback when the local user fails to receive the stream message that the remote user sends by calling the sendStreamMessage method.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param uid The ID of the remote user sending the message.
-   *
    * @param streamId The stream ID of the received message.
-   *
    * @param code The error code.
-   *
    * @param missed The number of lost messages.
-   *
    * @param cached Number of incoming cached messages when the data stream is interrupted.
    */
   onStreamMessageError?(
@@ -1865,7 +1876,7 @@ export interface IRtcEngineEventHandler {
 
   /**
    * Occurs when the token expires.
-   * When the token expires during a call, the SDK triggers this callback to remind the app to renew the token.Once you receive this callback, generate a new token on your app server, and call joinChannel [2/2] to rejoin the channel.
+   * When the token expires during a call, the SDK triggers this callback to remind the app to renew the token.Once you receive this callback, generate a new token on your app server, and call joinChannel to rejoin the channel.
    *
    * @param connection The connection information. See RtcConnection .
    */
@@ -1876,7 +1887,6 @@ export interface IRtcEngineEventHandler {
    * When the token is about to expire in 30 seconds, the SDK triggers this callback to remind the app to renew the token.Upon receiving this callback, generate a new token on your server, and call renewToken to pass the new token to the SDK.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param token The token that expires in 30 seconds.
    */
   onTokenPrivilegeWillExpire?(connection: RtcConnection, token: string): void;
@@ -1891,11 +1901,10 @@ export interface IRtcEngineEventHandler {
 
   /**
    * Occurs when the first audio frame is published.
-   * The SDK triggers this callback under one of the following circumstances:The local client enables the audio module and calls joinChannel [2/2] successfully.The local client calls muteLocalAudioStream (true) and muteLocalAudioStream(false) in sequence.The local client calls disableAudio and enableAudio in sequence.
+   * The SDK triggers this callback under one of the following circumstances:The local client enables the audio module and calls joinChannel successfully.The local client calls muteLocalAudioStream (true) and muteLocalAudioStream(false) in sequence.The local client calls disableAudio and enableAudio in sequence.
    *
    * @param connection The connection information. See RtcConnection .
-   *
-   * @param elapsed Time elapsed (ms) from the local user calling joinChannel [2/2] until the SDK triggers this callback.
+   * @param elapsed Time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.
    */
   onFirstLocalAudioFramePublished?(
     connection: RtcConnection,
@@ -1907,10 +1916,8 @@ export interface IRtcEngineEventHandler {
    * Deprecated:Use onRemoteAudioStateChanged instead.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param userId The ID of the remote user sending the audio frames.
-   *
-   * @param elapsed The time elapsed (ms) from the local user calling the joinChannel [2/2] method until the SDK triggers this callback.
+   * @param elapsed The time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback.
    */
   onFirstRemoteAudioFrame?(
     connection: RtcConnection,
@@ -1923,10 +1930,8 @@ export interface IRtcEngineEventHandler {
    * Deprecated:Use onRemoteAudioStateChanged instead.The SDK triggers this callback under one of the following circumstances:The remote user joins the channel and sends the audio stream.The remote user stops sending the audio stream and re-sends it after 15 seconds, and the possible reasons include:The remote user leaves the channel.The remote user is offline.The remote user calls muteLocalAudioStream to stop sending the video stream.The remote user calls disableAudio to disable video.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param uid The user ID of the remote user.
-   *
-   * @param elapsed The time elapsed (ms) from the local user calling the joinChannel [2/2] method until the SDK triggers this callback.
+   * @param elapsed The time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback.
    */
   onFirstRemoteAudioDecoded?(
     connection: RtcConnection,
@@ -1939,9 +1944,7 @@ export interface IRtcEngineEventHandler {
    * When the state of the local audio stream changes (including the state of the audio capture and encoding), the SDK triggers this callback to report the current state. This callback indicates the state of the local audio stream, and allows you to troubleshoot issues when audio exceptions occur.When the state is LocalAudioStreamStateFailed (3), you can view the error information in the error parameter.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param state The state of the local audio. See LocalAudioStreamState .
-   *
    * @param error Local audio state error codes. See LocalAudioStreamError .
    */
   onLocalAudioStateChanged?(
@@ -1955,14 +1958,10 @@ export interface IRtcEngineEventHandler {
    * When the audio state of a remote user (in a voice/video call channel) or host (in a live streaming channel) changes, the SDK triggers this callback to report the current state of the remote audio stream.This callback does not work properly when the number of users (in the communication profile) or hosts (in the live streaming channel) in a channel exceeds 17.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param remoteUid The ID of the remote user whose audio state changes.
-   *
    * @param state The state of the remote audio. See RemoteAudioState .
-   *
    * @param reason The reason of the remote audio state change. See RemoteAudioStateReason .
-   *
-   * @param elapsed Time elapsed (ms) from the local user calling the joinChannel [2/2] method until the SDK triggers this callback.
+   * @param elapsed Time elapsed (ms) from the local user calling the joinChannel method until the SDK triggers this callback.
    */
   onRemoteAudioStateChanged?(
     connection: RtcConnection,
@@ -1977,7 +1976,6 @@ export interface IRtcEngineEventHandler {
    * After a successful call of enableAudioVolumeIndication , the SDK continuously detects which remote user has the loudest volume. During the current period, the remote user, who is detected as the loudest for the most times, is the most active user.When the number of users is no less than two and an active remote speaker exists, the SDK triggers this callback and reports the uid of the most active remote speaker.If the most active remote speaker is always the same user, the SDK triggers the onActiveSpeaker callback only once.If the most active remote speaker changes to another user, the SDK triggers this callback again and reports the uid of the new active remote speaker.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param uid The user ID of the most active remote speaker.
    */
   onActiveSpeaker?(connection: RtcConnection, uid: number): void;
@@ -1992,15 +1990,10 @@ export interface IRtcEngineEventHandler {
    * After a successful takeSnapshot method call, the SDK triggers this callback to report whether the snapshot is successfully taken as well as the details for the snapshot taken.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param uid The user ID. One uid of 0 indicates the local user.
-   *
    * @param filePath The local path of the snapshot.
-   *
    * @param width The width (px) of the snapshot.
-   *
    * @param height The height (px) of the snapshot.
-   *
    * @param errCode The message that confirms success or gives the reason why the snapshot is not successfully taken:0: Success.< 0: Failure:-1: The SDK fails to write data to a file or encode a JPEG image.-2: The SDK does not find the video stream of the specified user within one second after the takeSnapshot method call succeeds. The possible reasons are: local capture stops, remote end stops publishing, or video data processing is blocked.-3: Calling the takeSnapshot method too frequently.
    */
   onSnapshotTaken?(
@@ -2017,11 +2010,8 @@ export interface IRtcEngineEventHandler {
    * The SDK triggers this callback when the local user switches their user role by calling setClientRole after joining the channel.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param oldRole Role that the user switches from: ClientRoleType .
-   *
    * @param newRole Role that the user switches to: ClientRoleType .
-   *
    * @param newRoleOptions Properties of the role that the user switches to. See ClientRoleOptions .
    */
   onClientRoleChanged?(
@@ -2036,9 +2026,7 @@ export interface IRtcEngineEventHandler {
    * In the live broadcasting channel profile, when the local user calls setClientRole [1/2] to switch their user role after joining the channel but the switch fails, the SDK triggers this callback to report the reason for the failure and the current user role.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param reason The reason for a user role switch failure. See ClientRoleChangeFailedReason .
-   *
    * @param currentRole Current user role. See ClientRoleType .
    */
   onClientRoleChangeFailed?(
@@ -2052,9 +2040,7 @@ export interface IRtcEngineEventHandler {
    * Occurs when the volume on the playback device, audio capture device, or the volume in the application changes.This callback is for Windows and macOS only.
    *
    * @param deviceType The device type. See MediaDeviceType .
-   *
    * @param volume The volume value. The range is [0, 255].
-   *
    * @param muted Whether the audio device is muted:true: The audio device is muted.false: The audio device is not muted.
    */
   onAudioDeviceVolumeChanged?(
@@ -2068,9 +2054,7 @@ export interface IRtcEngineEventHandler {
    * When the media push state changes, the SDK triggers this callback and reports the URL address and the current state of the media push. This callback indicates the state of the media push. When exceptions occur, you can troubleshoot issues by referring to the detailed error descriptions in the error code parameter.
    *
    * @param url The URL address where the state of the media push changes.
-   *
    * @param state The current state of the media push. See RtmpStreamPublishState .
-   *
    * @param errCode The detailed error information for the media push. See RtmpStreamPublishErrorType .
    */
   onRtmpStreamingStateChanged?(
@@ -2083,7 +2067,6 @@ export interface IRtcEngineEventHandler {
    * Reports events during the media push.
    *
    * @param url The URL of media push.
-   *
    * @param eventCode The event code of media push. See RtmpStreamingEvent .
    */
   onRtmpStreamingEvent?(url: string, eventCode: RtmpStreamingEvent): void;
@@ -2108,7 +2091,6 @@ export interface IRtcEngineEventHandler {
    * The SDK returns the state of the current media relay with any error message.
    *
    * @param state The state code. See ChannelMediaRelayState .
-   *
    * @param code The error code of the channel media relay. See ChannelMediaRelayError .
    */
   onChannelMediaRelayStateChanged?(
@@ -2138,16 +2120,12 @@ export interface IRtcEngineEventHandler {
 
   /**
    * Reports the transport-layer statistics of each remote audio stream.
-   * Deprecated:Please use onRemoteAudioStats instead.This callback reports the transport-layer statistics, such as the packet loss rate and network time delay after the local user receives an audio packet from a remote user. During a call, when the user receives the audio packet sent by the remote user, the callback is triggered every 2 seconds.
+   * Deprecated:Use onRemoteAudioStats instead.This callback reports the transport-layer statistics, such as the packet loss rate and network time delay after the local user receives an audio packet from a remote user. During a call, when the user receives the audio packet sent by the remote user, the callback is triggered every 2 seconds.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param remoteUid The ID of the remote user sending the audio streams.
-   *
    * @param delay The network delay (ms) from the remote user to the receiver.
-   *
    * @param lost The packet loss rate (%) of the audio packet sent from the remote user to the receiver.
-   *
    * @param rxKBitrate The bitrate of the received audio (Kbps).
    */
   onRemoteAudioTransportStats?(
@@ -2163,13 +2141,9 @@ export interface IRtcEngineEventHandler {
    * Deprecated:This callback is deprecated; use onRemoteVideoStats instead.This callback reports the transport-layer statistics, such as the packet loss rate and network time delay, once every two seconds after the local user receives a video packet from a remote user.During a call, when the user receives the video packet sent by the remote user/host, the callback is triggered every 2 seconds.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param remoteUid The ID of the remote user sending the video packets.
-   *
    * @param delay The network delay (ms) from the sender to the receiver.
-   *
    * @param lost The packet loss rate (%) of the video packet sent from the remote user.
-   *
    * @param rxKBitRate The bitrate of the received video (Kbps).
    */
   onRemoteVideoTransportStats?(
@@ -2185,7 +2159,6 @@ export interface IRtcEngineEventHandler {
    * When the network connection state changes, the SDK triggers this callback and reports the current connection state and the reason for the change.
    *
    * @param state The current connection state.
-   *
    * @param reason The reason for a connection state change.
    */
   onConnectionStateChanged?(
@@ -2218,7 +2191,6 @@ export interface IRtcEngineEventHandler {
    * This callback occurs when the connection state of the local user changes. You can get the connection state and reason for the state change in this callback. When the network connection is interrupted, this callback indicates whether the interruption is caused by a network type change or poor network conditions.
    *
    * @param connection The connection information. See RtcConnection .
-   *
    * @param type The type of the local network connection. See NetworkType .
    */
   onNetworkTypeChanged?(connection: RtcConnection, type: NetworkType): void;
@@ -2229,7 +2201,6 @@ export interface IRtcEngineEventHandler {
    *
    * @param connection The connection information. See RtcConnection .
    *
-   * @param errorType
    */
   onEncryptionError?(
     connection: RtcConnection,
@@ -2249,7 +2220,6 @@ export interface IRtcEngineEventHandler {
    * After the local user successfully calls registerLocalUserAccount to register the user account or calls joinChannelWithUserAccount to join a channel, the SDK triggers the callback and informs the local user's UID and User Account.
    *
    * @param uid The ID of the local user.
-   *
    * @param userAccount The user account of the local user.
    */
   onLocalUserRegistered?(uid: number, userAccount: string): void;
@@ -2259,7 +2229,6 @@ export interface IRtcEngineEventHandler {
    * After a remote user joins the channel, the SDK gets the UID and user account of the remote user, caches them in a mapping table object, and triggers this callback on the local client.
    *
    * @param uid The user ID of the remote user.
-   *
    * @param info The UserInfo object that contains the user ID and user account of the remote user. See UserInfo for details.
    */
   onUserInfoUpdated?(uid: number, info: UserInfo): void;
@@ -2278,13 +2247,9 @@ export interface IRtcEngineEventHandler {
    * Occurs when the audio subscribing state changes.
    *
    * @param channel The channel name.
-   *
    * @param uid The user ID of the remote user.
-   *
    * @param oldState The previous subscribing status, see StreamSubscribeState for details.
-   *
    * @param newState The current subscribing status, see StreamSubscribeState for details.
-   *
    * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state.
    */
   onAudioSubscribeStateChanged?(
@@ -2299,13 +2264,9 @@ export interface IRtcEngineEventHandler {
    * Occurs when the video subscribing state changes.
    *
    * @param channel The channel name.
-   *
    * @param uid The ID of the remote user.
-   *
    * @param oldState The previous subscribing status, see StreamSubscribeState for details.
-   *
    * @param newState The current subscribing status, see StreamSubscribeState for details.
-   *
    * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state.
    */
   onVideoSubscribeStateChanged?(
@@ -2320,11 +2281,8 @@ export interface IRtcEngineEventHandler {
    * Occurs when the audio publishing state changes.
    *
    * @param channel The channel name.
-   *
    * @param oldState The previous subscribing status. See StreamPublishState .
-   *
    * @param newState The current subscribing status. See StreamPublishState.
-   *
    * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state.
    */
   onAudioPublishStateChanged?(
@@ -2337,14 +2295,10 @@ export interface IRtcEngineEventHandler {
   /**
    * Occurs when the video publishing state changes.
    *
-   * @param channel The channel name.
-   *
    * @param source The capture type of the custom video source. See VideoSourceType .
-   *
+   * @param channel The channel name.
    * @param oldState For the previous publishing state, see StreamPublishState .
-   *
    * @param newState For the current publishing state, see StreamPublishState.
-   *
    * @param elapseSinceLastState The time elapsed (ms) from the previous state to the current state.
    */
   onVideoPublishStateChanged?(
@@ -2359,13 +2313,10 @@ export interface IRtcEngineEventHandler {
    * The event callback of the extension.
    * To listen for events while the extension is running, you need to register this callback.
    *
-   * @param value The value of the extension key.
-   *
-   * @param key The key of the extension.
-   *
    * @param provider The name of the extension provider.
-   *
    * @param extension The name of the extension.
+   * @param key The key of the extension.
+   * @param value The value of the extension key.
    */
   onExtensionEvent?(
     provider: string,
@@ -2379,7 +2330,6 @@ export interface IRtcEngineEventHandler {
    * After a successful call of enableExtension (true), the extension triggers this callback.
    *
    * @param provider The name of the extension provider.
-   *
    * @param extension The name of the extension.
    */
   onExtensionStarted?(provider: string, extension: string): void;
@@ -2388,9 +2338,8 @@ export interface IRtcEngineEventHandler {
    * Occurs when the extension is disabled.
    * After a successful call of enableExtension (false), this callback is triggered.
    *
-   * @param extension The name of the extension.
-   *
    * @param provider The name of the extension provider.
+   * @param extension The name of the extension.
    */
   onExtensionStopped?(provider: string, extension: string): void;
 
@@ -2399,11 +2348,8 @@ export interface IRtcEngineEventHandler {
    * When calling enableExtension (true) fails or the extension runs in error, the extension triggers this callback and reports the error code and reason.
    *
    * @param provider The name of the extension provider.
-   *
    * @param extension The name of the extension.
-   *
    * @param error Error code. For details, see the extension documentation provided by the extension provider.
-   *
    * @param message Reason. For details, see the extension documentation provided by the extension provider.
    */
   onExtensionError?(
@@ -2422,6 +2368,14 @@ export interface IRtcEngineEventHandler {
     userAccount: string
   ): void;
 
+  /**
+   * @ignore
+   */
+  onLocalVideoTranscoderError?(
+    stream: TranscodingVideoStream,
+    error: VideoTranscoderError
+  ): void;
+
   /**
    * @ignore
    */
@@ -2471,7 +2425,7 @@ export abstract class IVideoDeviceManager {
    * @param deviceIdUTF8 The ID of the video capture device.
    *
    * @returns
-   * 0: Success. Returns the number of video formats supported by this device. For example: If the specified camera supports 10 different video formats, the return value is 10.< 0: Failure.
+   * > 0: Success. Returns the number of video formats supported by this device. For example: If the specified camera supports 10 different video formats, the return value is 10.≤ 0: Failure.
    */
   abstract numberOfCapabilities(deviceIdUTF8: string): number;
 
@@ -2480,7 +2434,6 @@ export abstract class IVideoDeviceManager {
    * After calling numberOfCapabilities to get the number of video formats supported by the video capture device, you can call this method to get the specific video frame information supported by the specified index number.
    *
    * @param deviceIdUTF8 The ID of the video capture device.
-   *
    * @param deviceCapabilityNumber The index number of the video format. If the return value of numberOfCapabilities is i, the value range of this parameter is [0,i).
    *
    * @returns
@@ -2502,7 +2455,7 @@ export abstract class IVideoDeviceManager {
   abstract stopDeviceTest(): number;
 
   /**
-   * Releases all the resources occupied by the IVideoDeviceManager object.
+   * @ignore
    */
   abstract release(): void;
 }
@@ -2533,15 +2486,15 @@ export class RtcEngineContext {
   areaCode?: number;
   /**
    * The SDK log files are: agorasdk.log, agorasdk.1.log, agorasdk.2.log, agorasdk.3.log, and agorasdk.4.log.
-   * The API call log files are: agoraapi.log, agoraapi.1.log, agoraapi.2.log, agoraapi.3.log, and agoraapi.4.log.
-   * The default size for each SDK log file is 1,024 KB; the default size for each API call log file is 2,048 KB. These log files are encoded in UTF-8.
-   * The SDK writes the latest logs in agorasdk.log or agoraapi.log.
-   * When agorasdk.log is full, the SDK processes the log files in the following order:
-   * Delete the agorasdk.4.log file (if any).
-   * Rename agorasdk.3.log to agorasdk.4.log.
-   * Rename agorasdk.2.log to agorasdk.3.log.
-   * Rename agorasdk.1.log to agorasdk.2.log.
-   * Create a new agorasdk.log file. The overwrite rules for the agoraapi.log file are the same as for agorasdk.log. Sets the log file size. See LogConfig .By default, the SDK generates five SDK log files and five API call log files with the following rules:
+   *  The API call log files are: agoraapi.log, agoraapi.1.log, agoraapi.2.log, agoraapi.3.log, and agoraapi.4.log.
+   *  The default size for each SDK log file is 1,024 KB; the default size for each API call log file is 2,048 KB. These log files are encoded in UTF-8.
+   *  The SDK writes the latest logs in agorasdk.log or agoraapi.log.
+   *  When agorasdk.log is full, the SDK processes the log files in the following order:
+   *  Delete the agorasdk.4.log file (if any).
+   *  Rename agorasdk.3.log to agorasdk.4.log.
+   *  Rename agorasdk.2.log to agorasdk.3.log.
+   *  Rename agorasdk.1.log to agorasdk.2.log.
+   *  Create a new agorasdk.log file. The overwrite rules for the agoraapi.log file are the same as for agorasdk.log. Sets the log file size. See LogConfig .By default, the SDK generates five SDK log files and five API call log files with the following rules:
    */
   logConfig?: LogConfig;
   /**
@@ -2556,6 +2509,10 @@ export class RtcEngineContext {
    * Whether to enable domain name restriction:true: Enables the domain name restriction. This value is suitable for scenarios where IoT devices use IoT cards for network access. The SDK will only connect to servers in the domain name or IP whitelist that has been reported to the operator.false: (Default) Disables the domain name restriction. This value is suitable for most common scenarios.
    */
   domainLimit?: boolean;
+  /**
+   * @ignore
+   */
+  autoRegisterAgoraExtensions?: boolean;
 }
 
 /**
@@ -2625,89 +2582,89 @@ export interface IMetadataObserver {
 }
 
 /**
- * @ignore
+ * The CDN streaming error.
  */
 export enum DirectCdnStreamingError {
   /**
-   * @ignore
+   * 0: No error.
    */
   DirectCdnStreamingErrorOk = 0,
   /**
-   * @ignore
+   * 1: A general error; no specific reason. You can try to push the media stream again.
    */
   DirectCdnStreamingErrorFailed = 1,
   /**
-   * @ignore
+   * 2: An error occurs when pushing audio streams. For example, the local audio capture device is not working properly, is occupied by another process, or does not get the permission required.
    */
   DirectCdnStreamingErrorAudioPublication = 2,
   /**
-   * @ignore
+   * 3: An error occurs when pushing video streams. For example, the local video capture device is not working properly, is occupied by another process, or does not get the permission required.
    */
   DirectCdnStreamingErrorVideoPublication = 3,
   /**
-   * @ignore
+   * 4: Fails to connect to the CDN.
    */
   DirectCdnStreamingErrorNetConnect = 4,
   /**
-   * @ignore
+   * 5: The URL is already being used. Use a new URL for streaming.
    */
   DirectCdnStreamingErrorBadName = 5,
 }
 
 /**
- * @ignore
+ * The current CDN streaming state.
  */
 export enum DirectCdnStreamingState {
   /**
-   * @ignore
+   * 0: The initial state before the CDN streaming starts.
    */
   DirectCdnStreamingStateIdle = 0,
   /**
-   * @ignore
+   * 1: Streams are being pushed to the CDN. The SDK returns this value when you call the startDirectCdnStreaming method to push streams to the CDN.
    */
   DirectCdnStreamingStateRunning = 1,
   /**
-   * @ignore
+   * 2: Stops pushing streams to the CDN. The SDK returns this value when you call the stopDirectCdnStreaming method to stop pushing streams to the CDN.
    */
   DirectCdnStreamingStateStopped = 2,
   /**
-   * @ignore
+   * 3: Fails to push streams to the CDN. You can troubleshoot the issue with the information reported by the onDirectCdnStreamingStateChanged callback, and then push streams to the CDN again.
    */
   DirectCdnStreamingStateFailed = 3,
   /**
-   * @ignore
+   * 4: Tries to reconnect the Agora server to the CDN. The SDK attempts to reconnect a maximum of 10 times; if the connection is not restored, the streaming state becomes DirectCdnStreamingStateFailed.
    */
   DirectCdnStreamingStateRecovering = 4,
 }
 
 /**
- * @ignore
+ * The statistics of the current CDN streaming.
  */
 export class DirectCdnStreamingStats {
   /**
-   * @ignore
+   * The width (px) of the video frame.
    */
   videoWidth?: number;
   /**
-   * @ignore
+   * The height (px) of the video frame.
    */
   videoHeight?: number;
   /**
-   * @ignore
+   * The frame rate (fps) of the current video frame.
    */
   fps?: number;
   /**
-   * @ignore
+   * The bitrate (bps) of the current video frame.
    */
   videoBitrate?: number;
   /**
-   * @ignore
+   * The bitrate (bps) of the current audio frame.
    */
   audioBitrate?: number;
 }
 
 /**
- * @ignore
+ * The IDirectCdnStreamingEventHandler interface class is used by the SDK to send event notifications of CDN streaming to your app. Your app can get those notifications through methods that inherit this interface class.
  */
 export interface IDirectCdnStreamingEventHandler {
   /**
@@ -2726,23 +2683,23 @@ export interface IDirectCdnStreamingEventHandler {
 }
 
 /**
- * @ignore
+ * The media setting options for the host.
  */
 export class DirectCdnStreamingMediaOptions {
   /**
-   * @ignore
+   * Sets whether to publish the video captured by the camera:true: Publish the video captured by the camera.false: (Default) Do not publish the video captured by the camera.
    */
   publishCameraTrack?: boolean;
   /**
-   * @ignore
+   * Sets whether to publish the audio captured by the microphone:true: Publish the audio captured by the microphone.false: (Default) Do not publish the audio captured by the microphone.
    */
   publishMicrophoneTrack?: boolean;
   /**
-   * @ignore
+   * Sets whether to publish the captured audio from a custom source:true: Publish the captured audio from a custom source.false: (Default) Do not publish the captured audio from the custom source.
    */
   publishCustomAudioTrack?: boolean;
   /**
-   * @ignore
+   * Sets whether to publish the captured video from a custom source:true: Publish the captured video from a custom source.false: (Default) Do not publish the captured video from the custom source.
    */
   publishCustomVideoTrack?: boolean;
   /**
@@ -2754,7 +2711,7 @@ export class DirectCdnStreamingMediaOptions {
    */
   publishMediaPlayerId?: number;
   /**
-   * @ignore
+   * The video track ID returned by calling the createCustomVideoTrack method. The default value is 0.
    */
   customVideoTrackId?: number;
 }
@@ -2824,36 +2781,21 @@ export abstract class IRtcEngine {
   abstract getErrorDescription(code: number): string;
 
   /**
-   * Joins a channel.
-   * 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.
-   * 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. 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.
-   * 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.
-   *
-   * @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:
-   *  All lowercase English letters: a to z.
-   *  All uppercase English letters: A to Z.
-   *  All numeric characters: 0 to 9.
-   *  Space
-   *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
+   * @ignore
+   */
+  abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number };
+
+  /**
+   * 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.
    *
    * @param token The token generated on your server for authentication.
-   *
-   * @param info (Optional) Reserved for future use.
-   *
+   * @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:All lowercase English letters: a to z.All uppercase English letters: A to Z.All numeric characters: 0 to 9.Space"!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    * @param uid The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 232-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the onJoinChannelSuccess callback. Your application must record and maintain the returned user ID, because the SDK does not do so.
+   * @param options The channel media options. See ChannelMediaOptions .
    *
    * @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: Failes 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 recomments that you can 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.
-   * -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.
+   * 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.-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 recomments that you can 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.-121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.
    */
   abstract joinChannel(
     token: string,
@@ -2868,21 +2810,25 @@ export abstract class IRtcEngine {
    * @param options The channel media options. See ChannelMediaOptions .
    *
    * @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.-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 using the onConnectionStateChanged callback to get 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 [2/2] to join a channel before calling this method.
+   * 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.-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 recomments that you can 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.
    */
   abstract updateChannelMediaOptions(options: ChannelMediaOptions): number;
 
   /**
-   * Leaves a channel.
-   * This method releases all resources related to the session.This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.After joining the channel, you must call this method or leaveChannel to end the call, otherwise, the next call cannot be started.If you successfully call this method and leave the channel, the following callbacks are triggered:The local client: onLeaveChannel .The remote client: onUserOffline , if the user joining the channel is in the Communication profile, or is a host in the Live-broadcasting profile.If you call release immediately after calling this method, the SDK does not trigger the onLeaveChannel callback.If you have called joinChannelEx to join multiple channels, calling this method will leave the channels when calling joinChannel [2/2] and joinChannelEx at the same time.
+   * Sets channel options and leaves the channel.
+   * If you call release immediately after calling this method, the SDK does not trigger the onLeaveChannel callback.
+   *  If you have called joinChannelEx to join multiple channels, calling this method will leave the channels when calling joinChannel and joinChannelEx at the same time.
+   *  This method will release all resources related to the session, leave the channel, that is, hang up or exit the call. This method can be called whether or not a call is currently in progress.After joining the channel, you must call this method or to end the call, otherwise, the next call cannot be started.This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After actually leaving the channel, the local user triggers the onLeaveChannel callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the onUserOffline callback.
+   *
+   * @param options The options for leaving the channel. See LeaveChannelOptions .
    *
    * @returns
-   * 0: Success.< 0: Failure.-1: A general error occurs (no specified reason).-2: The parameter is invalid.-7: The SDK is not initialized.
+   * 0: Success.< 0: Failure.
    */
   abstract leaveChannel(options?: LeaveChannelOptions): number;
 
   /**
-   * Gets a new token when the current token expires after a period of time.
+   * Renews the token.
    * The SDK triggers the onTokenPrivilegeWillExpire callback.The onConnectionStateChanged callback reports ConnectionChangedTokenExpired(9).
    *
    * @param token The new token.
@@ -2894,23 +2840,24 @@ export abstract class IRtcEngine {
 
   /**
    * Sets the channel profile.
-   * After initializing the SDK, the default channel profile is the live streaming profile. You can call this method to set the usage scenario of Agora channel. The Agora SDK differentiates channel profiles and applies optimization algorithms accordingly. For example, it prioritizes smoothness and low latency for a video call and prioritizes video quality for interactive live video streaming.To ensure the quality of real-time communication, Agora recommends that all users in a channel use the same channel profile.This method must be called and set before joinChannel [2/2], and cannot be set again after joining the channel.The default video encoding bitrate are different in different channel profiles.
+   * After initializing the SDK, the default channel profile is the live streaming profile. You can call this method to set the usage scenario of the channel. For example, it prioritizes smoothness and low latency for a video call, and prioritizes video quality for the interactive live video streaming.To ensure the quality of real-time communication, Agora recommends that all users in a channel use the same channel profile.This method must be called and set before joinChannel, and cannot be set again after joining the channel.The default video encoding bitrate are different in different channel profiles.
    *
    * @param profile The channel profile. See ChannelProfileType .
    *
    * @returns
-   * 0(ERR_OK): Success.< 0: Failure.-2(ERR_INVALID_ARGUMENT): The parameter is invalid.-7(ERR_NOT_INITIALIZED): The SDK is not initialized.
+   * 0(ERR_OK): Success.< 0: Failure.-2: The parameter is invalid.-7: The SDK is not initialized.
    */
   abstract setChannelProfile(profile: ChannelProfileType): number;
 
   /**
-   * Sets the client role.
-   * If you call this method to set the user's role as the host before joining the channel and set the local video property through the setupLocalVideo method, the local video preview is automatically enabled when the user joins the channel.You can call this method either before or after joining the channel to set the user role as audience or host.If you call this method to switch the user role after joining the channel, the SDK triggers the following callbacks:The local client: onClientRoleChanged .The remote client: onUserJoined or onUserOffline (UserOfflineBecomeAudience).
+   * Sets the user role and level in an interactive live streaming channel.
+   * In the interactive live streaming profile, the SDK sets the user role as audience by default. You can call this method to set the user role as host.You can call this method either before or after joining a channel.If you call this method to set the user's role as the host before joining the channel and set the local video property through the setupLocalVideo method, the local video preview is automatically enabled when the user joins the channel.If you call this method to switch the user role after joining a channel, the SDK automatically does the following:Calls muteLocalAudioStream and muteLocalVideoStream to change the publishing state.Triggers onClientRoleChanged on the local client.Triggers onUserJoined or onUserOffline on the remote client.This method applies to the interactive live streaming profile (the profile parameter of setChannelProfile is ChannelProfileLiveBroadcasting) only.
    *
-   * @param role The user role. See ClientRoleType .
+   * @param role The user role in the interactive live streaming. See ClientRoleType .
+   * @param options The detailed options of a user, including the user level. See ClientRoleOptions .
    *
    * @returns
-   * 0: Success.< 0: Failure.-1: A general error occurs (no specified reason).-2: The parameter is invalid.-7: The SDK is not initialized.
+   * 0: Success.< 0: Failure.-1: A general error occurs (no specified reason).-2: The parameter is invalid.-5: The request is rejected.-7: The SDK is not initialized.
    */
   abstract setClientRole(
     role: ClientRoleType,
@@ -2918,22 +2865,22 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Starts an audio call test.
-   * This method starts an audio call test to determine whether the audio devices (for example, headset and speaker) and the network connection are working properly. To conduct the test, let the user speak for a while, and the recording is played back within the set interval. If the user can hear the recording within the interval, the audio devices and network connection are working properly.Call this method before joining a channel.After calling startEchoTest, you must call stopEchoTest to end the test. Otherwise, the app cannot perform the next echo test, and you cannot join the channel.In the live streaming channels, only a host can call this method.
+   * Starts an audio and video call loop test.
+   * Before joining a channel, 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.Call this method before joining a channel.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 intervalInSeconds The time interval (s) between when you speak and when the recording plays back. The value range is [2, 10], and the default value is 10.
+   * @param config The configuration of the audio and video call loop test. See EchoTestConfiguration .
    *
    * @returns
    * 0: Success.< 0: Failure.
    */
-  abstract startEchoTest(intervalInSeconds?: number): number;
+  abstract startEchoTest(config: EchoTestConfiguration): number;
 
   /**
    * Stops the audio call test.
    *
    * @returns
    * 0: Success.
-   * < 0: Failure.-5(ERR_REFUSED): Failed to stop the echo test. The echo test may not be running.
+   *  < 0: Failure.-5(ERR_REFUSED): Failed to stop the echo test. The echo test may not be running.
    */
   abstract stopEchoTest(): number;
 
@@ -2942,7 +2889,6 @@ export abstract class IRtcEngine {
    * In scenarios where there are existing cameras to capture video, Agora recommends that you use the following steps to capture and publish video with multiple cameras:Call this method to enable multi-channel camera capture.Call startPreview [1/2] to start the local video preview.Call startSecondaryCameraCapture to start video capture with the second camera.Call joinChannelEx , and set publishSecondaryCameraTrack to true to publish the video stream captured by the second camera in the channel.If you want to disable multi-channel camera capture, use the following steps:Call stopSecondaryCameraCapture .Call this method with enabled set to false.You can call this method before and after startPreview [1/2] to enable multi-camera capture:If it is enabled before startPreview [1/2], the local video preview shows the image captured by the two cameras at the same time.If it is enabled after startPreview [1/2], the SDK stops the current camera capture first, and then enables the primary camera and the second camera. The local video preview appears black for a short time, and then automatically returns to normal.When using this function, ensure that the system version is 13.0 or later.The minimum iOS device types that support multi-camera capture are as follows:iPhone XRiPhone XSiPhone XS MaxiPad Pro 3rd generation and later
    *
    * @param enabled Whether to enable multi-camera video capture mode:true: Enable multi-camera capture mode; the SDK uses multiple cameras to capture video.false: Disable multi-camera capture mode; the SDK uses a single camera to capture video.
-   *
    * @param config Capture configuration for the second camera. See CameraCapturerConfiguration .
    *
    * @returns
@@ -2955,7 +2901,7 @@ export abstract class IRtcEngine {
 
   /**
    * Enables the video module.
-   * Call this method either before joining a channel or during a call. If this method is called before joining a channel, the call starts in the video mode. Call disableVideo to disable the video mode.A successful call of this method triggers the onRemoteVideoStateChanged callback on the remote client.This method enables the internal engine and is valid after leaving the channel.This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the video engine modules separately: enableLocalVideo : Whether to enable the camera to create the local video stream. muteLocalVideoStream : Whether to publish the local video stream. muteRemoteVideoStream : Whether to subscribe to and play the remote video stream. muteAllRemoteVideoStreams : Whether to subscribe to and play all remote video streams.
+   * Call this method either before joining a channel or during a call. If this method is called before joining a channel, the call starts in the video mode; if called during a call, the audio call switches to a video call. Call disableVideo to disable the video mode.A successful call of this method triggers the onRemoteVideoStateChanged callback on the remote client.This method enables the internal engine and is valid after leaving the channel.This method resets the internal engine and thus might takes some time to take effect. Agora recommends using the following APIs to control the video modules separately: enableLocalVideo : Whether to enable the camera to create the local video stream. muteLocalVideoStream : Whether to publish the local video stream. muteRemoteVideoStream : Whether to subscribe to and play the remote video stream. muteAllRemoteVideoStreams : Whether to subscribe to and play all remote video streams.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -2964,7 +2910,7 @@ export abstract class IRtcEngine {
 
   /**
    * Disables the video module.
-   * This method disables video. You can call this method either before or after joining a channel. If you call it before joining a channel, an audio call starts when you join the channel. If you call it after joining a channel, a video call switches to an audio call. Call enableVideo to enable video.A successful call of this method triggers the onUserEnableVideo (false) callback on the remote client.This method affects the internal engine and can be called after leaving the channel.This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the video engine modules separately: enableLocalVideo : Whether to enable the camera to create the local video stream. muteLocalVideoStream : Whether to publish the local video stream. muteRemoteVideoStream : Whether to subscribe to and play the remote video stream. muteAllRemoteVideoStreams : Whether to subscribe to and play all remote video streams.
+   * This method can be called before joining a channel or during a call to disable the video module. If it is called before joining a channel, an audio call starts when you join the channel; if called during a call, a video call switches to an audio call. Call enableVideo to enable the video module.A successful call of this method triggers the onUserEnableVideo (false) callback on the remote client.This method affects the internal engine and can be called after leaving the channel.This method resets the internal engine and thus might takes some time to take effect. Agora recommends using the following APIs to control the video modules separately: enableLocalVideo : Whether to enable the camera to create the local video stream. muteLocalVideoStream : Whether to publish the local video stream. muteRemoteVideoStream : Whether to subscribe to and play the remote video stream. muteAllRemoteVideoStreams : Whether to subscribe to and play all remote video streams.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -2972,8 +2918,10 @@ export abstract class IRtcEngine {
   abstract disableVideo(): number;
 
   /**
-   * Enables the local video preview.
-   * This method starts the local video preview before joining the channel. Before calling this method, ensure that you do the following:Call setView to set the local preview window.Call enableVideo to enable the video.The local preview enables the mirror mode by default.After the local video preview is enabled, if you call leaveChannel [1/2] to exit the channel, the local preview remains until you call stopPreview [1/2] to disable it.
+   * Enables the local video preview and specifies the video source for the preview.
+   * This method starts the local video preview before joining the channel. Before calling this method, ensure that you do the following:Call setView to set the local preview window.Call enableVideo to enable the video.The local preview enables the mirror mode by default.After the local video preview is enabled, if you call leaveChannel to exit the channel, the local preview remains until you call stopPreview to disable it.The video source type set in this method needs to be consistent with the video source type of VideoCanvas you set in setupLocalVideo .
+   *
+   * @param sourceType The type of the video frame, see VideoSourceType .
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -2982,10 +2930,12 @@ export abstract class IRtcEngine {
 
   /**
    * Stops the local video preview.
-   * After calling startPreview [1/2] to start the preview, if you want to close the local video preview, please call this method.Please call this method before joining a channel or after leaving a channel.
+   * After calling startPreview to start the preview, if you want to close the local video preview, call this method.Call this method before joining a channel or after leaving a channel.
+   *
+   * @param sourceType The type of the video frame, see VideoSourceType .
    *
    * @returns
-   * 0: Success.< 0: Failure.
+   * < 0: Failure.
    */
   abstract stopPreview(sourceType?: VideoSourceType): number;
 
@@ -3025,11 +2975,9 @@ export abstract class IRtcEngine {
    * Sets the image enhancement options.
    * Enables or disables image enhancement, and sets the options.Call this method before calling enableVideo or startPreview [1/2] .This method relies on the video enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
    *
-   * @param type The type of the video source. See MediaSourceType .
-   *
    * @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 .
+   * @param type The type of the video source, see MediaSourceType .
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -3045,9 +2993,7 @@ export abstract class IRtcEngine {
    * The low-light enhancement feature can adaptively adjust the brightness value of the video captured in situations with low or uneven lighting, such as backlit, cloudy, or dark scenes. It restores or highlights the image details and improves the overall visual effect of the video.You can call this method to enable the color enhancement feature and set the options of the color enhancement effect.Call this method after calling enableVideo .Dark light enhancement has certain requirements for equipment performance. The low-light enhancement feature has certain performance requirements on devices. If your device overheats after you enable low-light enhancement, Agora recommends modifying the low-light enhancement options to a less performance-consuming level or disabling low-light enhancement entirely.Both this method and setExtensionProperty can turn on low-light enhancement:When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using setExtensionProperty.This method relies on the video enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
    *
    * @param enabled Whether to enable low-light enhancement function:true: Enable low-light enhancement function.false: (Default) Disable low-light enhancement function.
-   *
    * @param options The low-light enhancement options. See LowlightEnhanceOptions .
-   *
    * @param type The type of the video source. See MediaSourceType .
    *
    * @returns
@@ -3060,14 +3006,12 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Sets video noise reduction.
-   * Underlit environments and low-end video capture devices can cause video images to contain significant noise, which affects video quality. In real-time interactive scenarios, video noise also consumes bitstream resources and reduces encoding efficiency during encoding.You can call this method to enable the video noise reduction feature and set the options of the video noise reduction effect.Call this method after calling enableVideo .Video noise reduction has certain requirements for equipment performance. If your device overheats after you enable video noise reduction, Agora recommends modifying the video noise reduction options to a less performance-consuming level or disabling video noise reduction entirely.Both this method and setExtensionProperty can turn on video noise reduction function:When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using setExtensionProperty.This method relies on the video enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
-   *
-   * @param type The type of the video source. See MediaSourceType .
-   *
-   * @param enabled Whether to enable video noise reduction:true: Enable video noise reduction.false: (Default) Disable video noise reduction.
+   * Sets the image enhancement options.
+   * Enables or disables image enhancement, and sets the options.Call this method before calling enableVideo or startPreview [1/2] .This method relies on the video enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
    *
-   * @param options The video noise reduction options. See VideoDenoiserOptions .
+   * @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 .
+   * @param type The type of the video source, see MediaSourceType .
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -3079,14 +3023,12 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Sets color enhancement.
-   * The video images captured by the camera can have color distortion. The color enhancement feature intelligently adjusts video characteristics such as saturation and contrast to enhance the video color richness and color reproduction, making the video more vivid.You can call this method to enable the color enhancement feature and set the options of the color enhancement effect.Call this method after calling enableVideo .The color enhancement feature has certain performance requirements on devices. With color enhancement turned on, Agora recommends that you change the color enhancement level to one that consumes less performance or turn off color enhancement if your device is experiencing severe heat problems.Both this method and setExtensionProperty can enable color enhancement:When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using setExtensionProperty.This method relies on the video enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
-   *
-   * @param type The type of the video source. See MediaSourceType .
-   *
-   * @param enabled Whether to enable color enhancement:true Enable color enhancement.false: (Default) Disable color enhancement.
+   * Sets the image enhancement options.
+   * Enables or disables image enhancement, and sets the options.Call this method before calling enableVideo or startPreview [1/2] .This method relies on the video enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
    *
-   * @param options The color enhancement options. See ColorEnhanceOptions .
+   * @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 .
+   * @param type The type of the video source, see MediaSourceType .
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -3102,11 +3044,8 @@ export abstract class IRtcEngine {
    * The virtual background function allows you to replace the original background image of the local user or to blur the background. After successfully enabling the virtual background function, all users in the channel can see the customized background.Call this method before calling enableVideo or startPreview [1/2] .This feature requires high performance devices. Agora recommends that you implement it on devices equipped with the following chips:Devices with an i5 CPU and betterAgora recommends that you use this feature in scenarios that meet the following conditions:A high-definition camera device is used, and the environment is uniformly lit.There are few objects in the captured video. Portraits are half-length and unobstructed. Ensure that the background is a solid color that is different from the color of the user's clothing.This method relies on the virtual background dynamic library libagora_segmentation_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
    *
    * @param enabled Whether to enable virtual background:true: Enable virtual background.false: Disable virtual background.
-   *
    * @param backgroundSource The custom background image. See VirtualBackgroundSource . To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted.
-   *
    * @param segproperty Processing properties for background images. See SegmentationProperty .
-   *
    * @param type The type of the video source. See MediaSourceType .In this method, this parameter supports only the following two settings:The default value is PrimaryCameraSource.If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.
    *
    * @returns
@@ -3121,7 +3060,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.To update the rendering or mirror mode of the remote video view during a call, use the setRemoteRenderMode method.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.
+   * 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.
    *
    * @param canvas The remote video view and settings. See VideoCanvas .
    *
@@ -3132,7 +3071,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 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.You can call this method either before or after joining a channel.To update the rendering or mirror mode of the local video view during a call, use the setLocalRenderMode method.
+   * 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 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.You can call this method either before or after joining a channel.
    *
    * @param canvas The local video view and settings. See VideoCanvas .
    *
@@ -3141,9 +3080,14 @@ export abstract class IRtcEngine {
    */
   abstract setupLocalVideo(canvas: VideoCanvas): number;
 
+  /**
+   * @ignore
+   */
+  abstract setVideoScenario(scenarioType: VideoApplicationScenarioType): number;
+
   /**
    * Enables the audio module.
-   * The audio mode is enabled by default.This method enables the internal engine and can be called anytime after initialization. It is still valid after one leaves channel.This method enables the audio module and takes some time to take effect. Agora recommends using the following API methods to control the audio module separately: enableLocalAudio : Whether to enable the microphone to create the local audio stream. muteLocalAudioStream : Whether to publish the local audio stream. muteRemoteAudioStream : Whether to subscribe and play the remote audio stream. muteAllRemoteAudioStreams : Whether to subscribe to and play all remote audio streams.
+   * The audio mode is enabled by default.This method enables the internal engine and can be called anytime after initialization. It is still valid after one leaves channel.This method enables the whole audio module and thus might take a while to take effect. Agora recommends using the following APIs to control the audio module separately: enableLocalAudio : Whether to enable the microphone to create the local audio stream. muteLocalAudioStream : Whether to publish the local audio stream. muteRemoteAudioStream : Whether to subscribe and play the remote audio stream. muteAllRemoteAudioStreams : Whether to subscribe to and play all remote audio streams.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -3164,7 +3108,6 @@ export abstract class IRtcEngine {
    * You can call this method either before or after joining a channel.In scenarios requiring high-quality audio, such as online music tutoring, Agora recommends you set profile as AudioProfileMusicHighQuality(4)and scenario as AudioScenarioGameStreaming(3).
    *
    * @param profile The audio profile, including the sampling rate, bitrate, encoding mode, and the number of channels. See AudioProfileType .
-   *
    * @param scenario The audio scenarios. See AudioScenarioType . Under different audio scenarios, the device uses different volume types.
    *
    * @returns
@@ -3185,8 +3128,8 @@ export abstract class IRtcEngine {
   abstract setAudioScenario(scenario: AudioScenarioType): number;
 
   /**
-   * Enables/Disables the local audio capture.
-   * The audio function is enabled by default. This method disables or re-enables the local audio function to stop or restart local audio capturing.This method does not affect receiving or playing the remote audio streams, and enableLocalAudio (false) is applicable to scenarios where the user wants to receive remote audio streams without sending any audio stream to other users in the channel.Once the local audio function is disabled or re-enabled, the SDK triggers the onLocalAudioStateChanged callback, which reports LocalAudioStreamStateStopped (0) or LocalAudioStreamStateRecording (1).This method is different from the muteLocalAudioStream method:enableLocalAudio: Disables/Re-enables the local audio capturing and processing. If you disable or re-enable local audio capturing using the enableLocalAudio method, the local user might hear a pause in the remote audio playback.muteLocalAudioStream: Sends/Stops sending the local audio streams.You can call this method either before or after joining a channel. Calling it before joining a channel only sets the device state, and it takes effect immediately after you join the channel.
+   * Enables or disables the local audio capture.
+   * The audio function is enabled by default when users joining a channel. This method disables or re-enables the local audio function to stop or restart local audio capturing.This method does not affect receiving or playing the remote audio streams, and enableLocalAudio (false) is applicable to scenarios where the user wants to receive remote audio streams without sending any audio stream to other users in the channel.Once the local audio function is disabled or re-enabled, the SDK triggers the onLocalAudioStateChanged callback, which reports LocalAudioStreamStateStopped(0) or LocalAudioStreamStateRecording(1).The difference between this method and muteLocalAudioStream are as follow:enableLocalAudio: Disables or re-enables the local audio capturing and processing. If you disable or re-enable local audio capturing using the enableLocalAudio method, the local user might hear a pause in the remote audio playback.muteLocalAudioStream: Sends or stops sending the local audio streams.You can call this method either before or after joining a channel. Calling it before joining a channel only sets the device state, and it takes effect immediately after you join the channel.
    *
    * @param enabled true: (Default) Re-enable the local audio function, that is, to start the local audio capturing device (for example, the microphone).false: Disable the local audio function, that is, to stop local audio capturing.
    *
@@ -3199,7 +3142,7 @@ export abstract class IRtcEngine {
    * Stops or resumes publishing the local audio stream.
    * This method does not affect any ongoing audio recording, because it does not disable the audio capture device.
    *
-   * @param mute Whether to stop publishing the local audio stream.true: Stop publishing the local audio stream.false: (Default) Resumes publishing the local audio stream.
+   * @param mute Whether to stop publishing the local audio stream:true: Stops publishing the local audio stream.false: (Default) Resumes publishing the local audio stream.
    *
    * @returns
    * 0: Success. < 0: Failure.
@@ -3208,9 +3151,9 @@ export abstract class IRtcEngine {
 
   /**
    * Stops or resumes subscribing to the audio streams of all remote users.
-   * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.Call this method after joining a channel.If you do not want to subscribe the audio streams of remote users before joining a channel, you can call joinChannel [2/2] and set autoSubscribeAudio as false.
+   * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.Call this method after joining a channel.If you do not want to subscribe the audio streams of remote users before joining a channel, you can set autoSubscribeAudio as false when calling joinChannel .
    *
-   * @param mute Whether to stop subscribing to the audio streams of all remote users:true: Stop subscribing to the audio streams of all remote users.false: (Default) Subscribe to the audio streams of all remote users by default.
+   * @param mute Whether to stop subscribing to the audio streams of all remote users:true: Stops subscribing to the audio streams of all remote users.false: (Default) Subscribes to the audio streams of all remote users by default.
    *
    * @returns
    * 0: Success. < 0: Failure.
@@ -3218,18 +3161,22 @@ export abstract class IRtcEngine {
   abstract muteAllRemoteAudioStreams(mute: boolean): number;
 
   /**
-   * @ignore
+   * Stops or resumes subscribing to the audio streams of all remote users.
+   * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.Call this method after joinChannel .When using the spatial audio effect, if you need to set whether to stop subscribing to the audio streams of all remote users, Agora recommends calling this method instead of the muteAllRemoteAudioStreams method in IRtcEngine .After calling this method, you need to call updateSelfPosition and updateRemotePosition to update the spatial location of the local user and the remote user; otherwise, the settings in this method do not take effect.
+   *
+   * @param mute Whether to stop subscribing to the audio streams of all remote users:true: Stop subscribing to the audio streams of all remote users.false: Subscribe to the audio streams of all remote users.
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract setDefaultMuteAllRemoteAudioStreams(mute: boolean): number;
 
   /**
-   * Cancels or resumes subscribing to the specified remote user's audio stream.
+   * Stops or resumes subscribing to the audio stream of a specified user.
    * Call this method after joining a channel.
    *
    * @param uid The user ID of the specified user.
-   *
-   * @param mute Whether to stop subscribing to the audio stream of the specified user.
-   *  true: Unsubscribe from the specified user's audio stream.false: (Default) Subscribes to the specified user's audio stream.
+   * @param mute Whether to subscribe to the specified remote user's audio stream.true: Stop subscribing to the audio stream of the specified user.false: (Default) Subscribe to the audio stream of the specified user.
    *
    * @returns
    * 0: Success. < 0: Failure.
@@ -3249,9 +3196,9 @@ export abstract class IRtcEngine {
 
   /**
    * Enables/Disables the local video capture.
-   * This method disables or re-enables the local video capturer, and does not affect receiving the remote video stream.After calling enableVideo , the local video capturer is enabled by default. You can call enableLocalVideo (false) to disable the local video capturer. If you want to re-enable the local video, call enableLocalVideo(true).After the local video capturer is successfully disabled or re-enabled, the SDK triggers the onRemoteVideoStateChanged callback on the remote client.You can call this method either before or after joining a channel.This method enables the internal engine and is valid after leaving the channel.
+   * This method disables or re-enables the local video capture, and does not affect receiving the remote video stream.After calling enableVideo , the local video capture is enabled by default. You can call enableLocalVideo (false) to disable the local video capture. If you want to re-enable the local video capture, call enableLocalVideo(true).After the local video capturer is successfully disabled or re-enabled, the SDK triggers the onRemoteVideoStateChanged callback on the remote client.You can call this method either before or after joining a channel.This method enables the internal engine and is valid after leaving the channel.
    *
-   * @param enabled Whether to enable the local video capture.true: (Default) Enable the local video capture.false: Disables the local video capture. Once the local video is disabled, the remote users can no longer receive the video stream of this user, while this user can still receive the video streams of the other remote users. When set to false, this method does not require a local camera.
+   * @param enabled Whether to enable the local video capture.true: (Default) Enable the local video capture.false: Disable the local video capture. Once the local video is disabled, the remote users cannot receive the video stream of the local user, while the local user can still receive the video streams of remote users. When set to false, this method does not require a local camera.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -3260,7 +3207,7 @@ export abstract class IRtcEngine {
 
   /**
    * Stops or resumes subscribing to the video streams of all remote users.
-   * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.Call this method after joining a channel.If you do not want to subscribe the video streams of remote users before joining a channel, you can call joinChannel [2/2] and set autoSubscribeVideo as false.
+   * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.Call this method after joining a channel.If you do not want to subscribe the video streams of remote users before joining a channel, you can call joinChannel and set autoSubscribeVideo as false.
    *
    * @param mute Whether to stop subscribing to the video streams of all remote users.true: Stop subscribing to the video streams of all remote users.false: (Default) Subscribe to the audio streams of all remote users by default.
    *
@@ -3270,17 +3217,22 @@ export abstract class IRtcEngine {
   abstract muteAllRemoteVideoStreams(mute: boolean): number;
 
   /**
-   * @ignore
+   * Stops or resumes subscribing to the audio streams of all remote users.
+   * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.Call this method after joinChannel .When using the spatial audio effect, if you need to set whether to stop subscribing to the audio streams of all remote users, Agora recommends calling this method instead of the muteAllRemoteAudioStreams method in IRtcEngine .After calling this method, you need to call updateSelfPosition and updateRemotePosition to update the spatial location of the local user and the remote user; otherwise, the settings in this method do not take effect.
+   *
+   * @param mute Whether to stop subscribing to the audio streams of all remote users:true: Stop subscribing to the audio streams of all remote users.false: Subscribe to the audio streams of all remote users.
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract setDefaultMuteAllRemoteVideoStreams(mute: boolean): number;
 
   /**
-   * Cancels or resumes subscribing to the specified remote user's video stream.
+   * Stops or resumes subscribing to the video stream of a specified user.
    * Call this method after joining a channel.
    *
    * @param uid The user ID of the specified user.
-   *
-   * @param mute Whether to subscribe to the specified remote user's video stream.true: Unsubscribe from the specified user's video stream.false: (Default) Subscribes to the specified user's video stream.
+   * @param mute Whether to subscribe to the specified remote user's video stream.true: Stop subscribing to the video streams of the specified user.false: (Default) Subscribe to the video stream of the specified user.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -3292,7 +3244,6 @@ export abstract class IRtcEngine {
    * Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamMode (false), the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream.The SDK enables the low-quality video stream auto mode on the sender by default (not actively sending low-quality video streams). The host at the receiving end can call this method to initiate a low-quality video stream stream request on the receiving end, and the sender automatically switches to the low-quality video stream mode after receiving the request.The result of this method returns in the onApiCallExecuted callback.You can call this method either before or after joining a channel. If you call both setRemoteVideoStreamType and setRemoteDefaultVideoStreamType , the setting of setRemoteVideoStreamType takes effect.
    *
    * @param uid The user ID.
-   *
    * @param streamType The video stream type: VideoStreamType .
    *
    * @returns
@@ -3305,10 +3256,9 @@ export abstract class IRtcEngine {
 
   /**
    * Options for subscribing to remote video streams.
-   * When a remote user has enabled dual-stream mode, you can call this method to choose the option for subscribing to the video streams sent by the remote user.If you only register one IVideoFrameObserver object, the SDK subscribes to the raw video data and encoded video data by default (the effect is equivalent to setting encodedFrameOnly to false).If you only register one IVideoEncodedFrameObserver object, the SDK only subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to true).If you register one IVideoFrameObserver object and one IVideoEncodedFrameObserver object successively, the SDK subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to false).If you call this method first with the options parameter set, and then register one IVideoFrameObserver or IVideoEncodedFrameObserver object, you need to call this method again and set the options parameter as described in the above two items to get the desired results.Agora recommends the following steps:Set autoSubscribeVideo to false when calling joinChannel [2/2] to join a channel.Call this method after receiving the onUserJoined callback to set the subscription options for the specified remote user's video stream.Call the muteRemoteVideoStream method to resume subscribing to the video stream of the specified remote user. If you set encodedFrameOnly to true in the previous step, the SDK triggers the onEncodedVideoFrameReceived callback locally to report the received encoded video frame information.
+   * When a remote user has enabled dual-stream mode, you can call this method to choose the option for subscribing to the video streams sent by the remote user.If you only register one IVideoFrameObserver object, the SDK subscribes to the raw video data and encoded video data by default (the effect is equivalent to setting encodedFrameOnly to false).If you only register one IVideoEncodedFrameObserver object, the SDK only subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to true).If you register one IVideoFrameObserver object and one IVideoEncodedFrameObserver object successively, the SDK subscribes to the encoded video data by default (the effect is equivalent to setting encodedFrameOnly to false).If you call this method first with the options parameter set, and then register one IVideoFrameObserver or IVideoEncodedFrameObserver object, you need to call this method again and set the options parameter as described in the above two items to get the desired results.Agora recommends the following steps:Set autoSubscribeVideo to false when calling joinChannel to join a channel.Call this method after receiving the onUserJoined callback to set the subscription options for the specified remote user's video stream.Call the muteRemoteVideoStream method to resume subscribing to the video stream of the specified remote user. If you set encodedFrameOnly to true in the previous step, the SDK triggers the onEncodedVideoFrameReceived callback locally to report the received encoded video frame information.
    *
    * @param uid The user ID of the remote user.
-   *
    * @param options The video subscription options. See VideoSubscriptionOptions .
    *
    * @returns
@@ -3321,8 +3271,7 @@ export abstract class IRtcEngine {
 
   /**
    * Sets the default stream type of subscrption for remote video streams.
-   * The SDK enables the low-quality video stream auto mode on the sender by default (not actively sending low-quality video streams). The host at the receiving end can call this method to initiate a low-quality video stream stream request on the receiving end, and the sender automatically switches to the low-quality video stream mode after receiving the request.
-   * Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamMode (false), the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream.The result of this method returns in the onApiCallExecuted callback.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 SDK applies the settings in the setRemoteVideoStreamType method.
+   * The SDK enables the low-quality video stream auto mode on the sender by default (not actively sending low-quality video streams). The host at the receiving end can call this method to initiate a low-quality video stream stream request on the receiving end, and the sender automatically switches to the low-quality video stream mode after receiving the request.Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamMode (false), the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream.The result of this method returns in the onApiCallExecuted callback.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 SDK applies the settings in the setRemoteVideoStreamType method.
    *
    * @param streamType The default video-stream type. See VideoStreamType .
    *
@@ -3336,7 +3285,6 @@ export abstract class IRtcEngine {
    * You can call this method to specify the audio streams of a user that you do not want to subscribe to.You can call this method either before or after joining a channel.The blocklist is not affected by the setting in muteRemoteAudioStream , muteAllRemoteAudioStreams , and autoSubscribeAudio in ChannelMediaOptions .Once the blocklist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
    *
    * @param uidList The user ID list of users that you do not want to subscribe to.If you want to specify the audio streams of a user that you do not want to subscribe to, add the user ID in this list. If you want to remove a user from the blocklist, you need to call the setSubscribeAudioBlocklist method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.
-   *
    * @param uidNumber The number of users in the user ID list.
    *
    * @returns
@@ -3352,7 +3300,6 @@ export abstract class IRtcEngine {
    * You can call this method to specify the audio streams of a user that you want to subscribe to.If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.You can call this method either before or after joining a channel.The allowlist is not affected by the setting in muteRemoteAudioStream , muteAllRemoteAudioStreams and autoSubscribeAudio in ChannelMediaOptions .Once the allowlist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
    *
    * @param uidList The user ID list of users that you want to subscribe to.If you want to specify the audio streams of a user for subscription, add the user ID in this list. If you want to remove a user from the allowlist, you need to call the setSubscribeAudioAllowlist method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.
-   *
    * @param uidNumber The number of users in the user ID list.
    *
    * @returns
@@ -3364,13 +3311,12 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Set the blocklist of subscriptions for video streams.
-   * You can call this method to specify the video streams of a user that you do not want to subscribe to.If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.Once the blocklist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.You can call this method either before or after joining a channel.The blocklist is not affected by the setting in muteRemoteVideoStream , muteAllRemoteVideoStreams and autoSubscribeAudio in ChannelMediaOptions .
+   * Set the blocklist of subscriptions for audio streams.
+   * You can call this method to specify the audio streams of a user that you do not want to subscribe to.You can call this method either before or after joining a channel.The blocklist is not affected by the setting in muteRemoteAudioStream , muteAllRemoteAudioStreams , and autoSubscribeAudio in ChannelMediaOptions .Once the blocklist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
    *
+   * @param uidList The user ID list of users that you do not want to subscribe to.If you want to specify the audio streams of a user that you do not want to subscribe to, add the user ID in this list. If you want to remove a user from the blocklist, you need to call the setSubscribeAudioBlocklist method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.
    * @param uidNumber The number of users in the user ID list.
    *
-   * @param uidList The user ID list of users that you do not want to subscribe to.If you want to specify the video streams of a user that you do not want to subscribe to, add the user ID of that user in this list. If you want to remove a user from the blocklist, you need to call the setSubscribeVideoBlocklist method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.
-   *
    * @returns
    * 0: Success.< 0: Failure.
    */
@@ -3380,16 +3326,12 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Set the allowlist of subscriptions for video streams.
-   * You can call this method to specify the video streams of a user that you want to subscribe to.If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
-   * Once the allowlist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
-   * You can call this method either before or after joining a channel.
-   * The allowlist is not affected by the setting in muteRemoteVideoStream , muteAllRemoteVideoStreams and autoSubscribeAudio in ChannelMediaOptions .
+   * Set the blocklist of subscriptions for audio streams.
+   * You can call this method to specify the audio streams of a user that you do not want to subscribe to.You can call this method either before or after joining a channel.The blocklist is not affected by the setting in muteRemoteAudioStream , muteAllRemoteAudioStreams , and autoSubscribeAudio in ChannelMediaOptions .Once the blocklist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
    *
+   * @param uidList The user ID list of users that you do not want to subscribe to.If you want to specify the audio streams of a user that you do not want to subscribe to, add the user ID in this list. If you want to remove a user from the blocklist, you need to call the setSubscribeAudioBlocklist method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.
    * @param uidNumber The number of users in the user ID list.
    *
-   * @param uidList The user ID list of users that you want to subscribe to.If you want to specify the video streams of a user for subscription, add the user ID of that user in this list. If you want to remove a user from the allowlist, you need to call the setSubscribeVideoAllowlist method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.
-   *
    * @returns
    * 0: Success.< 0: Failure.
    */
@@ -3400,13 +3342,11 @@ export abstract class IRtcEngine {
 
   /**
    * Enables the reporting of users' volume indication.
-   * This method enables the SDK to regularly report the volume information of the local user who sends a stream and remote users (up to three) whose instantaneous volumes are the highest to the app. Once you call this method and users send streams in the channel, the SDK triggers the onAudioVolumeIndication callback at the time interval set in this method.You can call this method either before or after joining a channel.
-   *
-   * @param interval Sets the time interval between two consecutive volume indications:≤ 0: Disables the volume indication.> 0: Time interval (ms) between two consecutive volume indications. You need to set this parameter to an integer multiple of 200. If the value is lower than 200, the SDK automatically adjusts the value to 200.
-   *
-   * @param smooth The smoothing factor sets the sensitivity of the audio volume indicator. The value ranges between 0 and 10. The recommended value is 3. The greater the value, the more sensitive the indicator.
+   * This method enables the SDK to regularly report the volume information to the app of the local user who sends a stream and remote users (three users at most) whose instantaneous volumes are the highest. Once you call this method and users send streams in the channel, the SDK triggers the onAudioVolumeIndication callback at the time interval set in this method.You can call this method either before or after joining a channel.
    *
-   * @param reportVad true: Enable the voice activity detection of the local user. Once it is enabled,the vad parameter of the onAudioVolumeIndication callback reports the voice activity status of the local user.false: (Default) Disable the voice activity detection of the local user. Once it is disabled, the vad parameter of the onAudioVolumeIndication callback does not report the voice activity status of the local user, except for the scenario where the engine automatically detects the voice activity of the local user.
+   * @param interval Sets the time interval between two consecutive volume indications:≤ 0: Disables the volume indication.> 0: Time interval (ms) between two consecutive volume indications. The lowest value is 50.
+   * @param smooth The smoothing factor that sets the sensitivity of the audio volume indicator. The value ranges between 0 and 10. The recommended value is 3. The greater the value, the more sensitive the indicator.
+   * @param reportVad true: Enables the voice activity detection of the local user. Once it is enabled, the vad parameter of the onAudioVolumeIndication callback reports the voice activity status of the local user.false: (Default) Disables the voice activity detection of the local user. Once it is disabled, the vad parameter of the onAudioVolumeIndication callback does not report the voice activity status of the local user, except for the scenario where the engine automatically detects the voice activity of the local user.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -3418,10 +3358,10 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Starts the audio recording on the client.
-   * The Agora SDK allows recording during a call. After successfully calling this method, you can record the audio of all the users in the channel and get an audio recording file. Supported formats of the recording file are as follows:WAV: High-fidelity files with typically larger file sizes. For example, the size of a WAV file with a sample rate of 32,000 Hz and a recording duration of 10 minutes is around 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 a 10-minute recording is approximately 2 MB.Once the user leaves the channel, the recording automatically stops.Call this method after joining a channel.
+   * 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: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.
    *
-   * @param config Recording configuration. See AudioRecordingConfiguration .
+   * @param config Recording configurations. See AudioRecordingConfiguration .
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -3430,9 +3370,7 @@ export abstract class IRtcEngine {
 
   /**
    * Registers an encoded audio observer.
-   * Call this method after joining a channel.You can call this method or the startAudioRecording method to set the audio content and audio quality. Agora does not recommend using this method and startAudioRecording at the same time; otherwise, only the method called later takes effect.
-   *
-   * @param config
+   * Call this method after joining a channel.You can call this method or startAudioRecording to set the recording type and quality of audio files, but Agora does not recommend using this method and startAudioRecording at the same time. Only the method called later will take effect.
    *
    * @returns
    * One IAudioEncodedFrameObserver object.
@@ -3461,27 +3399,41 @@ export abstract class IRtcEngine {
   /**
    * Destroys the media player instance.
    *
-   * @param mediaPlayer  IMediaPlayer object.
+   * @param mediaPlayer One IMediaPlayer object.
    *
    * @returns
-   * ≥ 0: Success. Returns the ID of the media player instance.< 0: Failure.
+   * ≥ 0: Success. Returns the ID of media player instance.< 0: Failure.
    */
   abstract destroyMediaPlayer(mediaPlayer: IMediaPlayer): number;
 
+  /**
+   * Occurs when the uplink network information changes.
+   * The SDK triggers this callback when the uplink network information changes.This callback only applies to scenarios where you push externally encoded video data in H.264 format to the SDK.
+   *
+   * @param info The uplink network information. See UplinkNetworkInfo .
+   */
+  abstract createMediaRecorder(info: RecorderStreamInfo): IMediaRecorder;
+
+  /**
+   * @ignore
+   */
+  abstract destroyMediaRecorder(mediaRecorder: IMediaRecorder): number;
+
   /**
    * 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.For the audio file formats supported by this method, see What formats of audio files the Agora RTC SDK support.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 the warn code 701.
+   * 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.For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
+   *  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.
    *
-   * @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 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.-1: Play the audio file in an infinite loop.
-   *
    * @param startPos The playback position (ms) of the music file.
    *
    * @returns
-   * 0: Success.< 0: Failure.
+   * 0: Success.< 0: Failure.-1: A general error occurs (no specified reason).-2: The parameter is invalid.-3: The SDK is not ready.The audio module is disabled.The program is not complete.The initialization of IRtcEngine fails. Reinitialize the IRtcEngine.
    */
   abstract startAudioMixing(
     filePath: string,
@@ -3500,7 +3452,7 @@ export abstract class IRtcEngine {
   abstract stopAudioMixing(): number;
 
   /**
-   * Pauses playing the music file.
+   * Pauses playing and mixing the music file.
    * Call this method after joining a channel.
    *
    * @returns
@@ -3518,13 +3470,7 @@ export abstract class IRtcEngine {
   abstract resumeAudioMixing(): number;
 
   /**
-   * Selects the audio track used during playback.
-   * After getting the track index of the audio file, you can call this method to specify any track to play. For example, if different tracks of a multi-track file store songs in different languages, you can call this method to set the playback language.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 ()].
-   *
-   * @returns
-   * 0: Success.< 0: Failure.
+   * @ignore
    */
   abstract selectAudioTrack(index: number): number;
 
@@ -3539,7 +3485,7 @@ 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 the startAudioMixing method.
+   * 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.
    *
@@ -3550,7 +3496,7 @@ export abstract class IRtcEngine {
 
   /**
    * Adjusts the volume of audio mixing for publishing.
-   * This method adjusts the audio mixing volume on the remote clients.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).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.
    *
@@ -3608,7 +3554,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, rather than playing the file 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).You need to call this method after calling startAudioMixing and receiving the onAudioMixingStateChanged(AudioMixingStatePlaying) callback.
    *
    * @param pos Integer. The playback position (ms).
    *
@@ -3641,7 +3587,7 @@ export abstract class IRtcEngine {
 
   /**
    * Retrieves the volume of the audio effects.
-   * The volume range is [0,100]. The default value is 100, the original volume.Call this method after the playEffect method.
+   * The volume is an integer ranging from 0 to 100. The default value is 100, which means the original volume.Call this method after playEffect .
    *
    * @returns
    * Volume of the audio effects, if this method call succeeds.< 0: Failure.
@@ -3650,7 +3596,7 @@ export abstract class IRtcEngine {
 
   /**
    * Sets the volume of the audio effects.
-   * Call this method after the playEffect method.
+   * 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.
    *
@@ -3661,12 +3607,10 @@ export abstract class IRtcEngine {
 
   /**
    * Preloads a specified audio effect file into the memory.
-   * To ensure smooth communication, limit the size of the audio effect file. Agora recommends using this method to preload the audio effect before calling joinChannel [2/2].This method does not support online audio effect files.For the audio file formats supported by this method, see What formats of audio files the Agora RTC SDK support.
+   * 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.This method does not support online audio effect files.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: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 startPos The playback position (ms) of the audio effect file.
    *
    * @returns
@@ -3683,19 +3627,12 @@ export abstract class IRtcEngine {
    * 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.
    *
    * @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 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 effect in an infinite loop.
-   *
+   * @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.
    * @param pitch The pitch of the audio effect. The value range is 0.5 to 2.0. The default value is 1.0, which means the original pitch. The lower the value, the lower the pitch.
-   *
    * @param pan The spatial position of the audio effect. The value ranges between -1.0 and 1.0:-1.0: The audio effect is heard on the left of the user.0.0: The audio effect is heard in front of the user.1.0: The audio effect is heard on the right of the user.
-   *
    * @param gain The volume of the audio effect. The value range is 0.0 to 100.0. The default value is 100.0, which means the original volume. The smaller the value, the lower the volume.
-   *
    * @param publish Whether to publish the audio effect to the remote users:true: Publish the audio effect to the remote users. Both the local user and remote users can hear the audio effect.false: Do not publish the audio effect to the remote users. Only the local user can hear the audio effect.
-   *
    * @param startPos The playback position (ms) of the audio effect file.
    *
    * @returns
@@ -3713,18 +3650,17 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Plays all audio effects.
+   * Plays all audio effect files.
    * After calling preloadEffect multiple times to preload multiple audio effects into the memory, you can call this method to play all the specified audio effects for all users in the channel.
    *
-   * @param loopCount The number of times the audio effect loops:-1: Play the audio effect in an indefinite loop until you call stopEffect or stopAllEffects .0: Play the audio effect once.1: Play the audio effect twice.
-   *
+   * @param loopCount The number of times the audio effect loops:-1: Play the audio effect files in an indefinite loop until you call stopEffect or stopAllEffects .0: Play the audio effect once.1: Play the audio effect twice.
    * @param pitch The pitch of the audio effect. The value ranges between 0.5 and 2.0. The default value is 1.0 (original pitch). The lower the value, the lower the pitch.
-   *
    * @param pan The spatial position of the audio effect. The value ranges between -1.0 and 1.0:-1.0: The audio effect shows on the left.0: The audio effect shows ahead.1.0: The audio effect shows on the right.
-   *
    * @param gain The volume of the audio effect. The value range is [0, 100]. The default value is 100 (original volume). The smaller the value, the lower the volume.
+   * @param publish Whether to publish the audio effect to the remote users:true: Publish the audio effect to the remote users. Both the local user and remote users can hear the audio effect.false: (Default) Do not publish the audio effect to the remote users. Only the local user can hear the audio effect.
    *
-   * @param publish Whether to publish the audio effect to the remote users:true: Publish the audio effect to the remote users. Both the local user and remote users can hear the audio effect.false: Do not publish the audio effect to the remote users. Only the local user can hear the audio effect.
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract playAllEffects(
     loopCount: number,
@@ -3735,20 +3671,19 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Gets the volume of a specified audio effect.
+   * Gets the volume of a specified audio effect file.
    *
-   * @param soundId The ID of the audio effect.
+   * @param soundId The ID of the audio effect file.
    *
    * @returns
-   * The volume of the specified audio effect, if the method call succeeds. The value range is [0,100]. 100 represents the original volume. < 0: Failure.
+   * ≥ 0: Returns the volume of the specified audio effect, if the method call is successful. The value ranges between 0 and 100. 100 represents the original volume. < 0: Failure.
    */
   abstract getVolumeOfEffect(soundId: number): number;
 
   /**
    * Sets the volume of a specified audio effect.
    *
-   * @param soundId The audio effect ID. The ID of each audio effect file is unique.
-   *
+   * @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.
    *
    * @returns
@@ -3757,7 +3692,7 @@ export abstract class IRtcEngine {
   abstract setVolumeOfEffect(soundId: number, volume: number): number;
 
   /**
-   * Pauses playing a specified audio effect file.
+   * Pauses a specified audio effect file.
    *
    * @param soundId The audio effect ID. The ID of each audio effect file is unique.
    *
@@ -3767,7 +3702,7 @@ export abstract class IRtcEngine {
   abstract pauseEffect(soundId: number): number;
 
   /**
-   * Pauses playing all audio effect files.
+   * Pauses all audio effects.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -3785,7 +3720,7 @@ export abstract class IRtcEngine {
   abstract resumeEffect(soundId: number): number;
 
   /**
-   * Resumes playing all audio effects.
+   * Resumes playing all audio effect files.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -3813,7 +3748,7 @@ export abstract class IRtcEngine {
   /**
    * Releases a specified preloaded audio effect from the memory.
    *
-   * @param soundId The audio effect ID. The ID of each audio effect file is unique.
+   * @param soundId The ID of the audio effect. Each audio effect has a unique ID.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -3844,7 +3779,6 @@ export abstract class IRtcEngine {
    * After a successful setting, the local audio effect file starts playing at the specified position.Call this method after playEffect.
    *
    * @param soundId The audio effect ID. The ID of each audio effect file is unique.
-   *
    * @param pos The playback position (ms) of the audio effect file.
    *
    * @returns
@@ -3864,7 +3798,7 @@ export abstract class IRtcEngine {
   abstract getEffectCurrentPosition(soundId: number): number;
 
   /**
-   * Enables/Disables stereo panning for remote users.
+   * Enables or disables stereo panning for remote users.
    * Ensure that you call this method before joining a channel to enable stereo panning for remote users so that the local user can track the position of a remote user by calling setRemoteVoicePosition.
    *
    * @param enabled Whether to enable stereo panning for remote users:true: Enable stereo panning.false: Disable stereo panning.
@@ -3879,9 +3813,7 @@ export abstract class IRtcEngine {
    * This method sets the 2D position and volume of a remote user, so that the local user can easily hear and identify the remote user's position.When the local user calls this method to set the voice position of a remote user, the voice difference between the left and right channels allows the local user to track the real-time position of the remote user, creating a sense of space. This method applies to massive multiplayer online games, such as Battle Royale games.For this method to work, enable stereo panning for remote users by calling the enableSoundPositionIndication method before joining a channel.For the best voice positioning, Agora recommends using a wired headset.Call this method after joining a channel.
    *
    * @param uid The user ID of the remote user.
-   *
    * @param pan The voice position of the remote user. The value ranges from -1.0 to 1.0:0.0: (Default) The remote voice comes from the front.-1.0: The remote voice comes from the left.1.0: The remote voice comes from the right.
-   *
    * @param gain The volume of the remote user. The value ranges from 0.0 to 100.0. The default value is 100.0 (the original volume of the remote user). The smaller the value, the lower the volume.
    *
    * @returns
@@ -3908,9 +3840,7 @@ export abstract class IRtcEngine {
    * Sets the spatial audio effect parameters of the remote user.
    * Call this method after enableSpatialAudio . After successfully setting the spatial audio effect parameters of the remote user, the local user can hear the remote user with a sense of space.
    *
-   * @param uid The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.
-   *
-   * @param params The spatial audio parameters. See SpatialAudioParams for details.
+   * @param uid The user ID.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -3955,13 +3885,11 @@ export abstract class IRtcEngine {
 
   /**
    * Sets parameters for SDK preset audio effects.
-   * Call this method to set the following parameters for the local user who sends an audio stream:3D voice effect: Sets the cycle period of the 3D voice effect.Pitch correction effect: Sets the basic mode and tonic pitch of the pitch correction effect. Different songs have different modes and tonic pitches. Agora recommends bounding this method with interface elements to enable users to adjust the pitch correction interactively.After setting the audio parameters, all users in the channel can hear the effect.You can call this method either before or after joining a channel.To get better audio effect quality, Agora recommends calling and setting scenario in setAudioProfile as AudioScenarioGameStreaming(3) before calling this method.Do not set the profile parameter in setAudioProfile to AudioProfileSpeechStandard(1) or AudioProfileIot(6), or the method does not take effect.This method works best with the human voice. Agora does not recommend using this method for audio containing music.After calling setAudioEffectParameters, Agora recommends not calling the following methods, or the settings in setAudioEffectParameters are overridden: setAudioEffectPreset setVoiceBeautifierPreset setLocalVoicePitch setLocalVoiceEqualization setLocalVoiceReverb setVoiceBeautifierParameters setVoiceConversionPreset
-   *
-   * @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.If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.PitchCorrection; pitch correction effect: To achieve better audio effect quality, Agora recommends setting the profile parameter in setAudioProfile to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5) before setting this enumerator.
+   * Call this method to set the following parameters for the local user who sends an audio stream:3D voice effect: Sets the cycle period of the 3D voice effect.Pitch correction effect: Sets the basic mode and tonic pitch of the pitch correction effect. Different songs have different modes and tonic pitches. Agora recommends bounding this method with interface elements to enable users to adjust the pitch correction interactively.After setting the audio parameters, all users in the channel can hear the effect.You can call this method either before or after joining a channel.To get better audio effect quality, Agora recommends setting the scenario parameter of setAudioProfile as AudioScenarioGameStreaming(3) before calling this method.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 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
    *
-   * @param param1 If you set preset to RoomAcoustics3dVoice, param1 indicates the cycle period of the 3D voice effect. The value range is [1,60], in seconds. The default value is 10, indicating that the voice moves around you every 10 seconds. If you set preset to PitchCorrection, param1 indicates the basic mode of the pitch correction effect:1: (Default) Natural major scale.2: Natural minor scale.3: Japanese pentatonic scale.
-   *
-   * @param param2 If you set preset to RoomAcoustics3dVoice, you need to set param2 to 0. If you set preset to PitchCorrection, param2 indicates the tonic pitch of the pitch correction effect:1: A2: A#3: B4: (Default) C5: C#6: D7: D#8: E9: F10: F#11: G12: G#
+   * @param preset The options for SDK preset audio effects:RoomAcoustics3dVoice, 3D voice effect:Call setAudioProfile and set the profile parameter in to AudioProfileMusicStandardStereo(3) or AudioProfileMusicHighQualityStereo(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.PitchCorrection, Pitch correction effect: To achieve better audio effect quality, Agora recommends setting the profile parameter in setAudioProfile to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5) before setting this enumerator.
+   * @param param1 If you set preset to RoomAcoustics3dVoice, param1 sets the cycle period of the 3D voice effect. The value range is [1,60] and the unit is seconds. The default value is 10, indicating that the voice moves around you every 10 seconds.If you set preset to PitchCorrection, param1 indicates the basic mode of the pitch correction effect:1: (Default) Natural major scale.2: Natural minor scale.3: Japanese pentatonic scale.
+   * @param param2 If you set preset to RoomAcoustics3dVoice , you need to set param2 to 0.If you set preset to PitchCorrection, param2 indicates the tonic pitch of the pitch correction effect:1: A2: A#3: B4: (Default) C5: C#6: D7: D#8: E9: F10: F#11: G12: G#
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -3974,12 +3902,10 @@ export abstract class IRtcEngine {
 
   /**
    * Sets parameters for the preset voice beautifier effects.
-   * Call this method to set a gender characteristic and a reverberation effect for the singing beautifier effect. This method sets parameters for the local user who sends an audio stream. After setting the audio parameters, all users in the channel can hear the effect.For better voice effects, Agora recommends that you call setAudioProfile and set scenario to AudioScenarioGameStreaming(3) and profile to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5) before calling this method.You can call this method either before or after joining a channel.Do not set the profile parameter in setAudioProfile to AudioProfileSpeechStandard(1)This method works best with the human voice. Agora does not recommend using this method for audio containing music.After calling setVoiceBeautifierParameters, Agora recommends not calling the following methods, because they can override settings in setVoiceBeautifierParameters: setAudioEffectPreset setAudioEffectParameters setVoiceBeautifierPreset setLocalVoicePitch setLocalVoiceEqualization setLocalVoiceReverb setVoiceConversionPreset
+   * Call this method to set a gender characteristic and a reverberation effect for the singing beautifier effect. This method sets parameters for the local user who sends an audio stream. After setting the audio parameters, all users in the channel can hear the effect.For better voice effects, Agora recommends that you call setAudioProfile and set scenario to AudioScenarioGameStreaming(3) and profile to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5) before calling this method.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 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
    *
    * @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.
-   *
    * @param param2 The reverberation effect options for the singing voice:1: The reverberation effect sounds like singing in a small room.2: The reverberation effect sounds like singing in a large room.3: The reverberation effect sounds like singing in a hall.
    *
    * @returns
@@ -3992,7 +3918,15 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * @ignore
+   * Sets parameters for the preset voice beautifier effects.
+   * Call this method to set a gender characteristic and a reverberation effect for the singing beautifier effect. This method sets parameters for the local user who sends an audio stream. After setting the audio parameters, all users in the channel can hear the effect.For better voice effects, Agora recommends that you call setAudioProfile and set scenario to AudioScenarioGameStreaming(3) and profile to AudioProfileMusicHighQuality(4) or AudioProfileMusicHighQualityStereo(5) before calling this method.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 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
+   *
+   * @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.
+   * @param param2 The reverberation effect options for the singing voice:1: The reverberation effect sounds like singing in a small room.2: The reverberation effect sounds like singing in a large room.3: The reverberation effect sounds like singing in a hall.
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract setVoiceConversionParameters(
     preset: VoiceConversionPreset,
@@ -4004,19 +3938,23 @@ 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 (no change to the pitch).
+   * @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
    * 0: Success.< 0: Failure.
    */
   abstract setLocalVoicePitch(pitch: number): number;
 
+  /**
+   * @ignore
+   */
+  abstract setLocalVoiceFormant(formantRatio: number): number;
+
   /**
    * 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.
-   *
+   * @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.
    *
    * @returns
@@ -4029,10 +3967,9 @@ export abstract class IRtcEngine {
 
   /**
    * Sets the local voice reverberation.
-   * The SDK also provides the setAudioEffectPreset method, which allows you to directly implement preset reverb effects for such as pop, R&B, and KTV.You can call this method either before or after joining a channel.
-   *
-   * @param reverbKey The reverberation key. Agora provides five reverberation keys; see AudioReverbType for details.
+   * The SDK provides an easier-to-use method, setAudioEffectPreset , to directly implement preset reverb effects for such as pop, R&B, and KTV.You can call this method either before or after joining a channel.
    *
+   * @param reverbKey The reverberation key. Agora provides five reverberation keys, see AudioReverbType .
    * @param value The value of the reverberation key.
    *
    * @returns
@@ -4059,7 +3996,6 @@ export abstract class IRtcEngine {
    * In a spatial audio effect scenario, if the preset headphone equalization effect is not achieved after calling the setHeadphoneEQPreset method, you can further adjust the headphone equalization effect by calling this method.
    *
    * @param lowGain The low-frequency parameters of the headphone equalizer. The value range is [-10,10]. The larger the value, the deeper the sound.
-   *
    * @param highGain The high-frequency parameters of the headphone equalizer. The value range is [-10,10]. The larger the value, the sharper the sound.
    *
    * @returns
@@ -4069,7 +4005,7 @@ export abstract class IRtcEngine {
 
   /**
    * 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 this method immediately after calling the initialize method to initialize the IRtcEngine , or the output log may not be complete.
+   * 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.
    *
    * @param filePath The complete path of the log files. These log files are encoded in UTF-8.
    *
@@ -4080,7 +4016,7 @@ export abstract class IRtcEngine {
 
   /**
    * Sets the log output level of the SDK.
-   * Deprecated:Use logConfig in initialize instead.This method sets the output log level of the SDK. You can use one or a combination of the log filter levels. The log level follows the sequence of LogFilterOff, LogFilterCritical, LogFilterError, LogFilterWarn, LogFilterInfo, and LogFilterDebug. Choose a level to see the logs preceding that level.If, for example, you set the log level to LogFilterWarn, you see the logs within levels LogFilterCritical, LogFilterError, and LogFilterWarn.
+   * Deprecated:Use logConfig in initialize instead.This method sets the output log level of the SDK. You can use one or a combination of the log filter levels. The log level follows the sequence of LogFilterOff, LogFilterCritical, LogFilterError, LogFilterWarn, LogFilterInfo, and LogFilterDebug. Choose a level to see the logs preceding that level.If, for example, you set the log level to LogFilterWarn, you see the logs within levels LogFilterCritical, LogFilterError and LogFilterWarn.
    *
    * @param filter The output log level of the SDK. See LogFilterType .
    *
@@ -4117,15 +4053,7 @@ export abstract class IRtcEngine {
   abstract uploadLogFile(requestId: string): number;
 
   /**
-   * 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.
-   *
-   * @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.
-   *
-   * @returns
-   * 0: Success. < 0: Failure.
+   * @ignore
    */
   abstract setLocalRenderMode(
     renderMode: RenderModeType,
@@ -4133,14 +4061,7 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Updates the display mode of the video view of a remote user.
-   * After initializing the video view of a remote user, you can call this method to update its rendering and mirror modes. This method affects only the video view that the local user sees.Please call this method after initializing the remote view by calling the setupRemoteVideo method.During a call, you can call this method as many times as necessary to update the display mode of the video view of a remote user.
-   *
-   * @param uid The user ID of the remote user.
-   *
-   * @param renderMode The rendering mode of the remote user view.
-   *
-   * @param mirrorMode The mirror mode of the remote user view.
+   * @ignore
    */
   abstract setRemoteRenderMode(
     uid: number,
@@ -4149,21 +4070,20 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Sets the local video mirror mode.
-   * Deprecated:This method is deprecated.Use setupLocalVideo or setLocalRenderMode instead.
-   *
-   * @param mirrorMode The local video mirror mode. See VideoMirrorModeType .
-   *
-   * @returns
-   * 0: Success.< 0: Failure.
+   * @ignore
    */
   abstract setLocalVideoMirrorMode(mirrorMode: VideoMirrorModeType): number;
 
   /**
-   * Enables or disables dual-stream mode on the sender side.
-   * This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.If you need to enable dual video streams in a multi-channel scenario, you can call the enableDualStreamModeEx method.You can call this method either before or after joining a channel.Dual streams are a pairing of a high-quality video stream and a low-quality video stream:High-quality video stream: High bitrate, high resolution.Low-quality video stream: Low bitrate, low resolution.After you enable dual-stream mode, you can call setRemoteVideoStreamType to choose to receive either the high-quality video stream or the low-quality video stream on the subscriber side.
+   * Enables or disables the dual-stream mode on the sender and sets the low-quality video stream.
+   * You can call this method to enable or disable the dual-stream mode on the publisher side. Dual streams are a pairing of a high-quality video stream and a low-quality video stream:
+   *  High-quality video stream: High bitrate, high resolution.
+   *  Low-quality video stream: Low bitrate, low resolution. After you enable dual-stream mode, you can call setRemoteVideoStreamType to choose to receive either the high-quality video stream or the low-quality video stream on the subscriber side. This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.
+   *  If you need to enable dual video streams in a multi-channel scenario, you can call the enableDualStreamModeEx method.
+   *  You can call this method either before or after joining a channel.
    *
-   * @param enabled Whether to enable dual-stream mode.true: Enable dual-stream mode.false: (Default) Disable dual-stream mode.
+   * @param enabled Whether to enable dual-stream mode:true: Enable dual-stream mode.false: (Default) Disable dual-stream mode.
+   * @param streamConfig The configuration of the low-quality video stream. See SimulcastStreamConfig .
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -4174,10 +4094,14 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Sets dual-stream mode on the sender side.
-   * The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to AutoSimulcastStream. If you want to modify this behavior, you can call this method and modify the mode to DisableSimulcastStream(always never send low-quality video streams) or EnableSimulcastStream (always send low-quality video streams).The difference and connection between this method and enableDualStreamMode [1/3] is as follows:When calling this method and setting mode to DisableSimulcastStream, it has the same effect as enableDualStreamMode [1/3](false).When calling this method and setting mode to EnableSimulcastStream, it has the same effect as enableDualStreamMode [1/3](true).Both methods can be called before and after joining a channel. If they are used at the same time, the settings in the method called later shall prevail.
+   * Sets dual-stream mode configuration on the sender, and sets the low-quality video stream.
+   * The difference and connection between this method and enableDualStreamMode [1/3] is as follows:
+   *  When calling this method and setting mode to DisableSimulcastStream, it has the same effect as enableDualStreamMode [1/3](false).
+   *  When calling this method and setting mode to EnableSimulcastStream, it has the same effect as enableDualStreamMode [1/3](true).
+   *  Both methods can be called before and after joining a channel. If they are used at the same time, the settings in the method called later shall prevail. The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to AutoSimulcastStream. If you want to modify this behavior, you can call this method and modify the mode to DisableSimulcastStream(never send low-quality video streams) or EnableSimulcastStream (always send low-quality video streams).
    *
    * @param mode The mode in which the video stream is sent. See SimulcastStreamMode .
+   * @param streamConfig The configuration of the low-quality video stream. See SimulcastStreamConfig .When setting mode to DisableSimulcastStream, setting streamConfig will not take effect.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -4187,52 +4111,21 @@ export abstract class IRtcEngine {
     streamConfig?: SimulcastStreamConfig
   ): number;
 
-  /**
-   * @ignore
-   */
-  abstract enableEchoCancellationExternal(
-    enabled: boolean,
-    audioSourceDelay: number
-  ): number;
-
   /**
    * @ignore
    */
   abstract enableCustomAudioLocalPlayback(
-    sourceId: number,
+    trackId: number,
     enabled: boolean
   ): number;
 
-  /**
-   * @ignore
-   */
-  abstract startPrimaryCustomAudioTrack(config: AudioTrackConfig): number;
-
-  /**
-   * @ignore
-   */
-  abstract stopPrimaryCustomAudioTrack(): number;
-
-  /**
-   * @ignore
-   */
-  abstract startSecondaryCustomAudioTrack(config: AudioTrackConfig): number;
-
-  /**
-   * @ignore
-   */
-  abstract stopSecondaryCustomAudioTrack(): number;
-
   /**
    * 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 = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s).
+   * 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).
    *
    * @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: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.
    *
    * @returns
@@ -4247,14 +4140,11 @@ export abstract class IRtcEngine {
 
   /**
    * Sets the audio data format for playback.
-   * 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 = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onPlaybackAudioFrame callback according to the sampling interval.
+   * 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 callback according to the sampling interval.onPlaybackAudioFrame
    *
    * @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: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.
    *
    * @returns
@@ -4271,9 +4161,7 @@ export abstract class IRtcEngine {
    * Sets the audio data format reported by onMixedAudioFrame .
    *
    * @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 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.
    *
    * @returns
@@ -4290,11 +4178,8 @@ export abstract class IRtcEngine {
    * This method is used to set the in-ear monitoring audio data format reported by the onEarMonitoringAudioFrame callback.Before calling this method, you need to call enableInEarMonitoring , and set includeAudioFilters to EarMonitoringFilterBuiltInAudioFilters or EarMonitoringFilterNoiseSuppression.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 onEarMonitoringAudioFrame callback according to the sampling interval.
    *
    * @param sampleRate The sample rate of the audio data reported in the onEarMonitoringAudioFrame callback, which can be set as 8,000, 16,000, 32,000, 44,100, or 48,000 Hz.
-   *
    * @param channel The number of audio channels reported in the onEarMonitoringAudioFrame callback.1: Mono.2: Stereo.
-   *
    * @param mode The use mode of the audio frame. See RawAudioFrameOpModeType .
-   *
    * @param samplesPerCall The number of data samples reported in the onEarMonitoringAudioFrame callback, such as 1,024 for the Media Push.
    *
    * @returns
@@ -4311,7 +4196,6 @@ export abstract class IRtcEngine {
    * Sets the audio data format reported by onPlaybackAudioFrameBeforeMixing .
    *
    * @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 external audio source, which can be set as 1(Mono) or 2(Stereo).
    *
    * @returns
@@ -4326,7 +4210,7 @@ export abstract class IRtcEngine {
    * Turns on audio spectrum monitoring.
    * If you want to obtain the audio spectrum data of local or remote users, you can register the audio spectrum observer and enable audio spectrum monitoring.You can call this method either before or after joining a channel.
    *
-   * @param intervalInMS The interval (in milliseconds) at which the SDK triggers the onLocalAudioSpectrum and onRemoteAudioSpectrum callbacks. The default value is 100. Do not set this parameter to less than 10 milliseconds, otherwise the calling of this method fails.
+   * @param intervalInMS The interval (in milliseconds) at which the SDK triggers the onLocalAudioSpectrum and onRemoteAudioSpectrum callbacks. The default value is 100. Do not set this parameter to a value less than 10, otherwise calling this method would fail.
    *
    * @returns
    * 0: Success.< 0: Failure.-2: Invalid parameters.
@@ -4343,9 +4227,9 @@ export abstract class IRtcEngine {
   abstract disableAudioSpectrumMonitor(): number;
 
   /**
-   * Registers an audio spectrum observer.
+   * Register an audio spectrum observer.
    * After successfully registering the audio spectrum observer and calling
-   * enableAudioSpectrumMonitor to enable the audio spectrum monitoring, the SDK reports the callback that you implement in the IAudioSpectrumObserver class at the time interval you set.You can call this method either before or after joining a channel.
+   *  enableAudioSpectrumMonitor to enable the audio spectrum monitoring, the SDK reports the callback that you implement in the IAudioSpectrumObserver class according to the time interval you set.You can call this method either before or after joining a channel.
    *
    * @param observer The audio spectrum observer. See IAudioSpectrumObserver .
    *
@@ -4357,8 +4241,9 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Unregisters the audio spectrum observer.
-   * After calling registerAudioSpectrumObserver , if you want to disable audio spectrum monitoring, you can call this method.You can call this method either before or after joining a channel.
+   * Unregisters the encoded audio frame observer.
+   *
+   * @param observer The encoded audio observer. See IAudioEncodedFrameObserver .
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -4381,7 +4266,7 @@ export abstract class IRtcEngine {
   /**
    * Whether to mute the recording signal.
    *
-   * @param mute true: Mute the recording signal.false: (Default) Do not mute the recording signal.
+   * @param mute true: Mute the recording signal.false: (Default) Unmute the recording signal.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -4392,10 +4277,7 @@ export abstract class IRtcEngine {
    * Adjusts the playback signal volume of all remote users.
    * This method adjusts the playback volume that is the mixed volume of all remote users.You can call this method either before or after joining a channel.
    *
-   * @param volume The volume of the user. The value range is [0,400].
-   *  0: Mute.
-   *  100: (Default) The original volume.
-   *  400: Four times the original volume (amplifying the audio signals by four times).
+   * @param volume The volume of the user. The value range is [0,400].0: Mute.100: (Default) The original volume.400: Four times the original volume (amplifying the audio signals by four times).
    *
    * @returns
    * 0: Success. < 0: Failure.
@@ -4406,9 +4288,8 @@ export abstract class IRtcEngine {
    * Adjusts the playback signal volume of a specified remote user.
    * You can call this method to adjust the playback volume of a specified remote user. To adjust the playback volume of different remote users, call the method as many times, once for each remote user.Call this method after joining a channel.The playback volume here refers to the mixed volume of a specified remote user.
    *
-   * @param volume Audio mixing volume. The value ranges between 0 and 100. The default value is 100, which means the original volume.
-   *
    * @param uid The user ID of the remote user.
+   * @param volume Audio mixing volume. The value ranges between 0 and 100. The default value is 100, which means the original volume.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -4427,13 +4308,24 @@ export abstract class IRtcEngine {
     option: StreamFallbackOptions
   ): number;
 
+  /**
+   * @ignore
+   */
+  abstract setHighPriorityUserList(
+    uidList: number[],
+    uidNum: number,
+    option: StreamFallbackOptions
+  ): number;
+
   /**
    * Enables loopback audio capturing.
    * If you enable loopback audio capturing, the output of the sound card is mixed into the audio stream sent to the other end.This method applies to the macOS and Windows platforms only.macOS does not support loopback audio capture of the default sound card. If you need to use this function, use a virtual sound card and pass its name to the deviceName parameter. Agora recommends using AgoraALD as the virtual sound card for audio capturing.You can call this method either before or after joining a channel.
    *
    * @param enabled Whether to enable loopback audio capturing.true: Enable loopback audio capturing.false: (Default) Disable loopback audio capturing.
+   * @param deviceName macOS: The device name of the virtual sound card. The default value is set to NULL, which means using AgoraALD for loopback audio capturing.Windows: The device name of the sound card. The default is set to NULL, which means the SDK uses the sound card of your device for loopback audio capturing.
    *
-   * @param deviceName macOS: The device name of the virtual sound card. The default value is set to NULL, which means using AgoraALD for loopback audio capturing.Windows: The device name of the sound card. The default is set to null, which means the SDK uses the sound card of your device for loopback audio capturing.
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract enableLoopbackRecording(
     enabled: boolean,
@@ -4461,7 +4353,6 @@ export abstract class IRtcEngine {
    * This method enables or disables in-ear monitoring.Users must use earphones (wired or Bluetooth) to hear the in-ear monitoring effect.You can call this method either before or after joining a channel.
    *
    * @param enabled Enables or disables in-ear monitoring.true: Enables in-ear monitoring.false: (Default) Disables in-ear monitoring.
-   *
    * @param includeAudioFilters The audio filter of in-ear monitoring: See EarMonitoringFilterType .
    *
    * @returns
@@ -4477,6 +4368,9 @@ export abstract class IRtcEngine {
    * Users must use wired earphones to hear their own voices.You can call this method either before or after joining a channel.
    *
    * @param volume The volume of the in-ear monitor. The value ranges between 0 and 100. The default value is 100.
+   *
+   * @returns
+   * < 0: Failure.
    */
   abstract setInEarMonitoringVolume(volume: number): number;
 
@@ -4484,7 +4378,6 @@ export abstract class IRtcEngine {
    * Adds an extension to the SDK.
    *
    * @param path The extension library path and name. For example: /library/libagora_segmentation_extension.dll.
-   *
    * @param unloadAfterUse Whether to uninstall the current extension when you no longer using it:true: Uninstall the extension when the IRtcEngine is destroyed.false: (Rcommended) Do not uninstall the extension until the process terminates.
    *
    * @returns
@@ -4499,11 +4392,12 @@ export abstract class IRtcEngine {
    * Sets the properties of the extension provider.
    * You can call this method to set the attributes of the extension provider and initialize the relevant parameters according to the type of the provider.Call this method after enableExtension , and before enabling the audio ( enableAudio / enableLocalAudio ) or the video ( enableVideo / enableLocalVideo ).
    *
-   * @param value The value of the extension key.
-   *
+   * @param provider The name of the extension provider.
    * @param key The key of the extension.
+   * @param value The value of the extension key.
    *
-   * @param provider The name of the extension provider.
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract setExtensionProviderProperty(
     provider: string,
@@ -4515,11 +4409,9 @@ export abstract class IRtcEngine {
    * Registers an extension.
    * After the extension is loaded, you can call this method to register the extension.This method applies to Windows only.
    *
-   * @param type Type of media source. See MediaSourceType .In this method, this parameter supports only the following two settings:The default value is UnknownMediaSource.If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.
-   *
-   * @param extension The name of the extension.
-   *
    * @param provider The name of the extension provider.
+   * @param extension The name of the extension.
+   * @param type Type of media source. See MediaSourceType .In this method, this parameter supports only the following two settings:The default value is UnknownMediaSource.If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -4531,19 +4423,16 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Enables/Disables an extension.
+   * Enables or disables extensions.
    * To call this method, call it immediately after initializing the IRtcEngine object.If you want to enable multiple extensions, you need to call this method multiple times.The data processing order of different extensions in the SDK is determined by the order in which the extensions are enabled. That is, the extension that is enabled first will process the data first.
    *
-   * @param extension The name of the extension.
-   *
    * @param provider The name of the extension provider.
-   *
+   * @param extension The name of the extension.
    * @param enable Whether to enable the extension:true: Enable the extension.false: Disable the extension.
-   *
    * @param type Type of media source. See MediaSourceType .In this method, this parameter supports only the following two settings:The default value is UnknownMediaSource.If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.
    *
    * @returns
-   * 0: Success.< 0: Failure.
+   * 0: Success.< 0: Failure.-3: The extension library is not loaded. Agora recommends that you check the storage location or the name of the dynamic library.
    */
   abstract enableExtension(
     provider: string,
@@ -4557,14 +4446,13 @@ export abstract class IRtcEngine {
    * After enabling the extension, you can call this method to set the properties of the extension.
    *
    * @param provider The name of the extension provider.
-   *
    * @param extension The name of the extension.
-   *
    * @param key The key of the extension.
-   *
    * @param value The value of the extension key.
+   * @param type The type of the video source, see MediaSourceType .
    *
-   * @param type The type of the video source. See MediaSourceType .
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract setExtensionProperty(
     provider: string,
@@ -4578,14 +4466,10 @@ export abstract class IRtcEngine {
    * Gets detailed information on the extensions.
    *
    * @param provider The name of the extension provider.
-   *
    * @param extension The name of the extension.
-   *
    * @param key The key of the extension.
-   *
-   * @param type Source type of the extension. See MediaSourceType .
-   *
    * @param bufLen Maximum length of the JSON string indicating the extension property. The maximum value is 512 bytes.
+   * @param type Source type of the extension. See MediaSourceType .
    *
    * @returns
    * The extension information, if the method call succeeds.An empty string, if the method call fails.
@@ -4630,7 +4514,12 @@ export abstract class IRtcEngine {
   abstract destroyCustomVideoTrack(videoTrackId: number): number;
 
   /**
-   * @ignore
+   * Destroys the specified video track.
+   *
+   * @param videoTrackId The video track ID returned by calling the createCustomVideoTrack method.
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract destroyCustomEncodedVideoTrack(videoTrackId: number): number;
 
@@ -4670,7 +4559,13 @@ export abstract class IRtcEngine {
   abstract setCameraZoomFactor(factor: number): number;
 
   /**
-   * @ignore
+   * Enables/Disables the local video capture.
+   * This method disables or re-enables the local video capture, and does not affect receiving the remote video stream.After calling enableVideo , the local video capture is enabled by default. You can call enableLocalVideo (false) to disable the local video capture. If you want to re-enable the local video capture, call enableLocalVideo(true).After the local video capturer is successfully disabled or re-enabled, the SDK triggers the onRemoteVideoStateChanged callback on the remote client.You can call this method either before or after joining a channel.This method enables the internal engine and is valid after leaving the channel.
+   *
+   * @param enabled Whether to enable the local video capture.true: (Default) Enable the local video capture.false: Disable the local video capture. Once the local video is disabled, the remote users cannot receive the video stream of the local user, while the local user can still receive the video streams of remote users. When set to false, this method does not require a local camera.
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract enableFaceDetection(enabled: boolean): number;
 
@@ -4693,7 +4588,13 @@ export abstract class IRtcEngine {
   abstract setCameraTorchOn(isOn: boolean): number;
 
   /**
-   * @ignore
+   * Enables/Disables the local video capture.
+   * This method disables or re-enables the local video capture, and does not affect receiving the remote video stream.After calling enableVideo , the local video capture is enabled by default. You can call enableLocalVideo (false) to disable the local video capture. If you want to re-enable the local video capture, call enableLocalVideo(true).After the local video capturer is successfully disabled or re-enabled, the SDK triggers the onRemoteVideoStateChanged callback on the remote client.You can call this method either before or after joining a channel.This method enables the internal engine and is valid after leaving the channel.
+   *
+   * @param enabled Whether to enable the local video capture.true: (Default) Enable the local video capture.false: Disable the local video capture. Once the local video is disabled, the remote users cannot receive the video stream of the local user, while the local user can still receive the video streams of remote users. When set to false, this method does not require a local camera.
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract setCameraAutoFocusFaceModeEnabled(enabled: boolean): number;
 
@@ -4716,7 +4617,13 @@ export abstract class IRtcEngine {
   abstract isCameraAutoExposureFaceModeSupported(): boolean;
 
   /**
-   * @ignore
+   * Enables/Disables the local video capture.
+   * This method disables or re-enables the local video capture, and does not affect receiving the remote video stream.After calling enableVideo , the local video capture is enabled by default. You can call enableLocalVideo (false) to disable the local video capture. If you want to re-enable the local video capture, call enableLocalVideo(true).After the local video capturer is successfully disabled or re-enabled, the SDK triggers the onRemoteVideoStateChanged callback on the remote client.You can call this method either before or after joining a channel.This method enables the internal engine and is valid after leaving the channel.
+   *
+   * @param enabled Whether to enable the local video capture.true: (Default) Enable the local video capture.false: Disable the local video capture. Once the local video is disabled, the remote users cannot receive the video stream of the local user, while the local user can still receive the video streams of remote users. When set to false, this method does not require a local camera.
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract setCameraAutoExposureFaceModeEnabled(enabled: boolean): number;
 
@@ -4739,13 +4646,11 @@ export abstract class IRtcEngine {
 
   /**
    * Gets a list of shareable screens and windows.
-   * You can call this method before sharing a screen or window to get a list of shareable screens and windows, which enables a user to use thumbnails in the list to choose a particular screen or window to share. This list also contains important information such as window ID and screen ID, with which you can call startScreenCaptureByWindowId or startScreenCaptureByDisplayId to start the sharing.
+   * You can call this method before sharing a screen or window to get a list of shareable screens and windows, which enables a user to use thumbnails in the list to easily choose a particular screen or window to share. This list also contains important information such as window ID and screen ID, with which you can call startScreenCaptureByWindowId or startScreenCaptureByDisplayId to start the sharing.
    *
    * @param thumbSize The target size of the screen or window thumbnail (the width and height are in pixels). The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and thumbSize is 100 × 100, the actual size of the thumbnail is 100 × 75. If the target size is larger than the original size, the thumbnail is the original image and the SDK does not scale it.
-   *
    * @param iconSize The target size of the icon corresponding to the application program (the width and height are in pixels). The SDK scales the original image to make the length of the longest side of the image the same as that of the target size without distorting the original image. For example, if the original image is 400 × 300 and iconSize is 100 × 100, the actual size of the icon is 100 × 75. If the target size is larger than the original size, the icon is the original image and the SDK does not scale it.
-   *
-   * @param includeScreen Whether the SDK returns the screen information in addition to the window information:true: The SDK returns screen and window information.false: The SDK returns the window information only.
+   * @param includeScreen Whether the SDK returns the screen information in addition to the window information:true: The SDK returns screen and window information.false: The SDK returns window information only.
    *
    * @returns
    * The ScreenCaptureSourceInfo array.
@@ -4765,16 +4670,14 @@ export abstract class IRtcEngine {
 
   /**
    * Shares the screen by specifying the display ID.
-   * This method shares a screen or part of the screen.There are two ways to start screen sharing, you can choose one according to the actual needs:Call this method before joining a channel, and then call joinChannel [2/2] to join a channel and set publishScreenTrack or publishSecondaryScreenTrack to true to start screen sharing.Call this method after joining a channel, and then call updateChannelMediaOptions and set publishScreenTrack or publishSecondaryScreenTrack to true to start screen sharing.
+   * This method shares a screen or part of the screen.There are two ways to start screen sharing, you can choose one according to your needs:Call this method before joining a channel, and then call joinChannel to join a channel and set publishScreenTrack or publishSecondaryScreenTrack to true to start screen sharing.Call this method after joining a channel, and then call updateChannelMediaOptions and set publishScreenTrack or publishSecondaryScreenTrack to true to start screen sharing.
    *
    * @param displayId The display ID of the screen to be shared.
-   *
-   * @param regionRect (Optional) Sets the relative location of the region to the screen. If you do not set this parameter, the SDK shares the whole screen. See Rectangle . If the specified region overruns the screen, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen.
-   *
+   * @param regionRect (Optional) Sets the relative location of the region to the screen. If you do not set this parameter, the SDK shares the whole screen.
    * @param captureParams Screen sharing configurations. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters .
    *
    * @returns
-   * 0: Success.< 0: Failure.ERR_INVALID_STATE: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.ERR_INVALID_ARGUMENT: The parameter is invalid.
+   * 0: Success.< 0: Failure.-2: The parameter is invalid.-8: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.
    */
   abstract startScreenCaptureByDisplayId(
     displayId: number,
@@ -4784,20 +4687,14 @@ export abstract class IRtcEngine {
 
   /**
    * Shares the whole or part of a screen by specifying the screen rect.
-   * There are two ways to start screen sharing, you can choose one according to the actual needs:
-   * Call this method before joining a channel, and then call joinChannel [2/2] to join a channel and set publishScreenTrack or publishSecondaryScreenTrack to true to start screen sharing.
-   * Call this method after joining a channel, and then call updateChannelMediaOptions and set publishScreenTrack or publishSecondaryScreenTrack to true to start screen sharing. Deprecated:This method is deprecated. Use startScreenCaptureByDisplayId instead. Agora strongly recommends using startScreenCaptureByDisplayId if you need to start screen sharing on a device connected to another display.This method shares a screen or part of the screen. You need to specify the area of the screen to be shared.This method applies to Windows only.
+   * There are two ways to start screen sharing, you can choose one according to your needs:Call this method before joining a channel, and then call joinChannel to join a channel and set publishScreenTrack or publishSecondaryScreenTrack to true to start screen sharing.Call this method after joining a channel, and then call updateChannelMediaOptions and set publishScreenTrack or publishSecondaryScreenTrack to true to start screen sharing.Deprecated:This method is deprecated. Use startScreenCaptureByDisplayId instead. Agora strongly recommends using startScreenCaptureByDisplayId if you need to start screen sharing on a device connected to another display.This method shares a screen or part of the screen. You need to specify the area of the screen to be shared.This method applies to Windows only.
    *
    * @param screenRect Sets the relative location of the screen to the virtual screen.
-   *
    * @param regionRect  Rectangle . If the specified region overruns the screen, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen.
-   *
-   * @param captureParams The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters .
+   * @param captureParams The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters .
    *
    * @returns
-   * 0: Success.< 0: Failure.
-   * ERR_INVALID_STATE: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.
-   * ERR_INVALID_ARGUMENT: The parameter is invalid.
+   * 0: Success.< 0: Failure.-2: The parameter is invalid.-8: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.
    */
   abstract startScreenCaptureByScreenRect(
     screenRect: Rectangle,
@@ -4813,16 +4710,18 @@ export abstract class IRtcEngine {
 
   /**
    * Shares the whole or part of a window by specifying the window ID.
-   * There are two ways to start screen sharing, you can choose one according to the actual needs:Call this method before joining a channel, and then call joinChannel [2/2] to join a channel and set publishScreenTrack or publishSecondaryScreenTrack to true to start screen sharing.Call this method after joining a channel, and then call updateChannelMediaOptions and set publishScreenTrack or publishSecondaryScreenTrack to true to start screen sharing.This method shares a window or part of the window. You need to specify the ID of the window to be shared.Applies to the macOS and Windows platforms only.The window sharing feature of the Agora SDK relies on WGC (Windows Graphics Capture) or GDI (Graphics Device Interface) capture, and WGC cannot be set to disable mouse capture on systems earlier than Windows 10 2004. Therefore, captureMouseCursor(false) might not work when you start window sharing on a device with a system earlier than Windows 10 2004. See ScreenCaptureParameters .This method supports window sharing of UWP (Universal Windows Platform) applications. Agora tests the mainstream UWP applications by using the lastest SDK, see details as follows:
+   * There are two ways to start screen sharing, you can choose one according to your needs:
+   *  Call this method before joining a channel, and then call joinChannel to join a channel and set publishScreenTrack or publishSecondaryScreenTrack to true to start screen sharing.
+   *  Call this method after joining a channel, and then call updateChannelMediaOptions and set publishScreenTrack or publishSecondaryScreenTrack to true to start screen sharing. This method shares a window or part of the window. You need to specify the ID of the window to be shared.This method applies to the macOS and Windows platforms only.The window sharing feature of the Agora SDK relies on WGC (Windows Graphics Capture) or GDI (Graphics Device Interface) capture, and WGC cannot be set to disable mouse capture on systems earlier than Windows 10 2004. Therefore, captureMouseCursor(false) might not work when you start window sharing on a device with a system earlier than Windows 10 2004. See ScreenCaptureParameters .This method supports window sharing of UWP (Universal Windows Platform) applications. Agora tests the mainstream UWP applications by using the lastest SDK, see details as follows:
    *
    * @param windowId The ID of the window to be shared.
-   *
    * @param regionRect (Optional) Sets the relative location of the region to the screen. If you do not set this parameter, the SDK shares the whole screen. See Rectangle . If the specified region overruns the window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole window.
-   *
-   * @param captureParams Screen sharing configurations. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters .
+   * @param captureParams Screen sharing configurations. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters .
    *
    * @returns
-   * 0: Success.< 0: Failure.ERR_INVALID_STATE: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.ERR_INVALID_ARGUMENT: The parameter is invalid.
+   * 0: Success.< 0: Failure.
+   *  -2: The parameter is invalid.
+   *  -8: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.
    */
   abstract startScreenCaptureByWindowId(
     windowId: any,
@@ -4837,20 +4736,11 @@ export abstract class IRtcEngine {
    * @param contentHint The content hint for screen sharing. See VideoContentHint .
    *
    * @returns
-   * 0: Success.< 0: Failure.ERR_INVALID_STATE: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.ERR_INVALID_ARGUMENT: The parameter is invalid.
-   */
-  abstract setScreenCaptureContentHint(contentHint: VideoContentHint): number;
-
-  /**
-   * Sets the screen sharing scenario.
-   * When you start screen sharing or window sharing, you can call this method to set the screen sharing scenario. The SDK adjusts the video quality and experience of the sharing according to the scenario.This method applies to macOS and Windows only.
-   *
-   * @param screenScenario The screen sharing scenario. See ScreenScenarioType .
-   *
-   * @returns
    * 0: Success.< 0: Failure.
+   *  -2: The parameter is invalid.
+   *  -8: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.
    */
-  abstract setScreenCaptureScenario(screenScenario: ScreenScenarioType): number;
+  abstract setScreenCaptureContentHint(contentHint: VideoContentHint): number;
 
   /**
    * Updates the screen sharing region.
@@ -4859,7 +4749,9 @@ export abstract class IRtcEngine {
    * @param regionRect The relative location of the screen-share area to the screen or window. If you do not set this parameter, the SDK shares the whole screen or window. See Rectangle . If the specified region overruns the screen or window, the SDK shares only the region within it; if you set width or height as 0, the SDK shares the whole screen or window.
    *
    * @returns
-   * 0: Success.< 0: Failure.ERR_INVALID_STATE: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.ERR_INVALID_ARGUMENT: The parameter is invalid.
+   * 0: Success.< 0: Failure.
+   *  -2: The parameter is invalid.
+   *  -8: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.
    */
   abstract updateScreenCaptureRegion(regionRect: Rectangle): number;
 
@@ -4867,25 +4759,67 @@ export abstract class IRtcEngine {
    * Updates the screen sharing parameters.
    * This method is for Windows and macOS only.Call this method after starting screen sharing or window sharing.
    *
-   * @param captureParams The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters
+   * @param captureParams The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters
    *
    * @returns
    * 0: Success.< 0: Failure.
+   *  -2: The parameter is invalid.
+   *  -8: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.
    */
   abstract updateScreenCaptureParameters(
     captureParams: ScreenCaptureParameters
   ): number;
 
   /**
-   * @ignore
+   * Updates the screen sharing parameters.
+   * This method is for Windows and macOS only.Call this method after starting screen sharing or window sharing.
+   *
+   * @param captureParams The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
+   *  -2: The parameter is invalid.
+   *  -8: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.
    */
   abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number;
 
   /**
    * @ignore
    */
+  abstract startScreenCaptureBySourceType(
+    sourceType: VideoSourceType,
+    config: ScreenCaptureConfiguration
+  ): number;
+
+  /**
+   * Updates the screen sharing parameters.
+   * This method is for Windows and macOS only.Call this method after starting screen sharing or window sharing.
+   *
+   * @param captureParams The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See ScreenCaptureParameters
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
+   *  -2: The parameter is invalid.
+   *  -8: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.
+   */
   abstract updateScreenCapture(captureParams: ScreenCaptureParameters2): number;
 
+  /**
+   * @ignore
+   */
+  abstract queryScreenCaptureCapability(): number;
+
+  /**
+   * Sets the screen sharing scenario.
+   * When you start screen sharing or window sharing, you can call this method to set the screen sharing scenario. The SDK adjusts the video quality and experience of the sharing according to the scenario.This method applies to macOS and Windows only.
+   *
+   * @param screenScenario The screen sharing scenario. See ScreenScenarioType .
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
+   */
+  abstract setScreenCaptureScenario(screenScenario: ScreenScenarioType): number;
+
   /**
    * Stops screen sharing.
    *
@@ -4894,6 +4828,17 @@ export abstract class IRtcEngine {
    */
   abstract stopScreenCapture(): number;
 
+  /**
+   * Stops the local video preview.
+   * After calling startPreview to start the preview, if you want to close the local video preview, call this method.Call this method before joining a channel or after leaving a channel.
+   *
+   * @param sourceType The type of the video frame, see VideoSourceType .
+   *
+   * @returns
+   * < 0: Failure.
+   */
+  abstract stopScreenCaptureBySourceType(sourceType: VideoSourceType): 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. Some methods, such as rate and complain , must be called after the call ends to submit feedback to the SDK. These methods require the callId parameter.Call this method after joining a channel.
@@ -4908,9 +4853,7 @@ export abstract class IRtcEngine {
    * Ensure that you call this method after leaving a channel.
    *
    * @param callId The current call ID. You can get the call ID by calling getCallId .
-   *
-   * @param rating The rating of the call. The value is between 1 (lowest score) and 5 (highest score). If you set a value out of this range, the SDK returns the -2 (ERR_INVALID_ARGUMENT) error.
-   *
+   * @param rating The rating of the call. The value is between 1 (the lowest score) and 5 (the highest score). If you set a value out of this range, the SDK returns the -2 (ERR_INVALID_ARGUMENT) error.
    * @param description A description of the call. The string length should be less than 800 bytes.
    *
    * @returns
@@ -4923,30 +4866,29 @@ export abstract class IRtcEngine {
    * This method allows users to complain about the quality of the call. Call this method after the user leaves the channel.
    *
    * @param callId The current call ID. You can get the call ID by calling getCallId .
-   *
    * @param description A description of the call. The string length should be less than 800 bytes.
    *
    * @returns
-   * 0: Success.< 0: Failure.-2: The parameter is invalid.3: The SDK is not ready. Possible reasons include the following:The initialization of IRtcEngine fails. Reinitialize the IRtcEngine.No user has joined the channel when the method is called. Please check your code logic.The user has not left the channel when the rate or complain method is called. Please check your code logic.The audio module is disabled. The program is not complete.
+   * 0: Success.< 0: Failure.-2: The parameter is invalid.- 3: The SDK is not ready. Possible reasons include the following:The initialization of IRtcEngine fails. Reinitialize the IRtcEngine.No user has joined the channel when the method is called. Please check your code logic.The user has not left the channel when the rate or complain method is called. Please check your code logic.The audio module is disabled. The program is not complete.
    */
   abstract complain(callId: string, description: string): number;
 
   /**
    * Starts pushing media streams to a CDN without transcoding.
    * Ensure that you enable the Media Push service before using this function. See Enable Media Push.
-   * Call this method after joining a channel.
-   * Only hosts in the LIVE_BROADCASTING profile can call this method.
-   * If you want to retry pushing streams after a failed push, make sure to call stopRtmpStream first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
-   * Agora recommends that you use the server-side Media Push function. You can call this method to push an audio or video stream to the specified CDN address. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times.After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.
+   *  Call this method after joining a channel.
+   *  Only hosts in the LIVE_BROADCASTING profile can call this method.
+   *  If you want to retry pushing streams after a failed push, make sure to call stopRtmpStream first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
+   *  Agora recommends that you use the server-side Media Push function. You can call this method to push an audio or video stream to the specified CDN address. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times.After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.
    *
    * @param url The address of Media Push. The format is RTMP or RTMPS. The character length cannot exceed 1024 bytes. Special characters such as Chinese characters are not supported.
    *
    * @returns
    * 0: Success.
-   * < 0: Failure.
-   * -2: The URL is null or the string length is 0.
-   * -7: The SDK is not initialized before calling this method.
-   * -19: The Media Push URL is already in use, use another URL instead.
+   *  < 0: Failure.
+   *  -2: The URL is null or the string length is 0.
+   *  -7: The SDK is not initialized before calling this method.
+   *  -19: The Media Push URL is already in use, use another URL instead.
    */
   abstract startRtmpStreamWithoutTranscoding(url: string): number;
 
@@ -4955,7 +4897,6 @@ export abstract class IRtcEngine {
    * Agora recommends that you use the server-side Media Push function. You can call this method to push a live audio-and-video stream to the specified CDN address and set the transcoding configuration. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times.After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.Ensure that you enable the Media Push service before using this function. See Enable Media Push.Call this method after joining a channel.Only hosts in the LIVE_BROADCASTING profile can call this method.If you want to retry pushing streams after a failed push, make sure to call stopRtmpStream first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
    *
    * @param url The address of Media Push. The format is RTMP or RTMPS. The character length cannot exceed 1024 bytes. Special characters such as Chinese characters are not supported.
-   *
    * @param transcoding The transcoding configuration for Media Push. See LiveTranscoding .
    *
    * @returns
@@ -5002,7 +4943,7 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Update the local video mixing configuration.
+   * Updates the local video mixing configuration.
    * After calling startLocalVideoTranscoder , call this method if you want to update the local video mixing configuration.
    *
    * @param config Configuration of the local video mixing, see LocalTranscoderConfiguration .
@@ -5017,57 +4958,33 @@ export abstract class IRtcEngine {
   /**
    * Stops the local video mixing.
    * After calling startLocalVideoTranscoder , call this method if you want to stop the local video mixing.
-   *
-   * @returns
-   * 0: Success.< 0: Failure.
    */
   abstract stopLocalVideoTranscoder(): number;
 
   /**
-   * Starts video capture with a primary camera.
-   *
-   * @param config The configuration of the video capture with a primary camera. See CameraCapturerConfiguration .
-   *
-   * @returns
-   * 0: Success.< 0: Failure.
-   */
-  abstract startPrimaryCameraCapture(
-    config: CameraCapturerConfiguration
-  ): number;
-
-  /**
-   * Starts video capture with a secondary camera.
-   *
-   * @param config The configuration of the video capture with a primary camera. See CameraCapturerConfiguration .
+   * @ignore
    */
-  abstract startSecondaryCameraCapture(
+  abstract startCameraCapture(
+    sourceType: VideoSourceType,
     config: CameraCapturerConfiguration
   ): number;
 
   /**
-   * Stops capturing video through the primary camera.
-   * You can call this method to stop capturing video through the first camera after calling the startPrimaryCameraCapture method.If you are using the local video mixing function, calling this method can cause the local video mixing to be interrupted.
+   * Stops the local video preview.
+   * After calling startPreview to start the preview, if you want to close the local video preview, call this method.Call this method before joining a channel or after leaving a channel.
    *
-   * @returns
-   * 0: Success.< 0: Failure.
-   */
-  abstract stopPrimaryCameraCapture(): number;
-
-  /**
-   *  Stops capturing video through the second camera.
-   * startSecondaryCameraCapture You can call this method to stop capturing video through the second camera after calling the .
+   * @param sourceType The type of the video frame, see VideoSourceType .
    *
    * @returns
-   * 0: Success.< 0: Failure.
+   * < 0: Failure.
    */
-  abstract stopSecondaryCameraCapture(): number;
+  abstract stopCameraCapture(sourceType: VideoSourceType): number;
 
   /**
    * Sets the rotation angle of the captured video.
    * When the video capture device does not have the gravity sensing function, you can call this method to manually adjust the rotation angle of the captured video.
    *
    * @param type The video source type. See VideoSourceType .
-   *
    * @param orientation The clockwise rotation angle. See VideoOrientation .
    *
    * @returns
@@ -5079,48 +4996,19 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * @ignore
-   */
-  abstract setScreenCaptureOrientation(
-    type: VideoSourceType,
-    orientation: VideoOrientation
-  ): number;
-
-  /**
-   * Starts sharing the primary screen.
-   *
-   * @param config The configuration of the captured screen. See ScreenCaptureConfiguration .
-   */
-  abstract startPrimaryScreenCapture(
-    config: ScreenCaptureConfiguration
-  ): number;
-
-  /**
-   * Starts sharing a secondary screen.
-   *
-   * @param config The configuration of the captured screen. See ScreenCaptureConfiguration .
-   */
-  abstract startSecondaryScreenCapture(
-    config: ScreenCaptureConfiguration
-  ): number;
-
-  /**
-   * Stop sharing the first screen.
-   * After calling startPrimaryScreenCapture , you can call this method to stop sharing the first screen.
+   * Sets the rotation angle of the captured video.
+   * When the video capture device does not have the gravity sensing function, you can call this method to manually adjust the rotation angle of the captured video.
    *
-   * @returns
-   * 0: Success.< 0: Failure.
-   */
-  abstract stopPrimaryScreenCapture(): number;
-
-  /**
-   * Stops sharing the secondary screen.
-   * After calling startSecondaryScreenCapture , you can call this method to stop sharing the secondary screen.
+   * @param type The video source type. See VideoSourceType .
+   * @param orientation The clockwise rotation angle. See VideoOrientation .
    *
    * @returns
    * 0: Success.< 0: Failure.
    */
-  abstract stopSecondaryScreenCapture(): number;
+  abstract setScreenCaptureOrientation(
+    type: VideoSourceType,
+    orientation: VideoOrientation
+  ): number;
 
   /**
    * Gets the current connection state of the SDK.
@@ -5132,19 +5020,25 @@ export abstract class IRtcEngine {
   abstract getConnectionState(): ConnectionStateType;
 
   /**
-   * Adds event handlers.
+   * Adds event handlers
    * The SDK uses the IRtcEngineEventHandler class to send callbacks to the app. The app inherits the methods of this class to receive these callbacks. All methods in this class have default (empty) implementations. Therefore, apps only need to inherits callbacks according to the scenarios. In the callbacks, avoid time-consuming tasks or calling APIs that can block the thread, such as the sendStreamMessage method.
    * Otherwise, the SDK may not work properly.
    *
    * @param eventHandler Callback events to be added. See IRtcEngineEventHandler .
+   *
+   * @returns
+   * true: Success.false: Failure.
    */
   abstract registerEventHandler(eventHandler: IRtcEngineEventHandler): boolean;
 
   /**
-   * Removes the specified IRtcEngineEventHandler instance.
+   * Removes the specified callback handler.
    * This method removes the specified callback handler. For callback events that you want to listen for only once, call this method to remove the relevant callback handler after you have received them.
    *
    * @param eventHandler The callback handler to be deleted. See IRtcEngineEventHandler .
+   *
+   * @returns
+   * true: Success.false: Failure.
    */
   abstract unregisterEventHandler(
     eventHandler: IRtcEngineEventHandler
@@ -5160,7 +5054,7 @@ export abstract class IRtcEngine {
 
   /**
    * Sets the built-in encryption mode.
-   * Deprecated:Use enableEncryption instead.The Agora SDK supports built-in encryption, which is set to the AES-128-GCM mode by default. Call this method to use other encryption modes. All users in the same channel must use the same encryption mode and secret. Refer to the information related to the AES encryption algorithm on the differences between the encryption modes.Before calling this method, please call setEncryptionSecret to enable the built-in encryption function.
+   * Deprecated:Use enableEncryption instead.The SDK supports built-in encryption schemes, AES-128-GCM is supported by default. Call this method to use other encryption modes. All users in the same channel must use the same encryption mode and secret. Refer to the information related to the AES encryption algorithm on the differences between the encryption modes.Before calling this method, please call setEncryptionSecret to enable the built-in encryption function.
    *
    * @param encryptionMode The following encryption modes:"aes-128-xts": 128-bit AES encryption, XTS mode."aes-128-ecb": 128-bit AES encryption, ECB mode."aes-256-xts": 256-bit AES encryption, XTS mode."sm4-128-ecb": 128-bit SM4 encryption, ECB mode."aes-128-gcm": 128-bit AES encryption, GCM mode."aes-256-gcm": 256-bit AES encryption, GCM mode."": When this parameter is set as null, the encryption mode is set as "aes-128-gcm" by default.
    *
@@ -5171,7 +5065,7 @@ export abstract class IRtcEngine {
 
   /**
    * Enables built-in encryption with an encryption password before users join a channel.
-   * Deprecated:This method is deprecated. Use enableEncryption instead.Before joining the channel, you need to call this method to set the secret parameter to enable the built-in encryption. All users in the same channel should use the same secret. The secret is automatically cleared once a user leaves the channel. If you do not specify the secret or secret is set as null, the built-in encryption is disabled.Do not use this method for CDN live streaming.For optimal transmission, ensure that the encrypted data size does not exceed the original data size + 16 bytes. 16 bytes is the maximum padding size for AES encryption.
+   * Deprecated:Use enableEncryption instead.Before joining the channel, you need to call this method to set the secret parameter to enable the built-in encryption. All users in the same channel should use the same secret. The secret is automatically cleared once a user leaves the channel. If you do not specify the secret or secret is set as null, the built-in encryption is disabled.Do not use this method for Media Push.For optimal transmission, ensure that the encrypted data size does not exceed the original data size + 16 bytes. 16 bytes is the maximum padding size for AES encryption.
    *
    * @param secret The encryption password.
    *
@@ -5181,11 +5075,10 @@ export abstract class IRtcEngine {
   abstract setEncryptionSecret(secret: string): number;
 
   /**
-   * Enables/Disables the built-in encryption.
+   * 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.
    *
    * @param enabled Whether to enable built-in encryption:true: Enable the built-in encryption.false: Disable the built-in encryption.
-   *
    * @param config Built-in encryption configurations. See EncryptionConfig .
    *
    * @returns
@@ -5210,9 +5103,7 @@ export abstract class IRtcEngine {
    * A failed method call triggers the onStreamMessageError callback on the remote client.Ensure that you call createDataStream to create a data channel before calling this method.In live streaming scenarios, this method only applies to hosts.
    *
    * @param streamId The data stream ID. You can get the data stream ID by calling createDataStream.
-   *
-   * @param data The data to be sent.
-   *
+   * @param data The message to be sent.
    * @param length The length of the data.
    *
    * @returns
@@ -5229,8 +5120,7 @@ export abstract class IRtcEngine {
    * This method adds a PNG watermark image to the local video in the live streaming. Once the watermark image is added, all the audience in the channel (CDN audience included), and the capturing device can see and capture it. The Agora SDK supports adding only one watermark image onto a local video or CDN live stream. The newly added watermark image replaces the previous one.The watermark coordinates are dependent on the settings in the setVideoEncoderConfiguration method:If the orientation mode of the encoding video ( OrientationMode ) is fixed landscape mode or the adaptive landscape mode, the watermark uses the landscape orientation.If the orientation mode of the encoding video (OrientationMode) is fixed portrait mode or the adaptive portrait mode, the watermark uses the portrait orientation.When setting the watermark position, the region must be less than the dimensions set in the setVideoEncoderConfiguration method; otherwise, the watermark image will be cropped.Ensure that calling this method after enableVideo .If you only want to add a watermark to the media push, you can call this method or the setLiveTranscoding method.This method supports adding a watermark image in the PNG file format only. Supported pixel formats of the PNG image are RGBA, RGB, Palette, Gray, and Alpha_gray.If the dimensions of the PNG image differ from your settings in this method, the image will be cropped or zoomed to conform to your settings.If you have enabled the local video preview by calling the startPreview method, you can use the visibleInPreview member to set whether or not the watermark is visible in the preview.If you have enabled the mirror mode for the local video, the watermark on the local video is also mirrored. To avoid mirroring the watermark, Agora recommends that you do not use the mirror and watermark functions for the local video at the same time. You can implement the watermark function in your application layer.
    *
    * @param watermarkUrl The local file path of the watermark image to be added. This method supports adding a watermark image from the local absolute or relative file path.
-   *
-   * @param options The options of the watermark image to be added.
+   * @param options The options of the watermark image to be added. See WatermarkOptions .
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -5260,9 +5150,9 @@ export abstract class IRtcEngine {
 
   /**
    * Enables interoperability with the Agora Web SDK (applicable only in the live streaming scenarios).
-   * Deprecated:The SDK automatically enables interoperability with the Web SDK, so you no longer need to call this method.This method enables or disables interoperability with the Agora Web SDK. If the channel has Web SDK users, ensure that you call this method, or the video of the Native user will be a black screen for the Web user.This method is only applicable in live streaming scenarios, and interoperability is enabled by default in communication scenarios.
+   * Deprecated:The SDK automatically enables interoperability with the Web SDK, so you no longer need to call this method.You can call this method to enable or disable interoperability with the Agora Web SDK. If a channel has Web SDK users, ensure that you call this method, or the video of the Native user will be a black screen for the Web user.This method is only applicable in live streaming scenarios, and interoperability is enabled by default in communication scenarios.
    *
-   * @param enabled Whether to enable interoperability with the Agora Web SDK.true: Enable interoperability.false: (Default) Disable interoperability.
+   * @param enabled Whether to enable interoperability:true: Enable interoperability.false: (Default) Disable interoperability.
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -5284,10 +5174,9 @@ export abstract class IRtcEngine {
   /**
    * Registers the metadata observer.
    * You need to implement the IMetadataObserver class and specify the metadata type in this method. This method enables you to add synchronized metadata in the video stream for more diversified
-   * live interactive streaming, such as sending shopping links, digital coupons, and online quizzes.Call this method before joinChannel [2/2].
+   *  live interactive streaming, such as sending shopping links, digital coupons, and online quizzes.Call this method before joinChannel.
    *
    * @param observer The metadata observer. See IMetadataObserver .
-   *
    * @param type The metadata type. The SDK currently only supports VideoMetadata. See MetadataType .
    *
    * @returns
@@ -5299,11 +5188,12 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Unregisters the specified metadata observer.
-   *
-   * @param type The metadata type. The SDK currently only supports VideoMetadata. See MetadataType .
+   * Registers the metadata observer.
+   * You need to implement the IMetadataObserver class and specify the metadata type in this method. This method enables you to add synchronized metadata in the video stream for more diversified
+   *  live interactive streaming, such as sending shopping links, digital coupons, and online quizzes.Call this method before joinChannel.
    *
    * @param observer The metadata observer. See IMetadataObserver .
+   * @param type The metadata type. The SDK currently only supports VideoMetadata. See MetadataType .
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -5335,13 +5225,17 @@ export abstract class IRtcEngine {
     location: string
   ): number;
 
+  /**
+   * @ignore
+   */
+  abstract setAINSMode(enabled: boolean, mode: AudioAinsMode): number;
+
   /**
    * Registers a user account.
-   * Once registered, the user account can be used to identify the local user when the user joins the channel. After the registration is successful, the user account can identify the identity of the local user, and the user can use it to join the channel.After the user successfully registers a user account, the SDK triggers the onLocalUserRegistered callback on the local client, reporting the user ID and user account of the local user.This method is optional. To join a channel with a user account, you can choose either of the following ways:Call registerLocalUserAccount to create a user account, and then call joinChannelWithUserAccount to join the channel.Call the joinChannelWithUserAccount method to join the channel.The difference between the two ways is that the time elapsed between calling the registerLocalUserAccount method and joining the channel is shorter than directly calling joinChannelWithUserAccount.Ensure that you set the userAccount parameter; otherwise, this method does not take effect.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.
+   * Once registered, the user account can be used to identify the local user when the user joins the channel. After the registration is successful, the user account can identify the identity of the local user, and the user can use it to join the channel.After the user successfully registers a user account, the SDK triggers the onLocalUserRegistered callback on the local client, reporting the user ID and account of the local user.This method is optional. To join a channel with a user account, you can choose either of the following ways:Call registerLocalUserAccount to create a user account, and then call joinChannelWithUserAccount to join the channel.Call the joinChannelWithUserAccount method to join the channel.The difference between the two ways is that the time elapsed between calling the registerLocalUserAccount method and joining the channel is shorter than directly calling joinChannelWithUserAccount.Ensure that you set the userAccount parameter; otherwise, this method does not take effect.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.
    *
    * @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 (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"!", "#", "$", "%", "&amp;", "(", ")", "+", "-", ":", ";", "&lt;", "= ", ".", "&gt;", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
+   * @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):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.
@@ -5350,31 +5244,15 @@ export abstract class IRtcEngine {
 
   /**
    * Joins the channel with a user account, and configures whether to automatically subscribe to audio or video streams after joining the channel.
-   * 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: onUserJoined and onUserInfoUpdated , if the user is in the COMMUNICATION profile, or 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.
-   *
-   * @param options The channel media options. See ChannelMediaOptions .
+   * 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.
    *
    * @param token The token generated on your server for authentication.
-   *
-   * @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:
-   *  All lowercase English letters: a to z.
-   *  All uppercase English letters: A to Z.
-   *  All numeric characters: 0 to 9.
-   *  Space
-   *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
-   *
+   * @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:All lowercase English letters: a to z.All uppercase English letters: A to Z.All numeric characters: 0 to 9.Space"!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    * @param userAccount The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as NULL. Supported characters are (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"!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
+   * @param options The channel media options. See ChannelMediaOptions .
    *
    * @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: Failes 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 recomments that you can 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.
-   * -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.
+   * 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.-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 recomments that you can 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.-121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.
    */
   abstract joinChannelWithUserAccount(
     token: string,
@@ -5385,23 +5263,15 @@ export abstract class IRtcEngine {
 
   /**
    * Joins the channel with a user account, and configures whether to automatically subscribe to audio or video streams after joining the channel.
-   * 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.
+   * 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.
    *
    * @param token The token generated on your server for authentication.
-   *
-   * @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:
-   *  All lowercase English letters: a to z.
-   *  All uppercase English letters: A to Z.
-   *  All numeric characters: 0 to 9.
-   *  Space
-   *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
-   *
+   * @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:All lowercase English letters: a to z.All uppercase English letters: A to Z.All numeric characters: 0 to 9.Space"!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
    * @param userAccount The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as NULL. Supported characters are (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"!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
-   *
    * @param options The channel media options. See ChannelMediaOptions .
    *
    * @returns
-   * 0: Success.< 0: Failure.
+   * 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.-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 recomments that you can 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.-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,
@@ -5412,30 +5282,36 @@ export abstract class IRtcEngine {
 
   /**
    * Gets the user information by passing in the User Account.
-   * After a remote user joins the channel, the SDK gets the UID and User Account of the remote user, caches them in a mapping table object, and triggers the onUserInfoUpdated callback on the local client. After receiving the callback, you can call this method to get the user account of the remote user from the UserInfo object by passing in the user ID.
+   * After a remote user joins the channel, the SDK gets the user ID and account of the remote user, caches them in a mapping table object, and triggers the onUserInfoUpdated callback on the local client. After receiving the callback, you can call this method to get the user account of the remote user from the UserInfo object by passing in the user ID.
    *
    * @param userAccount The user account.
    *
    * @returns
-   * The UserInfo object that identifies the user information. A pointer to the UserInfo instance, if the method call succeeds.
-   * If the call fails, returns NULL.
+   * A pointer to the UserInfo instance, if the method call succeeds.If the call fails, returns NULL.
    */
   abstract getUserInfoByUserAccount(userAccount: string): UserInfo;
 
   /**
    * Gets the user information by passing in the user ID.
-   * After a remote user joins the channel, the SDK gets the UID and User Account of the remote user, caches them in a mapping table object, and triggers the onUserInfoUpdated callback on the local client. After receiving the callback, you can call this method to get the user account of the remote user from the UserInfo object by passing in the user ID.
+   * After a remote user joins the channel, the SDK gets the user ID and account of the remote user, caches them in a mapping table object, and triggers the onUserInfoUpdated callback on the local client. After receiving the callback, you can call this method to get the user account of the remote user from the UserInfo object by passing in the user ID.
    *
    * @param uid The user ID.
    *
    * @returns
-   * The UserInfo object that identifies the user information.A pointer to the UserInfo instance, if the method call succeeds.If the call fails, returns NULL.
+   * A pointer to the UserInfo instance, if the method call succeeds.If the call fails, returns NULL.
    */
   abstract getUserInfoByUid(uid: number): UserInfo;
 
+  /**
+   * @ignore
+   */
+  abstract startOrUpdateChannelMediaRelay(
+    configuration: ChannelMediaRelayConfiguration
+  ): number;
+
   /**
    * Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels.
-   * After a successful method call, the SDK triggers the onChannelMediaRelayStateChanged and onChannelMediaRelayEvent callbacks, and these callbacks return the state and events of the media stream relay.If the onChannelMediaRelayStateChanged callback returns RelayStateRunning (2) and RelayOk (0), and the onChannelMediaRelayEvent callback returns RelayEventPacketSentToDestChannel (4), it means that the SDK starts relaying media streams between the source channel and the destination channel.If the onChannelMediaRelayStateChanged callback returnsRelayStateFailure (3), an exception occurs during the media stream relay.Call this method after joining the channel.This method takes effect only when you are a host in a live streaming channel.After a successful method call, if you want to call this method again, ensure that you call the stopChannelMediaRelay method to quit the current relay.The relaying media streams across channels function needs to be enabled.We do not support string user accounts in this API.
+   * After a successful method call, the SDK triggers the onChannelMediaRelayStateChanged and onChannelMediaRelayEvent callbacks, and these callbacks return the state and events of the media stream relay.If the onChannelMediaRelayStateChanged callback returns RelayStateRunning (2) and RelayOk (0), and the onChannelMediaRelayEvent callback returns RelayEventPacketSentToDestChannel (4), it means that the SDK starts relaying media streams between the source channel and the target channel.If the onChannelMediaRelayStateChanged callback returnsRelayStateFailure (3), an exception occurs during the media stream relay.Call this method after joining the channel.This method takes effect only when you are a host in a live streaming channel.After a successful method call, if you want to call this method again, ensure that you call the stopChannelMediaRelay method to quit the current relay.The relaying media streams across channels function needs to be enabled by contacting .We do not support string user accounts in this API.
    *
    * @param configuration The configuration of the media stream relay. See ChannelMediaRelayConfiguration .
    *
@@ -5450,7 +5326,7 @@ export abstract class IRtcEngine {
    * Updates the channels for media stream relay.
    * After the media relay starts, if you want to relay the media stream to more channels, or leave the current relay channel, you can call this method.After a successful method call, the SDK triggers the onChannelMediaRelayEvent callback with the RelayEventPacketUpdateDestChannel (7) state code.Call the method after successfully calling the startChannelMediaRelay method and receiving onChannelMediaRelayStateChanged (RelayStateRunning, RelayOk); otherwise, the method call fails.
    *
-   * @param configuration The configuration of the media stream relay.
+   * @param configuration The configuration of the media stream relay. See ChannelMediaRelayConfiguration .
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -5460,7 +5336,7 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Stops the media stream relay. Once the relay stops, the host quits all the destination channels.
+   * Stops the media stream relay. Once the relay stops, the host quits all the target channels.
    * After a successful method call, the SDK triggers the onChannelMediaRelayStateChanged callback. If the callback reports RelayStateIdle (0) and RelayOk (0), the host successfully stops the relay.If the method call fails, the SDK triggers the onChannelMediaRelayStateChanged callback with the RelayErrorServerNoResponse (2) or RelayErrorServerConnectionLost (8) status code. You can call the leaveChannel method to leave the channel, and the media stream relay automatically stops.
    *
    * @returns
@@ -5469,8 +5345,8 @@ export abstract class IRtcEngine {
   abstract stopChannelMediaRelay(): number;
 
   /**
-   * Pauses the media stream relay to all destination channels.
-   * After the cross-channel media stream relay starts, you can call this method to pause relaying media streams to all destination channels; after the pause, if you want to resume the relay, call resumeAllChannelMediaRelay .After a successful method call, the SDK triggers the onChannelMediaRelayEvent callback to report whether the media stream relay is successfully paused.Call this method after the startChannelMediaRelay method.
+   * Pauses the media stream relay to all target channels.
+   * After the cross-channel media stream relay starts, you can call this method to pause relaying media streams to all target channels; after the pause, if you want to resume the relay, call resumeAllChannelMediaRelay .After a successful method call, the SDK triggers the onChannelMediaRelayEvent callback to report whether the media stream relay is successfully paused.Call this method after startChannelMediaRelay .
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -5478,12 +5354,21 @@ export abstract class IRtcEngine {
   abstract pauseAllChannelMediaRelay(): number;
 
   /**
-   * @ignore
+   * Resumes the media stream relay to all target channels.
+   * After calling the pauseAllChannelMediaRelay method, you can call this method to resume relaying media streams to all destination channels.After a successful method call, the SDK triggers the onChannelMediaRelayEvent callback to report whether the media stream relay is successfully resumed.Call this method after pauseAllChannelMediaRelay .
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract resumeAllChannelMediaRelay(): number;
 
   /**
-   * @ignore
+   * Sets the audio profile of the audio streams directly pushed to the CDN by the host.
+   *
+   * @param profile The audio profile, including the sampling rate, bitrate, encoding mode, and the number of channels. See AudioProfileType .
+   *
+   * @returns
+   * < 0: Failure.
    */
   abstract setDirectCdnStreamingAudioConfiguration(
     profile: AudioProfileType
@@ -5497,7 +5382,15 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * @ignore
+   * Starts pushing media streams to the CDN directly.
+   * Aogra does not support pushing media streams to one URL repeatedly.Media optionsAgora does not support setting the value of publishCameraTrack and publishCustomVideoTrack as true, or the value of publishMicrophoneTrack and publishCustomAudioTrack as true at the same time. When choosing media setting options ( DirectCdnStreamingMediaOptions ), you can refer to the following examples:If you want to push audio and video streams published by the host to the CDN, the media setting options should be set as follows:publishCustomAudioTrack is set as true and call the pushAudioFrame methodpublishCustomVideoTrack is set as true and call the pushVideoFrame methodpublishCameraTrack is set as false (the default value)publishMicrophoneTrack is set as false (the default value)
+   *
+   * @param eventHandler See onDirectCdnStreamingStateChanged and onDirectCdnStreamingStats .
+   * @param publishUrl The CDN live streaming URL.
+   * @param options The media setting options for the host. See DirectCdnStreamingMediaOptions .
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract startDirectCdnStreaming(
     eventHandler: IDirectCdnStreamingEventHandler,
@@ -5506,12 +5399,23 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * @ignore
+   * Stops pushing media streams to the CDN directly.
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract stopDirectCdnStreaming(): number;
 
   /**
-   * @ignore
+   * Sets channel options and leaves the channel.
+   * If you call release immediately after calling this method, the SDK does not trigger the onLeaveChannel callback.
+   *  If you have called joinChannelEx to join multiple channels, calling this method will leave the channels when calling joinChannel and joinChannelEx at the same time.
+   *  This method will release all resources related to the session, leave the channel, that is, hang up or exit the call. This method can be called whether or not a call is currently in progress.After joining the channel, you must call this method or to end the call, otherwise, the next call cannot be started.This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After actually leaving the channel, the local user triggers the onLeaveChannel callback; after the user in the communication scenario and the host in the live streaming scenario leave the channel, the remote user triggers the onUserOffline callback.
+   *
+   * @param options The options for leaving the channel. See LeaveChannelOptions .
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract updateDirectCdnStreamingMediaOptions(
     options: DirectCdnStreamingMediaOptions
@@ -5541,7 +5445,6 @@ export abstract class IRtcEngine {
    * 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.This method takes a snapshot of the published video stream specified in ChannelMediaOptions .If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.
    *
    * @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:Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.jpgmacOS: ～/Library/Logs/example.jpgEnsure that the path you specify exists and is writable.
    *
    * @returns
@@ -5554,7 +5457,6 @@ export abstract class IRtcEngine {
    * When video screenshot and upload function is enabled, the SDK takes screenshots and upload 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 the video screenshot upload service has been activated. This method relies on the video screenshot and upload dynamic library libagora_content_inspect_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
    *
    * @param enabled Whether to enable video screenshot and uploadtrue: Enables video screenshot and upload. false: Disables video screenshot and upload.
-   *
    * @param config Configuration of video screenshot and upload. See ContentInspectConfig .
    *
    * @returns
@@ -5570,14 +5472,13 @@ export abstract class IRtcEngine {
    * Ensure you have called the setExternalAudioSource method to create an external audio track before calling this method.If you want to change the volume of the audio to be published, you need to call this method again.
    *
    * @param sourceId The ID of external audio source. If you want to publish a custom external audio source, set this parameter to the ID of the corresponding custom audio track you want to publish.
-   *
    * @param volume The volume of the audio source. The value can range from 0 to 100. 0 means mute; 100 means the original volume.
    *
    * @returns
    * 0: Success.< 0: Failure.
    */
   abstract adjustCustomAudioPublishVolume(
-    sourceId: number,
+    trackId: number,
     volume: number
   ): number;
 
@@ -5585,13 +5486,13 @@ export abstract class IRtcEngine {
    * @ignore
    */
   abstract adjustCustomAudioPlayoutVolume(
-    sourceId: number,
+    trackId: number,
     volume: number
   ): number;
 
   /**
-   * Sets the Agora cloud proxy service.
-   * When users' network access is restricted by a firewall, configure the firewall to allow specific IP addresses and ports provided by Agora; then, call this method to enable the cloud proxy and set the cloud proxy type with the proxyType parameter.After successfully connecting to the cloud proxy, the SDK triggers the onConnectionStateChanged (ConnectionStateConnecting, ConnectionChangedSettingProxyServer) callback.To disable the cloud proxy that has been set, call the setCloudProxy (NoneProxy).To change the cloud proxy type that has been set, call the setCloudProxy (NoneProxy) first, and then call the setCloudProxy to set the proxyType you want.Agora recommends that you call this method before joining the channel or after leaving the channel.When a user is behind a firewall and uses the Force UDP cloud proxy, the services for the Media Push and cohosting across channels are not available.When you use the Force TCP cloud proxy, note that an error would occur when calling the startAudioMixing method to play online music files in the HTTP protocol. The services for the Media Push and cohosting across channels use the cloud proxy with the TCP protocol.
+   * Sets up cloud proxy service.
+   * When users' network access is restricted by a firewall, configure the firewall to allow specific IP addresses and ports provided by Agora; then, call this method to enable the cloud proxyType and set the cloud proxy type with the proxyType parameter.After successfully connecting to the cloud proxy, the SDK triggers the onConnectionStateChanged (ConnectionStateConnecting, ConnectionChangedSettingProxyServer) callback.To disable the cloud proxy that has been set, call the setCloudProxy (NoneProxy).To change the cloud proxy type that has been set, call the setCloudProxy (NoneProxy) first, and then call the setCloudProxy to set the proxyType you want.Agora recommends that you call this method after joining a channel.When a user is behind a firewall and uses the Force UDP cloud proxy, the services for Media Push and cohosting across channels are not available.When you use the Force TCP cloud proxy, note that an error would occur when calling the startAudioMixing method to play online music files in the HTTP protocol. The services for Media Push and cohosting across channels use the cloud proxy with the TCP protocol.
    *
    * @param proxyType The type of the cloud proxy. See CloudProxyType .This parameter is mandatory. The SDK reports an error if you do not pass in a value.
    *
@@ -5607,9 +5508,12 @@ export abstract class IRtcEngine {
 
   /**
    * Sets audio advanced options.
-   * If you have advanced audio processing requirements, such as capturing and sending stereo audio, you can call this method to set advanced audio options.Call this method after calling joinChannel [2/2] , enableAudio and enableLocalAudio .
+   * If you have advanced audio processing requirements, such as capturing and sending stereo audio, you can call this method to set advanced audio options.Call this method after calling joinChannel , enableAudio and enableLocalAudio .
    *
    * @param options The advanced options for audio. See AdvancedAudioOptions .
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract setAdvancedAudioOptions(
     options: AdvancedAudioOptions,
@@ -5626,7 +5530,6 @@ export abstract class IRtcEngine {
    * 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.
    *
    * @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 .
    *
    * @returns
@@ -5643,7 +5546,13 @@ export abstract class IRtcEngine {
   abstract getCurrentMonotonicTimeInMs(): number;
 
   /**
-   * @ignore
+   * Enables/Disables the local video capture.
+   * This method disables or re-enables the local video capture, and does not affect receiving the remote video stream.After calling enableVideo , the local video capture is enabled by default. You can call enableLocalVideo (false) to disable the local video capture. If you want to re-enable the local video capture, call enableLocalVideo(true).After the local video capturer is successfully disabled or re-enabled, the SDK triggers the onRemoteVideoStateChanged callback on the remote client.You can call this method either before or after joining a channel.This method enables the internal engine and is valid after leaving the channel.
+   *
+   * @param enabled Whether to enable the local video capture.true: (Default) Enable the local video capture.false: Disable the local video capture. Once the local video is disabled, the remote users cannot receive the video stream of the local user, while the local user can still receive the video streams of remote users. When set to false, this method does not require a local camera.
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract enableWirelessAccelerate(enabled: boolean): number;
 
@@ -5677,31 +5586,9 @@ export abstract class IRtcEngine {
   abstract enableInstantMediaRendering(): number;
 
   /**
-   * Destroys a video renderer object.
-   *
-   * @param view The HTMLElement object to be destroyed.
-   */
-  abstract destroyRendererByView(view: any): void;
-
-  /**
-   * Destroys multiple video renderer objects at one time.
-   *
-   * @param sourceType The type of the video frame, see VideoSourceType .
-   *
-   * @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:
-   *  All lowercase English letters: a to z.
-   *  All uppercase English letters: A to Z.
-   *  All numeric characters: 0 to 9.
-   *  Space
-   *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
-   *
-   * @param uid The user ID of the remote user.
+   * @ignore
    */
-  abstract destroyRendererByConfig(
-    sourceType: VideoSourceType,
-    channelId?: string,
-    uid?: number
-  ): void;
+  abstract getNtpWallTimeInMs(): number;
 
   /**
    * Gets the IAudioDeviceManager object to manage audio devices.
@@ -5736,15 +5623,6 @@ export abstract class IRtcEngine {
    */
   abstract getMediaEngine(): IMediaEngine;
 
-  /**
-   * Gets one IMediaRecorder object.
-   * Make sure the IRtcEngine is initialized before you call this method.
-   *
-   * @returns
-   * One IMediaRecorder object.
-   */
-  abstract getMediaRecorder(): IMediaRecorder;
-
   /**
    * Gets one ILocalSpatialAudioEngine object.
    * Make sure the IRtcEngine is initialized before you call this method.
@@ -5755,13 +5633,12 @@ export abstract class IRtcEngine {
   abstract getLocalSpatialAudioEngine(): ILocalSpatialAudioEngine;
 
   /**
-   * Sends media affiliate information.
-   * If the media attachment information is successfully sent, the receiver will receive the onMetadataReceived callback.
+   * Sends media metadata.
+   * If the metadata is sent successfully, the SDK triggers the onMetadataReceived callback on the receiver.
    *
+   * @param metadata Media metadata See Metadata .
    * @param sourceType The type of the video frame, see VideoSourceType .
    *
-   * @param metadata Media metadata. See Metadata .
-   *
    * @returns
    * 0: Success.< 0: Failure.
    */
@@ -5771,16 +5648,36 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Sets the maximum size of media metadata information.
-   * After calling registerMediaMetadataObserver , you can call this method to set the maximum size of media metadata information.
+   * Sets the maximum size of the media metadata.
+   * After calling registerMediaMetadataObserver , you can call this method to set the maximum size of the media metadata.
    *
-   * @param size Sets the maximum size of media metadata information.
+   * @param size The maximum size of media metadata.
    *
    * @returns
    * 0: Success.< 0: Failure.
    */
   abstract setMaxMetadataSize(size: number): number;
 
+  /**
+   * Destroys a video renderer object.
+   *
+   * @param view The HTMLElement object to be destroyed.
+   */
+  abstract destroyRendererByView(view: any): void;
+
+  /**
+   * Destroys multiple video renderer objects at one time.
+   *
+   * @param sourceType The type of the video frame, see VideoSourceType .
+   * @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:All lowercase English letters: a to z.All uppercase English letters: A to Z.All numeric characters: 0 to 9.Space"!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
+   * @param uid The user ID of the remote user.
+   */
+  abstract destroyRendererByConfig(
+    sourceType: VideoSourceType,
+    channelId?: string,
+    uid?: number
+  ): void;
+
   /**
    * Unregisters the encoded audio frame observer.
    *