[AUTO] Generate code by terra

Author: LichKing-2234

ts/AgoraSdk.ts

@@ -26,11 +26,11 @@ export * from './Utils';
 const instance = new RtcEngineExInternal();
 
 /**
- * Creates an IRtcEngine object.
- * Currently, the Agora RTC SDK v4.x supports creating only one IRtcEngine object for each app.
+ * IRtcEngineEx
+ * Currently, the Agora RTC SDK v4.x supports creating only one IRtcEngineEx object for each app.
  *
  * @returns
- * One IRtcEngine object.
+ * One IRtcEngineEx object.
  */
 export function createAgoraRtcEngine(options?: AgoraEnvOptions): IRtcEngineEx {
   Object.assign(AgoraEnv, options);

ts/Private/AgoraBase.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.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 .
+   * 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;
   /**

ts/Private/AgoraMediaBase.ts

@@ -68,11 +68,11 @@ 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 file path is:macOSIf Sandbox is enabled: App~/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。
+   * 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.
    */
   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 to a value lower than 128 KB, the SDK adjusts it to 128 KB. If you set fileSizeInKBytes to a value higher than 1,024 KB, the SDK adjusts it to 1,024 KB.
+   * 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.
    */
   fileSizeInKB?: number;
   /**

ts/Private/AgoraMediaPlayerTypes.ts

@@ -84,10 +84,8 @@ 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.
+   * @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.
@@ -127,7 +125,7 @@ export abstract class IMediaEngine {
    * 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 which can be set as 8000, 16000, 32000, 44100, or 48000.
+   * @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.
@@ -145,15 +143,27 @@ export abstract class IMediaEngine {
   ): number;
 
   /**
-   * @ignore
+   * 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.
+   *
+   * @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.
    */
   abstract createCustomAudioTrack(
     trackType: AudioTrackType,
     config: AudioTrackConfig
   ): number;
 
   /**
-   * @ignore
+   * Destroys the specified video track.
+   *
+   * @param trackId The custom audio track ID returned in createCustomAudioTrack .
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract destroyCustomAudioTrack(trackId: number): number;
 

ts/Private/IAgoraLog.ts

@@ -31,7 +31,7 @@ export abstract class IMediaPlayer {
    * Opens the media resource.
    * This method is called asynchronously.If you need to play a media file, make sure you receive the onPlayerSourceStateChanged callback reporting PlayerStateOpenCompleted before calling the play method to play the file.
    *
-   * @param url The path of the media file. Both local path and online path are supported.On the Android platform, if you need to open a file in URI format, use open .
+   * @param url The path of the media file. Both local path and online path are supported.
    * @param startPos The starting position (ms) for playback. Default value is 0.
    *
    * @returns
@@ -164,7 +164,13 @@ export abstract class IMediaPlayer {
   abstract setPlaybackSpeed(speed: number): number;
 
   /**
-   * @ignore
+   * Selects the audio track used during playback.
+   * After getting the track index of the audio file, you can call this method to specify any track to play. For example, if different tracks of a multi-track file store songs in different languages, you can call this method to set the playback language.You need to call this method after calling getStreamInfo to get the audio stream index value.
+   *
+   * @param index The index of the audio track.
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract selectAudioTrack(index: number): number;
 
@@ -198,7 +204,13 @@ export abstract class IMediaPlayer {
   abstract takeScreenshot(filename: string): number;
 
   /**
-   * @ignore
+   * 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.
    */
   abstract selectInternalSubtitle(index: number): number;
 
@@ -272,7 +284,7 @@ export abstract class IMediaPlayer {
    * Gets the volume of the media file for publishing.
    *
    * @returns
-   * The remote playback volume, if the method call succeeds.< 0: Failure.
+   * ≥ 0: The remote playback volume.< 0: Failure.
    */
   abstract getPublishSignalVolume(): number;
 
@@ -284,7 +296,12 @@ export abstract class IMediaPlayer {
   abstract setView(view: any): number;
 
   /**
-   * @ignore
+   * Sets the render mode of the media player.
+   *
+   * @param renderMode Sets the render mode of the view. See RenderModeType .
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract setRenderMode(renderMode: RenderModeType): number;
 
@@ -315,17 +332,21 @@ export abstract class IMediaPlayer {
   /**
    * Registers an audio frame observer object.
    *
+   * @param observer The audio frame observer, reporting the reception of each audio frame. See IAudioPcmFrameSink .
    * @param mode The use mode of the audio frame. See RawAudioFrameOpModeType .
+   *
+   * @returns
+   * 0: Success.< 0: Failure.
    */
   abstract registerAudioFrameObserver(
     observer: IAudioPcmFrameSink,
     mode?: RawAudioFrameOpModeType
   ): number;
 
   /**
-   * Unregisters an audio observer.
+   * Unregisters an audio frame observer.
    *
-   * @param observer The audio observer. See IMediaPlayerAudioFrameObserver .
+   * @param observer The audio observer. See IAudioPcmFrameSink .
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -366,9 +387,9 @@ export abstract class IMediaPlayer {
   ): number;
 
   /**
-   * Unregisters the encoded audio frame observer.
+   * Unregisters the video frame observer.
    *
-   * @param observer The encoded audio observer. See IAudioEncodedFrameObserver .
+   * @param observer The video observer, reporting the reception of each video frame. See IVideoFrameObserver .
    *
    * @returns
    * 0: Success.< 0: Failure.
@@ -394,7 +415,10 @@ export abstract class IMediaPlayer {
   abstract getPlayerSdkVersion(): string;
 
   /**
-   * @ignore
+   * Gets the path of the media resource being played.
+   *
+   * @returns
+   * The path of the media resource being played.
    */
   abstract getPlaySrc(): string;
 
@@ -512,8 +536,7 @@ export abstract class IMediaPlayerCacheManager {
    * You can call this method to delete a cached media file when the storage space for the cached files is about to reach its limit. After you call this method, the SDK deletes the cached media file that is least used.The cached media file currently being played will not be deleted.
    *
    * @returns
-   * 0: Success.
-   *  < 0: Failure. See MediaPlayerError .
+   * 0: Success.< 0: Failure. See MediaPlayerError .
    */
   abstract removeOldCache(): number;
 
@@ -524,8 +547,7 @@ export abstract class IMediaPlayerCacheManager {
    * @param uri The URI (Uniform Resource Identifier) of the media file to be deleted.
    *
    * @returns
-   * 0: Success.
-   *  < 0: Failure. See MediaPlayerError .
+   * 0: Success.< 0: Failure. See MediaPlayerError .
    */
   abstract removeCacheByUri(uri: string): number;
 
@@ -557,7 +579,8 @@ export abstract class IMediaPlayerCacheManager {
    * @param cacheSize The maximum size (bytes) of the aggregate storage space for cached media files. The default value is 1 GB.
    *
    * @returns
-   * 0: Success.< 0: Failure. See MediaPlayerError .
+   * 0: Success.
+   *  < 0: Failure. See MediaPlayerError .
    */
   abstract setMaxCacheFileSize(cacheSize: number): number;
 

ts/Private/IAgoraMediaEngine.ts

@@ -13,10 +13,10 @@ import {
  */
 export interface IMediaPlayerSourceObserver {
   /**
-   * Reports the playback state change.
+   * Reports the changes of playback state.
    * When the state of the media player changes, the SDK triggers this callback to report the current playback state.
    *
-   * @param state The playback state, see MediaPlayerState .
+   * @param state The playback state. See MediaPlayerState .
    * @param ec The error code. See MediaPlayerError .
    */
   onPlayerSourceStateChanged?(
@@ -26,17 +26,17 @@ export interface IMediaPlayerSourceObserver {
 
   /**
    * Reports current playback progress.
-   * When playing media files, the SDK triggers this callback every one second to report current playback progress.
+   * When playing media files, the SDK triggers this callback every two second to report current playback progress.
    *
    * @param position The playback position (ms) of media files.
    */
   onPositionChanged?(positionMs: number): void;
 
   /**
-   * Reports the playback event.
+   * Reports the player events.
    * After calling the seek method, the SDK triggers the callback to report the results of the seek operation.
    *
-   * @param eventCode The playback event. See MediaPlayerEvent .
+   * @param eventCode The player events. See MediaPlayerEvent .
    * @param elapsedTime The time (ms) when the event occurs.
    * @param message Information about the event.
    */

ts/Private/IAgoraMediaPlayer.ts

@@ -5,30 +5,37 @@ import {
 } from './AgoraMediaBase';
 
 /**
- * Used for recording audio and video on the client.
- * IMediaRecorder can record the following:
- *  The audio captured by the local microphone and encoded in AAC format.The video captured by the local camera and encoded by the SDK.
+ * This class provides APIs for local and remote recording.
  */
 export abstract class IMediaRecorder {
   /**
-   * Registers one IMediaRecorderObserver object.
-   * Make sure that IRtcEngine is initialized before you call this method.
+   * Registers one IMediaRecorderObserver oberver.
+   * This method is used to set the callbacks of audio and video recording, so as to notify the app of the recording status and information of the audio and video stream during recording.Before calling this method, ensure the following:The IRtcEngine object is created and initialized.The recording object is created through createMediaRecorder .
    *
-   * @param connection The connection information. See RtcConnection .
-   * @param callback The callbacks for recording local audio and video streams. See IMediaRecorderObserver .
+   * @param callback The callbacks for recording audio and video streams. See IMediaRecorderObserver .
    *
    * @returns
    * 0: Success.< 0: Failure.
    */
   abstract setMediaRecorderObserver(callback: IMediaRecorderObserver): number;
 
   /**
-   * @ignore
+   * Starts recording audio and video streams.
+   * You can call this method to enable the recording function. Agora supports recording the media streams of local and remote users at the same time.Before you call this method, ensure the following:The recording object is created through createMediaRecorder .The recording observer is registered through setMediaRecorderObserver .You have joined the channel which the remote user that you want to record is in.Supported formats of recording are listed as below:AAC-encoded audio captured by the microphone.Video captured by a camera and encoded in H.264 or H.265.Once the recording is started, if the video resolution is changed, the SDK stops the recording; if the sampling rate and audio channel changes, the SDK continues recording and generates audio files respectively.The SDK can generate a recording file only when it detects audio and video streams; when there are no audio and video streams to be recorded or the audio and video streams are interrupted for more than five seconds, the SDK stops the recording and triggers the onRecorderStateChanged(RecorderStateError, RecorderErrorNoStream) callback.If you want to record the media streams of the local user, ensure the role of the local user is set as broadcaster.If you want to record the media streams of a remote user, ensure you have subscribed to the user's media streams before starting the recording.
+   *
+   * @param config The recording configuration. See MediaRecorderConfiguration .
+   *
+   * @returns
+   * 0: Success.< 0: Failure.-2: The parameter is invalid. Ensure the following:The specified path of the recording file exists and is writable.The specified format of the recording file is supported.The maximum recording duration is correctly set.-4: IRtcEngine does not support the request. The recording is ongoing or the recording stops because an error occurs.-7: The method is called before IRtcEngine is initialized. Ensure the IMediaRecorder object is created before calling this method.
    */
   abstract startRecording(config: MediaRecorderConfiguration): number;
 
   /**
-   * @ignore
+   * Stops recording audio and video streams.
+   * After calling startRecording , if you want to stop the recording, you must call this method; otherwise, the generated recording files may not be playable.
+   *
+   * @returns
+   * 0: Success.< 0: Failure.-7: The method is called before IRtcEngine is initialized. Ensure the IMediaRecorder object is created before calling this method.
    */
   abstract stopRecording(): number;
 }

ts/Private/IAgoraMediaPlayerSource.ts

@@ -109,7 +109,13 @@ export abstract class MusicChartCollection {
   abstract getCount(): number;
 
   /**
-   * @ignore
+   * 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.
    */
   abstract get(index: number): MusicChartInfo;
 }
@@ -377,12 +383,19 @@ export abstract class IMusicContentCenter {
   abstract preload(songCode: number, jsonOption?: string): number;
 
   /**
-   * @ignore
+   * 删除已缓存的音乐资源。
+   * 你可以调用该方法删除某一已缓存的音乐资源，如需删除多个音乐资源，你可以多次调用该方法。 The cached media file currently being played will not be deleted.
+   *
+   * @param songCode 待删除的音乐资源的编号。
+   *
+   * @returns
+   * 0: 方法调用成功，音乐资源已删除。< 0: Failure.
    */
   abstract removeCache(songCode: number): number;
 
   /**
-   * @ignore
+   * 获取已缓存的音乐资源信息。
+   * 当你不再需要使用已缓存的音乐资源时，你需要及时释放内存以防止内存泄漏。
    */
   abstract getCaches(): { cacheInfo: MusicCacheInfo[]; cacheInfoSize: number };