[AUTO] Generate codes by terra (#1238)

Co-authored-by: guoxianzhe <[email protected]>

ts/Private/AgoraBase.ts

@@ -622,7 +622,7 @@ export enum QualityType {
    */
   QualityUnsupported = 7,
   /**
-   * 8: Detecting the network quality.
+   * 8: The last-mile network probe test is in progress.
    */
   QualityDetecting = 8,
 }
@@ -3296,7 +3296,7 @@ export class MixedAudioStream {
   /**
    * @ignore
    */
-  channelName?: string;
+  channelId?: string;
   /**
    * @ignore
    */
@@ -3314,7 +3314,7 @@ export class LocalAudioMixerConfiguration {
   /**
    * @ignore
    */
-  sourceStreams?: MixedAudioStream[];
+  audioInputStreams?: MixedAudioStream[];
   /**
    * @ignore
    */
@@ -3972,7 +3972,7 @@ export class ColorEnhanceOptions {
  */
 export enum BackgroundSourceType {
   /**
-   * 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.
+   * @ignore
    */
   BackgroundNone = 0,
   /**
@@ -4087,6 +4087,10 @@ export class AudioTrackConfig {
    * Whether to enable the local audio-playback device: true : (Default) Enable the local audio-playback device. false : Do not enable the local audio-playback device.
    */
   enableLocalPlayback?: boolean;
+  /**
+   * @ignore
+   */
+  enableAudioProcessing?: boolean;
 }
 
 /**

ts/Private/AgoraMediaBase.ts

@@ -1024,7 +1024,7 @@ export class ExternalVideoFrame {
    */
   d3d11Texture2d?: any;
   /**
-   * @ignore
+   * 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.
    */
   textureSliceIndex?: number;
   /**
@@ -1108,7 +1108,9 @@ export class VideoFrame {
    */
   matrix?: number[];
   /**
-   * 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.
+   * 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.
+   *  Make sure that alphaBuffer is exactly the same size as the video frame (width × height), otherwise it may cause the app to crash.
    */
   alphaBuffer?: Uint8Array;
   /**
@@ -1120,7 +1122,7 @@ export class VideoFrame {
    */
   pixelBuffer?: Uint8Array;
   /**
-   * The meta information in the video frame. To use this parameter, please contact.
+   * The meta information in the video frame. To use this parameter, contact.
    */
   metaInfo?: IVideoFrameMetaInfo;
   /**
@@ -1440,7 +1442,7 @@ 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 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.
    */
   onRemoteAudioSpectrum?(

ts/Private/IAgoraMediaEngine.ts

@@ -57,13 +57,7 @@ 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.
+   * 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.
    *
    * @param observer The observer instance. See IVideoFrameObserver.
    *
@@ -76,14 +70,7 @@ export abstract class IMediaEngine {
   /**
    * 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. Call this method before joining a channel.
    *
    * @param observer The video frame observer object. See IVideoEncodedFrameObserver.
    *

ts/Private/IAgoraMediaPlayerSource.ts

@@ -66,8 +66,8 @@ export interface IMediaPlayerSourceObserver {
    * Reports the playback duration that the buffered data can support.
    *
    * When playing online media resources, the SDK triggers this callback every two seconds to report the playback duration that the currently buffered data can support.
-   *  When the playback duration supported by the buffered data is less than the threshold (0 by default), the SDK returns PlayerEventBufferLow.
-   *  When the playback duration supported by the buffered data is greater than the threshold (0 by default), the SDK returns PlayerEventBufferRecover.
+   *  When the playback duration supported by the buffered data is less than the threshold (0 by default), the SDK returns PlayerEventBufferLow (6).
+   *  When the playback duration supported by the buffered data is greater than the threshold (0 by default), the SDK returns PlayerEventBufferRecover (7).
    *
    * @param playCachedBuffer The playback duration (ms) that the buffered data can support.
    */

ts/Private/IAgoraMusicContentCenter.ts

@@ -289,19 +289,7 @@ export interface IMusicContentCenterEventHandler {
   ): void;
 
   /**
-   * 音乐资源的详细信息回调。
-   *
-   * 当你调用 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 。
+   * @ignore
    */
   onSongSimpleInfoResult?(
     requestId: string,