agora-electron-sdk 4.2.6 → 4.3.0-dev.1

package/ts/Private/IAgoraRtcEngine.ts

@@ -14,7 +14,6 @@ import {
   CaptureBrightnessLevelType,
   ChannelMediaRelayConfiguration,
   ChannelMediaRelayError,
-  ChannelMediaRelayEvent,
   ChannelMediaRelayState,
   ChannelProfileType,
   ClientRoleChangeFailedReason,
@@ -40,10 +39,10 @@ import {
   LiveTranscoding,
   LocalAccessPointConfiguration,
   LocalAudioStats,
-  LocalAudioStreamError,
+  LocalAudioStreamReason,
   LocalAudioStreamState,
   LocalTranscoderConfiguration,
-  LocalVideoStreamError,
+  LocalVideoStreamReason,
   LocalVideoStreamState,
   LowlightEnhanceOptions,
   MediaTraceEvent,
@@ -58,7 +57,7 @@ import {
   RemoteVideoState,
   RemoteVideoStateReason,
   RtcStats,
-  RtmpStreamPublishErrorType,
+  RtmpStreamPublishReason,
   RtmpStreamPublishState,
   RtmpStreamingEvent,
   ScreenCaptureParameters,
@@ -84,8 +83,10 @@ import {
   VideoDenoiserOptions,
   VideoEncoderConfiguration,
   VideoFormat,
+  VideoLayout,
   VideoMirrorModeType,
   VideoOrientation,
+  VideoQoePreferenceType,
   VideoRenderingTracingInfo,
   VideoStreamType,
   VideoSubscriptionOptions,
@@ -107,6 +108,7 @@ import {
   RenderModeType,
   VideoSourceType,
 } from './AgoraMediaBase';
+import { IH265Transcoder } from './IAgoraH265Transcoder';
 import { LogConfig, LogFilterType, LogLevel } from './IAgoraLog';
 import { AudioMixingDualMonoMode, IMediaEngine } from './IAgoraMediaEngine';
 import { IMediaPlayer } from './IAgoraMediaPlayer';
@@ -114,7 +116,7 @@ import { IMediaRecorder } from './IAgoraMediaRecorder';
 import { IMusicContentCenter } from './IAgoraMusicContentCenter';
 import {
   AgoraRhythmPlayerConfig,
-  RhythmPlayerErrorType,
+  RhythmPlayerReason,
   RhythmPlayerStateType,
 } from './IAgoraRhythmPlayer';
 import { RtcConnection } from './IAgoraRtcEngineEx';
@@ -1113,6 +1115,10 @@ export class ChannelMediaOptions {
    * Whether to publish the local transcoded video: true : Publish the local transcoded video. false : Do not publish the local transcoded video.
    */
   publishTranscodedVideoTrack?: boolean;
+  /**
+   * @ignore
+   */
+  publishMixedAudioTrack?: boolean;
   /**
    * Whether to automatically subscribe to all remote audio streams when the user joins a channel: true : Subscribe to all remote audio streams. false : Do not automatically subscribe to any remote audio streams.
    */
@@ -1251,6 +1257,10 @@ export class LeaveChannelOptions {
 
 /**
  * The SDK uses the IRtcEngineEventHandler interface to send event notifications to your app. Your app can get those notifications through methods that inherit this interface.
+ *
+ * All methods in this interface have default (empty) implementation. You can choose to inherit events related to your app scenario.
+ *  In the callbacks, avoid implementing time-consuming tasks or calling APIs that may cause thread blocking (such as sendMessage). Otherwise, the SDK may not work properly.
+ *  The SDK no longer catches exceptions in the code logic that developers implement themselves in IRtcEngineEventHandler class. You need to handle this exception yourself, otherwise the app may crash when the exception occurs.
  */
 export interface IRtcEngineEventHandler {
   /**
@@ -1296,7 +1306,7 @@ export interface IRtcEngineEventHandler {
   /**
    * Reports an error during SDK runtime.
    *
-   * 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.
+   * 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 app to take action or informs the user about the issue.
    *
    * @param err Error code. See ErrorCodeType.
    * @param msg The error message.
@@ -1354,7 +1364,7 @@ export interface IRtcEngineEventHandler {
   /**
    * Occurs when a user leaves a channel.
    *
-   * This callback notifies the app that the user leaves the channel by calling leaveChannel. From this callback, the app can get information such as the call duration and quality statistics.
+   * This callback notifies the app that the user leaves the channel by calling leaveChannel. From this callback, the app can get information such as the call duration and statistics.
    *
    * @param connection The connection information. See RtcConnection.
    * @param stats The statistics of the call. See RtcStats.
@@ -1378,7 +1388,7 @@ export interface IRtcEngineEventHandler {
    *
    * @param deviceId The device ID.
    * @param deviceType The device type. See MediaDeviceType.
-   * @param deviceState Media device states.
+   * @param deviceState The device state. See MediaDeviceStateType.
    */
   onAudioDeviceStateChanged?(
     deviceId: string,
@@ -1422,7 +1432,7 @@ export interface IRtcEngineEventHandler {
    *
    * @param deviceId The device ID.
    * @param deviceType Media device types. See MediaDeviceType.
-   * @param deviceState Media device states.
+   * @param deviceState Media device states. See MediaDeviceStateType.
    */
   onVideoDeviceStateChanged?(
     deviceId: string,
@@ -1516,7 +1526,6 @@ export interface IRtcEngineEventHandler {
    *  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.
@@ -1555,18 +1564,18 @@ export interface IRtcEngineEventHandler {
   /**
    * Occurs when the local video stream state changes.
    *
-   * 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:
+   * 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 LocalVideoStreamReasonCaptureFailure in the following situations:
    *  The app switches to the background, and the system gets the camera resource.
-   *  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.
+   *  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 LocalVideoStreamReasonCaptureFailure. 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 type of the video source. See VideoSourceType.
    * @param state The state of the local video, see LocalVideoStreamState.
-   * @param error The detailed error information, see LocalVideoStreamError.
+   * @param reason The reasons for changes in local video state. See LocalVideoStreamReason.
    */
   onLocalVideoStateChanged?(
     source: VideoSourceType,
     state: LocalVideoStreamState,
-    error: LocalVideoStreamError
+    reason: LocalVideoStreamReason
   ): void;
 
   /**
@@ -1711,24 +1720,24 @@ export interface IRtcEngineEventHandler {
   ): void;
 
   /**
-   * Reports the statistics of the local audio stream.
+   * Reports the transport-layer statistics of each remote audio stream.
    *
-   * The SDK triggers this callback once every two seconds.
+   * The SDK triggers this callback once every two seconds for each remote user who is sending audio streams. If a channel includes multiple remote users, the SDK triggers this callback as many times.
    *
    * @param connection The connection information. See RtcConnection.
-   * @param stats Local audio statistics. See LocalAudioStats.
+   * @param stats The statistics of the received remote audio streams. See RemoteAudioStats.
    */
-  onLocalAudioStats?(connection: RtcConnection, stats: LocalAudioStats): void;
+  onRemoteAudioStats?(connection: RtcConnection, stats: RemoteAudioStats): void;
 
   /**
-   * Reports the transport-layer statistics of each remote audio stream.
+   * Reports the statistics of the local audio stream.
    *
-   * The SDK triggers this callback once every two seconds for each remote user who is sending audio streams. If a channel includes multiple remote users, the SDK triggers this callback as many times.
+   * The SDK triggers this callback once every two seconds.
    *
    * @param connection The connection information. See RtcConnection.
-   * @param stats The statistics of the received remote audio streams. See RemoteAudioStats.
+   * @param stats Local audio statistics. See LocalAudioStats.
    */
-  onRemoteAudioStats?(connection: RtcConnection, stats: RemoteAudioStats): void;
+  onLocalAudioStats?(connection: RtcConnection, stats: LocalAudioStats): void;
 
   /**
    * Reports the statistics of the local video stream.
@@ -1813,7 +1822,7 @@ export interface IRtcEngineEventHandler {
    */
   onRhythmPlayerStateChanged?(
     state: RhythmPlayerStateType,
-    errorCode: RhythmPlayerErrorType
+    reason: RhythmPlayerReason
   ): void;
 
   /**
@@ -1874,7 +1883,7 @@ export interface IRtcEngineEventHandler {
    * @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 code ErrorCodeType The error code.
    * @param missed The number of lost messages.
    * @param cached Number of incoming cached messages when the data stream is interrupted.
    */
@@ -1932,21 +1941,6 @@ export interface IRtcEngineEventHandler {
     elapsed: number
   ): void;
 
-  /**
-   * Occurs when the SDK receives the first audio frame from a specific remote user.
-   *
-   * Deprecated: Use onRemoteAudioStateChanged instead.
-   *
-   * @param connection The connection information. See RtcConnection.
-   * @param userId The user ID of the remote user.
-   * @param elapsed The time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.
-   */
-  onFirstRemoteAudioFrame?(
-    connection: RtcConnection,
-    userId: number,
-    elapsed: number
-  ): void;
-
   /**
    * Occurs when the SDK decodes the first remote audio frame for playback.
    *
@@ -1968,6 +1962,21 @@ export interface IRtcEngineEventHandler {
     elapsed: number
   ): void;
 
+  /**
+   * Occurs when the SDK receives the first audio frame from a specific remote user.
+   *
+   * Deprecated: Use onRemoteAudioStateChanged instead.
+   *
+   * @param connection The connection information. See RtcConnection.
+   * @param userId The user ID of the remote user.
+   * @param elapsed The time elapsed (ms) from the local user calling joinChannel until the SDK triggers this callback.
+   */
+  onFirstRemoteAudioFrame?(
+    connection: RtcConnection,
+    userId: number,
+    elapsed: number
+  ): void;
+
   /**
    * Occurs when the local audio stream state changes.
    *
@@ -1975,12 +1984,12 @@ export interface IRtcEngineEventHandler {
    *
    * @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.
+   * @param reason Reasons for local audio state changes. See LocalAudioStreamReason.
    */
   onLocalAudioStateChanged?(
     connection: RtcConnection,
     state: LocalAudioStreamState,
-    error: LocalAudioStreamError
+    reason: LocalAudioStreamReason
   ): void;
 
   /**
@@ -2080,7 +2089,7 @@ export interface IRtcEngineEventHandler {
   /**
    * Reports the volume change of the audio device or app.
    *
-   * Occurs when the volume on the playback device, audio capture device, or the volume in the application changes.
+   * Occurs when the volume on the playback device, audio capture device, or the volume of the app changes.
    *
    * @param deviceType The device type. See MediaDeviceType.
    * @param volume The volume value. The range is [0, 255].
@@ -2099,12 +2108,12 @@ export interface IRtcEngineEventHandler {
    *
    * @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.
+   * @param reason Reasons for the changes in the Media Push status. See RtmpStreamPublishReason.
    */
   onRtmpStreamingStateChanged?(
     url: string,
     state: RtmpStreamPublishState,
-    errCode: RtmpStreamPublishErrorType
+    reason: RtmpStreamPublishReason
   ): void;
 
   /**
@@ -2118,7 +2127,7 @@ export interface IRtcEngineEventHandler {
   /**
    * Occurs when the publisher's transcoding is updated.
    *
-   * When the LiveTranscoding class in the method updates, the SDK triggers the onTranscodingUpdated callback to report the update information. If you call the method to set the LiveTranscoding class for the first time, the SDK does not trigger this callback.
+   * When the LiveTranscoding class in the startRtmpStreamWithTranscoding method updates, the SDK triggers the onTranscodingUpdated callback to report the update information. If you call the startRtmpStreamWithTranscoding method to set the LiveTranscoding class for the first time, the SDK does not trigger this callback.
    */
   onTranscodingUpdated?(): void;
 
@@ -2151,22 +2160,20 @@ export interface IRtcEngineEventHandler {
     code: ChannelMediaRelayError
   ): void;
 
-  /**
-   * Reports events during the media stream relay.
-   *
-   * Deprecated: This callback is deprecated.
-   *
-   * @param code The event code of channel media relay. See ChannelMediaRelayEvent.
-   */
-  onChannelMediaRelayEvent?(code: ChannelMediaRelayEvent): void;
-
   /**
    * @ignore
    */
   onLocalPublishFallbackToAudioOnly?(isFallbackOrRecover: boolean): void;
 
   /**
-   * @ignore
+   * Occurs when the remote media stream falls back to the audio-only stream due to poor network conditions or switches back to the video stream after the network conditions improve.
+   *
+   * If you call setRemoteSubscribeFallbackOption and set option to StreamFallbackOptionAudioOnly, the SDK triggers this callback in the following situations:
+   *  The downstream network condition is poor, and the subscribed video stream is downgraded to audio-only stream.
+   *  The downstream network condition has improved, and the subscribed stream has been restored to video stream. Once the remote media stream switches to the low-quality video stream due to weak network conditions, you can monitor the stream switch between a high-quality and low-quality stream in the onRemoteVideoStats callback.
+   *
+   * @param uid The user ID of the remote user.
+   * @param isFallbackOrRecover true : The subscribed media stream falls back to audio-only due to poor network conditions. false : The subscribed media stream switches back to the video stream after the network conditions improve.
    */
   onRemoteSubscribeFallbackToAudioOnly?(
     uid: number,
@@ -2297,6 +2304,45 @@ export interface IRtcEngineEventHandler {
    */
   onUserInfoUpdated?(uid: number, info: UserInfo): void;
 
+  /**
+   * @ignore
+   */
+  onUserAccountUpdated?(
+    connection: RtcConnection,
+    remoteUid: number,
+    remoteUserAccount: string
+  ): void;
+
+  /**
+   * Video frame rendering event callback.
+   *
+   * After calling the startMediaRenderingTracing method or joining the channel, the SDK triggers this callback to report the events of video frame rendering and the indicators during the rendering process. Developers can optimize the indicators to improve the efficiency of the first video frame rendering.
+   *
+   * @param connection The connection information. See RtcConnection.
+   * @param uid The user ID.
+   * @param currentEvent The current video frame rendering event. See MediaTraceEvent.
+   * @param tracingInfo The indicators during the video frame rendering process. Developers need to reduce the value of indicators as much as possible in order to improve the efficiency of the first video frame rendering. See VideoRenderingTracingInfo.
+   */
+  onVideoRenderingTracingResult?(
+    connection: RtcConnection,
+    uid: number,
+    currentEvent: MediaTraceEvent,
+    tracingInfo: VideoRenderingTracingInfo
+  ): void;
+
+  /**
+   * Occurs when there's an error during the local video mixing.
+   *
+   * When you fail to call startLocalVideoTranscoder or updateLocalTranscoderConfiguration, the SDK triggers this callback to report the reason.
+   *
+   * @param stream The video streams that cannot be mixed during video mixing. See TranscodingVideoStream.
+   * @param error The reason for local video mixing error. See VideoTranscoderError.
+   */
+  onLocalVideoTranscoderError?(
+    stream: TranscodingVideoStream,
+    error: VideoTranscoderError
+  ): void;
+
   /**
    * @ignore
    */
@@ -2373,6 +2419,18 @@ export interface IRtcEngineEventHandler {
     elapseSinceLastState: number
   ): void;
 
+  /**
+   * @ignore
+   */
+  onTranscodedStreamLayoutInfo?(
+    connection: RtcConnection,
+    uid: number,
+    width: number,
+    height: number,
+    layoutCount: number,
+    layoutlist: VideoLayout[]
+  ): void;
+
   /**
    * The event callback of the extension.
    *
@@ -2430,41 +2488,7 @@ export interface IRtcEngineEventHandler {
   /**
    * @ignore
    */
-  onUserAccountUpdated?(
-    connection: RtcConnection,
-    remoteUid: number,
-    userAccount: string
-  ): void;
-
-  /**
-   * Occurs when there's an error during the local video mixing.
-   *
-   * When you fail to call startLocalVideoTranscoder or updateLocalTranscoderConfiguration, the SDK triggers this callback to report the reason.
-   *
-   * @param stream The video streams that cannot be mixed during video mixing. See TranscodingVideoStream.
-   * @param error The reason for local video mixing error. See VideoTranscoderError.
-   */
-  onLocalVideoTranscoderError?(
-    stream: TranscodingVideoStream,
-    error: VideoTranscoderError
-  ): void;
-
-  /**
-   * Video frame rendering event callback.
-   *
-   * After calling the startMediaRenderingTracing method or joining the channel, the SDK triggers this callback to report the events of video frame rendering and the indicators during the rendering process. Developers can optimize the indicators to improve the efficiency of the first video frame rendering.
-   *
-   * @param connection The connection information. See RtcConnection.
-   * @param uid The user ID.
-   * @param currentEvent The current video frame rendering event. See MediaTraceEvent.
-   * @param tracingInfo The indicators during the video frame rendering process. Developers need to reduce the value of indicators as much as possible in order to improve the efficiency of the first video frame rendering. See VideoRenderingTracingInfo.
-   */
-  onVideoRenderingTracingResult?(
-    connection: RtcConnection,
-    uid: number,
-    currentEvent: MediaTraceEvent,
-    tracingInfo: VideoRenderingTracingInfo
-  ): void;
+  onSetRtmFlagResult?(connection: RtcConnection, code: number): void;
 }
 
 /**
@@ -2563,7 +2587,7 @@ export class RtcEngineContext {
    */
   license?: string;
   /**
-   * The audio scenarios. See AudioScenarioType. Under different audio scenarios, the device uses different volume types.
+   * The audio scenarios. Under different audio scenarios, the device uses different volume types. See AudioScenarioType.
    */
   audioScenario?: AudioScenarioType;
   /**
@@ -2573,7 +2597,7 @@ export class RtcEngineContext {
   /**
    * 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 default size of each SDK log file and API 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).
@@ -2671,33 +2695,33 @@ export interface IMetadataObserver {
 }
 
 /**
- * The CDN streaming error.
+ * Reasons for the changes in CDN streaming status.
  */
-export enum DirectCdnStreamingError {
+export enum DirectCdnStreamingReason {
   /**
    * 0: No error.
    */
-  DirectCdnStreamingErrorOk = 0,
+  DirectCdnStreamingReasonOk = 0,
   /**
    * 1: A general error; no specific reason. You can try to push the media stream again.
    */
-  DirectCdnStreamingErrorFailed = 1,
+  DirectCdnStreamingReasonFailed = 1,
   /**
    * 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,
+  DirectCdnStreamingReasonAudioPublication = 2,
   /**
    * 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,
+  DirectCdnStreamingReasonVideoPublication = 3,
   /**
    * 4: Fails to connect to the CDN.
    */
-  DirectCdnStreamingErrorNetConnect = 4,
+  DirectCdnStreamingReasonNetConnect = 4,
   /**
    * 5: The URL is already being used. Use a new URL for streaming.
    */
-  DirectCdnStreamingErrorBadName = 5,
+  DirectCdnStreamingReasonBadName = 5,
 }
 
 /**
@@ -2762,12 +2786,12 @@ export interface IDirectCdnStreamingEventHandler {
    * When the host directly pushes streams to the CDN, if the streaming state changes, the SDK triggers this callback to report the changed streaming state, error codes, and other information. You can troubleshoot issues by referring to this callback.
    *
    * @param state The current CDN streaming state. See DirectCdnStreamingState.
-   * @param error The CDN streaming error. See DirectCdnStreamingError.
+   * @param reason Reasons for changes in the status of CDN streaming. See DirectCdnStreamingReason.
    * @param message The information about the changed streaming state.
    */
   onDirectCdnStreamingStateChanged?(
     state: DirectCdnStreamingState,
-    error: DirectCdnStreamingError,
+    reason: DirectCdnStreamingReason,
     message: string
   ): void;
 
@@ -2843,17 +2867,6 @@ export class ExtensionInfo {
  * IRtcEngine provides the main methods that your app can call. Before calling other APIs, you must call createAgoraRtcEngine to create an IRtcEngine object.
  */
 export abstract class IRtcEngine {
-  /**
-   * Releases the IRtcEngine instance.
-   *
-   * This method releases all resources used by the Agora SDK. Use this method for apps in which users occasionally make voice or video calls. When users do not make calls, you can free up resources for other operations. After a successful method call, you can no longer use any method or callback in the SDK anymore. If you want to use the real-time communication functions again, you must call createAgoraRtcEngine and initialize to create a new IRtcEngine instance.
-   *  This method can be called synchronously. You need to wait for the resource of IRtcEngine to be released before performing other operations (for example, create a new IRtcEngine object). Therefore, Agora recommends calling this method in the child thread to avoid blocking the main thread.
-   *  Besides, Agora does not recommend you calling release in any callback of the SDK. Otherwise, the SDK cannot release the resources until the callbacks return results, which may result in a deadlock.
-   *
-   * @param sync Whether the method is called synchronously: true : Synchronous call. false : Asynchronous call. Currently this method only supports synchronous calls. Do not set this parameter to this value.
-   */
-  abstract release(sync?: boolean): void;
-
   /**
    * Creates and initializes IRtcEngine.
    *
@@ -2901,6 +2914,15 @@ export abstract class IRtcEngine {
    */
   abstract queryCodecCapability(): { codecInfo: CodecCapInfo[]; size: number };
 
+  /**
+   * Queries device score.
+   *
+   * @returns
+   * >0: The method call succeeeds, the value is the current device's score, the range is [0,100], the larger the value, the stronger the device capability. Most devices are rated between 60 and 100.
+   *  < 0: Failure.
+   */
+  abstract queryDeviceScore(): number;
+
   /**
    * Preloads a channel with token, channelId, and uid.
    *
@@ -2955,7 +2977,7 @@ export abstract class IRtcEngine {
    *  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):
+   * @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.
@@ -3006,7 +3028,7 @@ export abstract class IRtcEngine {
    *  All numeric characters: 0 to 9.
    *  Space
    *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
-   * @param uid The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 2 32 -1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the onJoinChannelSuccess callback. Your application must record and maintain the returned user ID, because the SDK does not do so.
+   * @param uid The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 2 32 -1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the onJoinChannelSuccess callback. Your app must record and maintain the returned user ID, because the SDK does not do so.
    * @param options The channel media options. See ChannelMediaOptions.
    *
    * @returns
@@ -3058,8 +3080,7 @@ export abstract class IRtcEngine {
   /**
    * Renews the token.
    *
-   * The SDK triggers the onTokenPrivilegeWillExpire callback.
-   *  The onConnectionStateChanged callback reports ConnectionChangedTokenExpired (9).
+   * The SDK triggers the onTokenPrivilegeWillExpire callback. onConnectionStateChanged The ConnectionChangedTokenExpired callback reports (9).
    *
    * @param token The new token.
    *
@@ -3178,7 +3199,7 @@ export abstract class IRtcEngine {
    * Enables the local video preview and specifies the video source for the preview.
    *
    * You can call this method to enable local video preview. Call this method after the following:
-   *  Call setView to initialize the local preview.
+   *  Call setupLocalVideo to initialize the local preview.
    *  Call enableVideo to enable the video module.
    *  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.
@@ -3208,9 +3229,7 @@ export abstract class IRtcEngine {
   /**
    * Starts the last mile network probe test.
    *
-   * This method starts the last-mile network probe test before joining a channel to get the uplink and downlink last mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT). Once this method is enabled, the SDK returns the following callbacks: onLastmileQuality : The SDK triggers this callback within two seconds depending on the network conditions. This callback rates the network conditions and is more closely linked to the user experience. onLastmileProbeResult : The SDK triggers this callback within 30 seconds depending on the network conditions. This callback returns the real-time statistics of the network conditions and is more objective. This method applies to the following scenarios:
-   *  Before a user joins a channel, call this method to check the uplink network quality.
-   *  In a live streaming channel, call this method to check the uplink network quality before an audience member switches to a host.
+   * This method starts the last-mile network probe test before joining a channel to get the uplink and downlink last mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT). Once this method is enabled, the SDK returns the following callbacks: onLastmileQuality : The SDK triggers this callback within two seconds depending on the network conditions. This callback rates the network conditions and is more closely linked to the user experience. onLastmileProbeResult : The SDK triggers this callback within 30 seconds depending on the network conditions. This callback returns the real-time statistics of the network conditions and is more objective. This method must be called before joining the channel, and is used to judge and predict whether the current uplink network quality is good enough.
    *  Do not call other methods before receiving the onLastmileQuality and onLastmileProbeResult callbacks. Otherwise, the callbacks may be interrupted.
    *  A host should not call this method after joining a channel (when in a call).
    *
@@ -3234,7 +3253,7 @@ export abstract class IRtcEngine {
   /**
    * Sets the video encoder configuration.
    *
-   * Sets the encoder configuration for the local video. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before enableVideo to reduce the time to render the first video frame.
+   * Sets the encoder configuration for the local video. Each configuration profile corresponds to a set of video parameters, including the resolution, frame rate, and bitrate. The config specified in this method is the maximum value under ideal network conditions. If the video engine cannot render the video using the specified config due to unreliable network conditions, the parameters further down the list are considered until a successful configuration is found. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before enableVideo to reduce the time to render the first video frame.
    *
    * @param config Video profile. See VideoEncoderConfiguration.
    *
@@ -3382,6 +3401,7 @@ export abstract class IRtcEngine {
    *
    * 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.
+   *  If you want to stop rendering the view, set view to null and then call this method again to stop rendering and clear the rendering cache.
    *
    * @param canvas The remote video view and settings. See VideoCanvas.
    *
@@ -3394,8 +3414,9 @@ export abstract class IRtcEngine {
   /**
    * Initializes the local video view.
    *
-   * This method initializes the video view of a local stream on the local device. It affects only the video view that the local user sees, not the published local video stream. Call this method to bind the local video stream to a video view (view) and to set the rendering and mirror modes of the video view. After initialization, call this method to set the local video and then join the channel. The local video still binds to the view after you leave the channel. To unbind the local video from the view, set the view parameter as NULL.
+   * This method initializes the video view of a local stream on the local device. It affects only the video view that the local user sees, not the published local video stream. Call this method to bind the local video stream to a video view (view) and to set the rendering and mirror modes of the video view. After initialization, call this method to set the local video and then join the channel. The local video still binds to the view after you leave the channel. To unbind the local video from the view, set the view parameter as null. In real-time interactive scenarios, if you need to simultaneously view multiple preview frames in the local video preview, and each frame is at a different observation position along the video link, you can repeatedly call this method to set different view s and set different observation positions for each view. For example, by setting the video source to the camera and then configuring two view s with position setting to PositionPostCapturerOrigin and PositionPostCapturer, you can simultaneously preview the raw, unprocessed video frame and the video frame that has undergone preprocessing (image enhancement effects, virtual background, watermark) in the local video preview.
    *  You can call this method either before or after joining a channel.
+   *  If you want to stop rendering the view, set view to null and then call this method again to stop rendering and clear the rendering cache.
    *
    * @param canvas The local video view and settings. See VideoCanvas.
    *
@@ -3428,9 +3449,17 @@ export abstract class IRtcEngine {
    * @returns
    * 0: Success.
    *  < 0: Failure.
+   *  -1: A general error occurs (no specified reason).
+   *  -4: Video application scenarios are not supported. Possible reasons include that you use the Voice SDK instead of the Video SDK.
+   *  -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
    */
   abstract setVideoScenario(scenarioType: VideoApplicationScenarioType): number;
 
+  /**
+   * @ignore
+   */
+  abstract setVideoQoEPreference(qoePreference: VideoQoePreferenceType): number;
+
   /**
    * Enables the audio module.
    *
@@ -3449,7 +3478,7 @@ export abstract class IRtcEngine {
    * Disables the audio module.
    *
    * This method disables the internal engine and can be called anytime after initialization. It is still valid after one leaves channel.
-   *  This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the audio modules 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.
+   *  This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the audio modules separately: enableLocalAudio : Whether to enable the microphone to create the local audio stream. enableLoopbackRecording : Whether to enable loopback audio capturing. 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.
@@ -3461,10 +3490,11 @@ export abstract class IRtcEngine {
    * Sets the audio profile and audio scenario.
    *
    * You can call this method either before or after joining a channel.
+   *  Due to iOS system restrictions, some audio routes cannot be recognized in call volume mode. Therefore, if you need to use an external sound card, it is recommended to set the audio scenario to AudioScenarioGameStreaming (3). In this scenario, the SDK will switch to media volume to avoid this issue.
    *  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.
+   * @param scenario The audio scenarios. Under different audio scenarios, the device uses different volume types. See AudioScenarioType.
    *
    * @returns
    * 0: Success.
@@ -3478,9 +3508,10 @@ export abstract class IRtcEngine {
   /**
    * Sets audio scenarios.
    *
-   * You can call this method either before or after joining a channel.
+   * Due to iOS system restrictions, some audio routes cannot be recognized in call volume mode. Therefore, if you need to use an external sound card, it is recommended to set the audio scenario to AudioScenarioGameStreaming (3). In this scenario, the SDK will switch to media volume to avoid this issue.
+   *  You can call this method either before or after joining a channel.
    *
-   * @param scenario The audio scenarios. See AudioScenarioType. Under different audio scenarios, the device uses different volume types.
+   * @param scenario The audio scenarios. Under different audio scenarios, the device uses different volume types. See AudioScenarioType.
    *
    * @returns
    * 0: Success.
@@ -3568,7 +3599,7 @@ export abstract class IRtcEngine {
   /**
    * 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.
+   * 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. If you call enableLocalVideo (false) to disable local video capture within the channel, it also simultaneously stops publishing the video stream within the channel. If you want to restart video catpure, you can call enableLocalVideo (true) and then call updateChannelMediaOptions to set the options parameter to publish the locally captured video stream in the channel. 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.
    *
@@ -3600,6 +3631,21 @@ export abstract class IRtcEngine {
    */
   abstract setDefaultMuteAllRemoteVideoStreams(mute: boolean): number;
 
+  /**
+   * Sets the default video stream type to subscribe to.
+   *
+   * The SDK defaults to enabling low-quality video stream adaptive mode (AutoSimulcastStream) on the sender side, which means the sender does not actively send low-quality video stream. The receiver can initiate a low-quality video stream request by calling this method, and the sender will automatically start sending low-quality video stream upon receiving the request. By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. The SDK will dynamically adjust the size of the corresponding video stream based on the size of the video window to save bandwidth and computing resources. The default aspect ratio of the low-quality video stream is the same as that of the high-quality video stream. According to the current aspect ratio of the high-quality video stream, the system will automatically allocate the resolution, frame rate, and bitrate of the low-quality video stream. Under limited network conditions, if the publisher does not disable 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, while the low-quality video stream has a lower resolution and bitrate.
+   *  Call this method before joining a channel. The SDK does not support changing the default subscribed video stream type after joining a channel.
+   *  If you call both this method and setRemoteVideoStreamType, the setting of setRemoteVideoStreamType takes effect.
+   *
+   * @param streamType The default video-stream type. See VideoStreamType.
+   *
+   * @returns
+   * 0: Success.
+   *  < 0: Failure.
+   */
+  abstract setRemoteDefaultVideoStreamType(streamType: VideoStreamType): number;
+
   /**
    * Stops or resumes subscribing to the video stream of a specified user.
    *
@@ -3615,12 +3661,12 @@ export abstract class IRtcEngine {
   abstract muteRemoteVideoStream(uid: number, mute: boolean): number;
 
   /**
-   * Sets the stream type of the remote video.
+   * Sets the video stream type to subscribe to.
    *
-   * 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. By default, the SDK enables the low-quality video stream auto mode on the sending end (it does not actively send the low-quality video stream). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling this method (the call to this method by the audience receiver does not take effect). After receiving the application, the sending end automatically switches to the low-quality video stream mode. 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.
+   * Under limited network conditions, if the publisher does not disable 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, while 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. The SDK will dynamically adjust the size of the corresponding video stream based on the size of the video window to save bandwidth and computing resources. The default aspect ratio of the low-quality video stream is the same as that of the high-quality video stream. According to the current aspect ratio of the high-quality video stream, the system will automatically allocate the resolution, frame rate, and bitrate of the low-quality video stream. The SDK defaults to enabling low-quality video stream adaptive mode (AutoSimulcastStream) on the sender side, which means the sender does not actively send low-quality video stream. The receiver can initiate a low-quality video stream request by calling this method, and the sender will automatically start sending low-quality video stream upon receiving the request. 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.
+   * @param streamType The video stream type, see VideoStreamType.
    *
    * @returns
    * 0: Success.
@@ -3655,21 +3701,6 @@ export abstract class IRtcEngine {
     options: VideoSubscriptionOptions
   ): number;
 
-  /**
-   * Sets the default stream type of subscrption for remote video streams.
-   *
-   * By default, the SDK enables the low-quality video stream auto mode on the sending end (it does not actively send the low-quality video stream). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling this method (the call to this method by the audience receiver does not take effect). After receiving the application, the sending end automatically switches to the low-quality video stream mode. 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-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.
-   *  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.
-   *
-   * @returns
-   * 0: Success.
-   *  < 0: Failure.
-   */
-  abstract setRemoteDefaultVideoStreamType(streamType: VideoStreamType): number;
-
   /**
    * Set the blocklist of subscriptions for audio streams.
    *
@@ -3761,7 +3792,7 @@ export abstract class IRtcEngine {
    *
    * @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.
+   *  > 0: Time interval (ms) between two consecutive volume indications. Ensure this parameter is set to a value greater than 10, otherwise you will not receive the onAudioVolumeIndication callback. Agora recommends that this value is set as greater than 100.
    * @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.
    *
@@ -3847,9 +3878,9 @@ export abstract class IRtcEngine {
    * Starts playing the music file.
    *
    * This method mixes the specified local or online audio file with the audio from the microphone, or replaces the microphone's audio with the specified local or remote audio file. A successful method call triggers the onAudioMixingStateChanged (AudioMixingStatePlaying) callback. When the audio mixing file playback finishes, the SDK triggers the onAudioMixingStateChanged (AudioMixingStateStopped) callback on the local client.
-   *  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.
+   *  For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
    *
    * @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.
@@ -4089,9 +4120,7 @@ export abstract class IRtcEngine {
   /**
    * Preloads a specified audio effect file into the memory.
    *
-   * To ensure smooth communication, It is recommended that you limit the size of the audio effect file. You can call this method to preload the audio effect before calling joinChannel.
-   *  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.
+   * To ensure smooth communication, It is recommended that you limit the size of the audio effect file. You can call this method to preload the audio effect before calling joinChannel. For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK support.
    *
    * @param soundId The audio effect ID. The ID of each audio effect file is unique.
    * @param filePath File path:
@@ -4635,7 +4664,7 @@ export abstract class IRtcEngine {
    * Deprecated: Use the logConfig parameter in initialize instead. By default, the SDK generates five SDK log files and five API call log files with the following rules:
    *  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 default size of each SDK log file and API 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).
@@ -4664,6 +4693,7 @@ export abstract class IRtcEngine {
    * After initializing the local video view, you can call this method to update its rendering and mirror modes. It affects only the video view that the local user sees, not the published local video stream.
    *  Ensure that you have called the setupLocalVideo method to initialize the local video view before calling this method.
    *  During a call, you can call this method as many times as necessary to update the display mode of the local video view.
+   *  This method only takes effect on the primary camera (PrimaryCameraSource). In scenarios involving custom video capture or the use of alternative video sources, you need to use setupLocalVideo instead of this method.
    *
    * @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.
@@ -4712,7 +4742,7 @@ export abstract class IRtcEngine {
   abstract setLocalVideoMirrorMode(mirrorMode: VideoMirrorModeType): number;
 
   /**
-   * Enables or disables the dual-stream mode on the sender and sets the low-quality video stream.
+   * Sets the dual-stream mode on the sender side and the low-quality video stream.
    *
    * Deprecated: This method is deprecated as of v4.2.0. Use setDualStreamMode instead. 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.
@@ -4722,7 +4752,7 @@ export abstract class IRtcEngine {
    *  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 streamConfig The configuration of the low-quality video stream. See SimulcastStreamConfig.
+   * @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.
@@ -4734,13 +4764,13 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Sets dual-stream mode configuration on the sender, and sets the low-quality video stream.
+   * Sets dual-stream mode configuration on the sender side.
    *
-   * The SDK enables the low-quality video stream auto mode on the sender side by default (it does not actively sending low-quality video streams). The host identity receiver can initiate a low-quality video stream application at the receiving end by calling setRemoteVideoStreamType. After receiving the application, the sending end automatically switches to the low-quality video stream mode.
-   *  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).
+   * The SDK defaults to enabling low-quality video stream adaptive mode (AutoSimulcastStream) on the sender side, which means the sender does not actively send low-quality video stream. The receiver can initiate a low-quality video stream request by calling setRemoteVideoStreamType, and the sender then automatically starts sending low-quality video stream upon receiving the request.
+   *  If you want to modify this behavior, you can call this method and set mode to DisableSimulcastStream (never send low-quality video streams) or EnableSimulcastStream (always send low-quality video streams).
    *  If you want to restore the default behavior after making changes, you can call this method again with mode set to AutoSimulcastStream. The difference and connection between this method and enableDualStreamMode is as follows:
-   *  When calling this method and setting mode to DisableSimulcastStream, it has the same effect as calling and setting enabled to false.
-   *  When calling this method and setting mode to EnableSimulcastStream, it has the same effect as calling and setting enabled to true.
+   *  When calling this method and setting mode to DisableSimulcastStream, it has the same effect as calling enableDualStreamMode and setting enabled to false.
+   *  When calling this method and setting mode to EnableSimulcastStream, it has the same effect as calling enableDualStreamMode and setting enabled to true.
    *  Both methods can be called before and after joining a channel. If both methods are used, the settings in the method called later takes precedence.
    *
    * @param mode The mode in which the video stream is sent. See SimulcastStreamMode.
@@ -4756,7 +4786,16 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * @ignore
+   * Sets whether to enable the local playback of external audio source.
+   *
+   * Ensure you have called the createCustomAudioTrack method to create a custom audio track before calling this method. After calling this method to enable the local playback of external audio source, if you need to stop local playback, you can call this method again and set enabled to false. You can call adjustCustomAudioPlayoutVolume to adjust the local playback volume of the custom audio track.
+   *
+   * @param trackId The audio track ID. Set this parameter to the custom audio track ID returned in createCustomAudioTrack.
+   * @param enabled Whether to play the external audio source: true : Play the external audio source. false : (Default) Do not play the external source.
+   *
+   * @returns
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract enableCustomAudioLocalPlayback(
     trackId: number,
@@ -4859,7 +4898,7 @@ 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).
+   * @param channel The number of channels of the audio data, which can be set as 1 (Mono) or 2 (Stereo).
    *
    * @returns
    * 0: Success.
@@ -4988,7 +5027,15 @@ export abstract class IRtcEngine {
   abstract setLocalPublishFallbackOption(option: StreamFallbackOptions): number;
 
   /**
-   * @ignore
+   * Sets the fallback option for the subscribed video stream based on the network conditions.
+   *
+   * An unstable network affects the audio and video quality in a video call or interactive live video streaming. If option is set as StreamFallbackOptionVideoStreamLow or StreamFallbackOptionAudioOnly, the SDK automatically switches the video from a high-quality stream to a low-quality stream or disables the video when the downlink network conditions cannot support both audio and video to guarantee the quality of the audio. Meanwhile, the SDK continuously monitors network quality and resumes subscribing to audio and video streams when the network quality improves. When the subscribed video stream falls back to an audio-only stream, or recovers from an audio-only stream to an audio-video stream, the SDK triggers the onRemoteSubscribeFallbackToAudioOnly callback. Ensure that you call this method before joining a channel.
+   *
+   * @param option Fallback options for the subscribed stream. See STREAM_FALLBACK_OPTIONS.
+   *
+   * @returns
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setRemoteSubscribeFallbackOption(
     option: StreamFallbackOptions
@@ -5004,40 +5051,113 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Enables loopback audio capturing.
+   * Enables or disables extensions.
    *
-   * If you enable loopback audio capturing, the output of the sound card is mixed into the audio stream sent to the other end.
-   *  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.
+   * 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 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 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.
+   *  -3: The extension library is not loaded. Agora recommends that you check the storage location or the name of the dynamic library.
    */
-  abstract enableLoopbackRecording(
-    enabled: boolean,
-    deviceName?: string
+  abstract enableExtension(
+    provider: string,
+    extension: string,
+    enable?: boolean,
+    type?: MediaSourceType
   ): number;
 
   /**
-   * Adjusts the volume of the signal captured by the sound card.
+   * Sets the properties of the extension.
    *
-   * After calling enableLoopbackRecording to enable loopback audio capturing, you can call this method to adjust the volume of the signal captured by the sound card.
+   * After enabling the extension, you can call this method to set the properties of the extension.
    *
-   * @param volume Audio mixing volume. The value ranges between 0 and 100. The default value is 100, which means the original volume.
+   * @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 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.
    */
-  abstract adjustLoopbackSignalVolume(volume: number): number;
+  abstract setExtensionProperty(
+    provider: string,
+    extension: string,
+    key: string,
+    value: string,
+    type?: MediaSourceType
+  ): number;
 
   /**
-   * @ignore
+   * 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 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.
+   */
+  abstract getExtensionProperty(
+    provider: string,
+    extension: string,
+    key: string,
+    bufLen: number,
+    type?: MediaSourceType
+  ): string;
+
+  /**
+   * 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.
+   *  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.
+   *  If you call the disableAudio method to disable the audio module, audio capturing will be disabled as well. If you need to enable audio capturing, call the enableAudio method to enable the audio module and then call the enableLoopbackRecording method.
+   *
+   * @param enabled Sets 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.
+   *
+   * @returns
+   * 0: Success.
+   *  < 0: Failure.
+   */
+  abstract enableLoopbackRecording(
+    enabled: boolean,
+    deviceName?: string
+  ): number;
+
+  /**
+   * Adjusts the volume of the signal captured by the sound card.
+   *
+   * After calling enableLoopbackRecording to enable loopback audio capturing, you can call this method to adjust the volume of the signal captured by the sound card.
+   *
+   * @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.
+   */
+  abstract adjustLoopbackSignalVolume(volume: number): number;
+
+  /**
+   * @ignore
    */
   abstract getLoopbackRecordingVolume(): number;
 
@@ -5064,13 +5184,12 @@ export abstract class IRtcEngine {
   /**
    * Sets the volume of the in-ear monitor.
    *
-   * 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.
+   * You can call this method either before or after joining a channel.
    *
-   * @returns
-   * < 0: Failure.
+   * @param volume The volume of the in-ear monitor. The value range is [0,400].
+   *  0: Mute.
+   *  100: (Default) The original volume.
+   *  400: Four times the original volume.
    */
   abstract setInEarMonitoringVolume(volume: number): number;
 
@@ -5131,78 +5250,6 @@ export abstract class IRtcEngine {
     type?: MediaSourceType
   ): number;
 
-  /**
-   * 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 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.
-   *  -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,
-    extension: string,
-    enable?: boolean,
-    type?: MediaSourceType
-  ): number;
-
-  /**
-   * Sets the properties of the extension.
-   *
-   * 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 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.
-   */
-  abstract setExtensionProperty(
-    provider: string,
-    extension: string,
-    key: string,
-    value: string,
-    type?: MediaSourceType
-  ): number;
-
-  /**
-   * 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 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.
-   */
-  abstract getExtensionProperty(
-    provider: string,
-    extension: string,
-    key: string,
-    bufLen: number,
-    type?: MediaSourceType
-  ): string;
-
   /**
    * @ignore
    */
@@ -5211,12 +5258,12 @@ export abstract class IRtcEngine {
   ): number;
 
   /**
-   * Creates a customized video track.
+   * Creates a custom video track.
    *
-   * When you need to publish multiple custom captured videos in the channel, you can refer to the following steps:
+   * To publish a custom video source, see the following steps:
    *  Call this method to create a video track and get the video track ID.
-   *  In each channel's ChannelMediaOptions, set the customVideoTrackId parameter to the ID of the video track you want to publish, and set publishCustomVideoTrack to true.
-   *  If you call pushVideoFrame, and specify customVideoTrackId as the videoTrackId set in step 2, you can publish the corresponding custom video source in multiple channels.
+   *  Call joinChannel to join the channel. In ChannelMediaOptions, set customVideoTrackId to the video track ID that you want to publish, and set publishCustomVideoTrack to true.
+   *  Call pushVideoFrame and specify videoTrackId as the video track ID set in step 2. You can then publish the corresponding custom video source in the channel.
    *
    * @returns
    * If the method call is successful, the video track ID is returned as the unique identifier of the video track.
@@ -5523,22 +5570,6 @@ export abstract class IRtcEngine {
    */
   abstract startScreenCapture(captureParams: ScreenCaptureParameters2): number;
 
-  /**
-   * Starts screen capture.
-   *
-   * This method, as well as startScreenCaptureByDisplayId and startScreenCaptureByWindowId, all have the capability to start screen capture, with the following differences: startScreenCaptureByDisplayId and startScreenCaptureByWindowId only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.
-   *  If you call this method to start screen capture, Agora recommends that you call stopScreenCaptureBySourceType to stop the capture and avoid using stopScreenCapture.
-   *
-   * @param sourceType The type of the video source. See VideoSourceType.
-   *  Windows supports up to four screen capture video streams.
-   *  macOS supports only one screen capture video stream. You can only set this parameter to VideoSourceScreen (2).
-   * @param config The configuration of the captured screen. See ScreenCaptureConfiguration.
-   */
-  abstract startScreenCaptureBySourceType(
-    sourceType: VideoSourceType,
-    config: ScreenCaptureConfiguration
-  ): number;
-
   /**
    * @ignore
    */
@@ -5573,20 +5604,6 @@ export abstract class IRtcEngine {
    */
   abstract stopScreenCapture(): number;
 
-  /**
-   * Stops screen capture.
-   *
-   * After calling startScreenCaptureBySourceType to start capturing video from one or more screens, you can call this method and set the sourceType parameter to stop capturing from the specified screens.
-   *  If you call startScreenCaptureByWindowId or startScreenCaptureByDisplayId to start screen capture, Agora recommends that you call stopScreenCapture to stop the capture and do not use this one.
-   *
-   * @param sourceType The type of the video source. See VideoSourceType.
-   *
-   * @returns
-   * 0: Success.
-   *  < 0: Failure.
-   */
-  abstract stopScreenCaptureBySourceType(sourceType: VideoSourceType): number;
-
   /**
    * Retrieves the call ID.
    *
@@ -5647,9 +5664,9 @@ export abstract class IRtcEngine {
    * @returns
    * 0: Success.
    *  < 0: Failure.
-   *  -2: The URL is null or the string length is 0.
+   *  -2: The URL or configuration of transcoding is invalid; check your URL and transcoding configurations.
    *  -7: The SDK is not initialized before calling this method.
-   *  -19: The Media Push URL is already in use, use another URL instead.
+   *  -19: The Media Push URL is already in use; use another URL instead.
    */
   abstract startRtmpStreamWithoutTranscoding(url: string): number;
 
@@ -5667,9 +5684,9 @@ export abstract class IRtcEngine {
    * @returns
    * 0: Success.
    *  < 0: Failure.
-   *  -2: The URL is null or the string length is 0.
+   *  -2: The URL or configuration of transcoding is invalid; check your URL and transcoding configurations.
    *  -7: The SDK is not initialized before calling this method.
-   *  -19: The Media Push URL is already in use, use another URL instead.
+   *  -19: The Media Push URL is already in use; use another URL instead.
    */
   abstract startRtmpStreamWithTranscoding(
     url: string,
@@ -5689,19 +5706,6 @@ export abstract class IRtcEngine {
    */
   abstract updateRtmpTranscoding(transcoding: LiveTranscoding): number;
 
-  /**
-   * Stops pushing media streams to a CDN.
-   *
-   * Agora recommends that you use the server-side Media Push function. You can call this method to stop the live stream on the specified CDN address. This method can stop pushing media streams to only one CDN address at a time, so if you need to stop pushing 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.
-   */
-  abstract stopRtmpStream(url: string): number;
-
   /**
    * Starts the local video mixing.
    *
@@ -5740,10 +5744,27 @@ export abstract class IRtcEngine {
     config: LocalTranscoderConfiguration
   ): number;
 
+  /**
+   * Stops pushing media streams to a CDN.
+   *
+   * Agora recommends that you use the server-side Media Push function. You can call this method to stop the live stream on the specified CDN address. This method can stop pushing media streams to only one CDN address at a time, so if you need to stop pushing 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.
+   */
+  abstract stopRtmpStream(url: string): number;
+
   /**
    * 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;
 
@@ -5755,6 +5776,10 @@ export abstract class IRtcEngine {
    * @param sourceType The type of the video source. See VideoSourceType.
    *  On the desktop platforms, you can capture video from up to 4 cameras.
    * @param config The configuration of the video capture. See CameraCapturerConfiguration.
+   *
+   * @returns
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract startCameraCapture(
     sourceType: VideoSourceType,
@@ -5814,8 +5839,7 @@ export abstract class IRtcEngine {
   /**
    * 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.
+   * 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.
    *
@@ -5917,8 +5941,7 @@ export abstract class IRtcEngine {
    * Sends data stream messages to all users in a channel. The SDK has the following restrictions on this method:
    *  Up to 30 packets can be sent per second in a channel with each packet having a maximum size of 1 KB.
    *  Each client can send up to 6 KB of data per second.
-   *  Each user can have up to five data streams simultaneously. A successful method call triggers the onStreamMessage callback on the remote client, from which the remote user gets the stream message.
-   * A failed method call triggers the onStreamMessageError callback on the remote client.
+   *  Each user can have up to five data streams simultaneously. A successful method call triggers the onStreamMessage callback on the remote client, from which the remote user gets the stream message. A failed method call triggers the onStreamMessageError callback on the remote client.
    *  Ensure that you call createDataStream to create a data channel before calling this method.
    *  In live streaming scenarios, this method only applies to hosts.
    *
@@ -5947,7 +5970,6 @@ export abstract class IRtcEngine {
    *  If you only want to add a watermark to the media push, you can call this method or the 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.
@@ -6045,7 +6067,7 @@ export abstract class IRtcEngine {
    */
   abstract startAudioFrameDump(
     channelId: string,
-    userId: number,
+    uid: number,
     location: string,
     uuid: string,
     passwd: string,
@@ -6058,7 +6080,7 @@ export abstract class IRtcEngine {
    */
   abstract stopAudioFrameDump(
     channelId: string,
-    userId: number,
+    uid: number,
     location: string
   ): number;
 
@@ -6093,7 +6115,7 @@ export abstract class IRtcEngine {
    *  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 as follow(89 in total):
+   * @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.
@@ -6120,7 +6142,7 @@ export abstract class IRtcEngine {
    *  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):
+   * @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.
@@ -6160,7 +6182,7 @@ export abstract class IRtcEngine {
    *  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):
+   * @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.
@@ -6188,7 +6210,7 @@ export abstract class IRtcEngine {
    *
    * @returns
    * A pointer to the UserInfo instance, if the method call succeeds.
-   *  If the call fails, returns NULL.
+   *  If the call fails, returns null.
    */
   abstract getUserInfoByUserAccount(userAccount: string): UserInfo;
 
@@ -6201,7 +6223,7 @@ export abstract class IRtcEngine {
    *
    * @returns
    * A pointer to the UserInfo instance, if the method call succeeds.
-   *  If the call fails, returns NULL.
+   *  If the call fails, returns null.
    */
   abstract getUserInfoByUid(uid: number): UserInfo;
 
@@ -6230,47 +6252,6 @@ export abstract class IRtcEngine {
     configuration: ChannelMediaRelayConfiguration
   ): number;
 
-  /**
-   * Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels.
-   *
-   * Deprecated: This method is deprecated. Use startOrUpdateChannelMediaRelay instead. 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 returns RelayStateFailure (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.
-   *  Agora does not support string user accounts in this API.
-   *
-   * @param configuration The configuration of the media stream relay. See ChannelMediaRelayConfiguration.
-   *
-   * @returns
-   * 0: Success.
-   *  < 0: Failure.
-   *  -1: A general error occurs (no specified reason).
-   *  -2: The parameter is invalid.
-   *  -7: The method call was rejected. It may be because the SDK has not been initialized successfully, or the user role is not a host.
-   *  -8: Internal state error. Probably because the user is not a broadcaster.
-   */
-  abstract startChannelMediaRelay(
-    configuration: ChannelMediaRelayConfiguration
-  ): number;
-
-  /**
-   * Updates the channels for media stream relay.
-   *
-   * Deprecated: This method is deprecated. Use startOrUpdateChannelMediaRelay instead. 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. See ChannelMediaRelayConfiguration.
-   *
-   * @returns
-   * 0: Success.
-   *  < 0: Failure.
-   */
-  abstract updateChannelMediaRelay(
-    configuration: ChannelMediaRelayConfiguration
-  ): number;
-
   /**
    * Stops the media stream relay. Once the relay stops, the host quits all the target channels.
    *
@@ -6308,9 +6289,6 @@ export abstract class IRtcEngine {
    * 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
@@ -6424,7 +6402,7 @@ export abstract class IRtcEngine {
   /**
    * Adjusts the volume of the custom audio track played remotely.
    *
-   * Ensure you have called the createCustomAudioTrack method to create a custom 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.
+   * Ensure you have called the createCustomAudioTrack method to create a custom audio track before calling this method. If you want to change the volume of the audio played remotely, you need to call this method again.
    *
    * @param trackId The audio track ID. Set this parameter to the custom audio track ID returned in createCustomAudioTrack.
    * @param volume The volume of the audio source. The value can range from 0 to 100. 0 means mute; 100 means the original volume.
@@ -6612,6 +6590,66 @@ export abstract class IRtcEngine {
    */
   abstract isFeatureAvailableOnDevice(type: FeatureType): boolean;
 
+  /**
+   * Starts screen capture.
+   *
+   * This method, as well as startScreenCaptureByDisplayId and startScreenCaptureByWindowId, can all be used to enable screen capture, with the following differences: startScreenCaptureByDisplayId and startScreenCaptureByWindowId only support capturing video from a single screen or window. By calling this method and specifying the sourceType parameter, you can capture multiple video streams used for local video mixing or multi-channel publishing.
+   *  If you call this method to start screen capture, Agora recommends that you call stopScreenCaptureBySourceType to stop the capture and avoid using stopScreenCapture.
+   *
+   * @param sourceType The type of the video source. See VideoSourceType.
+   *  Windows supports up to four screen capture video streams.
+   *  macOS supports only one screen capture video stream. You can only set this parameter to VideoSourceScreen (2).
+   * @param config The configuration of the captured screen. See ScreenCaptureConfiguration.
+   *
+   * @returns
+   * 0: Success.
+   *  < 0: Failure.
+   */
+  abstract startScreenCaptureBySourceType(
+    sourceType: VideoSourceType,
+    config: ScreenCaptureConfiguration
+  ): number;
+
+  /**
+   * Stops screen capture.
+   *
+   * After calling startScreenCaptureBySourceType to start capturing video from one or more screens, you can call this method and set the sourceType parameter to stop capturing from the specified screens.
+   *  If you call startScreenCaptureByWindowId or startScreenCaptureByDisplayId to start screen capture, Agora recommends that you call stopScreenCapture to stop the capture and do not use this one.
+   *
+   * @param sourceType The type of the video source. See VideoSourceType.
+   *
+   * @returns
+   * 0: Success.
+   *  < 0: Failure.
+   */
+  abstract stopScreenCaptureBySourceType(sourceType: VideoSourceType): number;
+
+  /**
+   * Releases the IRtcEngine instance.
+   *
+   * This method releases all resources used by the Agora SDK. Use this method for apps in which users occasionally make voice or video calls. When users do not make calls, you can free up resources for other operations. After a successful method call, you can no longer use any method or callback in the SDK anymore. If you want to use the real-time communication functions again, you must call createAgoraRtcEngine and initialize to create a new IRtcEngine instance.
+   *  This method can be called synchronously. You need to wait for the resource of IRtcEngine to be released before performing other operations (for example, create a new IRtcEngine object). Therefore, Agora recommends calling this method in the child thread to avoid blocking the main thread.
+   *  Besides, Agora does not recommend you calling release in any callback of the SDK. Otherwise, the SDK cannot release the resources until the callbacks return results, which may result in a deadlock.
+   *
+   * @param sync Whether the method is called synchronously: true : Synchronous call. false : Asynchronous call. Currently this method only supports synchronous calls. Do not set this parameter to this value.
+   */
+  abstract release(sync?: boolean): void;
+
+  /**
+   * Enables the local video preview.
+   *
+   * You can call this method to enable local video preview. Call this method after the following:
+   *  Call setupLocalVideo to initialize the local preview.
+   *  Call enableVideo to enable the video module.
+   *  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.
+   *
+   * @returns
+   * 0: Success.
+   *  < 0: Failure.
+   */
+  abstract startPreviewWithoutSourceType(): number;
+
   /**
    * Gets the IAudioDeviceManager object to manage audio devices.
    *
@@ -6656,6 +6694,11 @@ export abstract class IRtcEngine {
    */
   abstract getLocalSpatialAudioEngine(): ILocalSpatialAudioEngine;
 
+  /**
+   * @ignore
+   */
+  abstract getH265Transcoder(): IH265Transcoder;
+
   /**
    * Sends media metadata.
    *
@@ -6754,7 +6797,7 @@ export enum QualityReportFormatType {
  */
 export enum MediaDeviceStateType {
   /**
-   * @ignore
+   * 0: The device is ready for use.
    */
   MediaDeviceStateIdle = 0,
   /**