agora-electron-sdk 4.1.1-rc.1 → 4.2.0-dev.13

package/ts/Private/IAgoraMusicContentCenter.ts

@@ -1,25 +1,60 @@
 import './extension/IAgoraMusicContentCenterExtension';
 import { IMediaPlayer } from './IAgoraMediaPlayer';
+
 /**
  * @ignore
  */
 export enum PreloadStatusCode {
-  /* enum__KPreloadStatusCompleted */
+  /**
+   * @ignore
+   */
   KPreloadStatusCompleted = 0,
-  /* enum__KPreloadStatusFailed */
+  /**
+   * @ignore
+   */
   KPreloadStatusFailed = 1,
-  /* enum__KPreloadStatusPreloading */
+  /**
+   * @ignore
+   */
   KPreloadStatusPreloading = 2,
+  /**
+   * @ignore
+   */
+  KPreloadStatusRemoved = 3,
 }
 
 /**
  * @ignore
  */
 export enum MusicContentCenterStatusCode {
-  /* enum__KMusicContentCenterStatusOk */
+  /**
+   * @ignore
+   */
   KMusicContentCenterStatusOk = 0,
-  /* enum__KMusicContentCenterStatusErr */
+  /**
+   * @ignore
+   */
   KMusicContentCenterStatusErr = 1,
+  /**
+   * @ignore
+   */
+  KMusicContentCenterStatusErrGateway = 2,
+  /**
+   * @ignore
+   */
+  KMusicContentCenterStatusErrPermissionAndResource = 3,
+  /**
+   * @ignore
+   */
+  KMusicContentCenterStatusErrInternalDataParse = 4,
+  /**
+   * @ignore
+   */
+  KMusicContentCenterStatusErrMusicLoading = 5,
+  /**
+   * @ignore
+   */
+  KMusicContentCenterStatusErrMusicDecryption = 6,
 }
 
 /**
@@ -36,6 +71,34 @@ export class MusicChartInfo {
   id?: number;
 }
 
+/**
+ * @ignore
+ */
+export enum MusicCacheStatusType {
+  /**
+   * @ignore
+   */
+  MusicCacheStatusTypeCached = 0,
+  /**
+   * @ignore
+   */
+  MusicCacheStatusTypeCaching = 1,
+}
+
+/**
+ * @ignore
+ */
+export class MusicCacheInfo {
+  /**
+   * @ignore
+   */
+  songCode?: number;
+  /**
+   * @ignore
+   */
+  status?: MusicCacheStatusType;
+}
+
 /**
  * @ignore
  */
@@ -180,8 +243,8 @@ export interface IMusicContentCenterEventHandler {
    */
   onMusicChartsResult?(
     requestId: string,
-    status: MusicContentCenterStatusCode,
-    result: MusicChartInfo[]
+    result: MusicChartInfo[],
+    errorCode: MusicContentCenterStatusCode
   ): void;
 
   /**
@@ -189,14 +252,18 @@ export interface IMusicContentCenterEventHandler {
    */
   onMusicCollectionResult?(
     requestId: string,
-    status: MusicContentCenterStatusCode,
-    result: MusicCollection
+    result: MusicCollection,
+    errorCode: MusicContentCenterStatusCode
   ): void;
 
   /**
    * @ignore
    */
-  onLyricResult?(requestId: string, lyricUrl: string): void;
+  onLyricResult?(
+    requestId: string,
+    lyricUrl: string,
+    errorCode: MusicContentCenterStatusCode
+  ): void;
 
   /**
    * @ignore
@@ -204,9 +271,9 @@ export interface IMusicContentCenterEventHandler {
   onPreLoadEvent?(
     songCode: number,
     percent: number,
+    lyricUrl: string,
     status: PreloadStatusCode,
-    msg: string,
-    lyricUrl?: string
+    errorCode: MusicContentCenterStatusCode
   ): void;
 }
 
@@ -226,6 +293,10 @@ export class MusicContentCenterConfiguration {
    * @ignore
    */
   mccUid?: number;
+  /**
+   * @ignore
+   */
+  maxCacheSize?: number;
 }
 
 /**
@@ -305,6 +376,16 @@ export abstract class IMusicContentCenter {
    */
   abstract preload(songCode: number, jsonOption?: string): number;
 
+  /**
+   * @ignore
+   */
+  abstract removeCache(songCode: number): number;
+
+  /**
+   * @ignore
+   */
+  abstract getCaches(): { cacheInfo: MusicCacheInfo[]; cacheInfoSize: number };
+
   /**
    * @ignore
    */