[AUTO] Generate comments by iris-doc

Author: Nero-Hu

ts/Private/AgoraBase.ts

@@ -2047,30 +2047,30 @@ export enum LocalVideoStreamError {
    */
   LocalVideoStreamErrorDeviceNotFound = 8,
   /**
-   * 9: (For macOS only) The video capture device currently in use is disconnected (such as being unplugged).
+   * 9: (macOS only) The video capture device currently in use is disconnected (such as being unplugged).
    */
   LocalVideoStreamErrorDeviceDisconnected = 9,
   /**
-   * 10: (For macOS and Windows only) The SDK cannot find the video device in the video device list. Check whether the ID of the video device is valid.
+   * 10: (macOS and Windows only) The SDK cannot find the video device in the video device list. Check whether the ID of the video device is valid.
    */
   LocalVideoStreamErrorDeviceInvalidId = 10,
   /**
    * 101: The current video capture device is unavailable due to excessive system pressure.
    */
   LocalVideoStreamErrorDeviceSystemPressure = 101,
   /**
-   * 11: (For macOS only) The shared window is minimized when you call startScreenCaptureByWindowId to share a window. The SDK cannot share a minimized window. You can cancel the minimization of this window at the application layer, for example by maximizing this window.
+   * 11: (macOS only) The shared window is minimized when you call startScreenCaptureByWindowId to share a window. The SDK cannot share a minimized window. You can cancel the minimization of this window at the application layer, for example by maximizing this window.
    */
   LocalVideoStreamErrorScreenCaptureWindowMinimized = 11,
   /**
-   * 12: (For macOS and Windows only) The error code indicates that a window shared by the window ID has been closed or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing. Common scenarios for reporting this error code:
+   * 12: (macOS and Windows only) The error code indicates that a window shared by the window ID has been closed or a full-screen window shared by the window ID has exited full-screen mode. After exiting full-screen mode, remote users cannot see the shared window. To prevent remote users from seeing a black screen, Agora recommends that you immediately stop screen sharing. Common scenarios reporting this error code:
    *  When the local user closes the shared window, the SDK reports this error code.
    *  The local user shows some slides in full-screen mode first, and then shares the windows of the slides. After the user exits full-screen mode, the SDK reports this error code.
    *  The local user watches a web video or reads a web document in full-screen mode first, and then shares the window of the web video or document. After the user exits full-screen mode, the SDK reports this error code.
    */
   LocalVideoStreamErrorScreenCaptureWindowClosed = 12,
   /**
-   * 13: (For Windows only) The window being shared is overlapped by another window, so the overlapped area is blacked out by the SDK during window sharing.
+   * 13: (Windows only) The window being shared is overlapped by another window, so the overlapped area is blacked out by the SDK during window sharing.
    */
   LocalVideoStreamErrorScreenCaptureWindowOccluded = 13,
   /**
@@ -2776,7 +2776,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;
   /**
@@ -3265,7 +3265,7 @@ export enum NetworkType {
    */
   NetworkTypeMobile4g = 5,
   /**
-   * @ignore
+   * 6: The network type is mobile 5G.
    */
   NetworkTypeMobile5g = 6,
 }
@@ -3870,7 +3870,7 @@ export class ScreenCaptureParameters {
    */
   bitrate?: number;
   /**
-   * Whether to capture the mouse in screen sharing: true : (Default) Capture the mouse. false : Do not capture the mouse.
+   * Whether to capture the mouse in screen sharing: true : (Default) Capture the mouse. false : Do not capture the mouse. Due to macOS system restrictions, setting this parameter to false is ineffective during screen sharing (it has no impact when sharing a window).
    */
   captureMouseCursor?: boolean;
   /**
@@ -3963,7 +3963,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;
   /**

ts/Private/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,
 }
@@ -414,7 +414,7 @@ export enum VideoPixelFormat {
    */
   VideoPixelRgba = 4,
   /**
-   * 8: The format is NV12.
+   * @ignore
    */
   VideoPixelNv12 = 8,
   /**
@@ -588,7 +588,7 @@ export class ExternalVideoFrame {
    */
   alphaBuffer?: Uint8Array;
   /**
-   * @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.
    */
   texture_slice_index?: number;
 }

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

ts/Private/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;