agora-electron-sdk 4.1.1-rc.1 → 4.2.0-dev.13

package/ts/Private/AgoraMediaBase.ts

@@ -1,5 +1,84 @@
 import './extension/AgoraMediaBaseExtension';
 import { EncodedVideoFrameInfo } from './AgoraBase';
+
+/**
+ * The capture type of the custom video source.
+ */
+export enum VideoSourceType {
+  /**
+   * @ignore
+   */
+  VideoSourceCameraPrimary = 0,
+  /**
+   * The camera.
+   */
+  VideoSourceCamera = 0,
+  /**
+   * The secondary camera.
+   */
+  VideoSourceCameraSecondary = 1,
+  /**
+   * The primary screen.
+   */
+  VideoSourceScreenPrimary = 2,
+  /**
+   * The screen.
+   */
+  VideoSourceScreen = 2,
+  /**
+   * The secondary screen.
+   */
+  VideoSourceScreenSecondary = 3,
+  /**
+   * The custom video source.
+   */
+  VideoSourceCustom = 4,
+  /**
+   * The video source from the media player.
+   */
+  VideoSourceMediaPlayer = 5,
+  /**
+   * The video source is a PNG image.
+   */
+  VideoSourceRtcImagePng = 6,
+  /**
+   * The video source is a JPEG image.
+   */
+  VideoSourceRtcImageJpeg = 7,
+  /**
+   * The video source is a GIF image.
+   */
+  VideoSourceRtcImageGif = 8,
+  /**
+   * The video source is remote video acquired by the network.
+   */
+  VideoSourceRemote = 9,
+  /**
+   * A transcoded video source.
+   */
+  VideoSourceTranscoded = 10,
+  /**
+   * @ignore
+   */
+  VideoSourceCameraThird = 11,
+  /**
+   * @ignore
+   */
+  VideoSourceCameraFourth = 12,
+  /**
+   * @ignore
+   */
+  VideoSourceScreenThird = 13,
+  /**
+   * @ignore
+   */
+  VideoSourceScreenFourth = 14,
+  /**
+   * An unknown video source.
+   */
+  VideoSourceUnknown = 100,
+}
+
 /**
  * The type of the audio route.
  */
@@ -374,6 +453,24 @@ export enum RenderModeType {
   RenderModeAdaptive = 3,
 }
 
+/**
+ * @ignore
+ */
+export enum CameraVideoSourceType {
+  /**
+   * @ignore
+   */
+  CameraSourceFront = 0,
+  /**
+   * @ignore
+   */
+  CameraSourceBack = 1,
+  /**
+   * @ignore
+   */
+  VideoSourceUnspecified = 2,
+}
+
 /**
  * @ignore
  */
@@ -474,11 +571,15 @@ export class ExternalVideoFrame {
    * This parameter only applies to video data in Texture format. The MetaData size. The default value is 0.
    */
   metadata_size?: number;
+  /**
+   * @ignore
+   */
+  alphaBuffer?: Uint8Array;
 }
 
 /**
  * Configurations of the video frame.
- * The video data format is YUV420. Note that the buffer provides a pointer to a pointer. This interface cannot modify the pointer of the buffer, but it can modify the content of the buffer.
+ * Note that the buffer provides a pointer to a pointer. This interface cannot modify the pointer of the buffer, but it can modify the content of the buffer.
  */
 export class VideoFrame {
   /**
@@ -549,6 +650,10 @@ export class VideoFrame {
    * @ignore
    */
   alphaBuffer?: Uint8Array;
+  /**
+   * @ignore
+   */
+  pixelBuffer?: Uint8Array;
 }
 
 /**
@@ -587,6 +692,19 @@ export enum VideoModulePosition {
   PositionPreEncoder = 1 << 2,
 }
 
+/**
+ * @ignore
+ */
+export interface IAudioPcmFrameSink {
+  /**
+   * Occurs each time the player receives a video frame.
+   * After registering the video frame observer, the callback occurs every time the player receives a video frame, reporting the detailed information of the video frame.
+   *
+   * @param frame Video frame information. See VideoFrame .
+   */
+  onFrame?(frame: AudioPcmFrame): void;
+}
+
 /**
  * Audio frame type.
  */
@@ -693,12 +811,11 @@ export class AudioParams {
  */
 export interface IAudioFrameObserverBase {
   /**
-   * Gets the captured audio frame.
-   * To ensure that the data format of captured audio frame is as expected, Agora recommends that you set the audio data format as follows: After calling setRecordingAudioFrameParameters to set the audio data format, call registerAudioFrameObserver to register the audio observer object, the SDK will calculate the sampling interval according to the parameters set in this method, and triggers the onRecordAudioFrame callback according to the sampling interval.
-   *
-   * @param audioFrame The raw audio data. See AudioFrame .
+   * Gets the raw audio frame for playback.
+   * To ensure that the data format of audio frame for playback is as expected, Agora recommends that you set the audio data format as follows: After calling setPlaybackAudioFrameParameters to set the audio data format and registerAudioFrameObserver to register the audio frame observer object, the SDK calculates the sampling interval according to the parameters set in the methods, and triggers the onPlaybackAudioFrame callback according to the sampling interval.
    *
    * @param channelId The channel ID.
+   * @param audioFrame The raw audio data. See AudioFrame .
    *
    * @returns
    * Reserved for future use.
@@ -709,9 +826,8 @@ export interface IAudioFrameObserverBase {
    * Gets the raw audio frame for playback.
    * To ensure that the data format of audio frame for playback is as expected, Agora recommends that you set the audio data format as follows: After calling setPlaybackAudioFrameParameters to set the audio data format and registerAudioFrameObserver to register the audio frame observer object, the SDK calculates the sampling interval according to the parameters set in the methods, and triggers the onPlaybackAudioFrame callback according to the sampling interval.
    *
-   * @param audioFrame The raw audio data. See AudioFrame .
-   *
    * @param channelId The channel ID.
+   * @param audioFrame The raw audio data. See AudioFrame .
    *
    * @returns
    * Reserved for future use.
@@ -719,12 +835,11 @@ export interface IAudioFrameObserverBase {
   onPlaybackAudioFrame?(channelId: string, audioFrame: AudioFrame): boolean;
 
   /**
-   * Retrieves the mixed captured and playback audio frame.
-   * To ensure that the data format of mixed captured and playback audio frame meets the expectations, Agora recommends that you set the data format as follows: After calling setMixedAudioFrameParameters to set the audio data format and registerAudioFrameObserver to register the audio frame observer object, the SDK calculates the sampling interval according to the parameters set in the methods, and triggers the onMixedAudioFrame callback according to the sampling interval.
-   *
-   * @param audioFrame The raw audio data. See AudioFrame .
+   * Gets the raw audio frame for playback.
+   * To ensure that the data format of audio frame for playback is as expected, Agora recommends that you set the audio data format as follows: After calling setPlaybackAudioFrameParameters to set the audio data format and registerAudioFrameObserver to register the audio frame observer object, the SDK calculates the sampling interval according to the parameters set in the methods, and triggers the onPlaybackAudioFrame callback according to the sampling interval.
    *
    * @param channelId The channel ID.
+   * @param audioFrame The raw audio data. See AudioFrame .
    *
    * @returns
    * Reserved for future use.
@@ -749,9 +864,7 @@ export interface IAudioFrameObserver extends IAudioFrameObserverBase {
    * Retrieves the audio frame of a specified user before mixing.
    *
    * @param channelId The channel ID.
-   *
    * @param uid The user ID of the specified user.
-   *
    * @param audioFrame The raw audio data. See AudioFrame .
    *
    * @returns
@@ -798,12 +911,12 @@ export class UserAudioSpectrumInfo {
 export interface IAudioSpectrumObserver {
   /**
    * Gets the statistics of a local audio spectrum.
-   * After successfully calling registerAudioSpectrumObserver to implement the onLocalAudioSpectrum callback in IAudioSpectrumObserver and calling enableAudioSpectrumMonitor to enable audio spectrum monitoring, the SDK will trigger the callback as the time interval you set to report the received remote audio data spectrum.
+   * After successfully calling registerAudioSpectrumObserver to implement the onLocalAudioSpectrumcallback in IAudioSpectrumObserver and calling enableAudioSpectrumMonitor to enable audio spectrum monitoring, the SDK will trigger the callback as the time interval you set to report the received remote audio data spectrum.
    *
    * @param data The audio spectrum data of the local user. See AudioSpectrumData .
    *
    * @returns
-   * Whether you have received the spectrum data:true: Spectrum data is received.false: No spectrum data is received.
+   * Whether the spectrum data is received:true: Spectrum data is received.false: No spectrum data is received.
    */
   onLocalAudioSpectrum?(data: AudioSpectrumData): boolean;
 
@@ -812,11 +925,10 @@ export interface IAudioSpectrumObserver {
    * After successfully calling registerAudioSpectrumObserver to implement the onRemoteAudioSpectrum callback in the IAudioSpectrumObserver and calling enableAudioSpectrumMonitor to enable audio spectrum monitoring, the SDK will trigger the callback as the time interval you set to report the received remote audio data spectrum.
    *
    * @param spectrums The audio spectrum information of the remote user, see UserAudioSpectrumInfo . The number of arrays is the number of remote users monitored by the SDK. If the array is null, it means that no audio spectrum of remote users is detected.
-   *
    * @param spectrumNumber The number of remote users.
    *
    * @returns
-   * Whether you have received the spectrum data:true: Spectrum data is received.false: No spectrum data is received.
+   * Whether the spectrum data is received:true: Spectrum data is received.false: No spectrum data is received.
    */
   onRemoteAudioSpectrum?(
     spectrums: UserAudioSpectrumInfo[],
@@ -833,11 +945,8 @@ export interface IVideoEncodedFrameObserver {
    * 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.
-   *
    * @param length The data length of the video image.
-   *
    * @param videoEncodedFrameInfo For the information of the encoded video frame, see EncodedVideoFrameInfo .
    *
    * @returns
@@ -871,112 +980,56 @@ export enum VideoFrameProcessMode {
 export interface IVideoFrameObserver {
   /**
    * Occurs each time the SDK receives a video frame captured by the local camera.
-   * 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 the local camera. You can then pre-process the data according to your scenarios.After pre-processing, you can send the processed video data back to the SDK through this callback.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, Agora 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 the local camera. You can then pre-process the data according to your scenarios.After pre-processing, you can send the processed video data back to the SDK through this callback.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 videoFrame The video frame. See VideoFrame .
+   * @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
    *
    * @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.
    */
-  onCaptureVideoFrame?(videoFrame: VideoFrame): boolean;
+  onCaptureVideoFrame?(
+    sourceType: VideoSourceType,
+    videoFrame: VideoFrame
+  ): boolean;
 
   /**
    * 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.
    *
-   * @param videoFrame The video frame. See VideoFrame .
+   * @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
    *
    * @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.
    */
-  onPreEncodeVideoFrame?(videoFrame: VideoFrame): boolean;
+  onPreEncodeVideoFrame?(
+    sourceType: VideoSourceType,
+    videoFrame: VideoFrame
+  ): boolean;
 
   /**
    * @ignore
    */
-  onSecondaryCameraCaptureVideoFrame?(videoFrame: VideoFrame): boolean;
-
-  /**
-   * Gets the video data captured from the second camera 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 captured from the second camera 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.
-   *
-   * @param videoFrame The video frame. See VideoFrame .
-   *
-   * @returns
-   * true: Sets the SDK to receive the video frame.false: Sets the SDK to discard the video frame.
-   */
-  onSecondaryPreEncodeCameraVideoFrame?(videoFrame: VideoFrame): boolean;
-
-  /**
-   * Occurs each time the SDK receives a video frame captured by the screen.
-   * 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 for screen sharing. You can then pre-process the data according to your scenarios.After pre-processing, you can send the processed video data back to the SDK through this callback.This callback does not support sending processed RGBA video data back to the SDK.The video data that this callback gets has not been pre-processed, and is not watermarked, cropped, rotated or beautified.
-   *
-   * @param videoFrame The video frame. See VideoFrame .
-   *
-   * @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.
-   */
-  onScreenCaptureVideoFrame?(videoFrame: VideoFrame): boolean;
-
-  /**
-   * Gets the video data captured from the screen 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 captured from the screen 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.This callback does not support sending processed RGBA video data back to the SDK.
-   *
-   * @param videoFrame The video frame. See VideoFrame .
-   *
-   * @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.
-   */
-  onPreEncodeScreenVideoFrame?(videoFrame: VideoFrame): boolean;
-
-  /**
-   * Gets the video data of the media player.
-   * After you successfully register the video frame observer and calling the createMediaPlayer method, the SDK triggers this callback each time when it receives a video frame. In this callback, you can get the video data of the media player. You can then process the data according to your particular scenarios.This callback only supports read-only mode.
-   *
-   * @param videoFrame The video frame. See VideoFrame .
-   *
-   * @param mediaPlayerId The ID of the media player.
-   *
-   * @returns
-   * true: Reserved for future use.false: Reserved for future use.
-   */
   onMediaPlayerVideoFrame?(
     videoFrame: VideoFrame,
     mediaPlayerId: number
   ): boolean;
 
-  /**
-   * @ignore
-   */
-  onSecondaryScreenCaptureVideoFrame?(videoFrame: VideoFrame): boolean;
-
-  /**
-   * Gets the video data captured from the second screen 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 captured from the second screen 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.
-   *
-   * @param videoFrame The video frame. See VideoFrame .
-   *
-   * @returns
-   * true: Sets the SDK to receive the video frame.false: Sets the SDK to discard the video frame.
-   */
-  onSecondaryPreEncodeScreenVideoFrame?(videoFrame: VideoFrame): boolean;
-
   /**
    * 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 before encoding. You can then process the data according to your particular scenarios.If the video data type you get is RGBA, Agora does not support processing the data of the alpha channel.
-   *
-   * @param videoFrame The video frame. See VideoFrame .
-   *
-   * @param remoteUid The user ID of the remote user who sends the current video frame.
+   * 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 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.
+   *  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,
@@ -985,7 +1038,13 @@ export interface IVideoFrameObserver {
   ): boolean;
 
   /**
-   * @ignore
+   * 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.
+   *
+   * @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
+   *
+   * @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.
    */
   onTranscodedVideoFrame?(videoFrame: VideoFrame): boolean;
 }
@@ -1129,10 +1188,14 @@ export interface IMediaRecorderObserver {
    * When the local audio or video recording state changes, the SDK triggers this callback to report the current recording state and the reason for the change.
    *
    * @param state The current recording state. See RecorderState .
-   *
    * @param error The reason for the state change. See RecorderErrorCode .
    */
-  onRecorderStateChanged?(state: RecorderState, error: RecorderErrorCode): void;
+  onRecorderStateChanged?(
+    channelId: string,
+    uid: number,
+    state: RecorderState,
+    error: RecorderErrorCode
+  ): void;
 
   /**
    * Occurs when the recording information is updated.
@@ -1140,5 +1203,9 @@ export interface IMediaRecorderObserver {
    *
    * @param info The information about the file that is recorded. See RecorderInfo .
    */
-  onRecorderInfoUpdated?(info: RecorderInfo): void;
+  onRecorderInfoUpdated?(
+    channelId: string,
+    uid: number,
+    info: RecorderInfo
+  ): void;
 }

package/ts/Private/AgoraMediaPlayerTypes.ts

@@ -404,7 +404,7 @@ export class MediaSource {
    */
   autoPlay?: boolean;
   /**
-   * Whether to cache the media file when it is being played:true:Enables caching.false: (Default) Disables caching.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.The SDK only supports caching on-demand streams.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;
   /**

package/ts/Private/IAgoraMediaEngine.ts

@@ -1,14 +1,19 @@
 import './extension/IAgoraMediaEngineExtension';
 import {
-  IAudioFrameObserver,
-  IVideoFrameObserver,
-  IVideoEncodedFrameObserver,
-  MediaSourceType,
+  AudioTrackConfig,
+  AudioTrackType,
+  EncodedVideoFrameInfo,
+  SenderOptions,
+} from './AgoraBase';
+import {
   AudioFrame,
-  ExternalVideoSourceType,
   ExternalVideoFrame,
+  ExternalVideoSourceType,
+  IAudioFrameObserver,
+  IVideoEncodedFrameObserver,
+  IVideoFrameObserver,
 } from './AgoraMediaBase';
-import { SenderOptions, EncodedVideoFrameInfo } from './AgoraBase';
+
 /**
  * The channel mode.
  */
@@ -48,9 +53,18 @@ export abstract class IMediaEngine {
 
   /**
    * 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 .
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract registerVideoFrameObserver(observer: IVideoFrameObserver): number;
 
@@ -71,41 +85,21 @@ export abstract class IMediaEngine {
    * Pushes the external audio frame.
    *
    * @param type The type of the audio recording device. See MediaSourceType .
-   *
    * @param frame The external audio frame. See AudioFrame .
-   *
    * @param wrap Whether to use the placeholder. Agora recommends using the default value.true: Use the placeholder.false: (Default) Do not use the placeholder.
-   *
    * @param sourceId The ID of external audio source. 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.
    */
-  abstract pushAudioFrame(
-    type: MediaSourceType,
-    frame: AudioFrame,
-    wrap?: boolean,
-    sourceId?: number
-  ): number;
-
-  /**
-   * @ignore
-   */
-  abstract pushCaptureAudioFrame(frame: AudioFrame): number;
-
-  /**
-   * @ignore
-   */
-  abstract pushReverseAudioFrame(frame: AudioFrame): number;
-
-  /**
-   * @ignore
-   */
-  abstract pushDirectAudioFrame(frame: AudioFrame): number;
+  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.
+   *
+   * @returns
+   * The AudioFrame instance, if the method call succeeds.An error code, if the call fails,.
    */
   abstract pullAudioFrame(): AudioFrame;
 
@@ -114,11 +108,8 @@ export abstract class IMediaEngine {
    * 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 sourceType Whether to encode the external video frame, see ExternalVideoSourceType .
-   *
+   * @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 .
    *
    * @returns
@@ -132,19 +123,14 @@ export abstract class IMediaEngine {
   ): number;
 
   /**
-   * Sets the external captured audio parameters and chooses whether to publish the audio to the remote user.
+   * Sets the external audio source parameters.
    * 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 sampleRate The sample rate (Hz) of the external audio source, which can be set as 8000, 16000, 32000, 44100, or 48000.
-   *
+   * @param sampleRate The sample rate (Hz) of the external audio 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.
    *
    * @returns
@@ -154,19 +140,29 @@ export abstract class IMediaEngine {
     enabled: boolean,
     sampleRate: number,
     channels: number,
-    sourceNumber?: number,
     localPlayback?: boolean,
     publish?: boolean
   ): number;
 
+  /**
+   * @ignore
+   */
+  abstract createCustomAudioTrack(
+    trackType: AudioTrackType,
+    config: AudioTrackConfig
+  ): number;
+
+  /**
+   * @ignore
+   */
+  abstract destroyCustomAudioTrack(trackId: number): number;
+
   /**
    * 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.
    *
    * @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.
    *
    * @returns
@@ -182,24 +178,15 @@ export abstract class IMediaEngine {
    * @ignore
    */
   abstract enableCustomAudioLocalPlayback(
-    sourceId: number,
+    trackId: number,
     enabled: boolean
   ): number;
 
-  /**
-   * @ignore
-   */
-  abstract setDirectExternalAudioSource(
-    enable: boolean,
-    localPlayback?: boolean
-  ): number;
-
   /**
    * Pushes the external raw video frame to the SDK.
-   * To push the unencoded external raw video frame to the SDK, call createCustomVideoTrack to get the video track ID, set customVideoTrackId as the video track ID you want to publish in the ChannelMediaOptions of each channel, and set publishCustomVideoTrack as true.
+   * 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