agora-electron-sdk 4.2.6 → 4.3.0

package/types/Private/AgoraBase.d.ts

@@ -1,5 +1,5 @@
 import './extension/AgoraBaseExtension';
-import { RenderModeType, VideoSourceType } from './AgoraMediaBase';
+import { RenderModeType, VideoModulePosition, VideoSourceType } from './AgoraMediaBase';
 /**
  * The channel profile.
  */
@@ -434,11 +434,7 @@ export declare enum ErrorCodeType {
     /**
      * 1501: Permission to access the camera is not granted. Check whether permission to access the camera permission is granted.
      */
-    ErrVdmCameraNotAuthorized = 1501,
-    /**
-     * @ignore
-     */
-    ErrAdmApplicationLoopback = 2007
+    ErrVdmCameraNotAuthorized = 1501
 }
 /**
  * @ignore
@@ -551,10 +547,6 @@ export declare enum InterfaceIdType {
      * @ignore
      */
     AgoraIidMediaEngineRegulator = 9,
-    /**
-     * @ignore
-     */
-    AgoraIidCloudSpatialAudio = 10,
     /**
      * @ignore
      */
@@ -566,7 +558,7 @@ export declare enum InterfaceIdType {
     /**
      * @ignore
      */
-    AgoraIidMetachatService = 14,
+    AgoraIidMetaService = 14,
     /**
      * @ignore
      */
@@ -835,7 +827,7 @@ export declare enum VideoCodecCapabilityLevel {
  */
 export declare enum VideoCodecType {
     /**
-     * @ignore
+     * 0: (Default) Unspecified codec format. The SDK automatically matches the appropriate codec format based on the current video stream's resolution and device performance.
      */
     VideoCodecNone = 0,
     /**
@@ -843,7 +835,7 @@ export declare enum VideoCodecType {
      */
     VideoCodecVp8 = 1,
     /**
-     * 2: (Default) Standard H.264.
+     * 2: Standard H.264.
      */
     VideoCodecH264 = 2,
     /**
@@ -1110,10 +1102,23 @@ export declare class VideoSubscriptionOptions {
      */
     encodedFrameOnly?: boolean;
 }
+/**
+ * The maximum length of the user account.
+ */
+export declare enum MaxUserAccountLengthType {
+    /**
+     * The maximum length of the user account is 256 bytes.
+     */
+    MaxUserAccountLength = 256
+}
 /**
  * Information about externally encoded video frames.
  */
 export declare class EncodedVideoFrameInfo {
+    /**
+     * The user ID to push the externally encoded video frame.
+     */
+    uid?: number;
     /**
      * The codec type of the local video stream. See VideoCodecType. The default value is VideoCodecH264 (2).
      */
@@ -1150,10 +1155,6 @@ export declare class EncodedVideoFrameInfo {
      * @ignore
      */
     decodeTimeMs?: number;
-    /**
-     * The user ID to push the externally encoded video frame.
-     */
-    uid?: number;
     /**
      * The type of video streams. See VideoStreamType.
      */
@@ -1293,7 +1294,7 @@ export declare class VideoEncoderConfiguration {
      */
     frameRate?: number;
     /**
-     * The encoding bitrate (Kbps) of the video.
+     * The encoding bitrate (Kbps) of the video. This parameter does not need to be set; keeping the default value STANDARD_BITRATE is sufficient. The SDK automatically matches the most suitable bitrate based on the video resolution and frame rate you have set. For the correspondence between video resolution, frame rate, and bitrate, please refer to. STANDARD_BITRATE (0): (Recommended) Standard bitrate mode. COMPATIBLE_BITRATE (-1): Adaptive bitrate mode. In general, Agora suggests that you do not use this value.
      */
     bitrate?: number;
     /**
@@ -1337,7 +1338,7 @@ export declare class DataStreamConfig {
  */
 export declare enum SimulcastStreamMode {
     /**
-     * -1: By default, the low-quality video steam is not sent; the SDK automatically switches to low-quality video stream mode after it receives a request to subscribe to a low-quality video stream.
+     * -1: By default, do not send the low-quality video stream until a subscription request for the low-quality video stream is received from the receiving end, then automatically start sending low-quality video stream.
      */
     AutoSimulcastStream = -1,
     /**
@@ -1413,7 +1414,7 @@ export declare class WatermarkRatio {
  */
 export declare class WatermarkOptions {
     /**
-     * Reserved for future use.
+     * Is the watermark visible in the local preview view? true : (Default) The watermark is visible in the local preview view. false : The watermark is not visible in the local preview view.
      */
     visibleInPreview?: boolean;
     /**
@@ -1466,11 +1467,11 @@ export declare class RtcStats {
      */
     rxVideoBytes?: number;
     /**
-     * Video transmission bitrate (Kbps), represented by an instantaneous value.
+     * The actual bitrate (Kbps) while sending the local video stream.
      */
     txKBitRate?: number;
     /**
-     * The receiving bitrate (Kbps), represented by an instantaneous value.
+     * The receiving bitrate (Kbps).
      */
     rxKBitRate?: number;
     /**
@@ -1829,6 +1830,27 @@ export declare enum VideoApplicationScenarioType {
      */
     ApplicationScenarioMeeting = 1
 }
+/**
+ * @ignore
+ */
+export declare enum VideoQoePreferenceType {
+    /**
+     * @ignore
+     */
+    VideoQoePreferenceBalance = 1,
+    /**
+     * @ignore
+     */
+    VideoQoePreferenceDelayFirst = 2,
+    /**
+     * @ignore
+     */
+    VideoQoePreferencePictureQualityFirst = 3,
+    /**
+     * @ignore
+     */
+    VideoQoePreferenceFluencyFirst = 4
+}
 /**
  * The brightness level of the video image captured by the local camera.
  */
@@ -1872,53 +1894,53 @@ export declare enum LocalAudioStreamState {
     LocalAudioStreamStateFailed = 3
 }
 /**
- * Local audio state error codes.
+ * Reasons for local audio state changes.
  */
-export declare enum LocalAudioStreamError {
+export declare enum LocalAudioStreamReason {
     /**
      * 0: The local audio is normal.
      */
-    LocalAudioStreamErrorOk = 0,
+    LocalAudioStreamReasonOk = 0,
     /**
      * 1: No specified reason for the local audio failure. Remind your users to try to rejoin the channel.
      */
-    LocalAudioStreamErrorFailure = 1,
+    LocalAudioStreamReasonFailure = 1,
     /**
      * 2: No permission to use the local audio capturing device. Remind your users to grant permission. Deprecated: This enumerator is deprecated. Please use RecordAudio in the onPermissionError callback instead.
      */
-    LocalAudioStreamErrorDeviceNoPermission = 2,
+    LocalAudioStreamReasonDeviceNoPermission = 2,
     /**
      * @ignore
      */
-    LocalAudioStreamErrorDeviceBusy = 3,
+    LocalAudioStreamReasonDeviceBusy = 3,
     /**
      * 4: The local audio capture fails.
      */
-    LocalAudioStreamErrorRecordFailure = 4,
+    LocalAudioStreamReasonRecordFailure = 4,
     /**
      * 5: The local audio encoding fails.
      */
-    LocalAudioStreamErrorEncodeFailure = 5,
+    LocalAudioStreamReasonEncodeFailure = 5,
     /**
-     * 6: (Windows only) The application cannot find the local audio capture device. Remind your users to check whether the microphone is connected to the device properly in the control plane of the device or if the microphone is working properly.
+     * 6: No local audio capture device. Remind your users to check whether the microphone is connected to the device properly in the control plane of the device or if the microphone is working properly.
      */
-    LocalAudioStreamErrorNoRecordingDevice = 6,
+    LocalAudioStreamReasonNoRecordingDevice = 6,
     /**
-     * 7: (Windows only) The application cannot find the local audio playback device. Remind your users to check whether the speaker is connected to the device properly in the control plane of the device or if the speaker is working properly.
+     * 7: No local audio capture device. Remind your users to check whether the speaker is connected to the device properly in the control plane of the device or if the speaker is working properly.
      */
-    LocalAudioStreamErrorNoPlayoutDevice = 7,
+    LocalAudioStreamReasonNoPlayoutDevice = 7,
     /**
      * @ignore
      */
-    LocalAudioStreamErrorInterrupted = 8,
+    LocalAudioStreamReasonInterrupted = 8,
     /**
      * 9: (Windows only) The ID of the local audio-capture device is invalid. Check the audio capture device ID.
      */
-    LocalAudioStreamErrorRecordInvalidId = 9,
+    LocalAudioStreamReasonRecordInvalidId = 9,
     /**
      * 10: (Windows only) The ID of the local audio-playback device is invalid. Check the audio playback device ID.
      */
-    LocalAudioStreamErrorPlayoutInvalidId = 10
+    LocalAudioStreamReasonPlayoutInvalidId = 10
 }
 /**
  * Local video state types.
@@ -1942,104 +1964,108 @@ export declare enum LocalVideoStreamState {
     LocalVideoStreamStateFailed = 3
 }
 /**
- * Local video state error codes.
+ * Reasons for local video state changes.
  */
-export declare enum LocalVideoStreamError {
+export declare enum LocalVideoStreamReason {
     /**
      * 0: The local video is normal.
      */
-    LocalVideoStreamErrorOk = 0,
+    LocalVideoStreamReasonOk = 0,
     /**
      * 1: No specified reason for the local video failure.
      */
-    LocalVideoStreamErrorFailure = 1,
+    LocalVideoStreamReasonFailure = 1,
     /**
      * 2: No permission to use the local video capturing device. Remind the user to grant permissions and rejoin the channel. Deprecated: This enumerator is deprecated. Please use CAMERA in the onPermissionError callback instead.
      */
-    LocalVideoStreamErrorDeviceNoPermission = 2,
+    LocalVideoStreamReasonDeviceNoPermission = 2,
     /**
      * 3: The local video capturing device is in use. Remind the user to check whether another application occupies the camera.
      */
-    LocalVideoStreamErrorDeviceBusy = 3,
+    LocalVideoStreamReasonDeviceBusy = 3,
     /**
      * 4: The local video capture fails. Remind your user to check whether the video capture device is working properly, whether the camera is occupied by another application, or try to rejoin the channel.
      */
-    LocalVideoStreamErrorCaptureFailure = 4,
+    LocalVideoStreamReasonCaptureFailure = 4,
     /**
      * 5: The local video encoding fails.
      */
-    LocalVideoStreamErrorEncodeFailure = 5,
+    LocalVideoStreamReasonCodecNotSupport = 5,
     /**
      * @ignore
      */
-    LocalVideoStreamErrorCaptureInbackground = 6,
+    LocalVideoStreamReasonCaptureInbackground = 6,
     /**
      * @ignore
      */
-    LocalVideoStreamErrorCaptureMultipleForegroundApps = 7,
+    LocalVideoStreamReasonCaptureMultipleForegroundApps = 7,
     /**
      * 8: Fails to find a local video capture device. Remind the user to check whether the camera is connected to the device properly or the camera is working properly, and then to rejoin the channel.
      */
-    LocalVideoStreamErrorDeviceNotFound = 8,
+    LocalVideoStreamReasonDeviceNotFound = 8,
     /**
      * 9: (macOS only) The video capture device currently in use is disconnected (such as being unplugged).
      */
-    LocalVideoStreamErrorDeviceDisconnected = 9,
+    LocalVideoStreamReasonDeviceDisconnected = 9,
     /**
      * 10: (macOS and Windows only) The SDK cannot find the video device in the video device list. Check whether the ID of the video device is valid.
      */
-    LocalVideoStreamErrorDeviceInvalidId = 10,
+    LocalVideoStreamReasonDeviceInvalidId = 10,
     /**
      * 101: The current video capture device is unavailable due to excessive system pressure.
      */
-    LocalVideoStreamErrorDeviceSystemPressure = 101,
+    LocalVideoStreamReasonDeviceSystemPressure = 101,
     /**
-     * 11: (macOS only) The shared window is minimized when you call startScreenCaptureByWindowId to share a window. The SDK cannot share a minimized window. You can cancel the minimization of this window at the application layer, for example by maximizing this window.
+     * 11: (macOS and Windows only) The shared windows is minimized when you call the startScreenCaptureByWindowId method to share a window. The SDK cannot share a minimized window. You can cancel the minimization of this window at the application layer, for example by maximizing this window.
      */
-    LocalVideoStreamErrorScreenCaptureWindowMinimized = 11,
+    LocalVideoStreamReasonScreenCaptureWindowMinimized = 11,
     /**
      * 12: (macOS and Windows only) The error code indicates that a window shared by the window ID has been closed or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing. Common scenarios reporting this error code:
      *  When the local user closes the shared window, the SDK reports this error code.
      *  The local user shows some slides in full-screen mode first, and then shares the windows of the slides. After the user exits full-screen mode, the SDK reports this error code.
      *  The local user watches a web video or reads a web document in full-screen mode first, and then shares the window of the web video or document. After the user exits full-screen mode, the SDK reports this error code.
      */
-    LocalVideoStreamErrorScreenCaptureWindowClosed = 12,
+    LocalVideoStreamReasonScreenCaptureWindowClosed = 12,
     /**
      * 13: (Windows only) The window being shared is overlapped by another window, so the overlapped area is blacked out by the SDK during window sharing.
      */
-    LocalVideoStreamErrorScreenCaptureWindowOccluded = 13,
+    LocalVideoStreamReasonScreenCaptureWindowOccluded = 13,
+    /**
+     * @ignore
+     */
+    LocalVideoStreamReasonScreenCaptureWindowNotSupported = 20,
     /**
      * @ignore
      */
-    LocalVideoStreamErrorScreenCaptureWindowNotSupported = 20,
+    LocalVideoStreamReasonScreenCaptureFailure = 21,
     /**
      * @ignore
      */
-    LocalVideoStreamErrorScreenCaptureFailure = 21,
+    LocalVideoStreamReasonScreenCaptureNoPermission = 22,
     /**
      * @ignore
      */
-    LocalVideoStreamErrorScreenCaptureNoPermission = 22,
+    LocalVideoStreamReasonScreenCaptureAutoFallback = 24,
     /**
      * @ignore
      */
-    LocalVideoStreamErrorScreenCapturePaused = 23,
+    LocalVideoStreamReasonScreenCaptureWindowHidden = 25,
     /**
      * @ignore
      */
-    LocalVideoStreamErrorScreenCaptureResumed = 24,
+    LocalVideoStreamReasonScreenCaptureWindowRecoverFromHidden = 26,
     /**
      * @ignore
      */
-    LocalVideoStreamErrorScreenCaptureWindowHidden = 25,
+    LocalVideoStreamReasonScreenCaptureWindowRecoverFromMinimized = 27,
     /**
      * @ignore
      */
-    LocalVideoStreamErrorScreenCaptureWindowRecoverFromHidden = 26,
+    LocalVideoStreamReasonScreenCapturePaused = 28,
     /**
      * @ignore
      */
-    LocalVideoStreamErrorScreenCaptureWindowRecoverFromMinimized = 27
+    LocalVideoStreamReasonScreenCaptureResumed = 29
 }
 /**
  * Remote audio states.
@@ -2165,11 +2191,11 @@ export declare enum RemoteVideoStateReason {
      */
     RemoteVideoStateReasonRemoteOffline = 7,
     /**
-     * @ignore
+     * 8: The remote audio-and-video stream falls back to the audio-only stream due to poor network conditions.
      */
     RemoteVideoStateReasonAudioFallback = 8,
     /**
-     * @ignore
+     * 9: The remote audio-only stream switches back to the audio-and-video stream after the network conditions improve.
      */
     RemoteVideoStateReasonAudioFallbackRecovery = 9,
     /**
@@ -2414,9 +2440,21 @@ export declare class LocalAudioStats {
      */
     txPacketLossRate?: number;
     /**
-     * The delay of the audio device module when playing or recording audio.
+     * The audio device module delay (ms) when playing or recording audio.
      */
     audioDeviceDelay?: number;
+    /**
+     * @ignore
+     */
+    audioPlayoutDelay?: number;
+    /**
+     * The ear monitor delay (ms), which is the delay from microphone input to headphone output.
+     */
+    earMonitorDelay?: number;
+    /**
+     * Acoustic echo cancellation (AEC) module estimated delay (ms), which is the signal delay between when audio is played locally before being locally captured.
+     */
+    aecEstimatedDelay?: number;
 }
 /**
  * States of the Media Push.
@@ -2450,77 +2488,77 @@ export declare enum RtmpStreamPublishState {
     RtmpStreamPublishStateDisconnecting = 5
 }
 /**
- * Error codes of the RTMP or RTMPS streaming.
+ * Reasons for changes in the status of RTMP or RTMPS streaming.
  */
-export declare enum RtmpStreamPublishErrorType {
+export declare enum RtmpStreamPublishReason {
     /**
      * 0: The RTMP or RTMPS streaming has not started or has ended.
      */
-    RtmpStreamPublishErrorOk = 0,
+    RtmpStreamPublishReasonOk = 0,
     /**
      * 1: Invalid argument used. Check the parameter setting.
      */
-    RtmpStreamPublishErrorInvalidArgument = 1,
+    RtmpStreamPublishReasonInvalidArgument = 1,
     /**
      * 2: The RTMP or RTMPS streaming is encrypted and cannot be published.
      */
-    RtmpStreamPublishErrorEncryptedStreamNotAllowed = 2,
+    RtmpStreamPublishReasonEncryptedStreamNotAllowed = 2,
     /**
      * 3: Timeout for the RTMP or RTMPS streaming.
      */
-    RtmpStreamPublishErrorConnectionTimeout = 3,
+    RtmpStreamPublishReasonConnectionTimeout = 3,
     /**
      * 4: An error occurs in Agora's streaming server.
      */
-    RtmpStreamPublishErrorInternalServerError = 4,
+    RtmpStreamPublishReasonInternalServerError = 4,
     /**
      * 5: An error occurs in the CDN server.
      */
-    RtmpStreamPublishErrorRtmpServerError = 5,
+    RtmpStreamPublishReasonRtmpServerError = 5,
     /**
      * 6: The RTMP or RTMPS streaming publishes too frequently.
      */
-    RtmpStreamPublishErrorTooOften = 6,
+    RtmpStreamPublishReasonTooOften = 6,
     /**
      * 7: The host publishes more than 10 URLs. Delete the unnecessary URLs before adding new ones.
      */
-    RtmpStreamPublishErrorReachLimit = 7,
+    RtmpStreamPublishReasonReachLimit = 7,
     /**
      * 8: The host manipulates other hosts' URLs. For example, the host updates or stops other hosts' streams. Check your app logic.
      */
-    RtmpStreamPublishErrorNotAuthorized = 8,
+    RtmpStreamPublishReasonNotAuthorized = 8,
     /**
      * 9: Agora's server fails to find the RTMP or RTMPS streaming.
      */
-    RtmpStreamPublishErrorStreamNotFound = 9,
+    RtmpStreamPublishReasonStreamNotFound = 9,
     /**
      * 10: The format of the RTMP or RTMPS streaming URL is not supported. Check whether the URL format is correct.
      */
-    RtmpStreamPublishErrorFormatNotSupported = 10,
+    RtmpStreamPublishReasonFormatNotSupported = 10,
     /**
      * 11: The user role is not host, so the user cannot use the CDN live streaming function. Check your application code logic.
      */
-    RtmpStreamPublishErrorNotBroadcaster = 11,
+    RtmpStreamPublishReasonNotBroadcaster = 11,
     /**
      * 13: The updateRtmpTranscoding method is called to update the transcoding configuration in a scenario where there is streaming without transcoding. Check your application code logic.
      */
-    RtmpStreamPublishErrorTranscodingNoMixStream = 13,
+    RtmpStreamPublishReasonTranscodingNoMixStream = 13,
     /**
      * 14: Errors occurred in the host's network.
      */
-    RtmpStreamPublishErrorNetDown = 14,
+    RtmpStreamPublishReasonNetDown = 14,
     /**
      * @ignore
      */
-    RtmpStreamPublishErrorInvalidAppid = 15,
+    RtmpStreamPublishReasonInvalidAppid = 15,
     /**
      * 16: Your project does not have permission to use streaming services. Refer to Media Push to enable the Media Push permission.
      */
-    RtmpStreamPublishErrorInvalidPrivilege = 16,
+    RtmpStreamPublishReasonInvalidPrivilege = 16,
     /**
-     * 100: The streaming has been stopped normally. After you stop the Media Push, the SDK returns this value.
+     * @ignore
      */
-    RtmpStreamUnpublishErrorOk = 100
+    RtmpStreamUnpublishReasonOk = 100
 }
 /**
  * Events during the Media Push.
@@ -2554,19 +2592,19 @@ export declare class RtcImage {
      */
     url?: string;
     /**
-     * The x coordinate (pixel) of the image on the video frame (taking the upper left corner of the video frame as the origin).
+     * The x-coordinate (px) of the image on the video frame (taking the upper left corner of the video frame as the origin).
      */
     x?: number;
     /**
-     * The y coordinate (pixel) of the image on the video frame (taking the upper left corner of the video frame as the origin).
+     * The y-coordinate (px) of the image on the video frame (taking the upper left corner of the video frame as the origin).
      */
     y?: number;
     /**
-     * The width (pixel) of the image on the video frame.
+     * The width (px) of the image on the video frame.
      */
     width?: number;
     /**
-     * The height (pixel) of the image on the video frame.
+     * The height (px) of the image on the video frame.
      */
     height?: number;
     /**
@@ -3053,7 +3091,15 @@ export declare enum ConnectionChangedReasonType {
     /**
      * @ignore
      */
-    ConnectionChangedCertificationVeryfyFailure = 22
+    ConnectionChangedCertificationVeryfyFailure = 22,
+    /**
+     * @ignore
+     */
+    ConnectionChangedStreamChannelNotAvailable = 23,
+    /**
+     * @ignore
+     */
+    ConnectionChangedInconsistentAppid = 24
 }
 /**
  * The reason for a user role switch failure.
@@ -3185,14 +3231,18 @@ export declare enum VideoViewSetupMode {
  * Attributes of the video canvas object.
  */
 export declare class VideoCanvas {
-    /**
-     * The video display window.
-     */
-    view?: any;
     /**
      * The user ID.
      */
     uid?: number;
+    /**
+     * Reserved for future use.
+     */
+    subviewUid?: number;
+    /**
+     * The video display window.
+     */
+    view?: any;
     /**
      * The background color of the video canvas in RGBA format. The default value is 0x00000000, which represents completely transparent black.
      */
@@ -3224,12 +3274,16 @@ export declare class VideoCanvas {
      */
     cropArea?: Rectangle;
     /**
-     * (Optional) Whether the receiver enables alpha mask rendering: true : The receiver enables alpha mask rendering. false : (default) The receiver disables alpha mask rendering. Alpha mask rendering can create images with transparent effects and extract portraits from videos. When used in combination with other methods, you can implement effects such as picture-in-picture and watermarking.
+     * (Optional) Whether the receiver enables alpha mask rendering: true : The receiver enables alpha mask rendering. false : (default) The receiver disables alpha mask rendering. Alpha mask rendering can create images with transparent effects and extract portraits from videos. When used in combination with other methods, you can implement effects such as portrait-in-picture and watermarking.
      *  This property applies to macOS only.
      *  The receiver can render alpha channel information only when the sender enables alpha transmission.
      *  To enable alpha transmission,.
      */
     enableAlphaMask?: boolean;
+    /**
+     * The observation position of the video frame in the video link. See VideoModulePosition.
+     */
+    position?: VideoModulePosition;
 }
 /**
  * The contrast level.
@@ -3421,11 +3475,11 @@ export declare class VirtualBackgroundSource {
      */
     background_source_type?: BackgroundSourceType;
     /**
-     * The type of the custom background image. The color of the custom background image. The format is a hexadecimal integer defined by RGB, without the # sign, such as 0xFFB6C1 for light pink. The default value is 0xFFFFFF, which signifies white. The value range is [0x000000, 0xffffff]. If the value is invalid, the SDK replaces the original background image with a white background image. This parameter takes effect only when the type of the custom background image is BackgroundColor.
+     * The type of the custom background image. The color of the custom background image. The format is a hexadecimal integer defined by RGB, without the # sign, such as 0xFFB6C1 for light pink. The default value is 0xFFFFFF, which signifies white. The value range is [0x000000, 0xffffff]. If the value is invalid, the SDK replaces the original background image with a white background image. This parameter is only applicable to custom backgrounds of the following types: BackgroundColor : The background image is a solid-colored image of the color passed in by the parameter. BackgroundImg : If the image in source has a transparent background, the transparent background will be filled with the color passed in by the parameter.
      */
     color?: number;
     /**
-     * The local absolute path of the custom background image. PNG and JPG formats are supported. If the path is invalid, the SDK replaces the original background image with a white background image. This parameter takes effect only when the type of the custom background image is BackgroundImg.
+     * The local absolute path of the custom background image. Supports PNG, JPG, MP4, AVI, MKV, and FLV formats. If the path is invalid, the SDK will use either the original background image or the solid color image specified by color. This parameter takes effect only when the type of the custom background image is BackgroundImg or BackgroundVideo.
      */
     source?: string;
     /**
@@ -4043,75 +4097,6 @@ export declare enum ChannelMediaRelayError {
      */
     RelayErrorDestTokenExpired = 11
 }
-/**
- * The event code of channel media relay.
- */
-export declare enum ChannelMediaRelayEvent {
-    /**
-     * 0: The user disconnects from the server due to a poor network connection.
-     */
-    RelayEventNetworkDisconnected = 0,
-    /**
-     * 1: The user is connected to the server.
-     */
-    RelayEventNetworkConnected = 1,
-    /**
-     * 2: The user joins the source channel.
-     */
-    RelayEventPacketJoinedSrcChannel = 2,
-    /**
-     * 3: The user joins the target channel.
-     */
-    RelayEventPacketJoinedDestChannel = 3,
-    /**
-     * 4: The SDK starts relaying the media stream to the target channel.
-     */
-    RelayEventPacketSentToDestChannel = 4,
-    /**
-     * 5: The server receives the audio stream from the source channel.
-     */
-    RelayEventPacketReceivedVideoFromSrc = 5,
-    /**
-     * 6: The server receives the audio stream from the source channel.
-     */
-    RelayEventPacketReceivedAudioFromSrc = 6,
-    /**
-     * 7: The target channel is updated.
-     */
-    RelayEventPacketUpdateDestChannel = 7,
-    /**
-     * @ignore
-     */
-    RelayEventPacketUpdateDestChannelRefused = 8,
-    /**
-     * 9: The target channel does not change, which means that the target channel fails to be updated.
-     */
-    RelayEventPacketUpdateDestChannelNotChange = 9,
-    /**
-     * 10: The target channel name is NULL.
-     */
-    RelayEventPacketUpdateDestChannelIsNull = 10,
-    /**
-     * 11: The video profile is sent to the server.
-     */
-    RelayEventVideoProfileUpdate = 11,
-    /**
-     * 12: The SDK successfully pauses relaying the media stream to target channels.
-     */
-    RelayEventPauseSendPacketToDestChannelSuccess = 12,
-    /**
-     * 13: The SDK fails to pause relaying the media stream to target channels.
-     */
-    RelayEventPauseSendPacketToDestChannelFailed = 13,
-    /**
-     * 14: The SDK successfully resumes relaying the media stream to target channels.
-     */
-    RelayEventResumeSendPacketToDestChannelSuccess = 14,
-    /**
-     * 15: The SDK fails to resume relaying the media stream to target channels.
-     */
-    RelayEventResumeSendPacketToDestChannelFailed = 15
-}
 /**
  * The state code of the channel media relay.
  */
@@ -4137,6 +4122,10 @@ export declare enum ChannelMediaRelayState {
  * Channel media information.
  */
 export declare class ChannelMediaInfo {
+    /**
+     * The user ID.
+     */
+    uid?: number;
     /**
      * The channel name.
      */
@@ -4145,24 +4134,20 @@ export declare class ChannelMediaInfo {
      * The token that enables the user to join the channel.
      */
     token?: string;
-    /**
-     * The user ID.
-     */
-    uid?: number;
 }
 /**
  * Configuration of cross channel media relay.
  */
 export declare class ChannelMediaRelayConfiguration {
     /**
-     * The information of the source channel. See ChannelMediaInfo. It contains the following members: channelName : The name of the source channel. The default value is NULL, which means the SDK applies the name of the current channel. token : The token for joining the source channel. This token is generated with the channelName and uid you set in srcInfo.
-     *  If you have not enabled the App Certificate, set this parameter as the default value NULL, which means the SDK applies the App ID.
+     * The information of the source channel. See ChannelMediaInfo. It contains the following members: channelName : The name of the source channel. The default value is null, which means the SDK applies the name of the current channel. token : The token for joining the source channel. This token is generated with the channelName and uid you set in srcInfo.
+     *  If you have not enabled the App Certificate, set this parameter as the default value null, which means the SDK applies the App ID.
      *  If you have enabled the App Certificate, you must use the token generated with the channelName and uid, and the uid must be set as 0. uid : The unique user ID to identify the relay stream in the source channel. Agora recommends leaving the default value of 0 unchanged.
      */
     srcInfo?: ChannelMediaInfo;
     /**
      * The information of the target channel ChannelMediaInfo. It contains the following members: channelName : The name of the target channel. token : The token for joining the target channel. It is generated with the channelName and uid you set in destInfos.
-     *  If you have not enabled the App Certificate, set this parameter as the default value NULL, which means the SDK applies the App ID.
+     *  If you have not enabled the App Certificate, set this parameter as the default value null, which means the SDK applies the App ID.
      *  If you have enabled the App Certificate, you must use the token generated with the channelName and uid. If the token of any target channel expires, the whole media relay stops; hence Agora recommends that you specify the same expiration time for the tokens of all the target channels. uid : The unique user ID to identify the relay stream in the target channel. The value ranges from 0 to (2 32 -1). To avoid user ID conflicts, this user ID must be different from any other user ID in the target channel. The default value is 0, which means the SDK generates a random user ID.
      */
     destInfos?: ChannelMediaInfo[];
@@ -4187,7 +4172,7 @@ export declare class PeerDownlinkInfo {
     /**
      * @ignore
      */
-    uid?: string;
+    userId?: string;
     /**
      * @ignore
      */
@@ -4278,7 +4263,7 @@ export declare class EncryptionConfig {
      */
     encryptionMode?: EncryptionMode;
     /**
-     * Encryption key in string type with unlimited length. Agora recommends using a 32-byte key. If you do not set an encryption key or set it as NULL, you cannot use the built-in encryption, and the SDK returns -2.
+     * Encryption key in string type with unlimited length. Agora recommends using a 32-byte key. If you do not set an encryption key or set it as null, you cannot use the built-in encryption, and the SDK returns -2.
      */
     encryptionKey?: string;
     /**
@@ -4337,15 +4322,6 @@ export declare enum PermissionType {
      */
     ScreenCapture = 2
 }
-/**
- * The maximum length of the user account.
- */
-export declare enum MaxUserAccountLengthType {
-    /**
-     * The maximum length of the user account is 256 bytes.
-     */
-    MaxUserAccountLength = 256
-}
 /**
  * The subscribing state.
  */
@@ -4413,7 +4389,7 @@ export declare class EchoTestConfiguration {
      */
     enableAudio?: boolean;
     /**
-     * Whether to enable the video device for the loop test: true : (Default) Enable the video device. To test the video device, set this parameter as true. false : Disable the video device.
+     * Whether to enable the video device for the loop test. Currently, video device loop test is not supported. Please set this parameter to false.
      */
     enableVideo?: boolean;
     /**
@@ -4425,7 +4401,9 @@ export declare class EchoTestConfiguration {
      */
     channelId?: string;
     /**
-     * The time interval (s) between when you start the call and when the recording plays back. The value range is [2, 10], and the default value is 2.
+     * Set the time interval or delay for returning the results of the audio and video loop test. The value range is [2,10], in seconds, with the default value being 2 seconds.
+     *  For audio loop tests, the test results will be returned according to the time interval you set.
+     *  For video loop tests, the video will be displayed in a short time, after which the delay will gradually increase until it reaches the delay you set.
      */
     intervalInSeconds?: number;
 }
@@ -4620,19 +4598,6 @@ export declare enum ConfigFetchType {
      */
     ConfigFetchTypeJoinChannel = 2
 }
-/**
- * @ignore
- */
-export declare class RecorderStreamInfo {
-    /**
-     * @ignore
-     */
-    channelId?: string;
-    /**
-     * @ignore
-     */
-    uid?: number;
-}
 /**
  * @ignore
  */
@@ -4708,6 +4673,23 @@ export declare class LocalAccessPointConfiguration {
      * @ignore
      */
     advancedConfig?: AdvancedConfigInfo;
+    /**
+     * @ignore
+     */
+    disableAut?: boolean;
+}
+/**
+ * @ignore
+ */
+export declare class RecorderStreamInfo {
+    /**
+     * @ignore
+     */
+    channelId?: string;
+    /**
+     * @ignore
+     */
+    uid?: number;
 }
 /**
  * The spatial audio parameters.
@@ -4762,4 +4744,41 @@ export declare class SpatialAudioParams {
      */
     enable_doppler?: boolean;
 }
+/**
+ * @ignore
+ */
+export declare class VideoLayout {
+    /**
+     * @ignore
+     */
+    channelId?: string;
+    /**
+     * @ignore
+     */
+    uid?: number;
+    /**
+     * @ignore
+     */
+    strUid?: string;
+    /**
+     * @ignore
+     */
+    x?: number;
+    /**
+     * @ignore
+     */
+    y?: number;
+    /**
+     * @ignore
+     */
+    width?: number;
+    /**
+     * @ignore
+     */
+    height?: number;
+    /**
+     * @ignore
+     */
+    videoState?: number;
+}
 //# sourceMappingURL=AgoraBase.d.ts.map