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

package/types/Private/IAgoraRtcEngine.d.ts

@@ -1,5 +1,5 @@
 import './extension/IAgoraRtcEngineExtension';
-import { AudienceLatencyLevelType, AudioAinsMode, AudioEffectPreset, AudioEncodedFrameObserverConfig, AudioProfileType, AudioRecordingConfiguration, AudioSampleRateType, AudioScenarioType, AudioSessionOperationRestriction, AudioVolumeInfo, BeautyOptions, CaptureBrightnessLevelType, ChannelMediaRelayConfiguration, ChannelMediaRelayError, ChannelMediaRelayState, ChannelProfileType, ClientRoleChangeFailedReason, ClientRoleOptions, ClientRoleType, CodecCapInfo, ColorEnhanceOptions, ConnectionChangedReasonType, ConnectionStateType, DataStreamConfig, DeviceInfo, DownlinkNetworkInfo, EarMonitoringFilterType, EchoTestConfiguration, EncryptionConfig, EncryptionErrorType, ErrorCodeType, HeadphoneEqualizerPreset, IAudioEncodedFrameObserver, LastmileProbeConfig, LastmileProbeResult, LicenseErrorType, LiveTranscoding, LocalAccessPointConfiguration, LocalAudioStats, LocalAudioStreamReason, LocalAudioStreamState, LocalTranscoderConfiguration, LocalVideoStreamReason, LocalVideoStreamState, LowlightEnhanceOptions, MediaTraceEvent, NetworkType, PermissionType, QualityAdaptIndication, QualityType, RecorderStreamInfo, Rectangle, RemoteAudioState, RemoteAudioStateReason, RemoteVideoState, RemoteVideoStateReason, RtcStats, RtmpStreamPublishReason, RtmpStreamPublishState, RtmpStreamingEvent, ScreenCaptureParameters, ScreenCaptureParameters2, ScreenScenarioType, SegmentationProperty, SenderOptions, SimulcastStreamConfig, SimulcastStreamMode, SpatialAudioParams, StreamPublishState, StreamSubscribeState, ThreadPriorityType, TranscodingVideoStream, UplinkNetworkInfo, UploadErrorReason, UserInfo, UserOfflineReasonType, VideoApplicationScenarioType, VideoCanvas, VideoCodecType, VideoContentHint, VideoDenoiserOptions, VideoEncoderConfiguration, VideoFormat, VideoLayout, VideoMirrorModeType, VideoOrientation, VideoQoePreferenceType, VideoRenderingTracingInfo, VideoStreamType, VideoSubscriptionOptions, VideoTranscoderError, VirtualBackgroundSource, VoiceBeautifierPreset, VoiceConversionPreset, WatermarkOptions, WlAccStats, WlaccMessageReason, WlaccSuggestAction } from './AgoraBase';
+import { AudienceLatencyLevelType, AudioAinsMode, AudioEffectPreset, AudioEncodedFrameObserverConfig, AudioProfileType, AudioRecordingConfiguration, AudioSampleRateType, AudioScenarioType, AudioSessionOperationRestriction, AudioVolumeInfo, BeautyOptions, CameraFocalLengthType, CameraStabilizationMode, CaptureBrightnessLevelType, ChannelMediaRelayConfiguration, ChannelMediaRelayError, ChannelMediaRelayState, ChannelProfileType, ClientRoleChangeFailedReason, ClientRoleOptions, ClientRoleType, CodecCapInfo, ColorEnhanceOptions, ConnectionChangedReasonType, ConnectionStateType, DataStreamConfig, DeviceInfo, DownlinkNetworkInfo, EarMonitoringFilterType, EchoTestConfiguration, EncryptionConfig, EncryptionErrorType, ErrorCodeType, FocalLengthInfo, HeadphoneEqualizerPreset, IAudioEncodedFrameObserver, LastmileProbeConfig, LastmileProbeResult, LicenseErrorType, LiveTranscoding, LocalAccessPointConfiguration, LocalAudioStats, LocalAudioStreamReason, LocalAudioStreamState, LocalTranscoderConfiguration, LocalVideoStreamReason, LocalVideoStreamState, LowlightEnhanceOptions, MediaTraceEvent, NetworkType, PermissionType, QualityAdaptIndication, QualityType, RecorderStreamInfo, Rectangle, RemoteAudioState, RemoteAudioStateReason, RemoteVideoState, RemoteVideoStateReason, RtcStats, RtmpStreamPublishReason, RtmpStreamPublishState, RtmpStreamingEvent, ScreenCaptureParameters, ScreenCaptureParameters2, ScreenScenarioType, SegmentationProperty, SenderOptions, SimulcastStreamConfig, SimulcastStreamMode, SpatialAudioParams, StreamPublishState, StreamSubscribeState, ThreadPriorityType, TranscodingVideoStream, UplinkNetworkInfo, UploadErrorReason, UserInfo, UserOfflineReasonType, VideoApplicationScenarioType, VideoCanvas, VideoCodecType, VideoContentHint, VideoDenoiserOptions, VideoEncoderConfiguration, VideoFormat, VideoLayout, VideoMirrorModeType, VideoOrientation, VideoQoePreferenceType, VideoRenderingTracingInfo, VideoStreamType, VideoSubscriptionOptions, VideoTranscoderError, VirtualBackgroundSource, VoiceBeautifierPreset, VoiceConversionPreset, WatermarkOptions, WlAccStats, WlaccMessageReason, WlaccSuggestAction } from './AgoraBase';
 import { ContentInspectConfig, ContentInspectResult, IAudioSpectrumObserver, MediaSourceType, RawAudioFrameOpModeType, RenderModeType, VideoSourceType } from './AgoraMediaBase';
 import { IH265Transcoder } from './IAgoraH265Transcoder';
 import { LogConfig, LogFilterType, LogLevel } from './IAgoraLog';
@@ -426,6 +426,10 @@ export declare class RemoteAudioStats {
      * @ignore
      */
     rxAudioBytes?: number;
+    /**
+     * End-to-end audio delay (in milliseconds), which refers to the time from when the audio is captured by the remote user to when it is played by the local user.
+     */
+    e2eDelay?: number;
 }
 /**
  * Statistics of the remote video stream.
@@ -688,11 +692,11 @@ export declare class PublisherConfiguration {
  */
 export declare enum CameraDirection {
     /**
-     * The rear camera.
+     * 0: The rear camera.
      */
     CameraRear = 0,
     /**
-     * The front camera.
+     * 1: (Default) The front camera.
      */
     CameraFront = 1
 }
@@ -722,17 +726,25 @@ export declare class CameraCapturerConfiguration {
      */
     cameraDirection?: CameraDirection;
     /**
-     * This method applies to Windows only. The ID of the camera. The maximum length is MaxDeviceIdLengthType.
+     * @ignore
+     */
+    cameraFocalLengthType?: CameraFocalLengthType;
+    /**
+     * The camera ID. The maximum length is MaxDeviceIdLengthType.
      */
     deviceId?: string;
     /**
-     * The format of the video frame. See VideoFormat.
+     * @ignore
      */
-    format?: VideoFormat;
+    cameraId?: string;
     /**
-     * Whether to follow the video aspect ratio set in setVideoEncoderConfiguration : true : (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in onCaptureVideoFrame and onPreEncodeVideoFrame. false : Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
+     * (Optional) Whether to follow the video aspect ratio set in setVideoEncoderConfiguration : true : (Default) Follow the set video aspect ratio. The SDK crops the captured video according to the set video aspect ratio and synchronously changes the local preview screen and the video frame in onCaptureVideoFrame and onPreEncodeVideoFrame. false : Do not follow the system default audio playback device. The SDK does not change the aspect ratio of the captured video frame.
      */
     followEncodeDimensionRatio?: boolean;
+    /**
+     * (Optional) The format of the video frame. See VideoFormat.
+     */
+    format?: VideoFormat;
 }
 /**
  * The configuration of the captured screen.
@@ -981,6 +993,10 @@ export declare class ChannelMediaOptions {
      * @ignore
      */
     publishMixedAudioTrack?: boolean;
+    /**
+     * @ignore
+     */
+    publishLipSyncTrack?: 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.
      */
@@ -1014,7 +1030,7 @@ export declare class ChannelMediaOptions {
      */
     channelProfile?: ChannelProfileType;
     /**
-     * @ignore
+     * Delay (in milliseconds) for sending audio frames. You can use this parameter to set the delay of the audio frames that need to be sent, to ensure audio and video synchronization. To switch off the delay, set the value to 0.
      */
     audioDelayMs?: number;
     /**
@@ -1037,7 +1053,7 @@ export declare class ChannelMediaOptions {
     publishRhythmPlayerTrack?: boolean;
     /**
      * Whether to enable interactive mode: true : Enable interactive mode. Once this mode is enabled and the user role is set as audience, the user can receive remote video streams with low latency. false :Do not enable interactive mode. If this mode is disabled, the user receives the remote video streams in default settings.
-     *  This parameter only applies to scenarios involving cohosting across channels. The cohosts need to call the joinChannelEx method to join the other host's channel as an audience member, and set isInteractiveAudience to true.
+     *  This parameter only applies to co-streaming scenarios. The cohosts need to call the joinChannelEx method to join the other host's channel as an audience member, and set isInteractiveAudience to true.
      *  This parameter takes effect only when the user role is ClientRoleAudience.
      */
     isInteractiveAudience?: boolean;
@@ -1348,9 +1364,7 @@ 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 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 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.
+     * When the status of the local video changes, the SDK triggers this callback to report the current local video state and the reason for the state change.
      *
      * @param source The type of the video source. See VideoSourceType.
      * @param state The state of the local video, see LocalVideoStreamState.
@@ -1442,11 +1456,11 @@ export interface IRtcEngineEventHandler {
     /**
      * Occurs when a specific remote user enables/disables the local video capturing function.
      *
-     * The SDK triggers this callback when the remote user resumes or stops capturing the video stream by calling the enableLocalVideo method.
+     * Deprecated: This callback is deprecated, use the following enumerations in the onRemoteVideoStateChanged callback: RemoteVideoStateStopped (0) and RemoteVideoStateReasonRemoteMuted (5). RemoteVideoStateDecoding (2) and RemoteVideoStateReasonRemoteUnmuted (6). The SDK triggers this callback when the remote user resumes or stops capturing the video stream by calling the enableLocalVideo method.
      *
      * @param connection The connection information. See RtcConnection.
      * @param remoteUid The user ID of the remote user.
-     * @param enabled Whether the specified remote user enables/disables the local video capturing function: true : The video module is enabled. Other users in the channel can see the video of this remote user. false : The video module is disabled. Other users in the channel can no longer receive the video stream from this remote user, while this remote user can still receive the video streams from other users.
+     * @param enabled Whether the specified remote user enables/disables local video capturing: true : The video module is enabled. Other users in the channel can see the video of this remote user. false : The video module is disabled. Other users in the channel can no longer receive the video stream from this remote user, while this remote user can still receive the video streams from other users.
      */
     onUserEnableLocalVideo?(connection: RtcConnection, remoteUid: number, enabled: boolean): void;
     /**
@@ -1569,7 +1583,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 ErrorCodeType The error code.
+     * @param code The error code. See ErrorCodeType.
      * @param missed The number of lost messages.
      * @param cached Number of incoming cached messages when the data stream is interrupted.
      */
@@ -1940,6 +1954,10 @@ export interface IRtcEngineEventHandler {
      * @ignore
      */
     onTranscodedStreamLayoutInfo?(connection: RtcConnection, uid: number, width: number, height: number, layoutCount: number, layoutlist: VideoLayout[]): void;
+    /**
+     * @ignore
+     */
+    onAudioMetadataReceived?(connection: RtcConnection, uid: number, metadata: string, length: number): void;
     /**
      * The event callback of the extension.
      *
@@ -1954,7 +1972,7 @@ export interface IRtcEngineEventHandler {
     /**
      * Occurs when the extension is enabled.
      *
-     * After a successful call of enableExtension (true), the extension triggers this callback.
+     * The extension triggers this callback after it is successfully enabled.
      *
      * @param provider The name of the extension provider.
      * @param extension The name of the extension.
@@ -1963,7 +1981,7 @@ export interface IRtcEngineEventHandler {
     /**
      * Occurs when the extension is disabled.
      *
-     * After a successful call of enableExtension (false), this callback is triggered.
+     * The extension triggers this callback after it is successfully destroyed.
      *
      * @param provider The name of the extension provider.
      * @param extension The name of the extension.
@@ -1972,7 +1990,7 @@ export interface IRtcEngineEventHandler {
     /**
      * Occurs when the extension runs incorrectly.
      *
-     * When calling enableExtension (true) fails or the extension runs in error, the extension triggers this callback and reports the error code and reason.
+     * In case of extension enabling failure or runtime errors, the extension triggers this callback and reports the error code along with the reasons.
      *
      * @param provider The name of the extension provider.
      * @param extension The name of the extension.
@@ -2418,38 +2436,7 @@ export declare abstract class IRtcEngine {
      */
     abstract preloadChannel(token: string, channelId: string, uid: number): number;
     /**
-     * Preloads a channel with token, channelId, and userAccount.
-     *
-     * When audience members need to switch between different channels frequently, calling the method can help shortening the time of joining a channel, thus reducing the time it takes for audience members to hear and see the host. As it may take a while for the SDK to preload a channel, Agora recommends that you call this method as soon as possible after obtaining the channel name and user ID to join a channel. If you join a preloaded channel, leave it and want to rejoin the same channel, you do not need to call this method unless the token for preloading the channel expires.
-     *  Failing to preload a channel does not mean that you can't join a channel, nor will it increase the time of joining a channel.
-     *  One IRtcEngine instance supports preloading 20 channels at most. When exceeding this limit, the latest 20 preloaded channels take effect.
-     *  When calling this method, ensure you set the user role as audience and do not set the audio scenario as AudioScenarioChorus, otherwise, this method does not take effect.
-     *  You also need to make sure that the User Account, channel ID and token passed in for preloading are the same as the values passed in when joining the channel, otherwise, this method does not take effect.
-     *
-     * @param token The token generated on your server for authentication. When the token for preloading channels expires, you can update the token based on the number of channels you preload.
-     *  When preloading one channel, calling this method to pass in the new token.
-     *  When preloading more than one channels:
-     *  If you use a wildcard token for all preloaded channels, call updatePreloadChannelToken to update the token. When generating a wildcard token, ensure the user ID is not set as 0.
-     *  If you use different tokens to preload different channels, call this method to pass in your user ID, channel name and the new token.
-     * @param channelId The channel name that you want to preload. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
-     *  All lowercase English letters: a to z.
-     *  All uppercase English letters: A to Z.
-     *  All numeric characters: 0 to 9.
-     *  Space
-     *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
-     * @param userAccount The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as null. Supported characters are (89 in total):
-     *  The 26 lowercase English letters: a to z.
-     *  The 26 uppercase English letters: A to Z.
-     *  All numeric characters: 0 to 9.
-     *  Space
-     *  "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
-     *
-     * @returns
-     * 0: Success.
-     *  < 0: Failure.
-     *  -2: The parameter is invalid. For example, the User Account is empty. You need to pass in a valid parameter and join the channel again.
-     *  -7: The IRtcEngine object has not been initialized. You need to initialize the IRtcEngine object before calling this method.
-     *  -102: The channel name is invalid. You need to pass in a valid channel name and join the channel again.
+     * @ignore
      */
     abstract preloadChannelWithUserAccount(token: string, channelId: string, userAccount: string): number;
     /**
@@ -2474,9 +2461,10 @@ export declare abstract class IRtcEngine {
      *  The remote client: onUserJoined, if the user joining the channel is in the Communication profile or is a host in the Live-broadcasting profile. When the connection between the client and Agora's server is interrupted due to poor network conditions, the SDK tries reconnecting to the server. When the local client successfully rejoins the channel, the SDK triggers the onRejoinChannelSuccess callback on the local client.
      *  This method allows users to join only one channel at a time.
      *  Ensure that the app ID you use to generate the token is the same app ID that you pass in the initialize method; otherwise, you may fail to join the channel by token.
+     *  If you choose the Testing Mode (using an App ID for authentication) for your project and call this method to join a channel, you will automatically exit the channel after 24 hours.
      *
      * @param token The token generated on your server for authentication. If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel.
-     * @param channelId The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters:
+     * @param channelId The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
      *  All lowercase English letters: a to z.
      *  All uppercase English letters: A to Z.
      *  All numeric characters: 0 to 9.
@@ -2605,10 +2593,7 @@ export declare abstract class IRtcEngine {
     /**
      * Enables the video module.
      *
-     * Call this method either before joining a channel or during a call. If this method is called before joining a channel, the call starts in the video mode; if called during a call, the audio call switches to a video call. Call disableVideo to disable the video mode. A successful call of this method triggers the onRemoteVideoStateChanged callback on the remote client.
-     *  This method enables the internal engine and is valid after leaving the channel.
-     *  Calling this method will reset the entire engine, resulting in a slow response time. Instead of callling this method, you can independently control a specific video module based on your actual needs using the following methods: enableLocalVideo : Whether to enable the camera to create the local video stream. muteLocalVideoStream : Whether to publish the local video stream. muteRemoteVideoStream : Whether to subscribe to and play the remote video stream. muteAllRemoteVideoStreams : Whether to subscribe to and play all remote video streams.
-     *  A successful call of this method resets enableLocalVideo, muteRemoteVideoStream, and muteAllRemoteVideoStreams. Proceed it with caution.
+     * The video module is disabled by default, call this method to enable it. If you need to disable the video module later, you need to call disableVideo.
      *
      * @returns
      * 0: Success.
@@ -2694,15 +2679,13 @@ export declare abstract class IRtcEngine {
      * Sets the image enhancement options.
      *
      * Enables or disables image enhancement, and sets the options.
-     *  Call this method before calling enableVideo or startPreview.
+     *  Call this method after calling enableVideo or startPreview.
      *  This method relies on the image enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
      *  This feature has high requirements on device performance. When calling this method, the SDK automatically checks the capabilities of the current device.
      *
      * @param enabled Whether to enable the image enhancement function: true : Enable the image enhancement function. false : (Default) Disable the image enhancement function.
      * @param options The image enhancement options. See BeautyOptions.
-     * @param type Type of media source. See MediaSourceType. In this method, this parameter supports only the following two settings:
-     *  The default value is UnknownMediaSource.
-     *  If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.
+     * @param type Source type of the extension. See MediaSourceType.
      *
      * @returns
      * 0: Success.
@@ -2722,7 +2705,7 @@ export declare abstract class IRtcEngine {
      *  When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using setExtensionProperty.
      *  This method relies on the image enhancement dynamic library libagora_clear_vision_extension.dll. If the dynamic library is deleted, the function cannot be enabled normally.
      *
-     * @param enabled Whether to enable low-light enhancement function: true : Enable low-light enhancement function. false : (Default) Disable low-light enhancement function.
+     * @param enabled Whether to enable low-light enhancement: true : Enable low-light enhancement. false : (Default) Disable low-light enhancement.
      * @param options The low-light enhancement options. See LowlightEnhanceOptions.
      * @param type The type of the video source. See MediaSourceType.
      *
@@ -2774,7 +2757,7 @@ export declare abstract class IRtcEngine {
     /**
      * Enables/Disables the virtual background.
      *
-     * The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background. Call this method before calling enableVideo or startPreview.
+     * The virtual background feature enables the local user to replace their original background with a static image, dynamic video, blurred background, or portrait-background segmentation to achieve picture-in-picture effect. Once the virtual background feature is enabled, all users in the channel can see the custom background. Call this method after calling enableVideo or startPreview.
      *  This feature has high requirements on device performance. When calling this method, the SDK automatically checks the capabilities of the current device. Agora recommends you use virtual background on devices with the following processors:
      *  Devices with an i5 CPU and better
      *  Agora recommends that you use this feature in scenarios that meet the following conditions:
@@ -3013,7 +2996,7 @@ export declare abstract class IRtcEngine {
     /**
      * 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.
+     * The SDK will dynamically adjust the size of the corresponding video stream based on the size of the video window to save bandwidth and computing resources. The default aspect ratio of the low-quality video stream is the same as that of the high-quality video stream. According to the current aspect ratio of the high-quality video stream, the system will automatically allocate the resolution, frame rate, and bitrate of the low-quality video stream. The SDK defaults to enabling low-quality video stream adaptive mode (AutoSimulcastStream) on the sending end, which means the sender does not actively send low-quality video stream. The receiver with the role of the host can initiate a low-quality video stream request by calling this method, and upon receiving the request, the sending end automatically starts sending the low-quality video stream.
      *  Call this method before joining a channel. The SDK does not support changing the default subscribed video stream type after joining a channel.
      *  If you call both this method and setRemoteVideoStreamType, the setting of setRemoteVideoStreamType takes effect.
      *
@@ -3040,7 +3023,11 @@ export declare abstract class IRtcEngine {
     /**
      * Sets the video stream type to subscribe to.
      *
-     * 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.
+     * The SDK defaults to enabling low-quality video stream adaptive mode (AutoSimulcastStream) on the sending end, which means the sender does not actively send low-quality video stream. The receiver with the role of the host can initiate a low-quality video stream request by calling this method, and upon receiving the request, the sending end automatically starts sending the low-quality video stream. The SDK will dynamically adjust the size of the corresponding video stream based on the size of the video window to save bandwidth and computing resources. The default aspect ratio of the low-quality video stream is the same as that of the high-quality video stream. According to the current aspect ratio of the high-quality video stream, the system will automatically allocate the resolution, frame rate, and bitrate of the low-quality video stream.
+     *  You can call this method either before or after joining a channel.
+     *  If the publisher has already called setDualStreamMode and set mode to DisableSimulcastStream (never send low-quality video stream), calling this method will not take effect, you should call setDualStreamMode again on the sending end and adjust the settings.
+     *  Calling this method on the receiving end of the audience role will not take effect.
+     *  If you call both setRemoteVideoStreamType and setRemoteDefaultVideoStreamType, the settings in setRemoteVideoStreamType take effect.
      *
      * @param uid The user ID.
      * @param streamType The video stream type, see VideoStreamType.
@@ -3410,6 +3397,21 @@ export declare abstract class IRtcEngine {
      *  < 0: Failure.
      */
     abstract setAudioMixingPitch(pitch: number): number;
+    /**
+     * Sets the playback speed of the current audio file.
+     *
+     * Ensure you call this method after calling startAudioMixing receiving the onAudioMixingStateChanged callback reporting the state as AudioMixingStatePlaying.
+     *
+     * @param speed The playback speed. Agora recommends that you set this to a value between 50 and 400, defined as follows:
+     *  50: Half the original speed.
+     *  100: The original speed.
+     *  400: 4 times the original speed.
+     *
+     * @returns
+     * 0: Success.
+     *  < 0: Failure.
+     */
+    abstract setAudioMixingPlaybackSpeed(speed: number): number;
     /**
      * Retrieves the volume of the audio effects.
      *
@@ -3921,6 +3923,10 @@ export declare abstract class IRtcEngine {
      * @ignore
      */
     abstract uploadLogFile(): string;
+    /**
+     * @ignore
+     */
+    abstract writeLog(level: LogLevel, fmt: string): number;
     /**
      * Updates the display mode of the local video view.
      *
@@ -3986,7 +3992,7 @@ export declare abstract class IRtcEngine {
     /**
      * Sets dual-stream mode configuration on the sender side.
      *
-     * 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.
+     * 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 receiving end with the role of the host can initiate a low-quality video stream request by calling setRemoteVideoStreamType, and upon receiving the request, the sending end automatically starts sending low-quality stream.
      *  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 enableDualStreamMode and setting enabled to false.
@@ -4224,9 +4230,7 @@ export declare abstract class IRtcEngine {
      * @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.
+     * @param type Source type of the extension. See MediaSourceType.
      *
      * @returns
      * 0: Success.
@@ -4243,9 +4247,7 @@ export declare abstract class IRtcEngine {
      * @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.
+     * @param type Source type of the extension. See MediaSourceType.
      *
      * @returns
      * 0: Success.
@@ -4307,7 +4309,7 @@ export declare abstract class IRtcEngine {
      *  You can call this method either before or after joining a channel.
      *
      * @param enabled Enables or disables in-ear monitoring. true : Enables in-ear monitoring. false : (Default) Disables in-ear monitoring.
-     * @param includeAudioFilters The audio filter of in-ear monitoring: See EarMonitoringFilterType.
+     * @param includeAudioFilters The audio filter types of in-ear monitoring. See EarMonitoringFilterType.
      *
      * @returns
      * 0: Success.
@@ -4356,13 +4358,13 @@ export declare abstract class IRtcEngine {
     /**
      * Registers an extension.
      *
-     * After the extension is loaded, you can call this method to register the extension. This method applies to Windows only.
+     * After the extension is loaded, you can call this method to register the extension.
+     *  Before calling this method, you need to call loadExtensionProvider to load the extension first.
+     *  For extensions external to the SDK (such as those from Extensions Marketplace and SDK Extensions), you need to call this method before calling setExtensionProperty.
      *
      * @param provider The name of the extension provider.
      * @param extension The name of the extension.
-     * @param type Type of media source. See MediaSourceType. In this method, this parameter supports only the following two settings:
-     *  The default value is UnknownMediaSource.
-     *  If you want to use the second camera to capture video, set this parameter to SecondaryCameraSource.
+     * @param type Source type of the extension. See MediaSourceType.
      *
      * @returns
      * 0: Success.
@@ -4476,6 +4478,10 @@ export declare abstract class IRtcEngine {
      * @ignore
      */
     abstract setCameraAutoExposureFaceModeEnabled(enabled: boolean): number;
+    /**
+     * @ignore
+     */
+    abstract setCameraStabilizationMode(mode: CameraStabilizationMode): number;
     /**
      * @ignore
      */
@@ -4492,6 +4498,27 @@ export declare abstract class IRtcEngine {
      * @ignore
      */
     abstract setRouteInCommunicationMode(route: number): number;
+    /**
+     * Check if the camera supports portrait center stage.
+     *
+     * This method applies to macOS only. Before calling enableCameraCenterStage to enable portrait center stage, it is recommended to call this method to check if the current device supports the feature.
+     *
+     * @returns
+     * true : The current camera supports the portrait center stage. false : The current camera supports the portrait center stage.
+     */
+    abstract isCameraCenterStageSupported(): boolean;
+    /**
+     * Enables or disables portrait center stage.
+     *
+     * The portrait center stage feature is off by default. You need to call this method to turn it on. If you need to disable this feature, you need to call this method again and set enabled to false. This method applies to macOS only.
+     *
+     * @param enabled Whether to enable the portrait center stage: true : Enable portrait center stage. false : Disable portrait center stage.
+     *
+     * @returns
+     * 0: Success.
+     *  < 0: Failure.
+     */
+    abstract enableCameraCenterStage(enabled: boolean): number;
     /**
      * Gets a list of shareable screens and windows.
      *
@@ -4546,15 +4573,7 @@ export declare abstract class IRtcEngine {
      */
     abstract startScreenCaptureByScreenRect(screenRect: Rectangle, regionRect: Rectangle, captureParams: ScreenCaptureParameters): number;
     /**
-     * Gets the audio device information.
-     *
-     * After calling this method, you can get whether the audio device supports ultra-low-latency capture and playback.
-     *  You can call this method either before or after joining a channel.
-     *
-     * @returns
-     * The DeviceInfo object that identifies the audio device information.
-     *  Not null: Success.
-     *  Null: Failure.
+     * @ignore
      */
     abstract getAudioDeviceInfo(): DeviceInfo;
     /**
@@ -4630,6 +4649,13 @@ export declare abstract class IRtcEngine {
      * @ignore
      */
     abstract queryScreenCaptureCapability(): number;
+    /**
+     * @ignore
+     */
+    abstract queryCameraFocalLengthCapability(): {
+        focalLengthInfos: FocalLengthInfo[];
+        size: number;
+    };
     /**
      * Sets the screen sharing scenario.
      *
@@ -4655,7 +4681,7 @@ export declare abstract class IRtcEngine {
     /**
      * Retrieves the call ID.
      *
-     * When a user joins a channel on a client, a callId is generated to identify the call from the client. Some methods, such as rate and complain, must be called after the call ends to submit feedback to the SDK. These methods require the callId parameter. Call this method after joining a channel.
+     * When a user joins a channel on a client, a callId is generated to identify the call from the client. You can call this method to get the callId parameter, and pass it in when calling methods such as rate and complain. Call this method after joining a channel.
      *
      * @returns
      * The current call ID, if the method succeeds.
@@ -4749,12 +4775,6 @@ export declare abstract class IRtcEngine {
      * Starts the local video mixing.
      *
      * After calling this method, you can merge multiple video streams into one video stream locally. For example, you can merge the video streams captured by the camera, screen sharing, media player, remote video, video files, images, etc. into one video stream, and then publish the mixed video stream to the channel.
-     *  Local video mixing requires more CPU resources. Therefore, Agora recommends enabling this function on devices with higher performance.
-     *  If you need to mix locally captured video streams, the SDK supports the following capture combinations:
-     *  On the Windows platform, it supports up to 4 video streams captured by cameras + 4 screen sharing streams.
-     *  On the macOS platform, it supports up to 4 video streams captured by cameras + 1 screen sharing stream.
-     *  If you need to mix the locally collected video streams, you need to call this method after startCameraCapture or startScreenCaptureBySourceType.
-     *  If you want to publish the mixed video stream to the channel, you need to set publishTranscodedVideoTrack in ChannelMediaOptions to true when calling joinChannel or updateChannelMediaOptions.
      *
      * @param config Configuration of the local video mixing, see LocalTranscoderConfiguration.
      *  The maximum resolution of each video stream participating in the local video mixing is 4096 × 2160. If this limit is exceeded, video mixing does not take effect.
@@ -4865,11 +4885,11 @@ export declare abstract class IRtcEngine {
      */
     abstract registerEventHandler(eventHandler: IRtcEngineEventHandler): boolean;
     /**
-     * Removes the specified callback handler.
+     * Removes the specified callback events.
      *
-     * This method removes the specified callback handler. For callback events that you want to listen for only once, call this method to remove the relevant callback handler after you have received them.
+     * You can call this method too remove all added callback events.
      *
-     * @param eventHandler The callback handler to be deleted. See IRtcEngineEventHandler.
+     * @param eventHandler Callback events to be removed. See IRtcEngineEventHandler.
      *
      * @returns
      * true : Success. false : Failure.
@@ -4917,7 +4937,7 @@ export declare abstract class IRtcEngine {
      *
      * In scenarios requiring high security, Agora recommends calling this method to enable the built-in encryption before joining a channel. All users in the same channel must use the same encryption mode and encryption key. After the user leaves the channel, the SDK automatically disables the built-in encryption. To enable the built-in encryption, call this method before the user joins the channel again. If you enable the built-in encryption, you cannot use the Media Push function.
      *
-     * @param enabled Whether to enable built-in encryption: true : Enable the built-in encryption. false : Disable the built-in encryption.
+     * @param enabled Whether to enable built-in encryption: true : Enable the built-in encryption. false : (Default) Disable the built-in encryption.
      * @param config Built-in encryption configurations. See EncryptionConfig.
      *
      * @returns
@@ -5092,18 +5112,19 @@ export declare abstract class IRtcEngine {
     /**
      * Joins the channel with a user account, and configures whether to automatically subscribe to audio or video streams after joining the channel.
      *
-     * This method allows a user to join the channel with the user account. After the user successfully joins the channel, the SDK triggers the following callbacks:
+     * To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type.
+     *  If you choose the Testing Mode (using an App ID for authentication) for your project and call this method to join a channel, you will automatically exit the channel after 24 hours. This method allows a user to join the channel with the user account. After the user successfully joins the channel, the SDK triggers the following callbacks:
      *  The local client: onLocalUserRegistered, onJoinChannelSuccess and onConnectionStateChanged callbacks.
-     *  The remote client: The onUserJoined callback, if the user is in the COMMUNICATION profile, and the onUserInfoUpdated callback if the user is a host in the LIVE_BROADCASTING profile. Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods. 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.
+     *  The remote client: The onUserJoined callback, if the user is in the COMMUNICATION profile, and the onUserInfoUpdated callback if the user is a host in the LIVE_BROADCASTING profile. Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.
      *
      * @param token The token generated on your server for authentication. If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel.
-     * @param channelId The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters:
+     * @param channelId The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
      *  All lowercase English letters: a to z.
      *  All uppercase English letters: A to Z.
      *  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 as follows(89 in total):
      *  The 26 lowercase English letters: a to z.
      *  The 26 uppercase English letters: A to Z.
      *  All numeric characters: 0 to 9.
@@ -5131,13 +5152,13 @@ export declare abstract class IRtcEngine {
      *  The remote client: The onUserJoined callback, if the user is in the COMMUNICATION profile, and the onUserInfoUpdated callback if the user is a host in the LIVE_BROADCASTING profile. Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods. To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type.
      *
      * @param token The token generated on your server for authentication. If you need to join different channels at the same time or switch between channels, Agora recommends using a wildcard token so that you don't need to apply for a new token every time joining a channel.
-     * @param channelId The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters:
+     * @param channelId The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
      *  All lowercase English letters: a to z.
      *  All uppercase English letters: A to Z.
      *  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 as follows(89 in total):
      *  The 26 lowercase English letters: a to z.
      *  The 26 uppercase English letters: A to Z.
      *  All numeric characters: 0 to 9.
@@ -5477,6 +5498,10 @@ export declare abstract class IRtcEngine {
      * true : The current device supports the specified feature. false : The current device does not support the specified feature.
      */
     abstract isFeatureAvailableOnDevice(type: FeatureType): boolean;
+    /**
+     * @ignore
+     */
+    abstract sendAudioMetadata(metadata: string, length: number): number;
     /**
      * Starts screen capture.
      *
@@ -5608,7 +5633,7 @@ export declare abstract class IRtcEngine {
      * Destroys multiple video renderer objects at one time.
      *
      * @param sourceType The type of the video source. See VideoSourceType.
-     * @param channelId The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters:
+     * @param channelId The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters (89 characters in total):
      *  All lowercase English letters: a to z.
      *  All uppercase English letters: A to Z.
      *  All numeric characters: 0 to 9.
@@ -5991,13 +6016,17 @@ export declare class VideoDeviceInfo {
     deviceName?: string;
 }
 /**
- * The AudioDeviceInfo class that contains the ID and device name of the audio devices.
+ * The AudioDeviceInfo class that contains the ID, name and type of the audio devices.
  */
 export declare class AudioDeviceInfo {
     /**
      * The device ID.
      */
     deviceId?: string;
+    /**
+     * Output parameter; indicates the type of audio devices, such as built-in, USB and HDMI.
+     */
+    deviceTypeName?: string;
     /**
      * The device name.
      */