[AUTO] Generate comments by iris-doc

src/AgoraBase.ts

@@ -1971,7 +1971,7 @@ export enum LocalAudioStreamError {
    */
   LocalAudioStreamErrorNoPlayoutDevice = 7,
   /**
-   * @ignore
+   * 8: The local audio capture is interrupted by a system call, Siri, or alarm clock. Remind your users to end the phone call, Siri, or alarm clock if the local audio capture is required.
    */
   LocalAudioStreamErrorInterrupted = 8,
   /**
@@ -2035,11 +2035,11 @@ export enum LocalVideoStreamError {
    */
   LocalVideoStreamErrorEncodeFailure = 5,
   /**
-   * 6: (For iOS only) The app is in the background. Remind the user that video capture cannot be performed normally when the app is in the background.
+   * 6: (iOS only) The app is in the background. Remind the user that video capture cannot be performed normally when the app is in the background.
    */
   LocalVideoStreamErrorCaptureInbackground = 6,
   /**
-   * 7: (For iOS only) The current application window is running in Slide Over, Split View, or Picture in Picture mode, and another app is occupying the camera. Remind the user that the application cannot capture video properly when the app is running in Slide Over, Split View, or Picture in Picture mode and another app is occupying the camera.
+   * 7: (iOS only) The current application window is running in Slide Over, Split View, or Picture in Picture mode, and another app is occupying the camera. Remind the user that the application cannot capture video properly when the app is running in Slide Over, Split View, or Picture in Picture mode and another app is occupying the camera.
    */
   LocalVideoStreamErrorCaptureMultipleForegroundApps = 7,
   /**
@@ -2775,7 +2775,7 @@ export class LiveTranscoding {
    */
   height?: number;
   /**
-   * Bitrate of the output video stream for Media Push in Kbps. The default value is 400 Kbps.
+   * Bitrate of the output video stream for Media Push in Kbps. The default value is 400 Kbps. Set this member according to the table. If you set a bitrate beyond the proper range, the SDK automatically adapts it to a value within the range.
    */
   videoBitrate?: number;
   /**
@@ -3264,7 +3264,7 @@ export enum NetworkType {
    */
   NetworkTypeMobile4g = 5,
   /**
-   * @ignore
+   * 6: The network type is mobile 5G.
    */
   NetworkTypeMobile5g = 6,
 }
@@ -3956,7 +3956,7 @@ export enum AudioEncodedFrameObserverPosition {
  */
 export class AudioRecordingConfiguration {
   /**
-   * The absolute path (including the filename extensions) of the recording file. For example: C:\music\audio.mp4. Ensure that the directory for the log files exists and is writable.
+   * The absolute path (including the filename extensions) of the recording file. For example: C:\music\audio.aac. Ensure that the directory for the log files exists and is writable.
    */
   filePath?: string;
   /**

src/AgoraMediaBase.ts

@@ -260,15 +260,15 @@ export enum ContentInspectType {
    */
   ContentInspectInvalid = 0,
   /**
-   * 1: Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
+   * @ignore
    */
   ContentInspectModeration = 1,
   /**
    * @ignore
    */
   ContentInspectSupervision = 2,
   /**
-   * @ignore
+   * 3: Video screenshot and upload via extensions from Agora Extensions Marketplace. SDK uses video moderation extensions from Agora Extensions Marketplace to take screenshots of the video stream in the channel and uploads them.
    */
   ContentInspectImageModeration = 3,
 }
@@ -296,7 +296,7 @@ export class ContentInspectConfig {
    */
   extraInfo?: string;
   /**
-   * @ignore
+   * (Optional) Server configuration related to uploading video screenshots via extensions from Agora Extensions Marketplace. This parameter only takes effect when type in ContentInspectModule is set to ContentInspectImageModeration. If you want to use it, contact.
    */
   serverConfig?: string;
   /**
@@ -414,7 +414,7 @@ export enum VideoPixelFormat {
    */
   VideoPixelRgba = 4,
   /**
-   * 8: The format is NV12.
+   * @ignore
    */
   VideoPixelNv12 = 8,
   /**

src/IAgoraMediaEngine.ts

@@ -286,7 +286,7 @@ export abstract class IMediaEngine {
   abstract unregisterVideoFrameObserver(observer: IVideoFrameObserver): number;
 
   /**
-   * Unregisters a receiver object for the encoded video image.
+   * Unregisters a receiver object for the encoded video frame.
    *
    * @param observer The video observer, reporting the reception of each video frame. See IVideoEncodedFrameObserver.
    *

src/IAgoraMediaPlayer.ts

@@ -141,7 +141,7 @@ export abstract class IMediaPlayer {
   /**
    * Gets the number of the media streams in the media resource.
    *
-   * Call this method after calling open.
+   * Call this method after you call open and receive the onPlayerSourceStateChanged callback reporting the state PlayerStateOpenCompleted.
    *
    * @returns
    * The number of the media streams in the media resource if the method call succeeds.
@@ -210,18 +210,7 @@ export abstract class IMediaPlayer {
   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 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.
-   *
-   * @returns
-   * 0: Success.
-   *  < 0: Failure.
+   * @ignore
    */
   abstract setPlayerOptionInString(key: string, value: string): number;