shengwang-electron-sdk 4.6.2-rc.1

package/js/Private/IAgoraMusicContentCenter.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IMusicContentCenter = exports.IMusicPlayer = exports.MusicContentCenterConfiguration = exports.MusicCollection = exports.Music = exports.ClimaxSegment = exports.MvProperty = exports.MusicChartCollection = exports.MusicCacheInfo = exports.MusicCacheStatusType = exports.MusicChartInfo = exports.MusicContentCenterStateReason = exports.PreloadState = exports.MusicPlayMode = void 0;
+require("./extension/IAgoraMusicContentCenterExtension");
+const IAgoraMediaPlayer_1 = require("./IAgoraMediaPlayer");
+/**
+ * 音乐资源的播放模式。
+ */
+var MusicPlayMode;
+(function (MusicPlayMode) {
+    /**
+     * 0：原唱。
+     */
+    MusicPlayMode[MusicPlayMode["KMusicPlayModeOriginal"] = 0] = "KMusicPlayModeOriginal";
+    /**
+     * 1：伴唱。
+     */
+    MusicPlayMode[MusicPlayMode["KMusicPlayModeAccompany"] = 1] = "KMusicPlayModeAccompany";
+    /**
+     * 2：导唱。
+     */
+    MusicPlayMode[MusicPlayMode["KMusicPlayModeLeadSing"] = 2] = "KMusicPlayModeLeadSing";
+})(MusicPlayMode = exports.MusicPlayMode || (exports.MusicPlayMode = {}));
+/**
+ * 音乐资源的加载状态。
+ */
+var PreloadState;
+(function (PreloadState) {
+    /**
+     * 0：音乐资源加载完成。
+     */
+    PreloadState[PreloadState["KPreloadStateCompleted"] = 0] = "KPreloadStateCompleted";
+    /**
+     * 1：音乐资源加载失败。
+     */
+    PreloadState[PreloadState["KPreloadStateFailed"] = 1] = "KPreloadStateFailed";
+    /**
+     * 2：音乐资源正在加载中。
+     */
+    PreloadState[PreloadState["KPreloadStatePreloading"] = 2] = "KPreloadStatePreloading";
+    /**
+     * 3：缓存的音乐资源已被移除。
+     */
+    PreloadState[PreloadState["KPreloadStateRemoved"] = 3] = "KPreloadStateRemoved";
+})(PreloadState = exports.PreloadState || (exports.PreloadState = {}));
+/**
+ * 音乐内容中心的请求状态码。
+ */
+var MusicContentCenterStateReason;
+(function (MusicContentCenterStateReason) {
+    /**
+     * 0：请求成功。
+     */
+    MusicContentCenterStateReason[MusicContentCenterStateReason["KMusicContentCenterReasonOk"] = 0] = "KMusicContentCenterReasonOk";
+    /**
+     * 1：一般错误，无明确归因。
+     */
+    MusicContentCenterStateReason[MusicContentCenterStateReason["KMusicContentCenterReasonError"] = 1] = "KMusicContentCenterReasonError";
+    /**
+     * 2：网关异常。可能的原因有：
+     *  当前使用的 Token 已过期。请重新生成 Token。
+     *  传入的 Token 无效。请确保你使用的是 RTM Token。
+     *  网络错误。请检查你的网络。
+     */
+    MusicContentCenterStateReason[MusicContentCenterStateReason["KMusicContentCenterReasonGateway"] = 2] = "KMusicContentCenterReasonGateway";
+    /**
+     * 3：权限错误或音乐资源不存在。请确保你的项目已开通声网音乐内容中心权限，请[联系技术支持](https://ticket.shengwang.cn/)。
+     */
+    MusicContentCenterStateReason[MusicContentCenterStateReason["KMusicContentCenterReasonPermissionAndResource"] = 3] = "KMusicContentCenterReasonPermissionAndResource";
+    /**
+     * 4：内部数据解析错误。请[联系技术支持](https://ticket.shengwang.cn/)。
+     */
+    MusicContentCenterStateReason[MusicContentCenterStateReason["KMusicContentCenterReasonInternalDataParse"] = 4] = "KMusicContentCenterReasonInternalDataParse";
+    /**
+     * 5：音乐资源加载时出错。请[联系技术支持](https://ticket.shengwang.cn/)。
+     */
+    MusicContentCenterStateReason[MusicContentCenterStateReason["KMusicContentCenterReasonMusicLoading"] = 5] = "KMusicContentCenterReasonMusicLoading";
+    /**
+     * 6：音乐资源解密时出错。请[联系技术支持](https://ticket.shengwang.cn/)。
+     */
+    MusicContentCenterStateReason[MusicContentCenterStateReason["KMusicContentCenterReasonMusicDecryption"] = 6] = "KMusicContentCenterReasonMusicDecryption";
+    /**
+     * 7：HTTP 内部出现错误。请稍后重试。
+     */
+    MusicContentCenterStateReason[MusicContentCenterStateReason["KMusicContentCenterReasonHttpInternalError"] = 7] = "KMusicContentCenterReasonHttpInternalError";
+})(MusicContentCenterStateReason = exports.MusicContentCenterStateReason || (exports.MusicContentCenterStateReason = {}));
+/**
+ * 音乐榜单的详细信息。
+ */
+class MusicChartInfo {
+}
+exports.MusicChartInfo = MusicChartInfo;
+/**
+ * 音乐资源的缓存状态。
+ */
+var MusicCacheStatusType;
+(function (MusicCacheStatusType) {
+    /**
+     * 0: 音乐资源已缓存。
+     */
+    MusicCacheStatusType[MusicCacheStatusType["MusicCacheStatusTypeCached"] = 0] = "MusicCacheStatusTypeCached";
+    /**
+     * 1: 音乐资源正在缓存。
+     */
+    MusicCacheStatusType[MusicCacheStatusType["MusicCacheStatusTypeCaching"] = 1] = "MusicCacheStatusTypeCaching";
+})(MusicCacheStatusType = exports.MusicCacheStatusType || (exports.MusicCacheStatusType = {}));
+/**
+ * 缓存的音乐资源的相关信息。
+ */
+class MusicCacheInfo {
+}
+exports.MusicCacheInfo = MusicCacheInfo;
+/**
+ * 音乐榜单的详细信息。
+ */
+class MusicChartCollection {
+}
+exports.MusicChartCollection = MusicChartCollection;
+/**
+ * @ignore
+ */
+class MvProperty {
+}
+exports.MvProperty = MvProperty;
+/**
+ * 音乐高潮片段设置。
+ */
+class ClimaxSegment {
+}
+exports.ClimaxSegment = ClimaxSegment;
+/**
+ * 音乐资源的详细信息。
+ */
+class Music {
+}
+exports.Music = Music;
+/**
+ * 音乐资源列表的详细信息。
+ */
+class MusicCollection {
+}
+exports.MusicCollection = MusicCollection;
+/**
+ * 音乐内容中心的设置。
+ */
+class MusicContentCenterConfiguration {
+}
+exports.MusicContentCenterConfiguration = MusicContentCenterConfiguration;
+/**
+ * 继承自 IMediaPlayer 类，提供音乐播放器的相关方法。
+ */
+class IMusicPlayer extends IAgoraMediaPlayer_1.IMediaPlayer {
+}
+exports.IMusicPlayer = IMusicPlayer;
+/**
+ * IMusicContentCenter 接口类提供音乐内容中心的相关方法。
+ */
+class IMusicContentCenter {
+}
+exports.IMusicContentCenter = IMusicContentCenter;

package/js/Private/IAgoraRhythmPlayer.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgoraRhythmPlayerConfig = exports.RhythmPlayerReason = exports.RhythmPlayerStateType = void 0;
+require("./extension/IAgoraRhythmPlayerExtension");
+/**
+ * 虚拟节拍器状态。
+ */
+var RhythmPlayerStateType;
+(function (RhythmPlayerStateType) {
+    /**
+     * 810：虚拟节拍器未开启或已关闭。
+     */
+    RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateIdle"] = 810] = "RhythmPlayerStateIdle";
+    /**
+     * 811：正在打开节拍音频文件。
+     */
+    RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateOpening"] = 811] = "RhythmPlayerStateOpening";
+    /**
+     * 812：正在解码节拍音频文件。
+     */
+    RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateDecoding"] = 812] = "RhythmPlayerStateDecoding";
+    /**
+     * 813：正在播放节拍音频文件。
+     */
+    RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStatePlaying"] = 813] = "RhythmPlayerStatePlaying";
+    /**
+     * 814：开启虚拟节拍器失败。你可以通过报告的错误码 errorCode 排查错误原因，也可以重新尝试开启虚拟节拍器。
+     */
+    RhythmPlayerStateType[RhythmPlayerStateType["RhythmPlayerStateFailed"] = 814] = "RhythmPlayerStateFailed";
+})(RhythmPlayerStateType = exports.RhythmPlayerStateType || (exports.RhythmPlayerStateType = {}));
+/**
+ * 虚拟节拍器错误信息。
+ */
+var RhythmPlayerReason;
+(function (RhythmPlayerReason) {
+    /**
+     * 0：正常播放节拍音频文件，没有错误。
+     */
+    RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonOk"] = 0] = "RhythmPlayerReasonOk";
+    /**
+     * 1：一般性错误，没有明确原因。
+     */
+    RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonFailed"] = 1] = "RhythmPlayerReasonFailed";
+    /**
+     * 801：打开节拍音频文件出错。
+     */
+    RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonCanNotOpen"] = 801] = "RhythmPlayerReasonCanNotOpen";
+    /**
+     * 802：播放节拍音频文件出错。
+     */
+    RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonCanNotPlay"] = 802] = "RhythmPlayerReasonCanNotPlay";
+    /**
+     * 803：节拍音频文件时长超出限制。最大时长为 1.2 秒。
+     */
+    RhythmPlayerReason[RhythmPlayerReason["RhythmPlayerReasonFileOverDurationLimit"] = 803] = "RhythmPlayerReasonFileOverDurationLimit";
+})(RhythmPlayerReason = exports.RhythmPlayerReason || (exports.RhythmPlayerReason = {}));
+/**
+ * 虚拟节拍器配置。
+ */
+class AgoraRhythmPlayerConfig {
+}
+exports.AgoraRhythmPlayerConfig = AgoraRhythmPlayerConfig;