agora-electron-sdk 4.2.6 → 4.3.0-dev.1

package/ts/Private/IAgoraMediaPlayer.ts

@@ -134,7 +134,7 @@ export abstract class IMediaPlayer {
    *
    * @returns
    * Returns the current playback progress (ms) if the call succeeds.
-   *  < 0: Failure. See MediaPlayerError.
+   *  < 0: Failure. See MediaPlayerReason.
    */
   abstract getPlayPosition(): number;
 
@@ -145,7 +145,7 @@ export abstract class IMediaPlayer {
    *
    * @returns
    * The number of the media streams in the media resource if the method call succeeds.
-   *  < 0: Failure. See MediaPlayerError.
+   *  < 0: Failure. See MediaPlayerReason.
    */
   abstract getStreamCount(): number;
 
@@ -154,11 +154,11 @@ export abstract class IMediaPlayer {
    *
    * Call this method after calling getStreamCount.
    *
-   * @param index The index of the media stream.
+   * @param index The index of the media stream. This parameter must be less than the return value of getStreamCount.
    *
    * @returns
    * If the call succeeds, returns the detailed information of the media stream. See PlayerStreamInfo.
-   *  If the call fails, returns NULL.
+   *  If the call fails, returns null.
    */
   abstract getStreamInfo(index: number): PlayerStreamInfo;
 
@@ -207,12 +207,10 @@ export abstract class IMediaPlayer {
   /**
    * @ignore
    */
-  abstract setPlayerOptionInInt(key: string, value: number): number;
-
-  /**
-   * @ignore
-   */
-  abstract setPlayerOptionInString(key: string, value: string): number;
+  abstract selectMultiAudioTrack(
+    playoutTrackIndex: number,
+    publishTrackIndex: number
+  ): number;
 
   /**
    * @ignore
@@ -558,6 +556,34 @@ export abstract class IMediaPlayer {
    * @ignore
    */
   abstract setSoundPositionParams(pan: number, gain: number): number;
+
+  /**
+   * Set media player options for providing technical previews or special customization features.
+   *
+   * 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.
+   *
+   * @param key The key of the option.
+   * @param value The value of the key.
+   *
+   * @returns
+   * 0: Success.
+   *  < 0: Failure.
+   */
+  abstract setPlayerOptionInInt(key: string, value: number): number;
+
+  /**
+   * Set media player options for providing technical previews or special customization features.
+   *
+   * 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.
+   *
+   * @param key The key of the option.
+   * @param value The value of the key.
+   *
+   * @returns
+   * 0: Success.
+   *  < 0: Failure.
+   */
+  abstract setPlayerOptionInString(key: string, value: string): number;
 }
 
 /**
@@ -571,7 +597,7 @@ export abstract class IMediaPlayerCacheManager {
    *
    * @returns
    * 0: Success.
-   *  < 0: Failure. See MediaPlayerError.
+   *  < 0: Failure. See MediaPlayerReason.
    */
   abstract removeAllCaches(): number;
 
@@ -582,7 +608,7 @@ export abstract class IMediaPlayerCacheManager {
    *
    * @returns
    * 0: Success.
-   *  < 0: Failure. See MediaPlayerError.
+   *  < 0: Failure. See MediaPlayerReason.
    */
   abstract removeOldCache(): number;
 
@@ -595,7 +621,7 @@ export abstract class IMediaPlayerCacheManager {
    *
    * @returns
    * 0: Success.
-   *  < 0: Failure. See MediaPlayerError.
+   *  < 0: Failure. See MediaPlayerReason.
    */
   abstract removeCacheByUri(uri: string): number;
 
@@ -608,7 +634,7 @@ export abstract class IMediaPlayerCacheManager {
    *
    * @returns
    * 0: Success.
-   *  < 0: Failure. See MediaPlayerError.
+   *  < 0: Failure. See MediaPlayerReason.
    */
   abstract setCacheDir(path: string): number;
 
@@ -619,7 +645,7 @@ export abstract class IMediaPlayerCacheManager {
    *
    * @returns
    * 0: Success.
-   *  < 0: Failure. See MediaPlayerError.
+   *  < 0: Failure. See MediaPlayerReason.
    */
   abstract setMaxCacheFileCount(count: number): number;
 
@@ -630,7 +656,7 @@ export abstract class IMediaPlayerCacheManager {
    *
    * @returns
    * 0: Success.
-   *  < 0: Failure. See MediaPlayerError.
+   *  < 0: Failure. See MediaPlayerReason.
    */
   abstract setMaxCacheFileSize(cacheSize: number): number;
 
@@ -643,7 +669,7 @@ export abstract class IMediaPlayerCacheManager {
    *
    * @returns
    * 0: Success.
-   *  < 0: Failure. See MediaPlayerError.
+   *  < 0: Failure. See MediaPlayerReason.
    */
   abstract enableAutoRemoveCache(enable: boolean): number;
 
@@ -656,7 +682,7 @@ export abstract class IMediaPlayerCacheManager {
    *
    * @returns
    * The call succeeds, and the SDK returns the storage path of the cached media files.
-   *  < 0: Failure. See MediaPlayerError.
+   *  < 0: Failure. See MediaPlayerReason.
    */
   abstract getCacheDir(length: number): string;
 
@@ -667,7 +693,7 @@ export abstract class IMediaPlayerCacheManager {
    *
    * @returns
    * > 0: The call succeeds and returns the maximum number of media files that can be cached.
-   *  < 0: Failure. See MediaPlayerError.
+   *  < 0: Failure. See MediaPlayerReason.
    */
   abstract getMaxCacheFileCount(): number;
 
@@ -678,7 +704,7 @@ export abstract class IMediaPlayerCacheManager {
    *
    * @returns
    * > 0: The call succeeds and returns the maximum size (in bytes) of the aggregate storage space for cached media files.
-   *  < 0: Failure. See MediaPlayerError.
+   *  < 0: Failure. See MediaPlayerReason.
    */
   abstract getMaxCacheFileSize(): number;
 
@@ -687,7 +713,7 @@ export abstract class IMediaPlayerCacheManager {
    *
    * @returns
    * ≥ 0: The call succeeds and returns the number of media files that are cached.
-   *  < 0: Failure. See MediaPlayerError.
+   *  < 0: Failure. See MediaPlayerReason.
    */
   abstract getCacheFileCount(): number;
 }

package/ts/Private/IAgoraMediaPlayerSource.ts

@@ -1,8 +1,10 @@
 import './extension/IAgoraMediaPlayerSourceExtension';
 import {
-  MediaPlayerError,
+  CacheStatistics,
   MediaPlayerEvent,
+  MediaPlayerReason,
   MediaPlayerState,
+  PlayerPlaybackStats,
   PlayerPreloadEvent,
   PlayerUpdatedInfo,
   SrcInfo,
@@ -18,21 +20,22 @@ export interface IMediaPlayerSourceObserver {
    * When the state of the media player changes, the SDK triggers this callback to report the current playback state.
    *
    * @param state The playback state. See MediaPlayerState.
-   * @param ec The error code. See MediaPlayerError.
+   * @param reason The reason for the changes in the media player status. See MediaPlayerReason.
    */
   onPlayerSourceStateChanged?(
     state: MediaPlayerState,
-    ec: MediaPlayerError
+    reason: MediaPlayerReason
   ): void;
 
   /**
-   * Reports current playback progress.
+   * Reports the playback progress of the media file.
    *
    * When playing media files, the SDK triggers this callback every two second to report current playback progress.
    *
-   * @param position The playback position (ms) of media files.
+   * @param positionMs The playback position (ms) of media files.
+   * @param timeStampMs The NTP timestamp (ms) of the current playback progress.
    */
-  onPositionChanged?(positionMs: number): void;
+  onPositionChanged?(positionMs: number, timestampMs: number): void;
 
   /**
    * Reports the player events.
@@ -105,6 +108,24 @@ export interface IMediaPlayerSourceObserver {
    */
   onPlayerInfoUpdated?(info: PlayerUpdatedInfo): void;
 
+  /**
+   * Reports the statistics of the media file being cached.
+   *
+   * After you call the openWithMediaSource method and set enableCache as true, the SDK triggers this callback once per second to report the statistics of the media file being cached.
+   *
+   * @param stats The statistics of the media file being cached. See CacheStatistics.
+   */
+  onPlayerCacheStats?(stats: CacheStatistics): void;
+
+  /**
+   * The statistics of the media file being played.
+   *
+   * The SDK triggers this callback once per second to report the statistics of the media file being played.
+   *
+   * @param stats The statistics of the media file. See PlayerPlaybackStats.
+   */
+  onPlayerPlaybackStats?(stats: PlayerPlaybackStats): void;
+
   /**
    * Reports the volume of the media player.
    *

package/ts/Private/IAgoraMediaStreamingSource.ts

@@ -1,80 +1,81 @@
 import './extension/IAgoraMediaStreamingSourceExtension';
-/* enum_streamingsrcerr */
+
+/* enum_StreamingSrcErr */
 export enum StreamingSrcErr {
-  /* enum_streamingsrcerr_StreamingSrcErrNone */
+  /* enum_StreamingSrcErr_StreamingSrcErrNone */
   StreamingSrcErrNone = 0,
-  /* enum_streamingsrcerr_StreamingSrcErrUnknown */
+  /* enum_StreamingSrcErr_StreamingSrcErrUnknown */
   StreamingSrcErrUnknown = 1,
-  /* enum_streamingsrcerr_StreamingSrcErrInvalidParam */
+  /* enum_StreamingSrcErr_StreamingSrcErrInvalidParam */
   StreamingSrcErrInvalidParam = 2,
-  /* enum_streamingsrcerr_StreamingSrcErrBadState */
+  /* enum_StreamingSrcErr_StreamingSrcErrBadState */
   StreamingSrcErrBadState = 3,
-  /* enum_streamingsrcerr_StreamingSrcErrNoMem */
+  /* enum_StreamingSrcErr_StreamingSrcErrNoMem */
   StreamingSrcErrNoMem = 4,
-  /* enum_streamingsrcerr_StreamingSrcErrBufferOverflow */
+  /* enum_StreamingSrcErr_StreamingSrcErrBufferOverflow */
   StreamingSrcErrBufferOverflow = 5,
-  /* enum_streamingsrcerr_StreamingSrcErrBufferUnderflow */
+  /* enum_StreamingSrcErr_StreamingSrcErrBufferUnderflow */
   StreamingSrcErrBufferUnderflow = 6,
-  /* enum_streamingsrcerr_StreamingSrcErrNotFound */
+  /* enum_StreamingSrcErr_StreamingSrcErrNotFound */
   StreamingSrcErrNotFound = 7,
-  /* enum_streamingsrcerr_StreamingSrcErrTimeout */
+  /* enum_StreamingSrcErr_StreamingSrcErrTimeout */
   StreamingSrcErrTimeout = 8,
-  /* enum_streamingsrcerr_StreamingSrcErrExpired */
+  /* enum_StreamingSrcErr_StreamingSrcErrExpired */
   StreamingSrcErrExpired = 9,
-  /* enum_streamingsrcerr_StreamingSrcErrUnsupported */
+  /* enum_StreamingSrcErr_StreamingSrcErrUnsupported */
   StreamingSrcErrUnsupported = 10,
-  /* enum_streamingsrcerr_StreamingSrcErrNotExist */
+  /* enum_StreamingSrcErr_StreamingSrcErrNotExist */
   StreamingSrcErrNotExist = 11,
-  /* enum_streamingsrcerr_StreamingSrcErrExist */
+  /* enum_StreamingSrcErr_StreamingSrcErrExist */
   StreamingSrcErrExist = 12,
-  /* enum_streamingsrcerr_StreamingSrcErrOpen */
+  /* enum_StreamingSrcErr_StreamingSrcErrOpen */
   StreamingSrcErrOpen = 13,
-  /* enum_streamingsrcerr_StreamingSrcErrClose */
+  /* enum_StreamingSrcErr_StreamingSrcErrClose */
   StreamingSrcErrClose = 14,
-  /* enum_streamingsrcerr_StreamingSrcErrRead */
+  /* enum_StreamingSrcErr_StreamingSrcErrRead */
   StreamingSrcErrRead = 15,
-  /* enum_streamingsrcerr_StreamingSrcErrWrite */
+  /* enum_StreamingSrcErr_StreamingSrcErrWrite */
   StreamingSrcErrWrite = 16,
-  /* enum_streamingsrcerr_StreamingSrcErrSeek */
+  /* enum_StreamingSrcErr_StreamingSrcErrSeek */
   StreamingSrcErrSeek = 17,
-  /* enum_streamingsrcerr_StreamingSrcErrEof */
+  /* enum_StreamingSrcErr_StreamingSrcErrEof */
   StreamingSrcErrEof = 18,
-  /* enum_streamingsrcerr_StreamingSrcErrCodecopen */
+  /* enum_StreamingSrcErr_StreamingSrcErrCodecopen */
   StreamingSrcErrCodecopen = 19,
-  /* enum_streamingsrcerr_StreamingSrcErrCodecclose */
+  /* enum_StreamingSrcErr_StreamingSrcErrCodecclose */
   StreamingSrcErrCodecclose = 20,
-  /* enum_streamingsrcerr_StreamingSrcErrCodecproc */
+  /* enum_StreamingSrcErr_StreamingSrcErrCodecproc */
   StreamingSrcErrCodecproc = 21,
 }
 
-/* enum_streamingsrcstate */
+/* enum_StreamingSrcState */
 export enum StreamingSrcState {
-  /* enum_streamingsrcstate_StreamingSrcStateClosed */
+  /* enum_StreamingSrcState_StreamingSrcStateClosed */
   StreamingSrcStateClosed = 0,
-  /* enum_streamingsrcstate_StreamingSrcStateOpening */
+  /* enum_StreamingSrcState_StreamingSrcStateOpening */
   StreamingSrcStateOpening = 1,
-  /* enum_streamingsrcstate_StreamingSrcStateIdle */
+  /* enum_StreamingSrcState_StreamingSrcStateIdle */
   StreamingSrcStateIdle = 2,
-  /* enum_streamingsrcstate_StreamingSrcStatePlaying */
+  /* enum_StreamingSrcState_StreamingSrcStatePlaying */
   StreamingSrcStatePlaying = 3,
-  /* enum_streamingsrcstate_StreamingSrcStateSeeking */
+  /* enum_StreamingSrcState_StreamingSrcStateSeeking */
   StreamingSrcStateSeeking = 4,
-  /* enum_streamingsrcstate_StreamingSrcStateEof */
+  /* enum_StreamingSrcState_StreamingSrcStateEof */
   StreamingSrcStateEof = 5,
-  /* enum_streamingsrcstate_StreamingSrcStateError */
+  /* enum_StreamingSrcState_StreamingSrcStateError */
   StreamingSrcStateError = 6,
 }
 
-/* class_inputseidata */
+/* class_InputSeiData */
 export class InputSeiData {
-  /* class_inputseidata_type */
+  /* class_InputSeiData_type */
   type?: number;
-  /* class_inputseidata_timestamp */
+  /* class_InputSeiData_timestamp */
   timestamp?: number;
-  /* class_inputseidata_frame_index */
+  /* class_InputSeiData_frame_index */
   frame_index?: number;
-  /* class_inputseidata_private_data */
+  /* class_InputSeiData_private_data */
   private_data?: Uint8Array;
-  /* class_inputseidata_data_size */
+  /* class_InputSeiData_data_size */
   data_size?: number;
 }

package/ts/Private/IAgoraMusicContentCenter.ts

@@ -4,61 +4,61 @@ import { IMediaPlayer } from './IAgoraMediaPlayer';
 /**
  * @ignore
  */
-export enum PreloadStatusCode {
+export enum PreloadState {
   /**
    * @ignore
    */
-  KPreloadStatusCompleted = 0,
+  KPreloadStateCompleted = 0,
   /**
    * @ignore
    */
-  KPreloadStatusFailed = 1,
+  KPreloadStateFailed = 1,
   /**
    * @ignore
    */
-  KPreloadStatusPreloading = 2,
+  KPreloadStatePreloading = 2,
   /**
    * @ignore
    */
-  KPreloadStatusRemoved = 3,
+  KPreloadStateRemoved = 3,
 }
 
 /**
  * @ignore
  */
-export enum MusicContentCenterStatusCode {
+export enum MusicContentCenterStateReason {
   /**
    * @ignore
    */
-  KMusicContentCenterStatusOk = 0,
+  KMusicContentCenterReasonOk = 0,
   /**
    * @ignore
    */
-  KMusicContentCenterStatusErr = 1,
+  KMusicContentCenterReasonError = 1,
   /**
    * @ignore
    */
-  KMusicContentCenterStatusErrGateway = 2,
+  KMusicContentCenterReasonGateway = 2,
   /**
    * @ignore
    */
-  KMusicContentCenterStatusErrPermissionAndResource = 3,
+  KMusicContentCenterReasonPermissionAndResource = 3,
   /**
    * @ignore
    */
-  KMusicContentCenterStatusErrInternalDataParse = 4,
+  KMusicContentCenterReasonInternalDataParse = 4,
   /**
    * @ignore
    */
-  KMusicContentCenterStatusErrMusicLoading = 5,
+  KMusicContentCenterReasonMusicLoading = 5,
   /**
    * @ignore
    */
-  KMusicContentCenterStatusErrMusicDecryption = 6,
+  KMusicContentCenterReasonMusicDecryption = 6,
   /**
    * @ignore
    */
-  KMusicContentCenterStatusErrHttpInternalError = 7,
+  KMusicContentCenterReasonHttpInternalError = 7,
 }
 
 /**
@@ -248,7 +248,7 @@ export interface IMusicContentCenterEventHandler {
   onMusicChartsResult?(
     requestId: string,
     result: MusicChartInfo[],
-    errorCode: MusicContentCenterStatusCode
+    reason: MusicContentCenterStateReason
   ): void;
 
   /**
@@ -257,7 +257,7 @@ export interface IMusicContentCenterEventHandler {
   onMusicCollectionResult?(
     requestId: string,
     result: MusicCollection,
-    errorCode: MusicContentCenterStatusCode
+    reason: MusicContentCenterStateReason
   ): void;
 
   /**
@@ -267,7 +267,7 @@ export interface IMusicContentCenterEventHandler {
     requestId: string,
     songCode: number,
     lyricUrl: string,
-    errorCode: MusicContentCenterStatusCode
+    reason: MusicContentCenterStateReason
   ): void;
 
   /**
@@ -277,7 +277,7 @@ export interface IMusicContentCenterEventHandler {
     requestId: string,
     songCode: number,
     simpleInfo: string,
-    errorCode: MusicContentCenterStatusCode
+    reason: MusicContentCenterStateReason
   ): void;
 
   /**
@@ -288,8 +288,8 @@ export interface IMusicContentCenterEventHandler {
     songCode: number,
     percent: number,
     lyricUrl: string,
-    status: PreloadStatusCode,
-    errorCode: MusicContentCenterStatusCode
+    state: PreloadState,
+    reason: MusicContentCenterStateReason
   ): void;
 }
 

package/ts/Private/IAgoraRhythmPlayer.ts

@@ -1,4 +1,5 @@
 import './extension/IAgoraRhythmPlayerExtension';
+
 /**
  * @ignore
  */
@@ -28,27 +29,27 @@ export enum RhythmPlayerStateType {
 /**
  * @ignore
  */
-export enum RhythmPlayerErrorType {
+export enum RhythmPlayerReason {
   /**
    * @ignore
    */
-  RhythmPlayerErrorOk = 0,
+  RhythmPlayerReasonOk = 0,
   /**
    * @ignore
    */
-  RhythmPlayerErrorFailed = 1,
+  RhythmPlayerReasonFailed = 1,
   /**
    * @ignore
    */
-  RhythmPlayerErrorCanNotOpen = 801,
+  RhythmPlayerReasonCanNotOpen = 801,
   /**
    * @ignore
    */
-  RhythmPlayerErrorCanNotPlay = 802,
+  RhythmPlayerReasonCanNotPlay = 802,
   /**
    * @ignore
    */
-  RhythmPlayerErrorFileOverDurationLimit = 803,
+  RhythmPlayerReasonFileOverDurationLimit = 803,
 }
 
 /**