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

package/ts/Private/AgoraBase.ts

@@ -238,7 +238,7 @@ export enum ErrorCodeType {
   ErrNetDown = 14,
   /**
    * 17: The request to join the channel is rejected. Possible reasons include the following:
-   *  The user is already in the channel. Agora recommends that you use the onConnectionStateChanged callback to determine whether the user exists in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected (1) state.
+   *  The user is already in the channel. Agora recommends that you use the onConnectionStateChanged callback to see whether the user is in the channel. Do not call this method to join the channel unless you receive the ConnectionStateDisconnected (1) state.
    *  After calling startEchoTest for the call test, the user tries to join the channel without calling stopEchoTest to end the current test. To join a channel, the call test must be ended by calling stopEchoTest.
    */
   ErrJoinChannelRejected = 17,
@@ -1300,6 +1300,10 @@ export class AdvanceOptions {
    * Compression preference for video encoding. See CompressionPreference.
    */
   compressionPreference?: CompressionPreference;
+  /**
+   * Whether to encode and send the Alpha data present in the video frame to the remote end: true : Encode and send Alpha data. false : (Default) Do not encode and send Alpha data.
+   */
+  encodeAlpha?: boolean;
 }
 
 /**
@@ -1437,7 +1441,7 @@ export class VideoEncoderConfiguration {
    */
   orientationMode?: OrientationMode;
   /**
-   * Video degradation preference under limited bandwidth. See DegradationPreference.
+   * Video degradation preference under limited bandwidth. See DegradationPreference. When this parameter is set to MaintainFramerate (1) or MaintainBalanced (2), orientationMode needs to be set to OrientationModeAdaptive (0) at the same time, otherwise the setting will not take effect.
    */
   degradationPreference?: DegradationPreference;
   /**
@@ -1946,7 +1950,7 @@ export enum AudioScenarioType {
    */
   AudioScenarioGameStreaming = 3,
   /**
-   * 5: Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. For example, education scenarios. In this scenario, audience members receive a pop-up window to request permission of using microphones.
+   * 5: Chatroom scenario, where users need to frequently switch the user role or mute and unmute the microphone. For example, education scenarios.
    */
   AudioScenarioChatroom = 5,
   /**
@@ -2030,7 +2034,7 @@ export enum VideoApplicationScenarioType {
    */
   ApplicationScenarioGeneral = 0,
   /**
-   * If set to ApplicationScenarioMeeting (1), the SDK automatically enables the following strategies:
+   * ApplicationScenarioMeeting (1) is suitable for meeting scenarios. The SDK automatically enables the following strategies:
    *  In meeting scenarios where low-quality video streams are required to have a high bitrate, the SDK automatically enables multiple technologies used to deal with network congestions, to enhance the performance of the low-quality streams and to ensure the smooth reception by subscribers.
    *  The SDK monitors the number of subscribers to the high-quality video stream in real time and dynamically adjusts its configuration based on the number of subscribers.
    *  If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth.
@@ -2047,7 +2051,7 @@ export enum VideoApplicationScenarioType {
    */
   ApplicationScenarioMeeting = 1,
   /**
-   * @ignore
+   * ApplicationScenario1v1 (2) is suitable for 1v1 video call scenarios. To meet the requirements for low latency and high-quality video in this scenario, the SDK optimizes its strategies, improving performance in terms of video quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under weak network conditions. 2: 1v1 video call scenario.
    */
   ApplicationScenario1v1 = 2,
 }
@@ -2300,23 +2304,23 @@ export enum LocalVideoStreamReason {
    */
   LocalVideoStreamReasonScreenCaptureWindowNotSupported = 20,
   /**
-   * @ignore
+   * 21: (Windows only) The screen has not captured any data available for window sharing.
    */
   LocalVideoStreamReasonScreenCaptureFailure = 21,
   /**
-   * @ignore
+   * 22: No permission for screen capture.
    */
   LocalVideoStreamReasonScreenCaptureNoPermission = 22,
   /**
-   * @ignore
+   * 24: (Windows only) An unexpected error occurred during screen sharing (possibly due to window blocking failure), resulting in decreased performance, but the screen sharing process itself was not affected.
    */
   LocalVideoStreamReasonScreenCaptureAutoFallback = 24,
   /**
-   * @ignore
+   * 25: (Windows only) The window for the current screen capture is hidden and not visible on the current screen.
    */
   LocalVideoStreamReasonScreenCaptureWindowHidden = 25,
   /**
-   * @ignore
+   * 26: (Windows only) The window for screen capture has been restored from hidden state.
    */
   LocalVideoStreamReasonScreenCaptureWindowRecoverFromHidden = 26,
   /**
@@ -2324,15 +2328,15 @@ export enum LocalVideoStreamReason {
    */
   LocalVideoStreamReasonScreenCaptureWindowRecoverFromMinimized = 27,
   /**
-   * @ignore
+   * 28: (Windows only) Screen capture has been paused. Common scenarios reporting this error code: The current screen may have been switched to a secure desktop, such as a UAC dialog box or Winlogon desktop.
    */
   LocalVideoStreamReasonScreenCapturePaused = 28,
   /**
-   * @ignore
+   * 29: (Windows only) Screen capture has resumed from paused state.
    */
   LocalVideoStreamReasonScreenCaptureResumed = 29,
   /**
-   * @ignore
+   * 30: The displayer used for screen capture is disconnected.
    */
   LocalVideoStreamReasonScreenCaptureDisplayDisconnected = 30,
 }
@@ -3419,7 +3423,7 @@ export enum ConnectionChangedReasonType {
  */
 export enum ClientRoleChangeFailedReason {
   /**
-   * 1: The number of hosts in the channel is already at the upper limit. This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
+   * 1: The number of hosts in the channel exceeds the limit. This enumerator is reported only when the support for 128 users is enabled. The maximum number of hosts is based on the actual number of hosts configured when you enable the 128-user feature.
    */
   ClientRoleChangeFailedTooManyBroadcasters = 1,
   /**
@@ -3427,11 +3431,11 @@ export enum ClientRoleChangeFailedReason {
    */
   ClientRoleChangeFailedNotAuthorized = 2,
   /**
-   * 3: The request is timed out. Agora recommends you prompt the user to check the network connection and try to switch their user role again.
+   * 3: The request is timed out. Agora recommends you prompt the user to check the network connection and try to switch their user role again. Deprecated: This enumerator is deprecated since v4.4.0 and is not recommended for use.
    */
   ClientRoleChangeFailedRequestTimeOut = 3,
   /**
-   * 4: The SDK connection fails. You can use reason reported in the onConnectionStateChanged callback to troubleshoot the failure.
+   * 4: The SDK is disconnected from the Agora edge server. You can troubleshoot the failure through the reason reported by onConnectionStateChanged. Deprecated: This enumerator is deprecated since v4.4.0 and is not recommended for use.
    */
   ClientRoleChangeFailedConnectionFailed = 4,
 }
@@ -3533,7 +3537,7 @@ export enum NetworkType {
  */
 export enum VideoViewSetupMode {
   /**
-   * 0: (Default) Replaces a view.
+   * 0: (Default) Clear all added views and replace with a new view.
    */
   VideoViewSetupReplace = 0,
   /**
@@ -3593,7 +3597,7 @@ export 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 portrait-in-picture and watermarking.
+   * (Optional) Whether to enable alpha mask rendering: true : Enable alpha mask rendering. false : (Default) Disable 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.
    *  The receiver can render alpha channel information only when the sender enables alpha transmission.
    *  To enable alpha transmission,.
    */
@@ -3857,7 +3861,7 @@ export class ColorEnhanceOptions {
  */
 export enum BackgroundSourceType {
   /**
-   * 0: Process the background as alpha information without replacement, only separating the portrait and the background. After setting this value, you can call startLocalVideoTranscoder to implement the picture-in-picture effect.
+   * 0: Process the background as alpha data without replacement, only separating the portrait and the background. After setting this value, you can call startLocalVideoTranscoder to implement the picture-in-picture effect.
    */
   BackgroundNone = 0,
   /**
@@ -4221,47 +4225,47 @@ export enum HeadphoneEqualizerPreset {
 }
 
 /**
- * @ignore
+ * Voice AI tuner sound types.
  */
 export enum VoiceAiTunerType {
   /**
-   * @ignore
+   * 0: Mature male voice. A deep and magnetic male voice.
    */
   VoiceAiTunerMatureMale = 0,
   /**
-   * @ignore
+   * 1: Fresh male voice. A fresh and slightly sweet male voice.
    */
   VoiceAiTunerFreshMale = 1,
   /**
-   * @ignore
+   * 2: Elegant female voice. A deep and charming female voice.
    */
   VoiceAiTunerElegantFemale = 2,
   /**
-   * @ignore
+   * 3: Sweet female voice. A high-pitched and cute female voice.
    */
   VoiceAiTunerSweetFemale = 3,
   /**
-   * @ignore
+   * 4: Warm male singing. A warm and melodious male voice.
    */
   VoiceAiTunerWarmMaleSinging = 4,
   /**
-   * @ignore
+   * 5: Gentle female singing. A soft and delicate female voice.
    */
   VoiceAiTunerGentleFemaleSinging = 5,
   /**
-   * @ignore
+   * 6: Husky male singing. A unique husky male voice.
    */
   VoiceAiTunerHuskyMaleSinging = 6,
   /**
-   * @ignore
+   * 7: Warm elegant female singing. A warm and mature female voice.
    */
   VoiceAiTunerWarmElegantFemaleSinging = 7,
   /**
-   * @ignore
+   * 8: Powerful male singing. A strong and powerful male voice.
    */
   VoiceAiTunerPowerfulMaleSinging = 8,
   /**
-   * @ignore
+   * 9: Dreamy female singing. A dreamy and soft female voice.
    */
   VoiceAiTunerDreamyFemaleSinging = 9,
 }
@@ -4402,7 +4406,7 @@ export class AudioRecordingConfiguration {
    */
   fileRecordingType?: AudioFileRecordingType;
   /**
-   * Recording quality. See AudioRecordingQualityType. Note: This parameter applies to AAC files only.
+   * Recording quality. See AudioRecordingQualityType. This parameter applies to AAC files only.
    */
   quality?: AudioRecordingQualityType;
   /**

package/ts/Private/AgoraMediaBase.ts

@@ -2,23 +2,23 @@ import './extension/AgoraMediaBaseExtension';
 import { EncodedVideoFrameInfo } from './AgoraBase';
 
 /**
- * @ignore
+ * The context information of the extension.
  */
 export class ExtensionContext {
   /**
-   * @ignore
+   * Whether the uid in ExtensionContext is valid: true : The uid is valid. false : The uid is invalid.
    */
   isValid?: boolean;
   /**
-   * @ignore
+   * The user ID. 0 represents a local user, while greater than 0 represents a remote user.
    */
   uid?: number;
   /**
-   * @ignore
+   * The name of the extension provider.
    */
   providerName?: string;
   /**
-   * @ignore
+   * The name of the extension.
    */
   extensionName?: string;
 }
@@ -308,7 +308,7 @@ export enum ContentInspectType {
 }
 
 /**
- * A ContentInspectModule structure used to configure the frequency of video screenshot and upload.
+ * ContentInspectModule A structure used to configure the frequency of video screenshot and upload.
  */
 export class ContentInspectModule {
   /**
@@ -322,7 +322,7 @@ export class ContentInspectModule {
 }
 
 /**
- * Configuration of video screenshot and upload.
+ * Screenshot and upload configuration.
  */
 export class ContentInspectConfig {
   /**
@@ -399,6 +399,10 @@ export class AudioPcmFrame {
    * The audio frame.
    */
   data_?: number[];
+  /**
+   * @ignore
+   */
+  is_stereo_?: boolean;
 }
 
 /**
@@ -833,6 +837,32 @@ export class Hdr10MetadataInfo {
   maxFrameAverageLightLevel?: number;
 }
 
+/**
+ * @ignore
+ */
+export enum AlphaStitchMode {
+  /**
+   * @ignore
+   */
+  NoAlphaStitch = 0,
+  /**
+   * @ignore
+   */
+  AlphaStitchUp = 1,
+  /**
+   * @ignore
+   */
+  AlphaStitchBelow = 2,
+  /**
+   * @ignore
+   */
+  AlphaStitchLeft = 3,
+  /**
+   * @ignore
+   */
+  AlphaStitchRight = 4,
+}
+
 /**
  * @ignore
  */
@@ -924,7 +954,7 @@ export class ExternalVideoFrame {
   /**
    * @ignore
    */
-  fence_object?: number;
+  fenceObject?: number;
   /**
    * This parameter only applies to video data in Texture format. Incoming 4 × 4 transformational matrix. The typical value is a unit matrix.
    */
@@ -932,27 +962,33 @@ export class ExternalVideoFrame {
   /**
    * This parameter only applies to video data in Texture format. The MetaData buffer. The default value is NULL.
    */
-  metadata_buffer?: Uint8Array;
+  metadataBuffer?: Uint8Array;
   /**
    * This parameter only applies to video data in Texture format. The MetaData size. The default value is 0.
    */
-  metadata_size?: number;
+  metadataSize?: number;
   /**
-   * @ignore
+   * The alpha channel data output by using portrait segmentation algorithm. This data matches the size of the video frame, with each pixel value ranging from [0,255], where 0 represents the background and 255 represents the foreground (portrait). By setting this parameter, you can render the video background into various effects, such as transparent, solid color, image, video, etc. In custom video rendering scenarios, ensure that both the video frame and alphaBuffer are of the Full Range type; other types may cause abnormal alpha data rendering.
    */
   alphaBuffer?: Uint8Array;
   /**
-   * @ignore
+   * This parameter only applies to video data in BGRA or RGBA format. Whether to extract the alpha channel data from the video frame and automatically fill it into alphaBuffer : true ：Extract and fill the alpha channel data. false : (Default) Do not extract and fill the Alpha channel data. For video data in BGRA or RGBA format, you can set the Alpha channel data in either of the following ways:
+   *  Automatically by setting this parameter to true.
+   *  Manually through the alphaBuffer parameter.
    */
   fillAlphaBuffer?: boolean;
   /**
-   * @ignore
+   * When the video frame contains alpha channel data, it represents the relative position of alphaBuffer and the video frame. See AlphaStitchMode.
    */
-  alphaStitchMode?: number;
+  alphaStitchMode?: AlphaStitchMode;
   /**
-   * This parameter only applies to video data in Windows Texture format. It represents an index of an ID3D11Texture2D texture object used by the video frame in the ID3D11Texture2D array.
+   * This parameter only applies to video data in Windows Texture format. It represents a pointer to an object of type ID3D11Texture2D, which is used by a video frame.
    */
-  texture_slice_index?: number;
+  d3d11Texture2d?: any;
+  /**
+   * @ignore
+   */
+  textureSliceIndex?: number;
   /**
    * @ignore
    */
@@ -1034,19 +1070,19 @@ export class VideoFrame {
    */
   matrix?: number[];
   /**
-   * @ignore
+   * The alpha channel data output by using portrait segmentation algorithm. This data matches the size of the video frame, with each pixel value ranging from [0,255], where 0 represents the background and 255 represents the foreground (portrait). By setting this parameter, you can render the video background into various effects, such as transparent, solid color, image, video, etc. In custom video rendering scenarios, ensure that both the video frame and alphaBuffer are of the Full Range type; other types may cause abnormal alpha data rendering.
    */
   alphaBuffer?: Uint8Array;
   /**
-   * @ignore
+   * When the video frame contains alpha channel data, it represents the relative position of alphaBuffer and the video frame. See AlphaStitchMode.
    */
-  alphaStitchMode?: number;
+  alphaStitchMode?: AlphaStitchMode;
   /**
    * @ignore
    */
   pixelBuffer?: Uint8Array;
   /**
-   * The meta information in the video frame. To use this parameter, please.
+   * The meta information in the video frame. To use this parameter, please contact.
    */
   metaInfo?: IVideoFrameMetaInfo;
   /**
@@ -1420,6 +1456,7 @@ export interface IVideoFrameObserver {
    * Occurs each time the SDK receives a video frame before encoding.
    *
    * After you successfully register the video frame observer, the SDK triggers this callback each time it receives a video frame. In this callback, you can get the video data before encoding and then process the data according to your particular scenarios. After processing, you can send the processed video data back to the SDK in this callback.
+   *  It is recommended that you ensure the modified parameters in videoFrame are consistent with the actual situation of the video frames in the video frame buffer. Otherwise, it may cause unexpected rotation, distortion, and other issues in the local preview and remote video display.
    *  It's recommended that you implement this callback through the C++ API.
    *  Due to framework limitations, this callback does not support sending processed video data back to the SDK.
    *  The video data that this callback gets has been preprocessed, with its content cropped and rotated, and the image enhanced.
@@ -1443,6 +1480,7 @@ export interface IVideoFrameObserver {
    * Occurs each time the SDK receives a video frame sent by the remote user.
    *
    * After you successfully register the video frame observer, the SDK triggers this callback each time it receives a video frame. In this callback, you can get the video data sent from the remote end before rendering, and then process it according to the particular scenarios.
+   *  It is recommended that you ensure the modified parameters in videoFrame are consistent with the actual situation of the video frames in the video frame buffer. Otherwise, it may cause unexpected rotation, distortion, and other issues in the local preview and remote video display.
    *  If the video data type you get is RGBA, the SDK does not support processing the data of the alpha channel.
    *  It's recommended that you implement this callback through the C++ API.
    *  Due to framework limitations, this callback does not support sending processed video data back to the SDK.
@@ -1594,26 +1632,8 @@ export interface IFaceInfoObserver {
    *  yaw: Head yaw angle. A positve value means turning left, while a negative value means turning right.
    *  roll: Head roll angle. A positve value means tilting to the right, while a negative value means tilting to the left.
    *  timestamp: String. The timestamp of the output result, in milliseconds. Here is an example of JSON:
-   * {
-   *  "faces":[{
-   *  "blendshapes":{
-   *  "eyeBlinkLeft":0.9, "eyeLookDownLeft":0.0, "eyeLookInLeft":0.0, "eyeLookOutLeft":0.0, "eyeLookUpLeft":0.0,
-   *  "eyeSquintLeft":0.0, "eyeWideLeft":0.0, "eyeBlinkRight":0.0, "eyeLookDownRight":0.0, "eyeLookInRight":0.0,
-   *  "eyeLookOutRight":0.0, "eyeLookUpRight":0.0, "eyeSquintRight":0.0, "eyeWideRight":0.0, "jawForward":0.0,
-   *  "jawLeft":0.0, "jawRight":0.0, "jawOpen":0.0, "mouthClose":0.0, "mouthFunnel":0.0, "mouthPucker":0.0,
-   *  "mouthLeft":0.0, "mouthRight":0.0, "mouthSmileLeft":0.0, "mouthSmileRight":0.0, "mouthFrownLeft":0.0,
-   *  "mouthFrownRight":0.0, "mouthDimpleLeft":0.0, "mouthDimpleRight":0.0, "mouthStretchLeft":0.0, "mouthStretchRight":0.0,
-   *  "mouthRollLower":0.0, "mouthRollUpper":0.0, "mouthShrugLower":0.0, "mouthShrugUpper":0.0, "mouthPressLeft":0.0,
-   *  "mouthPressRight":0.0, "mouthLowerDownLeft":0.0, "mouthLowerDownRight":0.0, "mouthUpperUpLeft":0.0, "mouthUpperUpRight":0.0,
-   *  "browDownLeft":0.0, "browDownRight":0.0, "browInnerUp":0.0, "browOuterUpLeft":0.0, "browOuterUpRight":0.0,
-   *  "cheekPuff":0.0, "cheekSquintLeft":0.0, "cheekSquintRight":0.0, "noseSneerLeft":0.0, "noseSneerRight":0.0,
-   *  "tongueOut":0.0
-   *  },
-   *  "rotation":{"pitch":30.0, "yaw":25.5, "roll":-15.5},
-   *
-   *  }],
-   *  "timestamp":"654879876546"
-   * }
+   * { "faces":[{ "blendshapes":{ "eyeBlinkLeft":0.9, "eyeLookDownLeft":0.0, "eyeLookInLeft":0.0, "eyeLookOutLeft":0.0, "eyeLookUpLeft":0.0, "eyeSquintLeft":0.0, "eyeWideLeft":0.0, "eyeBlinkRight":0.0, "eyeLookDownRight":0.0, "eyeLookInRight":0.0, "eyeLookOutRight":0.0, "eyeLookUpRight":0.0, "eyeSquintRight":0.0, "eyeWideRight":0.0, "jawForward":0.0, "jawLeft":0.0, "jawRight":0.0, "jawOpen":0.0, "mouthClose":0.0, "mouthFunnel":0.0, "mouthPucker":0.0, "mouthLeft":0.0, "mouthRight":0.0, "mouthSmileLeft":0.0, "mouthSmileRight":0.0, "mouthFrownLeft":0.0, "mouthFrownRight":0.0, "mouthDimpleLeft":0.0, "mouthDimpleRight":0.0, "mouthStretchLeft":0.0, "mouthStretchRight":0.0, "mouthRollLower":0.0, "mouthRollUpper":0.0, "mouthShrugLower":0.0, "mouthShrugUpper":0.0, "mouthPressLeft":0.0, "mouthPressRight":0.0, "mouthLowerDownLeft":0.0, "mouthLowerDownRight":0.0, "mouthUpperUpLeft":0.0, "mouthUpperUpRight":0.0, "browDownLeft":0.0, "browDownRight":0.0, "browInnerUp":0.0, "browOuterUpLeft":0.0, "browOuterUpRight":0.0, "cheekPuff":0.0, "cheekSquintLeft":0.0, "cheekSquintRight":0.0, "noseSneerLeft":0.0, "noseSneerRight":0.0, "tongueOut":0.0 }, "rotation":{"pitch":30.0, "yaw":25.5, "roll":-15.5},
+   *  }], "timestamp":"654879876546" }
    *
    * @returns
    * true : Facial information JSON parsing successful. false : Facial information JSON parsing failed.

package/ts/Private/IAgoraLog.ts

@@ -28,6 +28,10 @@ export enum LogLevel {
    * @ignore
    */
   LogLevelApiCall = 0x0010,
+  /**
+   * @ignore
+   */
+  LogLevelDebug = 0x0020,
 }
 
 /**

package/ts/Private/IAgoraMediaEngine.ts

@@ -44,7 +44,7 @@ export abstract class IMediaEngine {
   /**
    * Registers an audio frame observer object.
    *
-   * Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger onMixedAudioFrame, onRecordAudioFrame, onPlaybackAudioFrame or onEarMonitoringAudioFrame callback, you need to use this method to register the callbacks. Ensure that you call this method before joining a channel.
+   * Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger the onMixedAudioFrame, onRecordAudioFrame, onPlaybackAudioFrame, onPlaybackAudioFrameBeforeMixing or onEarMonitoringAudioFrame callback, you need to use this method to register the callbacks.
    *
    * @param observer The observer instance. See IAudioFrameObserver. Agora recommends calling this method after receiving onLeaveChannel to release the audio observer object.
    *
@@ -64,10 +64,6 @@ export abstract class IMediaEngine {
    *  Call muteAllRemoteVideoStreams (false) to start receiving the video streams of all remote users. Then:
    *  The raw video data of group A users can be obtained through the callback in IVideoFrameObserver, and the SDK renders the data by default.
    *  The encoded video data of group B users can be obtained through the callback in IVideoEncodedFrameObserver. If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one IVideoFrameObserver class with this method. When calling this method to register a video observer, you can register callbacks in the IVideoFrameObserver class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.
-   *  Ensure that you call this method before joining a channel.
-   *  When handling the video data returned in the callbacks, pay attention to the changes in the width and height parameters, which may be adapted under the following circumstances:
-   *  When network conditions deteriorate, the video resolution decreases incrementally.
-   *  If the user adjusts the video profile, the resolution of the video returned in the callbacks also changes.
    *
    * @param observer The observer instance. See IVideoFrameObserver.
    *
@@ -103,7 +99,7 @@ export abstract class IMediaEngine {
    * Registers a facial information observer.
    *
    * You can call this method to register the onFaceInfo callback to receive the facial information processed by Agora speech driven extension. When calling this method to register a facial information observer, you can register callbacks in the IFaceInfoObserver class as needed. After successfully registering the facial information observer, the SDK triggers the callback you have registered when it captures the facial information converted by the speech driven extension.
-   *  Ensure that you call this method before joining a channel.
+   *  Call this method before joining a channel.
    *  Before calling this method, you need to make sure that the speech driven extension has been enabled by calling enableExtension.
    *
    * @param observer Facial information observer, see IFaceInfoObserver.
@@ -117,9 +113,7 @@ export abstract class IMediaEngine {
   /**
    * Pushes the external audio frame.
    *
-   * Before calling this method to push external audio data, perform the following steps:
-   *  Call createCustomAudioTrack to create a custom audio track and get the audio track ID.
-   *  Call joinChannel to join the channel. In ChannelMediaOptions, set publishCustomAudioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to true.
+   * Call this method to push external audio frames through the audio track.
    *
    * @param frame The external audio frame. See AudioFrame.
    * @param trackId The audio track ID. If you want to publish a custom external audio source, set this parameter to the ID of the corresponding custom audio track you want to publish.
@@ -133,12 +127,7 @@ export abstract class IMediaEngine {
   /**
    * Pulls the remote audio data.
    *
-   * Before calling this method, call setExternalAudioSink (enabled : true) to notify the app to enable and set the external audio rendering. After a successful call of this method, the app pulls the decoded and mixed audio data for playback.
-   *  Call this method after joining a channel.
-   *  Both this method and onPlaybackAudioFrame callback can be used to get audio data after remote mixing. Note that after calling setExternalAudioSink to enable external audio rendering, the app no longer receives data from the onPlaybackAudioFrame callback. Therefore, you should choose between this method and the onPlaybackAudioFrame callback based on your actual business requirements. The specific distinctions between them are as follows:
-   *  After calling this method, the app automatically pulls the audio data from the SDK. By setting the audio data parameters, the SDK adjusts the frame buffer to help the app handle latency, effectively avoiding audio playback jitter.
-   *  The SDK sends the audio data to the app through the onPlaybackAudioFrame callback. Any delay in processing the audio frames may result in audio jitter.
-   *  This method is only used for retrieving audio data after remote mixing. If you need to get audio data from different audio processing stages such as capture and playback, you can register the corresponding callbacks by calling registerAudioFrameObserver.
+   * After a successful call of this method, the app pulls the decoded and mixed audio data for playback.
    *
    * @returns
    * The AudioFrame instance, if the method call succeeds.
@@ -149,7 +138,7 @@ export abstract class IMediaEngine {
   /**
    * Configures the external video source.
    *
-   * Call this method before joining a channel.
+   * After calling this method to enable an external video source, you can call pushVideoFrame to push external video data to the SDK.
    *
    * @param enabled Whether to use the external video source: true : Use the external video source. The SDK prepares to accept the external video frame. false : (Default) Do not use the external video source.
    * @param useTexture Whether to use the external video frame in the Texture format. true : Use the external video frame in the Texture format. false : (Default) Do not use the external video frame in the Texture format.
@@ -170,7 +159,7 @@ export abstract class IMediaEngine {
   /**
    * Sets the external audio source parameters.
    *
-   * Deprecated: This method is deprecated, use createCustomAudioTrack instead. Call this method before joining a channel.
+   * Deprecated: This method is deprecated, use createCustomAudioTrack instead.
    *
    * @param enabled Whether to enable the external audio source: true : Enable the external audio source. false : (Default) Disable the external audio source.
    * @param sampleRate The sample rate (Hz) of the external audio source which can be set as 8000, 16000, 32000, 44100, or 48000.
@@ -193,7 +182,7 @@ export abstract class IMediaEngine {
   /**
    * Creates a custom audio track.
    *
-   * Ensure that you call this method before joining a channel. To publish a custom audio source, see the following steps:
+   * Call this method before joining a channel. To publish a custom audio source, see the following steps:
    *  Call this method to create a custom audio track and get the audio track ID.
    *  Call joinChannel to join the channel. In ChannelMediaOptions, set publishCustomAudioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to true.
    *  Call pushAudioFrame and specify trackId as the audio track ID set in step 2. You can then publish the corresponding custom audio source in the channel.
@@ -224,7 +213,7 @@ export abstract class IMediaEngine {
   /**
    * Sets the external audio sink.
    *
-   * This method applies to scenarios where you want to use external audio data for playback. After you set the external audio sink, you can call pullAudioFrame to pull remote audio frames. The app can process the remote audio and play it with the audio effects that you want.
+   * After enabling the external audio sink, you can call pullAudioFrame to pull remote audio frames. The app can process the remote audio and play it with the audio effects that you want.
    *
    * @param enabled Whether to enable or disable the external audio sink: true : Enables the external audio sink. false : (Default) Disables the external audio sink.
    * @param sampleRate The sample rate (Hz) of the external audio sink, which can be set as 16000, 32000, 44100, or 48000.

package/ts/Private/IAgoraMediaPlayer.ts

@@ -31,7 +31,7 @@ export abstract class IMediaPlayer {
   /**
    * Opens the media resource.
    *
-   * This method is called asynchronously. If you need to play a media file, make sure you receive the onPlayerSourceStateChanged callback reporting PlayerStateOpenCompleted before calling the play method to play the file.
+   * This method is called asynchronously.
    *
    * @param url The path of the media file. Both local path and online path are supported.
    * @param startPos The starting position (ms) for playback. Default value is 0.
@@ -58,8 +58,6 @@ export abstract class IMediaPlayer {
   /**
    * Plays the media file.
    *
-   * After calling open or seek, you can call this method to play the media file.
-   *
    * @returns
    * 0: Success.
    *  < 0: Failure.
@@ -78,6 +76,8 @@ export abstract class IMediaPlayer {
   /**
    * Stops playing the media track.
    *
+   * After calling this method to stop playback, if you want to play again, you need to call open or openWithMediaSource to open the media resource.
+   *
    * @returns
    * 0: Success.
    *  < 0: Failure.
@@ -96,9 +96,8 @@ export abstract class IMediaPlayer {
   /**
    * Seeks to a new playback position.
    *
-   * After successfully calling this method, you will receive the onPlayerEvent callback, reporting the result of the seek operation to the new playback position. To play the media file from a specific position, do the following:
-   *  Call this method to seek to the position you want to begin playback.
-   *  Call the play method to play the media file.
+   * If you call seek after the playback has completed (upon receiving callback onPlayerSourceStateChanged reporting playback status as PlayerStatePlaybackCompleted or PlayerStatePlaybackAllLoopsCompleted), the SDK will play the media file from the specified position. At this point, you will receive callback onPlayerSourceStateChanged reporting playback status as PlayerStatePlaying.
+   *  If you call seek while the playback is paused, upon successful call of this method, the SDK will seek to the specified position. To resume playback, call resume or play .
    *
    * @param newPos The new playback position (ms).
    *
@@ -152,8 +151,6 @@ export abstract class IMediaPlayer {
   /**
    * Gets the detailed information of the media stream.
    *
-   * Call this method after calling getStreamCount.
-   *
    * @param index The index of the media stream. This parameter must be less than the return value of getStreamCount.
    *
    * @returns
@@ -168,6 +165,8 @@ export abstract class IMediaPlayer {
    * If you want to loop, call this method and set the number of the loops. When the loop finishes, the SDK triggers onPlayerSourceStateChanged and reports the playback state as PlayerStatePlaybackAllLoopsCompleted.
    *
    * @param loopCount The number of times the audio effect loops:
+   *  ≥0: Number of times for playing. For example, setting it to 0 means no loop playback, playing only once; setting it to 1 means loop playback once, playing a total of twice.
+   *  -1: Play the audio file in an infinite loop.
    *
    * @returns
    * 0: Success.
@@ -314,6 +313,8 @@ export abstract class IMediaPlayer {
   /**
    * Sets the view.
    *
+   * @param view The render view. On Windows, this parameter sets the window handle (HWND).
+   *
    * @returns
    * 0: Success.
    *  < 0: Failure.
@@ -567,9 +568,9 @@ export abstract class IMediaPlayer {
   abstract setSoundPositionParams(pan: number, gain: number): number;
 
   /**
-   * Set media player options for providing technical previews or special customization features.
+   * Sets media player options.
    *
-   * The media player supports setting options through key and value. In general, you don't need to know about the option settings. You can use the default option settings of the media player. The difference between this method and setPlayerOptionInString is that the value parameter of this method is of type Int, while the value of setPlayerOptionInString is of type String. These two methods cannot be used together. Ensure that you call this method before open or openWithMediaSource.
+   * The media player supports setting options through key and value. The difference between this method and setPlayerOptionInString is that the value parameter of this method is of type Int, while the value of setPlayerOptionInString is of type String. These two methods cannot be used together.
    *
    * @param key The key of the option.
    * @param value The value of the key.
@@ -581,9 +582,9 @@ export abstract class IMediaPlayer {
   abstract setPlayerOptionInInt(key: string, value: number): number;
 
   /**
-   * Set media player options for providing technical previews or special customization features.
+   * Sets media player options.
    *
-   * Ensure that you call this method before open or openWithMediaSource. The media player supports setting options through key and value. In general, you don't need to know about the option settings. You can use the default option settings of the media player. The difference between this method and setPlayerOptionInInt is that the value parameter of this method is of type String, while the value of setPlayerOptionInInt is of type String. These two methods cannot be used together.
+   * The media player supports setting options through key and value. The difference between this method and setPlayerOptionInInt is that the value parameter of this method is of type String, while the value of setPlayerOptionInInt is of type String. These two methods cannot be used together.
    *
    * @param key The key of the option.
    * @param value The value of the key.

package/ts/Private/IAgoraMusicContentCenter.ts

@@ -289,7 +289,19 @@ export interface IMusicContentCenterEventHandler {
   ): void;
 
   /**
-   * @ignore
+   * 音乐资源的详细信息回调。
+   *
+   * 当你调用 getSongSimpleInfo 获取某一音乐资源的详细信息后，SDK 会触发该回调。
+   *
+   * @param requestId The request ID. 本次请求的唯一标识。
+   * @param songCode The code of the music, which is an unique identifier of the music.
+   * @param simpleInfo 音乐资源的相关信息，包含下列内容：
+   *  副歌片段的开始和结束的时间（ms）
+   *  副歌片段的歌词下载地址
+   *  副歌片段时长（ms）
+   *  歌曲名称
+   *  歌手名
+   * @param reason 音乐内容中心的请求状态码，详见 MusicContentCenterStateReason 。
    */
   onSongSimpleInfoResult?(
     requestId: string,