agora-electron-sdk 4.4.0-dev.2 → 4.4.0

package/ts/Private/AgoraBase.ts

@@ -2034,7 +2034,7 @@ export enum VideoApplicationScenarioType {
    */
   ApplicationScenarioGeneral = 0,
   /**
-   * ApplicationScenarioMeeting (1) is suitable for meeting scenarios. If set to ApplicationScenarioMeeting (1), the SDK automatically enables the following strategies:
+   * ApplicationScenarioMeeting (1) is suitable for meeting scenarios. The SDK automatically enables the following strategies:
    *  In meeting scenarios where low-quality video streams are required to have a high bitrate, the SDK automatically enables multiple technologies used to deal with network congestions, to enhance the performance of the low-quality streams and to ensure the smooth reception by subscribers.
    *  The SDK monitors the number of subscribers to the high-quality video stream in real time and dynamically adjusts its configuration based on the number of subscribers.
    *  If nobody subscribers to the high-quality stream, the SDK automatically reduces its bitrate and frame rate to save upstream bandwidth.
@@ -2051,7 +2051,7 @@ export enum VideoApplicationScenarioType {
    */
   ApplicationScenarioMeeting = 1,
   /**
-   * @ignore
+   * ApplicationScenario1v1 (2) is suitable for 1v1 video call scenarios. To meet the requirements for low latency and high-quality video in this scenario, the SDK optimizes its strategies, improving performance in terms of video quality, first frame rendering, latency on mid-to-low-end devices, and smoothness under weak network conditions. 2: 1v1 video call scenario.
    */
   ApplicationScenario1v1 = 2,
 }
@@ -2304,23 +2304,23 @@ export enum LocalVideoStreamReason {
    */
   LocalVideoStreamReasonScreenCaptureWindowNotSupported = 20,
   /**
-   * @ignore
+   * 21: (Windows only) The screen has not captured any data available for window sharing.
    */
   LocalVideoStreamReasonScreenCaptureFailure = 21,
   /**
-   * @ignore
+   * 22: No permission for screen capture.
    */
   LocalVideoStreamReasonScreenCaptureNoPermission = 22,
   /**
-   * @ignore
+   * 24: (Windows only) An unexpected error occurred during screen sharing (possibly due to window blocking failure), resulting in decreased performance, but the screen sharing process itself was not affected.
    */
   LocalVideoStreamReasonScreenCaptureAutoFallback = 24,
   /**
-   * @ignore
+   * 25: (Windows only) The window for the current screen capture is hidden and not visible on the current screen.
    */
   LocalVideoStreamReasonScreenCaptureWindowHidden = 25,
   /**
-   * @ignore
+   * 26: (Windows only) The window for screen capture has been restored from hidden state.
    */
   LocalVideoStreamReasonScreenCaptureWindowRecoverFromHidden = 26,
   /**
@@ -2328,15 +2328,15 @@ export enum LocalVideoStreamReason {
    */
   LocalVideoStreamReasonScreenCaptureWindowRecoverFromMinimized = 27,
   /**
-   * @ignore
+   * 28: (Windows only) Screen capture has been paused. Common scenarios reporting this error code: The current screen may have been switched to a secure desktop, such as a UAC dialog box or Winlogon desktop.
    */
   LocalVideoStreamReasonScreenCapturePaused = 28,
   /**
-   * @ignore
+   * 29: (Windows only) Screen capture has resumed from paused state.
    */
   LocalVideoStreamReasonScreenCaptureResumed = 29,
   /**
-   * @ignore
+   * 30: The displayer used for screen capture is disconnected.
    */
   LocalVideoStreamReasonScreenCaptureDisplayDisconnected = 30,
 }
@@ -3537,7 +3537,7 @@ export enum NetworkType {
  */
 export enum VideoViewSetupMode {
   /**
-   * 0: (Default) Replaces a view.
+   * 0: (Default) Clear all added views and replace with a new view.
    */
   VideoViewSetupReplace = 0,
   /**
@@ -4225,47 +4225,47 @@ export enum HeadphoneEqualizerPreset {
 }
 
 /**
- * @ignore
+ * Voice AI tuner sound types.
  */
 export enum VoiceAiTunerType {
   /**
-   * @ignore
+   * 0: Mature male voice. A deep and magnetic male voice.
    */
   VoiceAiTunerMatureMale = 0,
   /**
-   * @ignore
+   * 1: Fresh male voice. A fresh and slightly sweet male voice.
    */
   VoiceAiTunerFreshMale = 1,
   /**
-   * @ignore
+   * 2: Elegant female voice. A deep and charming female voice.
    */
   VoiceAiTunerElegantFemale = 2,
   /**
-   * @ignore
+   * 3: Sweet female voice. A high-pitched and cute female voice.
    */
   VoiceAiTunerSweetFemale = 3,
   /**
-   * @ignore
+   * 4: Warm male singing. A warm and melodious male voice.
    */
   VoiceAiTunerWarmMaleSinging = 4,
   /**
-   * @ignore
+   * 5: Gentle female singing. A soft and delicate female voice.
    */
   VoiceAiTunerGentleFemaleSinging = 5,
   /**
-   * @ignore
+   * 6: Husky male singing. A unique husky male voice.
    */
   VoiceAiTunerHuskyMaleSinging = 6,
   /**
-   * @ignore
+   * 7: Warm elegant female singing. A warm and mature female voice.
    */
   VoiceAiTunerWarmElegantFemaleSinging = 7,
   /**
-   * @ignore
+   * 8: Powerful male singing. A strong and powerful male voice.
    */
   VoiceAiTunerPowerfulMaleSinging = 8,
   /**
-   * @ignore
+   * 9: Dreamy female singing. A dreamy and soft female voice.
    */
   VoiceAiTunerDreamyFemaleSinging = 9,
 }
@@ -4406,7 +4406,7 @@ export class AudioRecordingConfiguration {
    */
   fileRecordingType?: AudioFileRecordingType;
   /**
-   * Recording quality. See AudioRecordingQualityType. Note: This parameter applies to AAC files only.
+   * Recording quality. See AudioRecordingQualityType. This parameter applies to AAC files only.
    */
   quality?: AudioRecordingQualityType;
   /**

package/ts/Private/AgoraMediaBase.ts

@@ -2,23 +2,23 @@ import './extension/AgoraMediaBaseExtension';
 import { EncodedVideoFrameInfo } from './AgoraBase';
 
 /**
- * @ignore
+ * The context information of the extension.
  */
 export class ExtensionContext {
   /**
-   * @ignore
+   * Whether the uid in ExtensionContext is valid: true : The uid is valid. false : The uid is invalid.
    */
   isValid?: boolean;
   /**
-   * @ignore
+   * The user ID. 0 represents a local user, while greater than 0 represents a remote user.
    */
   uid?: number;
   /**
-   * @ignore
+   * The name of the extension provider.
    */
   providerName?: string;
   /**
-   * @ignore
+   * The name of the extension.
    */
   extensionName?: string;
 }
@@ -960,27 +960,29 @@ export class ExternalVideoFrame {
    */
   matrix?: number[];
   /**
-   * @ignore
+   * This parameter only applies to video data in Texture format. The MetaData buffer. The default value is NULL.
    */
   metadataBuffer?: Uint8Array;
   /**
-   * @ignore
+   * This parameter only applies to video data in Texture format. The MetaData size. The default value is 0.
    */
   metadataSize?: number;
   /**
-   * @ignore
+   * The alpha channel data output by using portrait segmentation algorithm. This data matches the size of the video frame, with each pixel value ranging from [0,255], where 0 represents the background and 255 represents the foreground (portrait). By setting this parameter, you can render the video background into various effects, such as transparent, solid color, image, video, etc. In custom video rendering scenarios, ensure that both the video frame and alphaBuffer are of the Full Range type; other types may cause abnormal alpha data rendering.
    */
   alphaBuffer?: Uint8Array;
   /**
-   * @ignore
+   * This parameter only applies to video data in BGRA or RGBA format. Whether to extract the alpha channel data from the video frame and automatically fill it into alphaBuffer : true ：Extract and fill the alpha channel data. false : (Default) Do not extract and fill the Alpha channel data. For video data in BGRA or RGBA format, you can set the Alpha channel data in either of the following ways:
+   *  Automatically by setting this parameter to true.
+   *  Manually through the alphaBuffer parameter.
    */
   fillAlphaBuffer?: boolean;
   /**
-   * When the video frame contains alpha channel data, it represents the relative position of alphaBuffer and the video frame.
+   * When the video frame contains alpha channel data, it represents the relative position of alphaBuffer and the video frame. See AlphaStitchMode.
    */
   alphaStitchMode?: AlphaStitchMode;
   /**
-   * @ignore
+   * This parameter only applies to video data in Windows Texture format. It represents a pointer to an object of type ID3D11Texture2D, which is used by a video frame.
    */
   d3d11Texture2d?: any;
   /**
@@ -1064,15 +1066,15 @@ export class VideoFrame {
    */
   textureId?: number;
   /**
-   * @ignore
+   * This parameter only applies to video data in Texture format. Incoming 4 × 4 transformational matrix. The typical value is a unit matrix.
    */
   matrix?: number[];
   /**
-   * @ignore
+   * The alpha channel data output by using portrait segmentation algorithm. This data matches the size of the video frame, with each pixel value ranging from [0,255], where 0 represents the background and 255 represents the foreground (portrait). By setting this parameter, you can render the video background into various effects, such as transparent, solid color, image, video, etc. In custom video rendering scenarios, ensure that both the video frame and alphaBuffer are of the Full Range type; other types may cause abnormal alpha data rendering.
    */
   alphaBuffer?: Uint8Array;
   /**
-   * When the video frame contains alpha channel data, it represents the relative position of alphaBuffer and the video frame.
+   * When the video frame contains alpha channel data, it represents the relative position of alphaBuffer and the video frame. See AlphaStitchMode.
    */
   alphaStitchMode?: AlphaStitchMode;
   /**
@@ -1629,7 +1631,9 @@ export interface IFaceInfoObserver {
    *  pitch: Head pitch angle. A positve value means looking down, while a negative value means looking up.
    *  yaw: Head yaw angle. A positve value means turning left, while a negative value means turning right.
    *  roll: Head roll angle. A positve value means tilting to the right, while a negative value means tilting to the left.
-   *  timestamp: String. The timestamp of the output result, in milliseconds. Here is an example of JSON: { "faces":[{ "blendshapes":{ "eyeBlinkLeft":0.9, "eyeLookDownLeft":0.0, "eyeLookInLeft":0.0, "eyeLookOutLeft":0.0, "eyeLookUpLeft":0.0, "eyeSquintLeft":0.0, "eyeWideLeft":0.0, "eyeBlinkRight":0.0, "eyeLookDownRight":0.0, "eyeLookInRight":0.0, "eyeLookOutRight":0.0, "eyeLookUpRight":0.0, "eyeSquintRight":0.0, "eyeWideRight":0.0, "jawForward":0.0, "jawLeft":0.0, "jawRight":0.0, "jawOpen":0.0, "mouthClose":0.0, "mouthFunnel":0.0, "mouthPucker":0.0, "mouthLeft":0.0, "mouthRight":0.0, "mouthSmileLeft":0.0, "mouthSmileRight":0.0, "mouthFrownLeft":0.0, "mouthFrownRight":0.0, "mouthDimpleLeft":0.0, "mouthDimpleRight":0.0, "mouthStretchLeft":0.0, "mouthStretchRight":0.0, "mouthRollLower":0.0, "mouthRollUpper":0.0, "mouthShrugLower":0.0, "mouthShrugUpper":0.0, "mouthPressLeft":0.0, "mouthPressRight":0.0, "mouthLowerDownLeft":0.0, "mouthLowerDownRight":0.0, "mouthUpperUpLeft":0.0, "mouthUpperUpRight":0.0, "browDownLeft":0.0, "browDownRight":0.0, "browInnerUp":0.0, "browOuterUpLeft":0.0, "browOuterUpRight":0.0, "cheekPuff":0.0, "cheekSquintLeft":0.0, "cheekSquintRight":0.0, "noseSneerLeft":0.0, "noseSneerRight":0.0, "tongueOut":0.0 }, "rotation":{"pitch":30.0, "yaw":25.5, "roll":-15.5}, }], "timestamp":"654879876546" }
+   *  timestamp: String. The timestamp of the output result, in milliseconds. Here is an example of JSON:
+   * { "faces":[{ "blendshapes":{ "eyeBlinkLeft":0.9, "eyeLookDownLeft":0.0, "eyeLookInLeft":0.0, "eyeLookOutLeft":0.0, "eyeLookUpLeft":0.0, "eyeSquintLeft":0.0, "eyeWideLeft":0.0, "eyeBlinkRight":0.0, "eyeLookDownRight":0.0, "eyeLookInRight":0.0, "eyeLookOutRight":0.0, "eyeLookUpRight":0.0, "eyeSquintRight":0.0, "eyeWideRight":0.0, "jawForward":0.0, "jawLeft":0.0, "jawRight":0.0, "jawOpen":0.0, "mouthClose":0.0, "mouthFunnel":0.0, "mouthPucker":0.0, "mouthLeft":0.0, "mouthRight":0.0, "mouthSmileLeft":0.0, "mouthSmileRight":0.0, "mouthFrownLeft":0.0, "mouthFrownRight":0.0, "mouthDimpleLeft":0.0, "mouthDimpleRight":0.0, "mouthStretchLeft":0.0, "mouthStretchRight":0.0, "mouthRollLower":0.0, "mouthRollUpper":0.0, "mouthShrugLower":0.0, "mouthShrugUpper":0.0, "mouthPressLeft":0.0, "mouthPressRight":0.0, "mouthLowerDownLeft":0.0, "mouthLowerDownRight":0.0, "mouthUpperUpLeft":0.0, "mouthUpperUpRight":0.0, "browDownLeft":0.0, "browDownRight":0.0, "browInnerUp":0.0, "browOuterUpLeft":0.0, "browOuterUpRight":0.0, "cheekPuff":0.0, "cheekSquintLeft":0.0, "cheekSquintRight":0.0, "noseSneerLeft":0.0, "noseSneerRight":0.0, "tongueOut":0.0 }, "rotation":{"pitch":30.0, "yaw":25.5, "roll":-15.5},
+   *  }], "timestamp":"654879876546" }
    *
    * @returns
    * true : Facial information JSON parsing successful. false : Facial information JSON parsing failed.

package/ts/Private/IAgoraMediaPlayer.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.
+   * This method is called asynchronously.
    *
    * @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.
@@ -58,8 +58,6 @@ export abstract class IMediaPlayer {
   /**
    * Plays the media file.
    *
-   * After calling open or seek, you can call this method to play the media file.
-   *
    * @returns
    * 0: Success.
    *  < 0: Failure.
@@ -78,6 +76,8 @@ export abstract class IMediaPlayer {
   /**
    * Stops playing the media track.
    *
+   * After calling this method to stop playback, if you want to play again, you need to call open or openWithMediaSource to open the media resource.
+   *
    * @returns
    * 0: Success.
    *  < 0: Failure.
@@ -96,9 +96,8 @@ export abstract class IMediaPlayer {
   /**
    * Seeks to a new playback position.
    *
-   * 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.
+   * If you call seek after the playback has completed (upon receiving callback onPlayerSourceStateChanged reporting playback status as PlayerStatePlaybackCompleted or PlayerStatePlaybackAllLoopsCompleted), the SDK will play the media file from the specified position. At this point, you will receive callback onPlayerSourceStateChanged reporting playback status as PlayerStatePlaying.
+   *  If you call seek while the playback is paused, upon successful call of this method, the SDK will seek to the specified position. To resume playback, call resume or play .
    *
    * @param newPos The new playback position (ms).
    *
@@ -152,8 +151,6 @@ export abstract class IMediaPlayer {
   /**
    * Gets the detailed information of the media stream.
    *
-   * Call this method after calling getStreamCount.
-   *
    * @param index The index of the media stream. This parameter must be less than the return value of getStreamCount.
    *
    * @returns
@@ -168,6 +165,8 @@ export abstract class IMediaPlayer {
    * If you want to loop, call this method and set the number of the loops. When the loop finishes, the SDK triggers onPlayerSourceStateChanged and reports the playback state as PlayerStatePlaybackAllLoopsCompleted.
    *
    * @param loopCount The number of times the audio effect loops:
+   *  ≥0: Number of times for playing. For example, setting it to 0 means no loop playback, playing only once; setting it to 1 means loop playback once, playing a total of twice.
+   *  -1: Play the audio file in an infinite loop.
    *
    * @returns
    * 0: Success.
@@ -569,9 +568,9 @@ export abstract class IMediaPlayer {
   abstract setSoundPositionParams(pan: number, gain: number): number;
 
   /**
-   * Set media player options for providing technical previews or special customization features.
+   * Sets media player options.
    *
-   * The media player supports setting options through key and value. In general, you don't need to know about the option settings. You can use the default option settings of the media player. The difference between this method and setPlayerOptionInString is that the value parameter of this method is of type Int, while the value of setPlayerOptionInString is of type String. These two methods cannot be used together. Ensure that you call this method before open or openWithMediaSource.
+   * The media player supports setting options through key and value. The difference between this method and setPlayerOptionInString is that the value parameter of this method is of type Int, while the value of setPlayerOptionInString is of type String. These two methods cannot be used together.
    *
    * @param key The key of the option.
    * @param value The value of the key.
@@ -583,9 +582,9 @@ export abstract class IMediaPlayer {
   abstract setPlayerOptionInInt(key: string, value: number): number;
 
   /**
-   * Set media player options for providing technical previews or special customization features.
+   * Sets media player options.
    *
-   * Ensure that you call this method before open or openWithMediaSource. The media player supports setting options through key and value. In general, you don't need to know about the option settings. You can use the default option settings of the media player. The difference between this method and setPlayerOptionInInt is that the value parameter of this method is of type String, while the value of setPlayerOptionInInt is of type String. These two methods cannot be used together.
+   * The media player supports setting options through key and value. The difference between this method and setPlayerOptionInInt is that the value parameter of this method is of type String, while the value of setPlayerOptionInInt is of type String. These two methods cannot be used together.
    *
    * @param key The key of the option.
    * @param value The value of the key.

package/ts/Private/IAgoraMusicContentCenter.ts

@@ -289,7 +289,19 @@ export interface IMusicContentCenterEventHandler {
   ): void;
 
   /**
-   * @ignore
+   * 音乐资源的详细信息回调。
+   *
+   * 当你调用 getSongSimpleInfo 获取某一音乐资源的详细信息后，SDK 会触发该回调。
+   *
+   * @param requestId The request ID. 本次请求的唯一标识。
+   * @param songCode The code of the music, which is an unique identifier of the music.
+   * @param simpleInfo 音乐资源的相关信息，包含下列内容：
+   *  副歌片段的开始和结束的时间（ms）
+   *  副歌片段的歌词下载地址
+   *  副歌片段时长（ms）
+   *  歌曲名称
+   *  歌手名
+   * @param reason 音乐内容中心的请求状态码，详见 MusicContentCenterStateReason 。
    */
   onSongSimpleInfoResult?(
     requestId: string,