agora-electron-sdk 4.3.2 → 4.4.0-dev.1

package/ts/Private/AgoraMediaBase.ts

@@ -1,6 +1,28 @@
 import './extension/AgoraMediaBaseExtension';
 import { EncodedVideoFrameInfo } from './AgoraBase';
 
+/**
+ * @ignore
+ */
+export class ExtensionContext {
+  /**
+   * @ignore
+   */
+  isValid?: boolean;
+  /**
+   * @ignore
+   */
+  uid?: number;
+  /**
+   * @ignore
+   */
+  providerName?: string;
+  /**
+   * @ignore
+   */
+  extensionName?: string;
+}
+
 /**
  * The type of the video source.
  */
@@ -449,6 +471,10 @@ export enum VideoPixelFormat {
    * @ignore
    */
   VideoCvpixelBgra = 14,
+  /**
+   * @ignore
+   */
+  VideoCvpixelP010 = 15,
   /**
    * 16: The format is I422.
    */
@@ -519,6 +545,294 @@ export abstract class IVideoFrameMetaInfo {
   abstract getMetaInfoStr(key: MetaInfoKey): string;
 }
 
+/**
+ * @ignore
+ */
+export enum PrimaryID {
+  /**
+   * @ignore
+   */
+  PrimaryidBt709 = 1,
+  /**
+   * @ignore
+   */
+  PrimaryidUnspecified = 2,
+  /**
+   * @ignore
+   */
+  PrimaryidBt470m = 4,
+  /**
+   * @ignore
+   */
+  PrimaryidBt470bg = 5,
+  /**
+   * @ignore
+   */
+  PrimaryidSmpte170m = 6,
+  /**
+   * @ignore
+   */
+  PrimaryidSmpte240m = 7,
+  /**
+   * @ignore
+   */
+  PrimaryidFilm = 8,
+  /**
+   * @ignore
+   */
+  PrimaryidBt2020 = 9,
+  /**
+   * @ignore
+   */
+  PrimaryidSmptest428 = 10,
+  /**
+   * @ignore
+   */
+  PrimaryidSmptest431 = 11,
+  /**
+   * @ignore
+   */
+  PrimaryidSmptest432 = 12,
+  /**
+   * @ignore
+   */
+  PrimaryidJedecp22 = 22,
+}
+
+/**
+ * @ignore
+ */
+export enum RangeID {
+  /**
+   * @ignore
+   */
+  RangeidInvalid = 0,
+  /**
+   * @ignore
+   */
+  RangeidLimited = 1,
+  /**
+   * @ignore
+   */
+  RangeidFull = 2,
+  /**
+   * @ignore
+   */
+  RangeidDerived = 3,
+}
+
+/**
+ * @ignore
+ */
+export enum MatrixID {
+  /**
+   * @ignore
+   */
+  MatrixidRgb = 0,
+  /**
+   * @ignore
+   */
+  MatrixidBt709 = 1,
+  /**
+   * @ignore
+   */
+  MatrixidUnspecified = 2,
+  /**
+   * @ignore
+   */
+  MatrixidFcc = 4,
+  /**
+   * @ignore
+   */
+  MatrixidBt470bg = 5,
+  /**
+   * @ignore
+   */
+  MatrixidSmpte170m = 6,
+  /**
+   * @ignore
+   */
+  MatrixidSmpte240m = 7,
+  /**
+   * @ignore
+   */
+  MatrixidYcocg = 8,
+  /**
+   * @ignore
+   */
+  MatrixidBt2020Ncl = 9,
+  /**
+   * @ignore
+   */
+  MatrixidBt2020Cl = 10,
+  /**
+   * @ignore
+   */
+  MatrixidSmpte2085 = 11,
+  /**
+   * @ignore
+   */
+  MatrixidCdncls = 12,
+  /**
+   * @ignore
+   */
+  MatrixidCdcls = 13,
+  /**
+   * @ignore
+   */
+  MatrixidBt2100Ictcp = 14,
+}
+
+/**
+ * @ignore
+ */
+export enum TransferID {
+  /**
+   * @ignore
+   */
+  TransferidBt709 = 1,
+  /**
+   * @ignore
+   */
+  TransferidUnspecified = 2,
+  /**
+   * @ignore
+   */
+  TransferidGamma22 = 4,
+  /**
+   * @ignore
+   */
+  TransferidGamma28 = 5,
+  /**
+   * @ignore
+   */
+  TransferidSmpte170m = 6,
+  /**
+   * @ignore
+   */
+  TransferidSmpte240m = 7,
+  /**
+   * @ignore
+   */
+  TransferidLinear = 8,
+  /**
+   * @ignore
+   */
+  TransferidLog = 9,
+  /**
+   * @ignore
+   */
+  TransferidLogSqrt = 10,
+  /**
+   * @ignore
+   */
+  TransferidIec6196624 = 11,
+  /**
+   * @ignore
+   */
+  TransferidBt1361Ecg = 12,
+  /**
+   * @ignore
+   */
+  TransferidIec6196621 = 13,
+  /**
+   * @ignore
+   */
+  TransferidBt202010 = 14,
+  /**
+   * @ignore
+   */
+  TransferidBt202012 = 15,
+  /**
+   * @ignore
+   */
+  TransferidSmptest2084 = 16,
+  /**
+   * @ignore
+   */
+  TransferidSmptest428 = 17,
+  /**
+   * @ignore
+   */
+  TransferidAribStdB67 = 18,
+}
+
+/**
+ * @ignore
+ */
+export class ColorSpace {
+  /**
+   * @ignore
+   */
+  primaries?: PrimaryID;
+  /**
+   * @ignore
+   */
+  transfer?: TransferID;
+  /**
+   * @ignore
+   */
+  matrix?: MatrixID;
+  /**
+   * @ignore
+   */
+  range?: RangeID;
+}
+
+/**
+ * @ignore
+ */
+export class Hdr10MetadataInfo {
+  /**
+   * @ignore
+   */
+  redPrimaryX?: number;
+  /**
+   * @ignore
+   */
+  redPrimaryY?: number;
+  /**
+   * @ignore
+   */
+  greenPrimaryX?: number;
+  /**
+   * @ignore
+   */
+  greenPrimaryY?: number;
+  /**
+   * @ignore
+   */
+  bluePrimaryX?: number;
+  /**
+   * @ignore
+   */
+  bluePrimaryY?: number;
+  /**
+   * @ignore
+   */
+  whitePointX?: number;
+  /**
+   * @ignore
+   */
+  whitePointY?: number;
+  /**
+   * @ignore
+   */
+  maxMasteringLuminance?: number;
+  /**
+   * @ignore
+   */
+  minMasteringLuminance?: number;
+  /**
+   * @ignore
+   */
+  maxContentLightLevel?: number;
+  /**
+   * @ignore
+   */
+  maxFrameAverageLightLevel?: number;
+}
+
 /**
  * @ignore
  */
@@ -607,6 +921,10 @@ export class ExternalVideoFrame {
    * This parameter only applies to video data in Texture format. Incoming 4 × 4 transformational matrix. The typical value is a unit matrix.
    */
   textureId?: number;
+  /**
+   * @ignore
+   */
+  fence_object?: number;
   /**
    * This parameter only applies to video data in Texture format. Incoming 4 × 4 transformational matrix. The typical value is a unit matrix.
    */
@@ -627,10 +945,22 @@ export class ExternalVideoFrame {
    * @ignore
    */
   fillAlphaBuffer?: boolean;
+  /**
+   * @ignore
+   */
+  alphaStitchMode?: number;
   /**
    * 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;
+  /**
+   * @ignore
+   */
+  hdr10MetadataInfo?: Hdr10MetadataInfo;
+  /**
+   * @ignore
+   */
+  colorSpace?: ColorSpace;
 }
 
 /**
@@ -707,6 +1037,10 @@ export class VideoFrame {
    * @ignore
    */
   alphaBuffer?: Uint8Array;
+  /**
+   * @ignore
+   */
+  alphaStitchMode?: number;
   /**
    * @ignore
    */
@@ -715,6 +1049,14 @@ export class VideoFrame {
    * The meta information in the video frame. To use this parameter, please.
    */
   metaInfo?: IVideoFrameMetaInfo;
+  /**
+   * @ignore
+   */
+  hdr10MetadataInfo?: Hdr10MetadataInfo;
+  /**
+   * @ignore
+   */
+  colorSpace?: ColorSpace;
 }
 
 /**
@@ -999,7 +1341,7 @@ export interface IAudioSpectrumObserver {
   /**
    * Gets the statistics of a local audio spectrum.
    *
-   * After successfully calling registerAudioSpectrumObserver to implement the onLocalAudioSpectrum callback in IAudioSpectrumObserver and calling enableAudioSpectrumMonitor to enable audio spectrum monitoring, the SDK will trigger the callback as the time interval you set to report the received remote audio data spectrum.
+   * After successfully calling registerAudioSpectrumObserver to implement the onLocalAudioSpectrum callback in IAudioSpectrumObserver and calling enableAudioSpectrumMonitor to enable audio spectrum monitoring, the SDK triggers this callback as the time interval you set to report the received remote audio data spectrum before encoding.
    *
    * @param data The audio spectrum data of the local user. See AudioSpectrumData.
    */

package/ts/Private/IAgoraMediaEngine.ts

@@ -119,7 +119,7 @@ export abstract class IMediaEngine {
    *
    * Before calling this method to push external audio data, perform the following steps:
    *  Call createCustomAudioTrack to create a custom audio track and get the audio track ID.
-   *  Call joinChannel to join the channel. In ChannelMediaOptions, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to true.
+   *  Call joinChannel to join the channel. In ChannelMediaOptions, set publishCustomAudioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to true.
    *
    * @param frame The external audio frame. See AudioFrame.
    * @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.
@@ -195,7 +195,7 @@ export abstract class IMediaEngine {
    *
    * Ensure that you call this method before joining a channel. To publish a custom audio source, see the following steps:
    *  Call this method to create a custom audio track and get the audio track ID.
-   *  Call joinChannel to join the channel. In ChannelMediaOptions, set publishCustomAduioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to true.
+   *  Call joinChannel to join the channel. In ChannelMediaOptions, set publishCustomAudioTrackId to the audio track ID that you want to publish, and set publishCustomAudioTrack to true.
    *  Call pushAudioFrame and specify trackId as the audio track ID set in step 2. You can then publish the corresponding custom audio source in the channel.
    *
    * @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.
@@ -203,7 +203,7 @@ export abstract class IMediaEngine {
    *
    * @returns
    * If the method call is successful, the audio track ID is returned as the unique identifier of the audio track.
-   *  If the method call fails, a negative value is returned.
+   *  If the method call fails, 0xffffffff is returned.
    */
   abstract createCustomAudioTrack(
     trackType: AudioTrackType,