[AUTO] Generate comments by iris-doc (#684)

Co-authored-by: Nero-Hu <Nero-Hu@users.noreply.github.com>

src/AgoraBase.ts

@@ -3554,11 +3554,11 @@ export enum AudioTrackType {
    */
   AudioTrackInvalid = -1,
   /**
-   * 0: Mixable audio tracks. You can publish multiple mixable audio tracks in one channel, and SDK will automatically mix these tracks into one. The latency of mixable audio tracks is higher than that of direct audio tracks.
+   * 0: Mixable audio tracks. This type of audio track supports mixing with other audio streams (such as audio streams captured by microphone) and playing locally or publishing to channels after mixing. The latency of mixable audio tracks is higher than that of direct audio tracks.
    */
   AudioTrackMixable = 0,
   /**
-   * 1: Direct audio tracks. When creating multiple audio tracks of this type, each direct audio track can only be published in one channel and cannot be mixed with others. The latency of direct audio tracks is lower than that of mixable audio tracks.
+   * 1: Direct audio tracks. This type of audio track will replace the audio streams captured by the microphone and does not support mixing with other audio streams. The latency of direct audio tracks is lower than that of mixable audio tracks. 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.
    */
   AudioTrackDirect = 1,
 }

src/AgoraMediaBase.ts

@@ -162,11 +162,11 @@ export class AudioParameters {
  */
 export enum RawAudioFrameOpModeType {
   /**
-   * 0: Read-only mode,
+   * 0: Read-only mode, For example, when users acquire the data with the Agora SDK, then start the media push.
    */
   RawAudioFrameOpModeReadOnly = 0,
   /**
-   * 2: Read and write mode,
+   * 2: Read and write mode, For example, when users have their own audio-effect processing module and perform some voice preprocessing, such as a voice change.
    */
   RawAudioFrameOpModeReadWrite = 2,
 }

src/IAgoraMediaEngine.ts

@@ -151,12 +151,11 @@ 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 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.
    *
@@ -173,14 +172,14 @@ 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:
+   * 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 trackId as the audio track ID set in step 2, you can publish the corresponding custom audio source in multiple channels.
+   *  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

src/IAgoraMediaPlayer.ts

@@ -96,7 +96,7 @@ export abstract class IMediaPlayer {
   /**
    * Seeks to a new playback position.
    *
-   * fter successfully calling this method, you will receive the onPlayerEvent callback, reporting the result of the seek operation to the new playback position. To play the media file from a specific position, do the following:
+   * After successfully calling this method, you will receive the onPlayerEvent callback, reporting the result of the seek operation to the new playback position. To play the media file from a specific position, do the following:
    *  Call this method to seek to the position you want to begin playback.
    *  Call the play method to play the media file.
    *
@@ -180,7 +180,7 @@ export abstract class IMediaPlayer {
    *
    * Call this method after calling open.
    *
-   * @param speed The playback speed. Agora recommends that you limit this value to between 50 and 400, defined as follows:
+   * @param speed The playback speed. Agora recommends that you limit this value to a range between 50 and 400, which is defined as follows:
    *  50: Half the original speed.
    *  100: The original speed.
    *  400: 4 times the original speed.