@volcengine/veplayer 2.0.0-rc.1 → 2.0.0-rc.2

package/umd/veplayer.vod.development.js

@@ -8,6 +8,16 @@ var __publicField = (obj, key, value) => {
   return value;
 };
 
+  var Codec = /* @__PURE__ */ ((Codec2) => {
+    Codec2["H265"] = "h265";
+    Codec2["H264"] = "h264";
+    return Codec2;
+  })(Codec || {});
+  var DecodeType = /* @__PURE__ */ ((DecodeType2) => {
+    DecodeType2["Software"] = "software";
+    DecodeType2["Hardware"] = "hardware";
+    return DecodeType2;
+  })(DecodeType || {});
   function ownKeys(object, enumerableOnly) {
     var keys = Object.keys(object);
     if (Object.getOwnPropertySymbols) {
@@ -6126,7 +6136,7 @@ var __publicField = (obj, key, value) => {
     ErrorCode2[ErrorCode2["RUNTIME_NO_CANPLAY_ERROR"] = 9001] = "RUNTIME_NO_CANPLAY_ERROR";
     ErrorCode2[ErrorCode2["RUNTIME_BUFFERBREAK_ERROR"] = 9002] = "RUNTIME_BUFFERBREAK_ERROR";
     ErrorCode2[ErrorCode2["RUNTIME_BWAITING_TIMEOUT_ERROR"] = 9002] = "RUNTIME_BWAITING_TIMEOUT_ERROR";
-    ErrorCode2[ErrorCode2["MODULE_LOAD_ERROR"] = 100] = "MODULE_LOAD_ERROR";
+    ErrorCode2[ErrorCode2["MODULE_LOAD_ERROR"] = 110] = "MODULE_LOAD_ERROR";
     ErrorCode2["UNKNOWN"] = "UNKNOWN";
     return ErrorCode2;
   })(ErrorCode || {});
@@ -6212,7 +6222,7 @@ var __publicField = (obj, key, value) => {
       /* Error */
     },
     [
-      100
+      110
       /* MODULE_LOAD_ERROR */
     ]: {
       messageTextKey: "MODULE_LOAD_ERROR",
@@ -6287,6 +6297,11 @@ var __publicField = (obj, key, value) => {
     }
   };
   class VeError extends Error {
+    /**
+     * @hidden
+     * @param error
+     * @param i18n
+     */
     constructor(error2, i18n) {
       var _a;
       const errorInfo = typeof error2 === "string" ? {
@@ -6294,8 +6309,17 @@ var __publicField = (obj, key, value) => {
       } : error2;
       const message = (i18n == null ? void 0 : i18n.getText(errorInfo == null ? void 0 : errorInfo.messageTextKey)) ?? (errorInfo == null ? void 0 : errorInfo.message) ?? ((_a = errorInfo == null ? void 0 : errorInfo.error) == null ? void 0 : _a.message) ?? (i18n == null ? void 0 : i18n.getText("UNKNOWN"));
       super(message);
+      /**
+       * @brief 错误码，对应[错误码字典](#错误码)。
+       */
       __publicField(this, "errorCode");
+      /**
+       * @brief 错误等级。
+       */
       __publicField(this, "level");
+      /**
+       * @brief 其他错误信息。
+       */
       __publicField(this, "ext");
       this.errorCode = (errorInfo == null ? void 0 : errorInfo.errorCode) ?? "UNKNOWN";
       this.level = (errorInfo == null ? void 0 : errorInfo.level) ?? "Error";
@@ -10676,12 +10700,13 @@ var __publicField = (obj, key, value) => {
     }
   }
   var optionsIcon = "";
-  const ListType = {
-    Middle: "middle",
-    Bottom: "bottom",
-    Fullscreen: "fullscreen",
-    Inner: "inner"
-  };
+  var ListType = /* @__PURE__ */ ((ListType2) => {
+    ListType2["Middle"] = "middle";
+    ListType2["Bottom"] = "bottom";
+    ListType2["Fullscreen"] = "fullscreen";
+    ListType2["Inner"] = "inner";
+    return ListType2;
+  })(ListType || {});
   var RenderType = /* @__PURE__ */ ((RenderType2) => {
     RenderType2["Icon"] = "Icon";
     RenderType2["Text"] = "Text";
@@ -10689,20 +10714,26 @@ var __publicField = (obj, key, value) => {
   })(RenderType || {});
   const isMobile$1 = sniffer.device === "mobile";
   const MOBILE_LIST_TYPES = [
-    ListType.Bottom,
-    ListType.Fullscreen,
-    ListType.Inner
+    "bottom",
+    "fullscreen",
+    "inner"
+    /* Inner */
+  ];
+  const PC_LIST_TYPES = [
+    "middle"
+    /* Middle */
   ];
-  const PC_LIST_TYPES = [ListType.Middle];
   const MODAL_TYPES = [
-    ListType.Bottom,
-    ListType.Inner,
-    ListType.Fullscreen
+    "bottom",
+    "inner",
+    "fullscreen"
+    /* Fullscreen */
   ];
   const CUSTOM_TYPES = [
-    ListType.Bottom,
-    ListType.Inner,
-    ListType.Fullscreen
+    "bottom",
+    "inner",
+    "fullscreen"
+    /* Fullscreen */
   ];
   class OptionsIcon extends Plugin {
     constructor(args) {
@@ -10740,7 +10771,7 @@ var __publicField = (obj, key, value) => {
         // 默认手机端在“右上角”，pc端在控制栏右侧
         position: isMobile$1 ? POSITIONS.ROOT_TOP_RIGHT : POSITIONS.CONTROLS_RIGHT,
         // 默认手机端列表展示底部，pc端在控制栏默认
-        listType: isMobile$1 ? ListType.Bottom : ListType.Middle,
+        listType: isMobile$1 ? "bottom" : "middle",
         index: 100,
         list: [],
         listStyle: {},
@@ -10922,10 +10953,10 @@ var __publicField = (obj, key, value) => {
         listType = this.player.config.listType;
       }
       if (!isMobile$1 && (!listType || !MOBILE_LIST_TYPES.includes(listType))) {
-        listType = ListType.Bottom;
+        listType = "bottom";
       }
       if (!isMobile$1 && (!listType || !PC_LIST_TYPES.includes(listType))) {
-        listType = ListType.Middle;
+        listType = "middle";
       }
       return listType;
     }
@@ -12627,11 +12658,6 @@ var __publicField = (obj, key, value) => {
     }
   }
   var veplayerBase = "";
-  var Codec = /* @__PURE__ */ ((Codec2) => {
-    Codec2["H265"] = "h265";
-    Codec2["H264"] = "h264";
-    return Codec2;
-  })(Codec || {});
   const { POSITIONS: XGPosition } = Plugin;
   const POSITIONS = {
     ...XGPosition,
@@ -12641,7 +12667,7 @@ var __publicField = (obj, key, value) => {
     id: "veplayer",
     width: "100%",
     height: "100%",
-    decodeType: "hardware",
+    decodeType: DecodeType.Hardware,
     fullscreen: {
       useCssFullscreen: false
     }
@@ -12669,6 +12695,9 @@ var __publicField = (obj, key, value) => {
     return xgOptions;
   };
   class VePlayerBase {
+    /**
+     * @hidden
+     */
     constructor(options = {}) {
       __publicField(this, "_player");
       __publicField(this, "_sourceManager");
@@ -12720,74 +12749,162 @@ var __publicField = (obj, key, value) => {
       this._errorCallback = (err) => this._handleFallback(err);
       this._player.on(ERROR, this._errorCallback);
     }
+    /**
+     * @brief 获取视频的就绪状态，其状态枚举值、枚举名称和说明如下：
+     * - `0`：HAVE_NOTHING，没有关于媒体资源的可用信息
+     * - `1`：HAVE_METADATA，已检索到足够多的媒体资源来初始化元数据, 快进/快退不会引发异常
+     * - `2`：HAVE_CURRENT_DATA，当前播放位置的数据可用，但不足以播放下一帧
+     * - `3`：HAVE_FUTURE_DATA，当前播放位置以及未来至少一小段时间的数据是可用的（至少有两帧以上的数据）
+     * - `4`：HAVE_ENOUGH_DATA，有足够的数据可用，并且下载速率足够，媒体可以不间断地播放到最后
+     */
     get readyState() {
       return this._player.readyState;
     }
+    /**
+     * @brief 获取当前已缓冲的时间范围。
+     */
     get buffered() {
       return this._player.buffered;
     }
+    /**
+     * @brief 获取已经播放的音频/视频的时间范围。
+     */
     get played() {
       return this._player.played;
     }
+    /**
+     * @brief 设置/获取视频当前的播放时间, 单位为 s。
+     */
     get cumulateTime() {
       return this._player.cumulateTime;
     }
+    /**
+     * @brief 获取是否处于焦点状态，处于焦点状态会显示控制栏。
+     */
     get isFocused() {
       return this._player.isActive;
     }
+    /**
+     * @brief 获取播放器是否处于全屏状态。
+     */
     get isFullscreen() {
       return this._player.isFullscreen;
     }
+    /**
+     * @brief 获取播放器是否处于网页全屏状态。
+     */
     get isCssFullscreen() {
       return this._player.isCssfullScreen;
     }
+    /**
+     * @brief 获取视频的网络状态，其状态枚举值、枚举名称和说明如下：
+     * - `0`：NETWORK_EMPTY，目前还没有数据，readyState 的值是 HAVE_NOTHING
+     * - `1`：NETWORK_IDLE，HTMLMediaElement 处于活动状态并已选择资源，但未使用网络
+     * - `2`：NETWORK_LOADING，浏览器正在下载 HTMLMediaElement 数据
+     * - `3`：NETWORK_NO_SOURCE，未找到 HTMLMediaElement src。
+     */
     get networkState() {
       return this._player.networkState;
     }
+    /**
+     * @brief 获取当前视频是否处于暂停状态。
+     */
     get paused() {
       return this._player.paused;
     }
+    /**
+     * @brief 获取当前视频是否播放结束。
+     */
     get ended() {
       return this._player.ended;
     }
+    /**
+     * @brief 获取播放器当前所处的状态，其状态枚举值、枚举名称和说明如下：
+     * - `0`：ERROR，播放出现错误
+     * - `1`：INITIAL，初始化
+     * - `2`：READY，配置/事件/插件等均已经初始化/绑定/实例化完成
+     * - `3`：ATTACHING，进入媒体对象挂载阶段
+     * - `4`：ATTACHED，媒体对象已经挂载到了 DOM 中
+     * - `5`：NOTALLOW，播放被阻止
+     * - `6`：RUNNING，已经成功起播进入播放流程
+     * - `7`：ENDED，播放结束
+     * - `8`：DESTROYED，播放器实例处于已被销毁
+     */
     get state() {
       return this._player.state;
     }
+    /**
+     * 获取当前播放视频的拉流地址。
+     */
     get url() {
       return this._player.config.url;
     }
+    /**
+     * @brief 获取当播放视频的线路名称唯一标识（name）。
+     */
     get source() {
       var _a;
       return (_a = this._sourceManager.source) == null ? void 0 : _a.name;
     }
+    /**
+     * @brief 获取当前播放视频的清晰度唯一标识（definition）。
+     */
     get definition() {
       var _a;
       return (_a = this._sourceManager.definition) == null ? void 0 : _a.definition;
     }
+    /**
+     * @brief 获取和设置播放器的跨域配置信息，更多信息参考 [crossorigin](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/crossorigin) 属性介绍。
+     */
     get crossOrigin() {
       return this._player.crossOrigin;
     }
+    /**
+     * @brief 获取和设置播放器的跨域配置信息，更多信息参考 [crossorigin](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/crossorigin) 属性介绍。
+     */
     set crossOrigin(crossOrigin) {
       this._player.crossOrigin = crossOrigin;
     }
+    /**
+     * @brief 获取和设置视频的音量，取值范围为 [0,1]。
+     */
     // eslint-disable-next-line @typescript-eslint/member-ordering
     get volume() {
       return this._player.volume;
     }
+    /**
+     * @brief 获取和设置视频的音量，取值范围为 [0,1]。
+     */
     set volume(volume) {
       this._player.volume = volume;
     }
+    /**
+     * @brief 获取和设置视频静音状态。
+     * - `true`：静音
+     * - `false`：非静音
+     */
     // eslint-disable-next-line @typescript-eslint/member-ordering
     get muted() {
       return this._player.muted;
     }
+    /**
+     * @brief 获取和设置视频静音状态。
+     * - `true`：静音
+     * - `false`：非静音
+     */
     set muted(isMuted) {
       this._player.muted = isMuted;
     }
+    /**
+     * @brief 获取和设置当前语言。
+     */
     // eslint-disable-next-line @typescript-eslint/member-ordering
     get lang() {
       return this._i18nManager.getLang();
     }
+    /**
+     * @brief 获取和设置当前语言。
+     */
     set lang(lang) {
       var _a, _b;
       if (this._player.lang === lang) {
@@ -12809,6 +12926,9 @@ var __publicField = (obj, key, value) => {
     get _src() {
       return this._player.currentSrc;
     }
+    /**
+     * @hidden
+     */
     static async create(options = {}, Constructor) {
       var _a;
       const sourceManager = new SourceManager({
@@ -12830,6 +12950,11 @@ var __publicField = (obj, key, value) => {
         sourceManager
       });
     }
+    /**
+     * @brief 调用此方法切换拉流地址、线路、清晰度。
+     * @param target 目标地址，可以是播放地址，也可以是线路和清晰度
+     * @param options 更多配置信息
+     */
     async switch(target, options) {
       var _a, _b;
       if (typeof target === "string" && this._sourceManager.sources.length === 1 && ((_b = (_a = this._sourceManager.sources) == null ? void 0 : _a[0].definitions) == null ? void 0 : _b.length) === 1) {
@@ -12846,12 +12971,22 @@ var __publicField = (obj, key, value) => {
       await this._switch(targetDefinition);
       return targetDefinition;
     }
+    /**
+     * @brief 调用此方法更新拉流地址列表。
+     * @param playlist 要更新的播放列表。
+     * @param target 更新后默认播放的资源。
+     */
     updatePlaylist(playlist, target) {
       const sourceManager = this._sourceManager.updateSources(playlist, target);
       return this._switch(sourceManager.definition);
     }
     // TODO: 等西瓜播放器完善错误码后增加函数重载以提供更好的类型
-    once(event, callback, ...args) {
+    /**
+     * @brief 调用此方法监听指定事件，事件处理函数只执行一次。
+     * @param event 表示事件的名称。
+     * @param callback 表示事件的名称。
+     */
+    once(event, callback) {
       var _a;
       const { xgCallback, xgEventName } = this._transformEvent(event, callback);
       if (xgCallback) {
@@ -12859,27 +12994,45 @@ var __publicField = (obj, key, value) => {
           this._events[event] = /* @__PURE__ */ new Map();
         }
         this._events[event].set(callback, xgCallback);
-        this._player.once(xgEventName, xgCallback, ...args);
+        this._player.once(xgEventName, xgCallback);
       }
     }
-    off(event, callback, ...args) {
+    /**
+     * @brief 调用此方法解绑或移除指定事件的事件监听。
+     * @param event 表示事件的名称。
+     * @param callback 表示事件的名称。
+     */
+    off(event, callback) {
       var _a;
       const xgCallback = (_a = this._events[event]) == null ? void 0 : _a.get(callback);
       const { xgEventName } = this._transformEvent(event);
       if (xgCallback) {
-        this._player.off(xgEventName, xgCallback, ...args);
+        this._player.off(xgEventName, xgCallback);
         this._events[event].delete(callback);
       }
     }
-    emit(event, data, ...args) {
+    /**
+     * @brief 调用此方法触发指定事件。
+     * @param event 表示事件的名称。
+     * @param data 事件信息。
+     */
+    emit(event, data) {
       const { xgEventName } = this._transformEvent(event);
-      this._player.emit(xgEventName, data, ...args);
+      this._player.emit(xgEventName, data);
     }
+    /**
+     * @brief 调用此方法解绑或移除指定事件的所有事件监听。
+     */
     offAll() {
       this._events = {};
       this._player.offAll();
     }
-    on(event, callback, ...args) {
+    /**
+     * @brief 调用此方法监听指定事件。
+     * @param event 事件。
+     * @param callback 事件回调。
+     */
+    on(event, callback) {
       var _a;
       const { xgCallback, xgEventName } = this._transformEvent(event, callback);
       if (xgCallback) {
@@ -12887,56 +13040,105 @@ var __publicField = (obj, key, value) => {
           this._events[event] = /* @__PURE__ */ new Map();
         }
         this._events[event].set(callback, xgCallback);
-        this._player.on(xgEventName, xgCallback, ...args);
+        this._player.on(xgEventName, xgCallback);
       }
     }
+    /**
+     * @brief 调用此方法开始播放 。
+     */
     play() {
       /* istanbul ignore next -- @preserve */
       return this._player.play();
     }
+    /**
+     * @brief 调用此方法暂停播放。
+     */
     pause() {
       /* istanbul ignore next -- @preserve */
       return this._player.pause();
     }
+    /**
+     * @brief 调用此方法打开画中画。
+     */
     requestPIP() {
       var _a;
       /* istanbul ignore next -- @preserve */
       (_a = this._player.plugins.pip) == null ? void 0 : _a.requestPIP();
     }
+    /**
+     * @brief 调用此方法关闭画中画。
+     */
     exitPIP() {
       var _a;
       /* istanbul ignore next -- @preserve */
       (_a = this._player.plugins.pip) == null ? void 0 : _a.exitPIP();
     }
+    /**
+     * @brief 调用此方法重新拉流。
+     */
     retry() {
-      this._player.emit(Events.RETRY);
       return this._player.retry();
     }
+    /**
+     * @brief 播放器获取焦点，调用该方法 `veplayer.isFocused` 将会变为 `true`，并触发 `PLAYER_FOCUS` 事件。
+     * @param data 播放器获取焦点配置信息。
+     */
     focus(data) {
       return this._player.focus(data);
     }
+    /**
+     * @brief 播放器失去焦点，调用该方法 `veplayer.isFocused` 将会变为 `false`，并触发 `PLAYER_BLUR` 事件。
+     * @param data 播放器失去焦点配置信息。
+     */
     blur(data) {
       return this._player.blur(data);
     }
+    /**
+     * @brief 调用此方法进入系统全屏状态。如果该方法调用的时候处于网页全屏状态会自动退出网页全屏，下发事件 `Events.FULLSCREEN_CHANGE`。
+     * @param el 全屏作用的 DOM 节点。
+     */
     getFullscreen(el) {
       return this._player.getFullscreen(el);
     }
+    /**
+     * @brief 调用此方法退出系统全屏状态，调用该方法 `veplayer.isFullscreen` 将会变为 `false`，并触发 `Events.FULLSCREEN_CHANGE` 事件。
+     * @param el 全屏作用的 DOM 节点。
+     */
     exitFullscreen(el) {
       return this._player.exitFullscreen(el);
     }
+    /**
+     * @brief 调用此方法进入网页样式全屏状态，播放器进入网页全屏，利用 CSS 模拟实现全屏效果。如果该接口调用的时候处于全屏状态，会自动退出全屏，下发事件 `Events.CSS_FULLSCREEN_CHANGE`。
+     * @param el 全屏作用的 DOM 节点。
+     */
     getCssFullscreen(el) {
       return this._player.getCssFullscreen(el);
     }
+    /**
+     * @brief 调用此方法退出网页样式全屏状态。 调用该方法 `veplayer.isFullscreen` 将会变为 `false`，并触发 `Events.CSS_FULLSCREEN_CHANGE` 事件。
+     */
     exitCssFullscreen() {
       return this._player.exitCssFullscreen();
     }
+    /**
+     * @brief 调用此方法在当前播放器上注册指定插件。
+     * @param plugin 插件构造函数。
+     * @param config 插件的配置列表。
+     */
     registerPlugin(plugin, config) {
       return this._player.registerPlugin(plugin, config);
     }
-    unRegisterPlugin(plugin, removedFromConfig) {
-      return this._player.unRegisterPlugin(plugin, removedFromConfig);
+    /**
+     * @brief 调用此方法在当前播放器上销毁/注销指定插件。
+     * @param plugin 插件实例或者插件名称。
+     */
+    unRegisterPlugin(plugin) {
+      return this._player.unRegisterPlugin(plugin);
     }
-    // 显示插件
+    /**
+     * @brief 调用此接口显示指定插件图标。
+     * @param pluginNames 插件名称
+     */
     showIcon(pluginNames) {
       const morePlugin = this._player.getPlugin("more");
       pluginNames.forEach((pluginName) => {
@@ -12950,7 +13152,10 @@ var __publicField = (obj, key, value) => {
         }
       });
     }
-    // 隐藏插件显示
+    /**
+     * @brief 调用此接口隐藏指定插件图标。
+     * @param pluginNames 插件名称
+     */
     hideIcon(pluginNames) {
       const morePlugin = this._player.getPlugin("more");
       pluginNames.forEach((pluginName) => {
@@ -12964,10 +13169,16 @@ var __publicField = (obj, key, value) => {
         }
       });
     }
+    /**
+     * @brief 调用此方法销毁播放器实例。
+     */
     destroy() {
       this._player.off(ERROR, this._errorCallback);
       this._player.destroy();
     }
+    /**
+     * @hidden
+     */
     async prepare(url) {
       var _a, _b;
       const result = await ((_a = this._preparePlugins) == null ? void 0 : _a.call(this, url));