agora-electron-sdk 4.2.2-dev.4 → 4.2.2-dev.7

package/ts/Private/AgoraMediaBase.ts

@@ -62,15 +62,15 @@ export enum VideoSourceType {
    */
   VideoSourceCameraThird = 11,
   /**
-   * 12:The fourth camera.
+   * 12: The fourth camera.
    */
   VideoSourceCameraFourth = 12,
   /**
-   * 13:The third screen.
+   * 13: The third screen.
    */
   VideoSourceScreenThird = 13,
   /**
-   * 14:The fourth screen.
+   * 14: The fourth screen.
    */
   VideoSourceScreenFourth = 14,
   /**
@@ -270,7 +270,7 @@ export enum ContentInspectType {
 }
 
 /**
- * A structure used to configure the frequency of video screenshot and upload.ContentInspectModule
+ * A ContentInspectModule structure used to configure the frequency of video screenshot and upload.
  */
 export class ContentInspectModule {
   /**
@@ -288,11 +288,11 @@ export class ContentInspectModule {
  */
 export class ContentInspectConfig {
   /**
-   * Additional information on the video content (maximum length: 1024 Bytes).The SDK sends the screenshots and additional information on the video content to the Agora server. Once the video screenshot and upload process is completed, the Agora server sends the additional information and the callback notification to your server.
+   * Additional information on the video content (maximum length: 1024 Bytes). The SDK sends the screenshots and additional information on the video content to the Agora server. Once the video screenshot and upload process is completed, the Agora server sends the additional information and the callback notification to your server.
    */
   extraInfo?: string;
   /**
-   * Functional module. See ContentInspectModule.A maximum of 32 ContentInspectModule instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].A function module can only be configured with one instance at most. Currently only the video screenshot and upload function is supported.
+   * Functional module. See ContentInspectModule. A maximum of 32 ContentInspectModule instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32]. A function module can only be configured with one instance at most. Currently only the video screenshot and upload function is supported.
    */
   modules?: ContentInspectModule[];
   /**
@@ -433,6 +433,10 @@ export enum VideoPixelFormat {
    * 16: The format is I422.
    */
   VideoPixelI422 = 16,
+  /**
+   * @ignore
+   */
+  VideoTextureId3d11texture2d = 17,
 }
 
 /**
@@ -575,6 +579,14 @@ export class ExternalVideoFrame {
    * @ignore
    */
   alphaBuffer?: Uint8Array;
+  /**
+   * @ignore
+   */
+  d3d11_texture_2d?: any;
+  /**
+   * @ignore
+   */
+  texture_slice_index?: number;
 }
 
 /**
@@ -643,6 +655,10 @@ export class VideoFrame {
    * This parameter only applies to video data in Texture format. Texture ID.
    */
   textureId?: number;
+  /**
+   * @ignore
+   */
+  d3d11Texture2d?: any;
   /**
    * This parameter only applies to video data in Texture format. Incoming 4 × 4 transformational matrix. The typical value is a unit matrix.
    */
@@ -736,7 +752,9 @@ export class AudioFrame {
    */
   bytesPerSample?: BytesPerSample;
   /**
-   * The number of audio channels (the data are interleaved if it is stereo).1: Mono.2: Stereo.
+   * The number of audio channels (the data are interleaved if it is stereo).
+   *  1: Mono.
+   *  2: Stereo.
    */
   channels?: number;
   /**
@@ -744,11 +762,11 @@ export class AudioFrame {
    */
   samplesPerSec?: number;
   /**
-   * The data buffer of the audio frame. When the audio frame uses a stereo channel, the data buffer is interleaved.The size of the data buffer is as follows: buffer = samples × channels × bytesPerSample.
+   * The data buffer of the audio frame. When the audio frame uses a stereo channel, the data buffer is interleaved. The size of the data buffer is as follows: buffer = samples × channels × bytesPerSample.
    */
   buffer?: Uint8Array;
   /**
-   * The timestamp (ms) of the external audio frame.You can use this timestamp to restore the order of the captured audio frame, and synchronize audio and video frames in video scenarios, including scenarios where external video sources are used.
+   * The timestamp (ms) of the external audio frame. You can use this timestamp to restore the order of the captured audio frame, and synchronize audio and video frames in video scenarios, including scenarios where external video sources are used.
    */
   renderTimeMs?: number;
   /**
@@ -794,15 +812,24 @@ export enum AudioFramePosition {
 /**
  * Audio data format.
  *
- * The SDK sets the audio data format in the following callbacks according to AudioParams . onRecordAudioFrame onPlaybackAudioFrame onMixedAudioFrame The SDK calculates the sampling interval through the samplesPerCall , sampleRate , and channel parameters in AudioParams , and triggers the onRecordAudioFrame , onPlaybackAudioFrame , onMixedAudioFrame , and onEarMonitoringAudioFrame callbacks according to the sampling interval. Sample interval (sec) = samplePerCall /( sampleRate × channel ) . Ensure that the sample interval ≥ 0.01 (s).
+ * The SDK sets the audio data format in the following callbacks according to AudioParams. onRecordAudioFrame onPlaybackAudioFrame onMixedAudioFrame
+ *  The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in AudioParams, and triggers the onRecordAudioFrame, onPlaybackAudioFrame, onMixedAudioFrame, and onEarMonitoringAudioFrame callbacks according to the sampling interval. Sample interval (sec) = samplePerCall /(sampleRate × channel).
+ *  Ensure that the sample interval ≥ 0.01 (s).
  */
 export class AudioParams {
   /**
-   * The audio sample rate (Hz), which can be set as one of the following values:8000.(Default) 16000.32000.4410048000
+   * The audio sample rate (Hz), which can be set as one of the following values:
+   *  8000.
+   *  (Default) 16000.
+   *  32000.
+   *  44100
+   *  48000
    */
   sample_rate?: number;
   /**
-   * The number of audio channels, which can be set as either of the following values:1: (Default) Mono.2: Stereo.
+   * The number of audio channels, which can be set as either of the following values:
+   *  1: (Default) Mono.
+   *  2: Stereo.
    */
   channels?: number;
   /**
@@ -828,7 +855,7 @@ export interface IAudioFrameObserverBase {
    * @param audioFrame The raw audio data. See AudioFrame.
    *
    * @returns
-   * Reserved for future use.
+   * Without practical meaning.
    */
   onRecordAudioFrame?(channelId: string, audioFrame: AudioFrame): void;
 
@@ -841,7 +868,7 @@ export interface IAudioFrameObserverBase {
    * @param audioFrame The raw audio data. See AudioFrame.
    *
    * @returns
-   * Reserved for future use.
+   * Without practical meaning.
    */
   onPlaybackAudioFrame?(channelId: string, audioFrame: AudioFrame): void;
 
@@ -854,7 +881,7 @@ export interface IAudioFrameObserverBase {
    * @param audioFrame The raw audio data. See AudioFrame.
    *
    * @returns
-   * Reserved for future use.
+   * Without practical meaning.
    */
   onMixedAudioFrame?(channelId: string, audioFrame: AudioFrame): void;
 
@@ -866,7 +893,7 @@ export interface IAudioFrameObserverBase {
    * @param audioFrame The raw audio data. See AudioFrame.
    *
    * @returns
-   * Reserved for future use.
+   * Without practical meaning.
    */
   onEarMonitoringAudioFrame?(audioFrame: AudioFrame): void;
 }
@@ -883,7 +910,7 @@ export interface IAudioFrameObserver extends IAudioFrameObserverBase {
    * @param audioFrame The raw audio data. See AudioFrame.
    *
    * @returns
-   * Reserved for future use.
+   * Without practical meaning.
    */
   onPlaybackAudioFrameBeforeMixing?(
     channelId: string,
@@ -960,7 +987,7 @@ export interface IVideoEncodedFrameObserver {
   /**
    * Reports that the receiver has received the to-be-decoded video frame sent by the remote end.
    *
-   * If you call the setRemoteVideoSubscriptionOptions method and set encodedFrameOnly to true , the SDK triggers this callback locally to report the received encoded video frame information.
+   * If you call the setRemoteVideoSubscriptionOptions method and set encodedFrameOnly to true, the SDK triggers this callback locally to report the received encoded video frame information.
    *
    * @param uid The user ID of the remote user.
    * @param imageBuffer The encoded video image buffer.
@@ -968,7 +995,7 @@ export interface IVideoEncodedFrameObserver {
    * @param videoEncodedFrameInfo For the information of the encoded video frame, see EncodedVideoFrameInfo.
    *
    * @returns
-   * Reserved for future use.
+   * Without practical meaning.
    */
   onEncodedVideoFrameReceived?(
     uid: number,
@@ -983,11 +1010,11 @@ export interface IVideoEncodedFrameObserver {
  */
 export enum VideoFrameProcessMode {
   /**
-   * Read-only mode.In this mode, you do not modify the video frame. The video frame observer is a renderer.
+   * Read-only mode. In this mode, you do not modify the video frame. The video frame observer is a renderer.
    */
   ProcessModeReadOnly = 0,
   /**
-   * Read and write mode.In this mode, you modify the video frame. The video frame observer is a video filter.
+   * Read and write mode. In this mode, you modify the video frame. The video frame observer is a video filter.
    */
   ProcessModeReadWrite = 1,
 }
@@ -999,13 +1026,18 @@ export interface IVideoFrameObserver {
   /**
    * Occurs each time the SDK receives a video frame captured by local devices.
    *
-   * 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 captured by local devices. You can then pre-process the data according to your scenarios. Once the pre-processing is complete, you can directly modify videoFrame in this callback, and set the return value to true to send the modified video data to the SDK. The video data that this callback gets has not been pre-processed, and is not watermarked, cropped, rotated or beautified. If the video data type you get is RGBA, the SDK does not support processing the data of the alpha channel.
+   * 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 captured by local devices. You can then pre-process the data according to your scenarios. Once the pre-processing is complete, you can directly modify videoFrame in this callback, and set the return value to true to send the modified video data to the SDK.
+   *  The video data that this callback gets has not been pre-processed, and is not watermarked, cropped, rotated or beautified.
+   *  If the video data type you get is RGBA, the SDK does not support processing the data of the alpha channel.
    *
    * @param sourceType Video source types, including cameras, screens, or media player. See VideoSourceType.
-   * @param videoFrame The video frame. See VideoFrame.The default value of the video frame data format obtained through this callback is as follows:macOS: YUV 420Windows: YUV 420
+   * @param videoFrame The video frame. See VideoFrame. The default value of the video frame data format obtained through this callback is as follows:
+   *  macOS: YUV 420
+   *  Windows: YUV 420
    *
    * @returns
-   * When the video processing mode is ProcessModeReadOnly : true : Reserved for future use. false : Reserved for future use. When the video processing mode is ProcessModeReadWrite : true : Sets the SDK to receive the video frame. false : Sets the SDK to discard the video frame.
+   * When the video processing mode is ProcessModeReadOnly : true : Reserved for future use. false : Reserved for future use.
+   *  When the video processing mode is ProcessModeReadWrite : true : Sets the SDK to receive the video frame. false : Sets the SDK to discard the video frame.
    */
   onCaptureVideoFrame?(
     sourceType: VideoSourceType,
@@ -1015,19 +1047,17 @@ 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. The video data that this callback gets has been preprocessed, with its content cropped and rotated, and the image enhanced.
+   * 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.
+   *  The video data that this callback gets has been preprocessed, with its content cropped and rotated, and the image enhanced.
    *
    * @param sourceType The type of the video source. See VideoSourceType.
-   * @param videoFrame The video frame. See VideoFrame.The default value of the video frame data format obtained through this callback is as follows:
+   * @param videoFrame The video frame. See VideoFrame. The default value of the video frame data format obtained through this callback is as follows:
    *  macOS: YUV 420
    *  Windows: YUV 420
    *
    * @returns
-   * When the video processing mode is ProcessModeReadOnly :
-   *  true : Reserved for future use.
-   *  false : Reserved for future use. When the video processing mode is ProcessModeReadWrite :
-   *  true : Sets the SDK to receive the video frame.
-   *  false : Sets the SDK to discard the video frame.
+   * When the video processing mode is ProcessModeReadOnly : true : Reserved for future use. false : Reserved for future use.
+   *  When the video processing mode is ProcessModeReadWrite : true : Sets the SDK to receive the video frame. false : Sets the SDK to discard the video frame.
    */
   onPreEncodeVideoFrame?(
     sourceType: VideoSourceType,
@@ -1042,14 +1072,18 @@ 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. If the video data type you get is RGBA, the SDK does not support processing the data of the alpha channel.
+   * 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.
+   *  If the video data type you get is RGBA, the SDK does not support processing the data of the alpha channel.
    *
    * @param channelId The channel ID.
    * @param remoteUid The user ID of the remote user who sends the current video frame.
-   * @param videoFrame The video frame. See VideoFrame.The default value of the video frame data format obtained through this callback is as follows:macOS: YUV 420Windows: YUV 420
+   * @param videoFrame The video frame. See VideoFrame. The default value of the video frame data format obtained through this callback is as follows:
+   *  macOS: YUV 420
+   *  Windows: YUV 420
    *
    * @returns
-   * When the video processing mode is ProcessModeReadOnly : true : Reserved for future use. false : Reserved for future use. When the video processing mode is ProcessModeReadWrite : true : Sets the SDK to receive the video frame. false : Sets the SDK to discard the video frame.
+   * When the video processing mode is ProcessModeReadOnly : true : Reserved for future use. false : Reserved for future use.
+   *  When the video processing mode is ProcessModeReadWrite : true : Sets the SDK to receive the video frame. false : Sets the SDK to discard the video frame.
    */
   onRenderVideoFrame?(
     channelId: string,

package/ts/Private/AgoraMediaPlayerTypes.ts

@@ -378,7 +378,7 @@ export class PlayerUpdatedInfo {
    */
   deviceId?: string;
   /**
-   * The statistics about the media file being cached.If you call the openWithMediaSource method and set enableCache as true, the statistics about the media file being cached is updated every second after the media file is played. See CacheStatistics.
+   * The statistics about the media file being cached. If you call the openWithMediaSource method and set enableCache as true, the statistics about the media file being cached is updated every second after the media file is played. See CacheStatistics.
    */
   cacheStatistics?: CacheStatistics;
 }
@@ -400,19 +400,22 @@ export class MediaSource {
    */
   startPos?: number;
   /**
-   * Whether to enable autoplay once the media file is opened:true: (Default) Enables autoplay.false: Disables autoplay.If autoplay is disabled, you need to call the play method to play a media file after it is opened.
+   * Whether to enable autoplay once the media file is opened: true : (Default) Enables autoplay. false : Disables autoplay. If autoplay is disabled, you need to call the play method to play a media file after it is opened.
    */
   autoPlay?: boolean;
   /**
-   * Whether to cache the media file when it is being played:true:Enables caching.false: (Default) Disables caching.Agora only supports caching on-demand audio and video streams that are not transmitted in HLS protocol.If you need to enable caching, pass in a value to uri; otherwise, caching is based on the url of the media file.If you enable this function, the Media Player caches part of the media file being played on your local device, and you can play the cached media file without internet connection. The statistics about the media file being cached are updated every second after the media file is played. See CacheStatistics.
+   * Whether to cache the media file when it is being played: true :Enables caching. false : (Default) Disables caching.
+   *  Agora only supports caching on-demand audio and video streams that are not transmitted in HLS protocol.
+   *  If you need to enable caching, pass in a value to uri; otherwise, caching is based on the url of the media file.
+   *  If you enable this function, the Media Player caches part of the media file being played on your local device, and you can play the cached media file without internet connection. The statistics about the media file being cached are updated every second after the media file is played. See CacheStatistics.
    */
   enableCache?: boolean;
   /**
-   * Whether the media resource to be opened is a live stream or on-demand video distributed through Media Broadcast service:true: The media resource to be played is a live or on-demand video distributed through Media Broadcast service.false: (Default) The media resource is not a live stream or on-demand video distributed through Media Broadcast service.If you need to open a live stream or on-demand video distributed through Broadcast Streaming service, pass in the URL of the media resource to url, and set isAgoraSource as true; otherwise, you don't need to set the isAgoraSource parameter.
+   * Whether the media resource to be opened is a live stream or on-demand video distributed through Media Broadcast service: true : The media resource to be played is a live or on-demand video distributed through Media Broadcast service. false : (Default) The media resource is not a live stream or on-demand video distributed through Media Broadcast service. If you need to open a live stream or on-demand video distributed through Broadcast Streaming service, pass in the URL of the media resource to url, and set isAgoraSource as true; otherwise, you don't need to set the isAgoraSource parameter.
    */
   isAgoraSource?: boolean;
   /**
-   * Whether the media resource to be opened is a live stream:true: The media resource is a live stream.false: (Default) The media resource is not a live stream.If the media resource you want to open is a live stream, Agora recommends that you set this parameter as true so that the live stream can be loaded more quickly.If the media resource you open is not a live stream, but you set isLiveSource as true, the media resource is not to be loaded more quickly.
+   * Whether the media resource to be opened is a live stream: true : The media resource is a live stream. false : (Default) The media resource is not a live stream. If the media resource you want to open is a live stream, Agora recommends that you set this parameter as true so that the live stream can be loaded more quickly. If the media resource you open is not a live stream, but you set isLiveSource as true, the media resource is not to be loaded more quickly.
    */
   isLiveSource?: boolean;
 }

package/ts/Private/IAgoraLog.ts

@@ -68,15 +68,19 @@ export enum LogFilterType {
  */
 export class LogConfig {
   /**
-   * The complete path of the log files. Ensure that the path for the log file exists and is writable. You can use this parameter to rename the log files.The default path is:macOS:If Sandbox is enabled: App Sandbox/Library/Logs/agorasdk.log. For example, /Users/<username>/Library/Containers/<AppBundleIdentifier>/Data/Library/Logs/agorasdk.log.If Sandbox is disabled: ~/Library/Logs/agorasdk.logWindows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\agorasdk.log.
+   * The complete path of the log files. Ensure that the path for the log file exists and is writable. You can use this parameter to rename the log files. The default path is:
+   *  macOS:
+   *  If Sandbox is enabled: App Sandbox/Library/Logs/agorasdk.log. For example, /Users/<username>/Library/Containers/<AppBundleIdentifier>/Data/Library/Logs/agorasdk.log.
+   *  If Sandbox is disabled: ~/Library/Logs/agorasdk.log
+   *  Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\agorasdk.log.
    */
   filePath?: string;
   /**
-   * The size (KB) of an agorasdk.log file. The value range is [128,1024]. The default value is 1,024 KB. If you set fileSizeInKByte smaller than 128 KB, the SDK automatically adjusts it to 128 KB; if you set fileSizeInKByte greater than 1,024 KB, the SDK automatically adjusts it to 1,024 KB.
+   * The size (KB) of an agorasdk.log file. The value range is [128,20480]. The default value is 2,048 KB. If you set fileSizeInKByte smaller than 128 KB, the SDK automatically adjusts it to 128 KB; if you set fileSizeInKByte greater than 20,480 KB, the SDK automatically adjusts it to 20,480 KB.
    */
   fileSizeInKB?: number;
   /**
-   * The output level of the SDK log file. See LogLevel.For example, if you set the log level to WARN, the SDK outputs the logs within levels FATAL, ERROR, and WARN.
+   * The output level of the SDK log file. See LogLevel. For example, if you set the log level to WARN, the SDK outputs the logs within levels FATAL, ERROR, and WARN.
    */
   level?: LogLevel;
 }

package/ts/Private/IAgoraMediaEngine.ts

@@ -43,36 +43,56 @@ 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 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.
    *
-   * @param observer The observer object instance. See IAudioFrameObserver. Agora recommends calling this method after receiving onLeaveChannel to release the audio observer object.
+   * @param observer The observer instance. See IAudioFrameObserver. Agora recommends calling this method after receiving onLeaveChannel to release the audio observer object.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract registerAudioFrameObserver(observer: IAudioFrameObserver): number;
 
   /**
    * Registers a raw video frame observer object.
    *
-   * If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps: Call registerVideoFrameObserver to register the raw video frame observer before joining the channel. Call registerVideoEncodedFrameObserver to register the encoded video frame observer before joining the channel. After joining the channel, get the user IDs of group B users through onUserJoined , and then call setRemoteVideoSubscriptionOptions to set the encodedFrameOnly of this group of users to true . 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.
+   * If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps:
+   *  Call registerVideoFrameObserver to register the raw video frame observer before joining the channel.
+   *  Call registerVideoEncodedFrameObserver to register the encoded video frame observer before joining the channel.
+   *  After joining the channel, get the user IDs of group B users through onUserJoined, and then call setRemoteVideoSubscriptionOptions to set the encodedFrameOnly of this group of users to true.
+   *  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 object instance. See IVideoFrameObserver.
+   * @param observer The observer instance. See IVideoFrameObserver.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract registerVideoFrameObserver(observer: IVideoFrameObserver): number;
 
   /**
    * Registers a receiver object for the encoded video image.
    *
-   * If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one IVideoEncodedFrameObserver class through this method. If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps: Call registerVideoFrameObserver to register the raw video frame observer before joining the channel. Call registerVideoEncodedFrameObserver to register the encoded video frame observer before joining the channel. After joining the channel, get the user IDs of group B users through onUserJoined , and then call setRemoteVideoSubscriptionOptions to set the encodedFrameOnly of this group of users to true . 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 . Call this method before joining a channel.
+   * If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one IVideoEncodedFrameObserver class through this method. If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps:
+   *  Call registerVideoFrameObserver to register the raw video frame observer before joining the channel.
+   *  Call registerVideoEncodedFrameObserver to register the encoded video frame observer before joining the channel.
+   *  After joining the channel, get the user IDs of group B users through onUserJoined, and then call setRemoteVideoSubscriptionOptions to set the encodedFrameOnly of this group of users to true.
+   *  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.
+   *  Call this method before joining a channel.
    *
    * @param observer The video frame observer object. See IVideoEncodedFrameObserver.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract registerVideoEncodedFrameObserver(
     observer: IVideoEncodedFrameObserver
@@ -85,32 +105,41 @@ export abstract class IMediaEngine {
    * @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.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract pushAudioFrame(frame: AudioFrame, trackId?: number): number;
 
   /**
    * Pulls the remote audio data.
    *
-   * Before calling this method, you need to call setExternalAudioSink to notify the app to enable and set the external rendering. After a successful method call, the app pulls the decoded and mixed audio data for playback. This method only supports pulling data from custom audio source. If you need to pull the data captured by the SDK, do not call this method. Call this method after joining a channel. Once you enable the external audio sink, the app will not retrieve any audio data from the onPlaybackAudioFrame callback. The difference between this method and the onPlaybackAudioFrame callback is as follows: 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. After a successful method call, the app automatically pulls the audio data from the SDK. After setting the audio data parameters, the SDK adjusts the frame buffer and avoids problems caused by jitter in the external audio playback.
+   * Before calling this method, you need to call setExternalAudioSink to notify the app to enable and set the external rendering. After a successful method call, the app pulls the decoded and mixed audio data for playback.
+   *  This method only supports pulling data from custom audio source. If you need to pull the data captured by the SDK, do not call this method.
+   *  Call this method after joining a channel.
+   *  Once you enable the external audio sink, the app will not retrieve any audio data from the onPlaybackAudioFrame callback.
+   *  The difference between this method and the onPlaybackAudioFrame callback is as follows:
+   *  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.
+   *  After a successful method call, the app automatically pulls the audio data from the SDK. After setting the audio data parameters, the SDK adjusts the frame buffer and avoids problems caused by jitter in the external audio playback.
    *
    * @returns
-   * The AudioFrame instance, if the method call succeeds. An error code, if the call fails,.
+   * The AudioFrame instance, if the method call succeeds.
+   *  An error code, if the call fails,.
    */
-  abstract pullAudioFrame(): AudioFrame;
+  abstract pullAudioFrame(frame: AudioFrame): number;
 
   /**
    * Configures the external video source.
    *
    * Call this method before joining a channel.
    *
-   * @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.
+   * @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.
    * @param sourceType Whether the external video frame is encoded. See ExternalVideoSourceType.
-   * @param encodedVideoOption Video encoding options. This parameter needs to be set if sourceType is EncodedVideoFrame. To set this parameter, contact .
+   * @param encodedVideoOption Video encoding options. This parameter needs to be set if sourceType is EncodedVideoFrame. To set this parameter, contact.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setExternalVideoSource(
     enabled: boolean,
@@ -122,17 +151,17 @@ export abstract class IMediaEngine {
   /**
    * Sets the external audio source parameters.
    *
-   * Call this method before joining a channel.
+   * Deprecated: This method is deprecated, use createCustomAudioTrack instead. Call this method before joining a channel.
    *
-   * @param enabled Whether to enable the external audio source:true: Enable the external audio source.false: (Default) Disable the external audio source.
+   * @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.
    * @param channels The number of channels of the external audio source, which can be set as 1 (Mono) or 2 (Stereo).
-   * @param sourceNumber The number of external audio sources. The value of this parameter should be larger than 0. The SDK creates a corresponding number of custom audio tracks based on this parameter value and names the audio tracks starting from 0. In ChannelMediaOptions, you can set publishCustomAudioSourceId to the audio track ID you want to publish.
-   * @param localPlayback Whether to play the external audio source:true: Play the external audio source.false: (Default) Do not play the external source.
-   * @param publish Whether to publish audio to the remote users:true: (Default) Publish audio to the remote users.false: Do not publish audio to the remote users.
+   * @param localPlayback Whether to play the external audio source: true : Play the external audio source. false : (Default) Do not play the external source.
+   * @param publish Whether to publish audio to the remote users: true : (Default) Publish audio to the remote users. false : Do not publish audio to the remote users.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setExternalAudioSource(
     enabled: boolean,
@@ -143,15 +172,19 @@ export abstract class IMediaEngine {
   ): number;
 
   /**
-   * Creates a customized audio track.
+   * Creates a custom audio track.
    *
-   * When you need to publish multiple custom captured audios in the channel, you can refer to the following steps: Call this method to create a custom audio track and get the audio track ID. In ChannelMediaOptions of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to true . If you call pushAudioFrame trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.
+   * To publish a custom audio source to multiple channels, see the following steps:
+   *  Call this method to create a custom audio track and get the audio track ID.
+   *  In ChannelMediaOptions of each channel, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to true.
+   *  If you call pushAudioFrame, and specify trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.
    *
-   * @param trackType The type of the custom audio track. See AudioTrackType.
+   * @param trackType The type of the custom audio track. See AudioTrackType. If AudioTrackDirect is specified for this parameter, you must set publishMicrophoneTrack to false in ChannelMediaOptions when calling joinChannel to join the channel; otherwise, joining the channel fails and returns the error code -2.
    * @param config The configuration of the custom audio track. See AudioTrackConfig.
    *
    * @returns
-   * If the method call is successful, the audio track ID is returned as the unique identifier of the audio track. If the method call fails, a negative value is returned.
+   * If the method call is successful, the audio track ID is returned as the unique identifier of the audio track.
+   *  If the method call fails, a negative value is returned.
    */
   abstract createCustomAudioTrack(
     trackType: AudioTrackType,
@@ -164,7 +197,8 @@ export abstract class IMediaEngine {
    * @param trackId The custom audio track ID returned in createCustomAudioTrack.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract destroyCustomAudioTrack(trackId: number): number;
 
@@ -173,12 +207,15 @@ export abstract class IMediaEngine {
    *
    * 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.
    *
-   * @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 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.
-   * @param channels The number of audio channels of the external audio sink:1: Mono.2: Stereo.
+   * @param channels The number of audio channels of the external audio sink:
+   *  1: Mono.
+   *  2: Stereo.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract setExternalAudioSink(
     enabled: boolean,
@@ -197,13 +234,14 @@ export abstract class IMediaEngine {
   /**
    * Pushes the external raw video frame to the SDK.
    *
-   * If you call createCustomVideoTrack method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the ChannelMediaOptions of each channel, and set the publishCustomVideoTrack parameter to true , you can call this method to push the unencoded external video frame to the SDK.
+   * If you call createCustomVideoTrack method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the ChannelMediaOptions of each channel, and set the publishCustomVideoTrack parameter to true, you can call this method to push the unencoded external video frame to the SDK.
    *
    * @param frame The external raw video frame to be pushed. See ExternalVideoFrame.
    * @param videoTrackId The video track ID returned by calling the createCustomVideoTrack method. The default value is 0.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract pushVideoFrame(
     frame: ExternalVideoFrame,
@@ -231,7 +269,8 @@ export abstract class IMediaEngine {
    * @param observer The audio frame observer, reporting the reception of each audio frame. See IAudioFrameObserver.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract unregisterAudioFrameObserver(observer: IAudioFrameObserver): number;
 
@@ -241,7 +280,8 @@ export abstract class IMediaEngine {
    * @param observer The video observer, reporting the reception of each video frame. See IVideoFrameObserver.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract unregisterVideoFrameObserver(observer: IVideoFrameObserver): number;
 
@@ -251,7 +291,8 @@ export abstract class IMediaEngine {
    * @param observer The video observer, reporting the reception of each video frame. See IVideoEncodedFrameObserver.
    *
    * @returns
-   * 0: Success. < 0: Failure.
+   * 0: Success.
+   *  < 0: Failure.
    */
   abstract unregisterVideoEncodedFrameObserver(
     observer: IVideoEncodedFrameObserver