[AUTO] Generate code by terra (#1005)

Co-authored-by: LichKing-2234 <[email protected]>

Author: LichKing-2234

ts/AgoraSdk.ts

@@ -25,7 +25,7 @@ export * from './Utils';
 const instance = new RtcEngineExInternal();
 
 /**
- * IRtcEngineEx
+ * Creates one IRtcEngineEx object.
  * Currently, the Agora RTC SDK v4.x supports creating only one IRtcEngineEx object for each app.
  *
  * @returns

ts/Private/AgoraBase.ts

@@ -227,7 +227,7 @@ export enum ErrorCodeType {
    */
   ErrJoinChannelRejected = 17,
   /**
-   * 18: Fails to leave the channel. Possible reasons include the following:The user has left the channel before calling the method. Stop calling this method to clear this error.The user calls the method to leave the channel before joining the channel. In this case, no extra operation is needed.
+   * 18: Fails to leave the channel. Possible reasons include the following:The user has left the channel before calling the leaveChannel method. Stop calling this method to clear this error.The user calls the leaveChannel method to leave the channel before joining the channel. In this case, no extra operation is needed.
    */
   ErrLeaveChannelRejected = 18,
   /**
@@ -1332,7 +1332,7 @@ export class SimulcastStreamConfig {
    */
   dimensions?: VideoDimensions;
   /**
-   * @ignore
+   * Video receive bitrate (Kbps), represented by an instantaneous value. The default value is 65.
    */
   kBitrate?: number;
   /**
@@ -1655,7 +1655,7 @@ export enum AudioAinsMode {
    */
   AinsModeAggressive = 1,
   /**
-   * 2: Aggressive mode with low latency. The noise reduction delay of this mode is about only half of that of the balance and aggressive mode. It is suitable for scenarios that have high requirements on noise reduction with low latency, such as sing together online in real-time.
+   * 2: Aggressive mode with low latency. The noise reduction delay of this mode is about only half of that of the balance and aggressive modes. It is suitable for scenarios that have high requirements on noise reduction with low latency, such as sing together online in real time.
    */
   AinsModeUltralowlatency = 2,
 }
@@ -1941,9 +1941,9 @@ export enum LocalVideoStreamError {
    */
   LocalVideoStreamErrorCaptureFailure = 4,
   /**
-   * @ignore
+   * 5: The local video encoding fails.
    */
-  LocalVideoStreamErrorCodecNotSupport = 5,
+  LocalVideoStreamErrorEncodeFailure = 5,
   /**
    * @ignore
    */
@@ -2479,7 +2479,7 @@ export enum RtmpStreamPublishErrorType {
    */
   RtmpStreamPublishErrorInvalidPrivilege = 16,
   /**
-   * 100: The streaming has been stopped normally. After you stop the media push, the SDK returns this value.
+   * 100: The streaming has been stopped normally. After you stop the Media Push, the SDK returns this value.
    */
   RtmpStreamUnpublishErrorOk = 100,
 }
@@ -3367,15 +3367,15 @@ export class VirtualBackgroundSource {
    */
   background_source_type?: BackgroundSourceType;
   /**
-   * The type of the custom background image. The color of the custom background image. The format is a hexadecimal integer defined by RGB, without the # sign, such as 0xFFB6C1 for light pink. The default value is 0xFFFFFF, which signifies white. The value range is [0x000000, 0xffffff]. If the value is invalid, the SDK replaces the original background image with a white background image.This parameter takes effect only when the type of the custom background image isBackgroundColor .
+   * The type of the custom background image. The color of the custom background image. The format is a hexadecimal integer defined by RGB, without the # sign, such as 0xFFB6C1 for light pink. The default value is 0xFFFFFF, which signifies white. The value range is [0x000000, 0xffffff]. If the value is invalid, the SDK replaces the original background image with a white background image.This parameter takes effect only when the type of the custom background image is BackgroundColor.
    */
   color?: number;
   /**
-   * The local absolute path of the custom background image. PNG and JPG formats are supported. If the path is invalid, the SDK replaces the original background image with a white background image.This parameter takes effect only when the type of the custom background image isBackgroundImg .
+   * The local absolute path of the custom background image. PNG and JPG formats are supported. If the path is invalid, the SDK replaces the original background image with a white background image.This parameter takes effect only when the type of the custom background image is BackgroundImg.
    */
   source?: string;
   /**
-   * The degree of blurring applied to the custom background image. See BackgroundBlurDegree .This parameter takes effect only when the type of the custom background image isBackgroundBlur .
+   * The degree of blurring applied to the custom background image. See BackgroundBlurDegree .This parameter takes effect only when the type of the custom background image is BackgroundBlur.
    */
   blur_degree?: BackgroundBlurDegree;
 }
@@ -4574,15 +4574,15 @@ export enum ConfigFetchType {
 }
 
 /**
- * The information about the media streams to be recorded.
+ * @ignore
  */
 export class RecorderStreamInfo {
   /**
-   * The name of the channel in which the media streams publish.
+   * @ignore
    */
   channelId?: string;
   /**
-   * The ID of the user whose media streams you want to record.
+   * @ignore
    */
   uid?: number;
 }

ts/Private/AgoraMediaBase.ts

@@ -58,19 +58,19 @@ export enum VideoSourceType {
    */
   VideoSourceTranscoded = 10,
   /**
-   * @ignore
+   * 11: The third camera.
    */
   VideoSourceCameraThird = 11,
   /**
-   * @ignore
+   * 12:The fourth camera.
    */
   VideoSourceCameraFourth = 12,
   /**
-   * @ignore
+   * 13:The third screen.
    */
   VideoSourceScreenThird = 13,
   /**
-   * @ignore
+   * 14:The fourth screen.
    */
   VideoSourceScreenFourth = 14,
   /**
@@ -824,8 +824,8 @@ export interface IAudioFrameObserverBase {
   onRecordAudioFrame?(channelId: string, audioFrame: AudioFrame): boolean;
 
   /**
-   * 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.
+   * 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 .
@@ -836,8 +836,8 @@ export interface IAudioFrameObserverBase {
   onPlaybackAudioFrame?(channelId: string, audioFrame: AudioFrame): boolean;
 
   /**
-   * 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.
+   * 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 channelId The channel ID.
    * @param audioFrame The raw audio data. See AudioFrame .
@@ -997,14 +997,20 @@ export interface IVideoFrameObserver {
   ): boolean;
 
   /**
-   * 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.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.
+   * 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 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: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.
    */
   onPreEncodeVideoFrame?(
     sourceType: VideoSourceType,
@@ -1129,61 +1135,55 @@ export enum RecorderErrorCode {
 }
 
 /**
- * The recording configuration.
+ * @ignore
  */
 export class MediaRecorderConfiguration {
   /**
-   * The absolute path (including the filename extensions) of the recording file. For example:Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4macOS: ～/Library/Logs/example.mp4Ensure that the directory for the log files exists and is writable.
+   * @ignore
    */
   storagePath?: string;
   /**
-   * The format of the recording file. See MediaRecorderContainerFormat .
+   * @ignore
    */
   containerFormat?: MediaRecorderContainerFormat;
   /**
-   * The recording content. See MediaRecorderStreamType .
+   * @ignore
    */
   streamType?: MediaRecorderStreamType;
   /**
-   * The maximum recording duration, in milliseconds. The default value is 120000.
+   * @ignore
    */
   maxDurationMs?: number;
   /**
-   * The interval (ms) of updating the recording information. The value range is [1000,10000]. Based on the value you set in this parameter, the SDK triggers the onRecorderInfoUpdated callback to report the updated recording information.
+   * @ignore
    */
   recorderInfoUpdateInterval?: number;
 }
 
 /**
- * The information about the file that is recorded.
+ * @ignore
  */
 export class RecorderInfo {
   /**
-   * The absolute path of the recording file.
+   * @ignore
    */
   fileName?: string;
   /**
-   * The recording duration (ms).
+   * @ignore
    */
   durationMs?: number;
   /**
-   * The size (byte) of the recording file.
+   * @ignore
    */
   fileSize?: number;
 }
 
 /**
- * Provides callback events for audio and video recording.
+ * @ignore
  */
 export interface IMediaRecorderObserver {
   /**
-   * Occurs when the recording state changes.
-   * When the recording state changes, the SDK triggers this callback to report the current recording state and the reason for the change.
-   *
-   * @param channelId The channel name.
-   * @param uid The user ID.
-   * @param state The current recording state. See RecorderState .
-   * @param error The reason for the state change. See RecorderErrorCode .
+   * @ignore
    */
   onRecorderStateChanged?(
     channelId: string,
@@ -1193,12 +1193,7 @@ export interface IMediaRecorderObserver {
   ): void;
 
   /**
-   * Occurs when the recording information is updated.
-   * After you successfully enable the audio and video recording, the SDK periodically triggers this callback based on the value of recorderInfoUpdateInterval set in MediaRecorderConfiguration . This callback reports the file name, duration, and size of the current recording file.
-   *
-   * @param channelId The channel name.
-   * @param uid The user ID.
-   * @param info The information about the file that is recorded. See RecorderInfo .
+   * @ignore
    */
   onRecorderInfoUpdated?(
     channelId: string,

ts/Private/IAgoraMediaEngine.ts

@@ -144,21 +144,21 @@ export abstract class IMediaEngine {
 
   /**
    * Creates a customized audio track.
-   * When you need to publish multiple custom captured videos in the channel, you can refer to the following steps:Call this method to create a video track and get the video track ID.In ChannelMediaOptions of each channel, set customVideoTrackId to the video track ID that you want to publish, and set publishCustomVideoTrack to true.If you call pushAudioFrame trackId as the video track ID set in step 2, you can publish the corresponding custom video source in multiple channels.
+   * 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.
    *
    * @param trackType The type of the custom audio track. See AudioTrackType .
    * @param config The configuration of the custom audio track. See AudioTrackConfig .
    *
    * @returns
-   * If the method call is successful, the video track ID is returned as the unique identifier of the video 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,
     config: AudioTrackConfig
   ): number;
 
   /**
-   * Destroys the specified video track.
+   * Destroys the specified audio track.
    *
    * @param trackId The custom audio track ID returned in createCustomAudioTrack .
    *

ts/Private/IAgoraMediaPlayer.ts

@@ -175,20 +175,13 @@ export abstract class IMediaPlayer {
   abstract selectAudioTrack(index: number): number;
 
   /**
-   * Sets the private options for the media player.
-   * The media player supports setting private options by key and value. Under normal circumstances, you do not need to know the private option settings, and just use the default option settings.Ensure that you call this method before open .If you need to push streams with SEI into the CDN, call setPlayerOptionInInt("sei_data_with_uuid", 1); otherwise, the loss of SEI might occurs.
-   *
-   * @param key The key of the option.
-   * @param value The value of the key.
-   *
-   * @returns
-   * 0: Success.< 0: Failure.
+   * @ignore
    */
   abstract setPlayerOptionInInt(key: string, value: number): number;
 
   /**
    * Sets the private options for the media player.
-   * The media player supports setting private options by key and value. Under normal circumstances, you do not need to know the private option settings, and just use the default option settings.Ensure that you call this method before open .If you need to push streams with SEI into the CDN, call setPlayerOptionInInt("sei_data_with_uuid", 1); otherwise, the loss of SEI might occurs.
+   * The media player supports setting private options by key and value. Under normal circumstances, you do not need to know the private option settings, and just use the default option settings.Ensure that you call this method before open .If you need to push streams with SEI into the CDN, call setPlayerOptionInString("sei_data_with_uuid", 1); otherwise, the loss of SEI might occurs.
    *
    * @param key The key of the option.
    * @param value The value of the key.
@@ -204,24 +197,12 @@ export abstract class IMediaPlayer {
   abstract takeScreenshot(filename: string): number;
 
   /**
-   * Gets the detailed information of the media stream.
-   * Call this method after calling getStreamCount .
-   *
-   * @param index The index of the media stream.
-   *
-   * @returns
-   * If the call succeeds, returns the detailed information of the media stream. See PlayerStreamInfo .If the call fails, returns NULL.
+   * @ignore
    */
   abstract selectInternalSubtitle(index: number): number;
 
   /**
-   * Stops pushing media streams to a CDN.
-   * Agora recommends that you use the server-side Media Push function. You can call this method to stop the live stream on the specified CDN address. This method can stop pushing media streams to only one CDN address at a time, so if you need to stop pushing streams to multiple addresses, call this method multiple times.After you call this method, the SDK triggers the onRtmpStreamingStateChanged callback on the local client to report the state of the streaming.
-   *
-   * @param url The address of Media Push. The format is RTMP or RTMPS. The character length cannot exceed 1024 bytes. Special characters such as Chinese characters are not supported.
-   *
-   * @returns
-   * 0: Success.< 0: Failure.
+   * @ignore
    */
   abstract setExternalSubtitle(url: string): number;
 
@@ -289,9 +270,10 @@ export abstract class IMediaPlayer {
   abstract getPublishSignalVolume(): number;
 
   /**
-   * Destroys a video renderer object.
+   * Sets the view.
    *
-   * @param view The HTMLElement object to be destroyed.
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract setView(view: any): number;
 
@@ -387,12 +369,7 @@ export abstract class IMediaPlayer {
   ): number;
 
   /**
-   * Unregisters the video frame observer.
-   *
-   * @param observer The video observer, reporting the reception of each video frame. See IVideoFrameObserver .
-   *
-   * @returns
-   * 0: Success.< 0: Failure.
+   * @ignore
    */
   abstract unregisterMediaPlayerAudioSpectrumObserver(
     observer: IAudioSpectrumObserver