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

package/types/Private/IAgoraMusicContentCenter.d.ts

@@ -1,255 +1,336 @@
-import './extension/IAgoraMusicContentCenterExtension';
-import { IMediaPlayer } from './IAgoraMediaPlayer';
-/**
- * @ignore
- */
-export declare enum PreloadStatusCode {
-    KPreloadStatusCompleted = 0,
-    KPreloadStatusFailed = 1,
-    KPreloadStatusPreloading = 2
-}
-/**
- * @ignore
- */
-export declare enum MusicContentCenterStatusCode {
-    KMusicContentCenterStatusOk = 0,
-    KMusicContentCenterStatusErr = 1
-}
-/**
- * @ignore
- */
-export declare class MusicChartInfo {
-    /**
-     * @ignore
-     */
-    chartName?: string;
-    /**
-     * @ignore
-     */
-    id?: number;
-}
-/**
- * @ignore
- */
-export declare abstract class MusicChartCollection {
-    /**
-     * @ignore
-     */
-    abstract getCount(): number;
-    /**
-     * @ignore
-     */
-    abstract get(index: number): MusicChartInfo;
-}
-/**
- * @ignore
- */
-export declare class MvProperty {
-    /**
-     * @ignore
-     */
-    resolution?: string;
-    /**
-     * @ignore
-     */
-    bandwidth?: string;
-}
-/**
- * The climax parts of the music.
- */
-export declare class ClimaxSegment {
-    /**
-     * The time (ms) when the climax part begins.
-     */
-    startTimeMs?: number;
-    /**
-     * The time (ms) when the climax part ends.
-     */
-    endTimeMs?: number;
-}
-/**
- * @ignore
- */
-export declare class Music {
-    /**
-     * @ignore
-     */
-    songCode?: number;
-    /**
-     * @ignore
-     */
-    name?: string;
-    /**
-     * @ignore
-     */
-    singer?: string;
-    /**
-     * @ignore
-     */
-    poster?: string;
-    /**
-     * @ignore
-     */
-    releaseTime?: string;
-    /**
-     * @ignore
-     */
-    durationS?: number;
-    /**
-     * @ignore
-     */
-    type?: number;
-    /**
-     * @ignore
-     */
-    pitchType?: number;
-    /**
-     * @ignore
-     */
-    lyricCount?: number;
-    /**
-     * @ignore
-     */
-    lyricList?: number[];
-    /**
-     * @ignore
-     */
-    climaxSegmentCount?: number;
-    /**
-     * @ignore
-     */
-    climaxSegmentList?: ClimaxSegment[];
-    /**
-     * @ignore
-     */
-    mvPropertyCount?: number;
-    /**
-     * @ignore
-     */
-    mvPropertyList?: MvProperty[];
-}
-/**
- * @ignore
- */
-export declare abstract class MusicCollection {
-    /**
-     * @ignore
-     */
-    abstract getCount(): number;
-    /**
-     * @ignore
-     */
-    abstract getTotal(): number;
-    /**
-     * @ignore
-     */
-    abstract getPage(): number;
-    /**
-     * @ignore
-     */
-    abstract getPageSize(): number;
-    /**
-     * @ignore
-     */
-    abstract getMusic(index: number): Music;
-}
-/**
- * @ignore
- */
-export interface IMusicContentCenterEventHandler {
-    /**
-     * @ignore
-     */
-    onMusicChartsResult?(requestId: string, status: MusicContentCenterStatusCode, result: MusicChartInfo[]): void;
-    /**
-     * @ignore
-     */
-    onMusicCollectionResult?(requestId: string, status: MusicContentCenterStatusCode, result: MusicCollection): void;
-    /**
-     * @ignore
-     */
-    onLyricResult?(requestId: string, lyricUrl: string): void;
-    /**
-     * @ignore
-     */
-    onPreLoadEvent?(songCode: number, percent: number, status: PreloadStatusCode, msg: string, lyricUrl?: string): void;
-}
-/**
- * @ignore
- */
-export declare class MusicContentCenterConfiguration {
-    /**
-     * @ignore
-     */
-    appId?: string;
-    /**
-     * @ignore
-     */
-    token?: string;
-    /**
-     * @ignore
-     */
-    mccUid?: number;
-}
-/**
- * @ignore
- */
-export declare abstract class IMusicPlayer extends IMediaPlayer {
-    /**
-     * @ignore
-     */
-    abstract openWithSongCode(songCode: number, startPos?: number): number;
-}
-/**
- * @ignore
- */
-export declare abstract class IMusicContentCenter {
-    /**
-     * @ignore
-     */
-    abstract initialize(configuration: MusicContentCenterConfiguration): number;
-    /**
-     * @ignore
-     */
-    abstract renewToken(token: string): number;
-    /**
-     * @ignore
-     */
-    abstract release(): void;
-    /**
-     * @ignore
-     */
-    abstract registerEventHandler(eventHandler: IMusicContentCenterEventHandler): number;
-    /**
-     * @ignore
-     */
-    abstract unregisterEventHandler(): number;
-    /**
-     * @ignore
-     */
-    abstract createMusicPlayer(): IMusicPlayer;
-    /**
-     * @ignore
-     */
-    abstract getMusicCharts(): string;
-    /**
-     * @ignore
-     */
-    abstract getMusicCollectionByMusicChartId(musicChartId: number, page: number, pageSize: number, jsonOption?: string): string;
-    /**
-     * @ignore
-     */
-    abstract searchMusic(requestId: string, keyWord: string, page: number, pageSize: number, jsonOption?: string): number;
-    /**
-     * @ignore
-     */
-    abstract preload(songCode: number, jsonOption?: string): number;
-    /**
-     * @ignore
-     */
-    abstract isPreloaded(songCode: number): number;
-    /**
-     * @ignore
-     */
-    abstract getLyric(songCode: number, lyricType?: number): string;
-}
+import './extension/IAgoraMusicContentCenterExtension';
+import { IMediaPlayer } from './IAgoraMediaPlayer';
+/**
+ * @ignore
+ */
+export declare enum PreloadStatusCode {
+    /**
+     * @ignore
+     */
+    KPreloadStatusCompleted = 0,
+    /**
+     * @ignore
+     */
+    KPreloadStatusFailed = 1,
+    /**
+     * @ignore
+     */
+    KPreloadStatusPreloading = 2,
+    /**
+     * @ignore
+     */
+    KPreloadStatusRemoved = 3
+}
+/**
+ * @ignore
+ */
+export declare enum MusicContentCenterStatusCode {
+    /**
+     * @ignore
+     */
+    KMusicContentCenterStatusOk = 0,
+    /**
+     * @ignore
+     */
+    KMusicContentCenterStatusErr = 1,
+    /**
+     * @ignore
+     */
+    KMusicContentCenterStatusErrGateway = 2,
+    /**
+     * @ignore
+     */
+    KMusicContentCenterStatusErrPermissionAndResource = 3,
+    /**
+     * @ignore
+     */
+    KMusicContentCenterStatusErrInternalDataParse = 4,
+    /**
+     * @ignore
+     */
+    KMusicContentCenterStatusErrMusicLoading = 5,
+    /**
+     * @ignore
+     */
+    KMusicContentCenterStatusErrMusicDecryption = 6
+}
+/**
+ * @ignore
+ */
+export declare class MusicChartInfo {
+    /**
+     * @ignore
+     */
+    chartName?: string;
+    /**
+     * @ignore
+     */
+    id?: number;
+}
+/**
+ * @ignore
+ */
+export declare enum MusicCacheStatusType {
+    /**
+     * @ignore
+     */
+    MusicCacheStatusTypeCached = 0,
+    /**
+     * @ignore
+     */
+    MusicCacheStatusTypeCaching = 1
+}
+/**
+ * @ignore
+ */
+export declare class MusicCacheInfo {
+    /**
+     * @ignore
+     */
+    songCode?: number;
+    /**
+     * @ignore
+     */
+    status?: MusicCacheStatusType;
+}
+/**
+ * @ignore
+ */
+export declare abstract class MusicChartCollection {
+    /**
+     * @ignore
+     */
+    abstract getCount(): number;
+    /**
+     * @ignore
+     */
+    abstract get(index: number): MusicChartInfo;
+}
+/**
+ * @ignore
+ */
+export declare class MvProperty {
+    /**
+     * @ignore
+     */
+    resolution?: string;
+    /**
+     * @ignore
+     */
+    bandwidth?: string;
+}
+/**
+ * The climax parts of the music.
+ */
+export declare class ClimaxSegment {
+    /**
+     * The time (ms) when the climax part begins.
+     */
+    startTimeMs?: number;
+    /**
+     * The time (ms) when the climax part ends.
+     */
+    endTimeMs?: number;
+}
+/**
+ * @ignore
+ */
+export declare class Music {
+    /**
+     * @ignore
+     */
+    songCode?: number;
+    /**
+     * @ignore
+     */
+    name?: string;
+    /**
+     * @ignore
+     */
+    singer?: string;
+    /**
+     * @ignore
+     */
+    poster?: string;
+    /**
+     * @ignore
+     */
+    releaseTime?: string;
+    /**
+     * @ignore
+     */
+    durationS?: number;
+    /**
+     * @ignore
+     */
+    type?: number;
+    /**
+     * @ignore
+     */
+    pitchType?: number;
+    /**
+     * @ignore
+     */
+    lyricCount?: number;
+    /**
+     * @ignore
+     */
+    lyricList?: number[];
+    /**
+     * @ignore
+     */
+    climaxSegmentCount?: number;
+    /**
+     * @ignore
+     */
+    climaxSegmentList?: ClimaxSegment[];
+    /**
+     * @ignore
+     */
+    mvPropertyCount?: number;
+    /**
+     * @ignore
+     */
+    mvPropertyList?: MvProperty[];
+}
+/**
+ * @ignore
+ */
+export declare abstract class MusicCollection {
+    /**
+     * @ignore
+     */
+    abstract getCount(): number;
+    /**
+     * @ignore
+     */
+    abstract getTotal(): number;
+    /**
+     * @ignore
+     */
+    abstract getPage(): number;
+    /**
+     * @ignore
+     */
+    abstract getPageSize(): number;
+    /**
+     * @ignore
+     */
+    abstract getMusic(index: number): Music;
+}
+/**
+ * @ignore
+ */
+export interface IMusicContentCenterEventHandler {
+    /**
+     * @ignore
+     */
+    onMusicChartsResult?(requestId: string, result: MusicChartInfo[], errorCode: MusicContentCenterStatusCode): void;
+    /**
+     * @ignore
+     */
+    onMusicCollectionResult?(requestId: string, result: MusicCollection, errorCode: MusicContentCenterStatusCode): void;
+    /**
+     * @ignore
+     */
+    onLyricResult?(requestId: string, lyricUrl: string, errorCode: MusicContentCenterStatusCode): void;
+    /**
+     * @ignore
+     */
+    onPreLoadEvent?(songCode: number, percent: number, lyricUrl: string, status: PreloadStatusCode, errorCode: MusicContentCenterStatusCode): void;
+}
+/**
+ * @ignore
+ */
+export declare class MusicContentCenterConfiguration {
+    /**
+     * @ignore
+     */
+    appId?: string;
+    /**
+     * @ignore
+     */
+    token?: string;
+    /**
+     * @ignore
+     */
+    mccUid?: number;
+    /**
+     * @ignore
+     */
+    maxCacheSize?: number;
+}
+/**
+ * @ignore
+ */
+export declare abstract class IMusicPlayer extends IMediaPlayer {
+    /**
+     * @ignore
+     */
+    abstract openWithSongCode(songCode: number, startPos?: number): number;
+}
+/**
+ * @ignore
+ */
+export declare abstract class IMusicContentCenter {
+    /**
+     * @ignore
+     */
+    abstract initialize(configuration: MusicContentCenterConfiguration): number;
+    /**
+     * @ignore
+     */
+    abstract renewToken(token: string): number;
+    /**
+     * @ignore
+     */
+    abstract release(): void;
+    /**
+     * @ignore
+     */
+    abstract registerEventHandler(eventHandler: IMusicContentCenterEventHandler): number;
+    /**
+     * @ignore
+     */
+    abstract unregisterEventHandler(): number;
+    /**
+     * @ignore
+     */
+    abstract createMusicPlayer(): IMusicPlayer;
+    /**
+     * @ignore
+     */
+    abstract getMusicCharts(): string;
+    /**
+     * @ignore
+     */
+    abstract getMusicCollectionByMusicChartId(musicChartId: number, page: number, pageSize: number, jsonOption?: string): string;
+    /**
+     * @ignore
+     */
+    abstract searchMusic(requestId: string, keyWord: string, page: number, pageSize: number, jsonOption?: string): number;
+    /**
+     * @ignore
+     */
+    abstract preload(songCode: number, jsonOption?: string): number;
+    /**
+     * @ignore
+     */
+    abstract removeCache(songCode: number): number;
+    /**
+     * @ignore
+     */
+    abstract getCaches(): {
+        cacheInfo: MusicCacheInfo[];
+        cacheInfoSize: number;
+    };
+    /**
+     * @ignore
+     */
+    abstract isPreloaded(songCode: number): number;
+    /**
+     * @ignore
+     */
+    abstract getLyric(songCode: number, lyricType?: number): string;
+}
+//# sourceMappingURL=IAgoraMusicContentCenter.d.ts.map

package/types/Private/IAgoraMusicContentCenter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAgoraMusicContentCenter.d.ts","sourceRoot":"","sources":["../../ts/Private/IAgoraMusicContentCenter.ts"],"names":[],"mappings":"AAAA,OAAO,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD;;GAEG;AACH,oBAAY,iBAAiB;IAC3B;;OAEG;IACH,uBAAuB,IAAI;IAC3B;;OAEG;IACH,oBAAoB,IAAI;IACxB;;OAEG;IACH,wBAAwB,IAAI;IAC5B;;OAEG;IACH,qBAAqB,IAAI;CAC1B;AAED;;GAEG;AACH,oBAAY,4BAA4B;IACtC;;OAEG;IACH,2BAA2B,IAAI;IAC/B;;OAEG;IACH,4BAA4B,IAAI;IAChC;;OAEG;IACH,mCAAmC,IAAI;IACvC;;OAEG;IACH,iDAAiD,IAAI;IACrD;;OAEG;IACH,6CAA6C,IAAI;IACjD;;OAEG;IACH,wCAAwC,IAAI;IAC5C;;OAEG;IACH,2CAA2C,IAAI;CAChD;AAED;;GAEG;AACH,qBAAa,cAAc;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,oBAAY,oBAAoB;IAC9B;;OAEG;IACH,0BAA0B,IAAI;IAC9B;;OAEG;IACH,2BAA2B,IAAI;CAChC;AAED;;GAEG;AACH,qBAAa,cAAc;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;CAC/B;AAED;;GAEG;AACH,8BAAsB,oBAAoB;IACxC;;OAEG;IACH,QAAQ,CAAC,QAAQ,IAAI,MAAM;IAE3B;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc;CAC5C;AAED;;GAEG;AACH,qBAAa,UAAU;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,aAAa;IACxB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,KAAK;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,aAAa,EAAE,CAAC;IACpC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,UAAU,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,8BAAsB,eAAe;IACnC;;OAEG;IACH,QAAQ,CAAC,QAAQ,IAAI,MAAM;IAE3B;;OAEG;IACH,QAAQ,CAAC,QAAQ,IAAI,MAAM;IAE3B;;OAEG;IACH,QAAQ,CAAC,OAAO,IAAI,MAAM;IAE1B;;OAEG;IACH,QAAQ,CAAC,WAAW,IAAI,MAAM;IAE9B;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,mBAAmB,CAAC,CAClB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,cAAc,EAAE,EACxB,SAAS,EAAE,4BAA4B,GACtC,IAAI,CAAC;IAER;;OAEG;IACH,uBAAuB,CAAC,CACtB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,eAAe,EACvB,SAAS,EAAE,4BAA4B,GACtC,IAAI,CAAC;IAER;;OAEG;IACH,aAAa,CAAC,CACZ,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,4BAA4B,GACtC,IAAI,CAAC;IAER;;OAEG;IACH,cAAc,CAAC,CACb,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,iBAAiB,EACzB,SAAS,EAAE,4BAA4B,GACtC,IAAI,CAAC;CACT;AAED;;GAEG;AACH,qBAAa,+BAA+B;IAC1C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,8BAAsB,YAAa,SAAQ,YAAY;IACrD;;OAEG;IACH,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM;CACvE;AAED;;GAEG;AACH,8BAAsB,mBAAmB;IACvC;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,aAAa,EAAE,+BAA+B,GAAG,MAAM;IAE3E;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAE1C;;OAEG;IACH,QAAQ,CAAC,OAAO,IAAI,IAAI;IAExB;;OAEG;IACH,QAAQ,CAAC,oBAAoB,CAC3B,YAAY,EAAE,+BAA+B,GAC5C,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,sBAAsB,IAAI,MAAM;IAEzC;;OAEG;IACH,QAAQ,CAAC,iBAAiB,IAAI,YAAY;IAE1C;;OAEG;IACH,QAAQ,CAAC,cAAc,IAAI,MAAM;IAEjC;;OAEG;IACH,QAAQ,CAAC,gCAAgC,CACvC,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,UAAU,CAAC,EAAE,MAAM,GAClB,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,WAAW,CAClB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,UAAU,CAAC,EAAE,MAAM,GAClB,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM;IAE/D;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAE9C;;OAEG;IACH,QAAQ,CAAC,SAAS,IAAI;QAAE,SAAS,EAAE,cAAc,EAAE,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE;IAE5E;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAE9C;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM;CAChE"}