@volcengine/veplayer 2.4.3-rc.0 → 2.4.5-rc.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@volcengine/veplayer",
-  "version": "2.4.3-rc.0",
+  "version": "2.4.5-rc.0",
   "main": "./umd/veplayer.production.js",
   "module": "./esm/veplayer.production.js",
   "browser": "./umd/veplayer.production.js",

package/umd/index.d.ts

@@ -287,7 +287,7 @@ import MobilePanel = MobilePlayerPanelWrapper.MobilePlayerPanel;
  */
 declare enum ListType {
     /** {zh}
-     * @brief 全屏布局
+     * @brief 全屏布局。
      * @hidden
      */
     /** {en}
@@ -296,21 +296,21 @@ declare enum ListType {
      */
     Middle = "middle",
     /** {zh}
-     * @brief 底部抽屉
+     * @brief 底部抽屉。
      */
     /** {en}
      * @brief Bottom navigation drawer.
      */
     Bottom = "bottom",
     /** {zh}
-     * @brief 右侧抽屉，常用于全屏时展示
+     * @brief 右侧抽屉，常用于全屏时展示。
      */
     /** {en}
      * @brief Right navigation drawer. This is often used for fullscreen display.
      */
     Fullscreen = "fullscreen",
     /** {zh}
-     * @brief 窗口蒙层展示
+     * @brief 窗口蒙层展示。
      */
     /** {en}
      * @brief Overlay.
@@ -398,14 +398,15 @@ declare class OptionsIcon extends Plugin {
 }
 /** {zh}
  * @detail error
+ * @brief 错误等级。
  */
 /** {en}
  * @detail error
+ * @brief Error level.
  */
 declare enum Level {
     /** {zh}
-     * @brief 严重
-     *
+     * @brief 严重。
      */
     /** {en}
      * @brief Fatal.
@@ -413,7 +414,7 @@ declare enum Level {
      */
     Fatal = "Fatal",
     /** {zh}
-     * @brief 报错
+     * @brief 报错。
      */
     /** {en}
      * @brief Error.
@@ -779,7 +780,7 @@ interface ErrorInfo<T = TextKey> {
 /** {zh}
  * @list error
  * @detail error
- * @brief 错误对象
+ * @brief 错误对象。
  * @name VeError
  * @id VeError
  */
@@ -791,11 +792,11 @@ interface ErrorInfo<T = TextKey> {
  * @id VeError
  */
 declare class VeError<T extends string = TextKey> extends Error {
-    /**
+    /** {zh}
      * @brief 错误码。
      */
     /** {en}
-     * @brief The error code.
+     * @brief Error code.
      */
     readonly errorCode: ErrorCode;
     /** {zh}
@@ -1099,11 +1100,9 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
     poster?: string;
     /** {zh}
      * @brief 为播放器设置初始显示语言，语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
-     * @default -
      */
     /** {en}
      * @brief The initial display language of the player. If the language pack does not exist, the 'en'language pack will be displayed by default. The default value is `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`.
-     * @default -
      */
     lang?: Lang;
     /** {zh}
@@ -1162,25 +1161,20 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
      * @brief Whether to display the full-screen button.
      * - `true`: Display;
      * - `false`: Do not display.
-     * @default -
      */
     fullscreen?: boolean | Fullscreen;
     /** {zh}
      * @brief 为播放器设置报错信息，支持配置播放异常时，播放器显示的异常文案、图片，以及是否提供刷新按钮等。
-     * @default -
      */
     /** {en}
      * @brief The error message of the player. When a playback error occurs, you can configure the error message and image displayed and whether to display the refresh button.
-     * @default -
      */
     error?: ErrorConfig;
     /** {zh}
      * @brief 为播放器设置清晰度的相关配置。
-     * @default -
      */
     /** {en}
      * @brief Resolution-related configurations.
-     * @default -
      */
     definition?: DefinitionConfig;
     /** {zh}
@@ -1441,8 +1435,7 @@ interface Fullscreen {
      * `true`: Display;
      * `false`: Do not display.
      * @default false
-     * @brief
-     *        Whether to display a return button at the top-right corner when the player is in full-screen mode. This feature is usually turned on on mobile devices.
+     * @brief Whether to display a return button at the top-right corner when the player is in full-screen mode. This feature is usually turned on on mobile devices.
      *        - `true`: Display;
      *        - `false`: Do not display.
      */
@@ -1460,7 +1453,7 @@ interface Fullscreen {
  */
 interface CommonStyle {
     /** {zh}
-     * @brief 进度条底色
+     * @brief 进度条底色。
      * @default 无
      */
     /** {en}
@@ -1468,7 +1461,7 @@ interface CommonStyle {
      */
     progressColor?: string;
     /** {zh}
-     * @brief 播放完成部分进度条底色
+     * @brief 播放完成部分进度条底色。
      * @default 无
      */
     /** {en}
@@ -1476,7 +1469,7 @@ interface CommonStyle {
      */
     playedColor?: string;
     /** {zh}
-     * @brief 缓存部分进度条底色
+     * @brief 缓存部分进度条底色。
      * @default 无
      */
     /** {en}
@@ -1485,7 +1478,7 @@ interface CommonStyle {
      */
     cachedColor?: string;
     /** {zh}
-     * @brief 进度条滑块样式
+     * @brief 进度条滑块样式。
      * @default 无
      */
     /** {en}
@@ -1496,7 +1489,7 @@ interface CommonStyle {
         [propName: string]: any;
     };
     /** {zh}
-     * @brief 音量颜色
+     * @brief 音量颜色。
      * @default 无
      */
     /** {en}
@@ -1520,14 +1513,14 @@ type PreparePlugins = (url: string) => Promise<PrepareResult> | undefined;
  */
 declare enum Codec {
     /** {zh}
-     * @brief H.265 编码格式
+     * @brief H.265 编码格式。
      */
     /** {en}
      * @brief H.265.
      */
     H265 = "h265",
     /** {zh}
-     * @brief H.264 编码格式
+     * @brief H.264 编码格式。
      */
     /** {en}
      * @brief H.264.
@@ -1544,18 +1537,18 @@ declare enum Codec {
  */
 declare enum Degradation {
     /** {zh}
-     * @brief 硬解不支持降级到软解
+     * @brief 硬解不支持时，优先降级到软解。
      */
     /** {en}
-     * @brief The player does not support falling back to software decoding.
+     * @brief When hardware decoding is not supported, prioritize downgrading to software decoding.
      */
     SoftFirst = "soft-first",
     /** {zh}
-     * @brief 硬解不支持降级到h264
+     * @brief 硬解不支持时，优先降级到 H.264 解码。
      * @hidden
      */
     /** {en}
-     * @brief The player does not support falling back to H.264.
+     * @brief When hardware decoding is not supported, prioritize downgrading to H.264 decoding.
      * @hidden
      */
     H264First = "h264-first"
@@ -1572,14 +1565,14 @@ declare enum Degradation {
  */
 declare enum DecodeType {
     /** {zh}
-     * @brief 软解
+     * @brief 软解。
      */
     /** {en}
      * @brief Software decoding.
      */
     Software = "software",
     /** {zh}
-     * @brief 硬解
+     * @brief 硬解。
      */
     /** {en}
      * @brief Hardware decoding.
@@ -1732,6 +1725,11 @@ declare class VePlayerBase {
     /** {zh}
      * 获取播放器版本号
      * @returns
+     * @brief
+     *        获取播放器 SDK 版本号。
+     */
+    /** {en}
+     * @brief Retrieve the player SDK version number.
      */
     get playerVersion(): string;
     /** {zh}
@@ -1819,8 +1817,8 @@ declare class VePlayerBase {
     static create<T extends VePlayerBase>(options?: VePlayerBaseOptions, Constructor?: Constructor<T>): Promise<T>;
     /** {zh}
      * @brief 调用此方法切换拉流地址、线路、清晰度。
-     * @param target 目标地址，可以是播放地址，也可以是线路和清晰度
-     * @param options 更多配置信息
+     * @param target 目标地址，可以是播放地址，也可以是线路和清晰度。
+     * @param options 更多配置信息。
      */
     /** {en}
      * @brief Switches the pull stream address, playback source, or resolution.
@@ -1857,11 +1855,12 @@ declare class VePlayerBase {
          */
         fallbackToFirstDefinition?: boolean;
         /** {zh}
-         * @brief 是否无缝切换
-         * - true: 无缝切换
-         * - false: 非无缝切换
+         * @brief 是否无缝切换，true 为无缝切换，false 为非无缝切换。
          * @default false
          */
+        /** {en}
+         * @brief Whether seamless switching or not. True means seamless switching and false means non-seamless switching.
+         */
         seamless?: boolean;
     }): Promise<ExposedDefinition>;
     /** {zh}
@@ -1897,16 +1896,15 @@ declare class VePlayerBase {
         source?: string;
     }): Promise<void>;
     // TODO: 等西瓜播放器完善错误码后增加函数重载以提供更好的类型
-    /**
     /** {zh}
      * @brief 调用此方法监听指定事件，事件处理函数只执行一次。
      * @param event 表示事件的名称。
      * @param callback 表示事件的回调函数。
      */
     /** {en}
-     * @brief Add a one-time listener function for the specified event.
-     * @param event The event name.
-     * @param callback The callback function for the event.
+     * @brief Call this method to listen for the specified event. The event handler is executed only once.
+     * @param event The name representing the event.
+     * @param callback Callback functions representing events.
      */
     once(event: string, callback: (data?: any) => any): void;
     /** {zh}
@@ -2032,10 +2030,14 @@ declare class VePlayerBase {
         ignorePaused?: boolean;
     }): void;
     /** {zh}
-     * @brief 判断浏览器是否支持播放格式
-     * @param type 播放格式
+     * @brief 判断浏览器是否支持播放格式。
+     * @param type 播放格式。
      * @returns
      */
+    /** {en}
+     * @brief Determine whether the browser supports the playback format.
+     * @param type The playback format.
+     */
     canPlayType(type: string): boolean;
     /** {zh}
      * @brief 调用此方法进入系统全屏状态。如果该方法调用的时候处于网页全屏状态会自动退出网页全屏，下发事件 `Events.FULLSCREEN_CHANGE`。
@@ -2115,7 +2117,7 @@ declare class VePlayerBase {
     unRegisterPlugin(plugin: any): void;
     /** {zh}
      * @brief 调用此接口显示指定插件图标。
-     * @param pluginNames 插件名称
+     * @param pluginNames 插件名称。
      */
     /** {en}
      * @brief Displays the icon of a specified plugin.
@@ -2124,7 +2126,7 @@ declare class VePlayerBase {
     showIcon(pluginNames: string[]): void;
     /** {zh}
      * @brief 调用此接口隐藏指定插件图标。
-     * @param pluginNames 插件名称
+     * @param pluginNames 插件名称。
      */
     /** {en}
      * @brief Hides the icon of a specified plugin.
@@ -2545,7 +2547,7 @@ declare namespace strategy {
      */
     enum ListType {
         /** {zh}
-         * @brief 全屏布局
+         * @brief 全屏布局。
          * @hidden
          */
         /** {en}
@@ -2554,21 +2556,21 @@ declare namespace strategy {
          */
         Middle = "middle",
         /** {zh}
-         * @brief 底部抽屉
+         * @brief 底部抽屉。
          */
         /** {en}
          * @brief Bottom navigation drawer.
          */
         Bottom = "bottom",
         /** {zh}
-         * @brief 右侧抽屉，常用于全屏时展示
+         * @brief 右侧抽屉，常用于全屏时展示。
          */
         /** {en}
          * @brief Right navigation drawer. This is often used for fullscreen display.
          */
         Fullscreen = "fullscreen",
         /** {zh}
-         * @brief 窗口蒙层展示
+         * @brief 窗口蒙层展示。
          */
         /** {en}
          * @brief Overlay.
@@ -2656,14 +2658,15 @@ declare namespace strategy {
     }
     /** {zh}
      * @detail error
+     * @brief 错误等级。
      */
     /** {en}
      * @detail error
+     * @brief Error level.
      */
     enum Level {
         /** {zh}
-         * @brief 严重
-         *
+         * @brief 严重。
          */
         /** {en}
          * @brief Fatal.
@@ -2671,7 +2674,7 @@ declare namespace strategy {
          */
         Fatal = "Fatal",
         /** {zh}
-         * @brief 报错
+         * @brief 报错。
          */
         /** {en}
          * @brief Error.
@@ -3039,7 +3042,7 @@ declare namespace strategy {
     /** {zh}
      * @list error
      * @detail error
-     * @brief 错误对象
+     * @brief 错误对象。
      * @name VeError
      * @id VeError
      */
@@ -3051,11 +3054,11 @@ declare namespace strategy {
      * @id VeError
      */
     class VeError<T extends string = TextKey> extends Error {
-        /**
+        /** {zh}
          * @brief 错误码。
          */
         /** {en}
-         * @brief The error code.
+         * @brief Error code.
          */
         readonly errorCode: ErrorCode;
         /** {zh}
@@ -3420,11 +3423,9 @@ declare namespace strategy {
         poster?: string;
         /** {zh}
          * @brief 为播放器设置初始显示语言，语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
-         * @default -
          */
         /** {en}
          * @brief The initial display language of the player. If the language pack does not exist, the 'en'language pack will be displayed by default. The default value is `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`.
-         * @default -
          */
         lang?: Lang;
         /** {zh}
@@ -3483,25 +3484,20 @@ declare namespace strategy {
          * @brief Whether to display the full-screen button.
          * - `true`: Display;
          * - `false`: Do not display.
-         * @default -
          */
         fullscreen?: boolean | Fullscreen;
         /** {zh}
          * @brief 为播放器设置报错信息，支持配置播放异常时，播放器显示的异常文案、图片，以及是否提供刷新按钮等。
-         * @default -
          */
         /** {en}
          * @brief The error message of the player. When a playback error occurs, you can configure the error message and image displayed and whether to display the refresh button.
-         * @default -
          */
         error?: ErrorConfig;
         /** {zh}
          * @brief 为播放器设置清晰度的相关配置。
-         * @default -
          */
         /** {en}
          * @brief Resolution-related configurations.
-         * @default -
          */
         definition?: DefinitionConfig;
         /** {zh}
@@ -3762,8 +3758,7 @@ declare namespace strategy {
          * `true`: Display;
          * `false`: Do not display.
          * @default false
-         * @brief
-         *        Whether to display a return button at the top-right corner when the player is in full-screen mode. This feature is usually turned on on mobile devices.
+         * @brief Whether to display a return button at the top-right corner when the player is in full-screen mode. This feature is usually turned on on mobile devices.
          *        - `true`: Display;
          *        - `false`: Do not display.
          */
@@ -3781,7 +3776,7 @@ declare namespace strategy {
      */
     interface CommonStyle {
         /** {zh}
-         * @brief 进度条底色
+         * @brief 进度条底色。
          * @default 无
          */
         /** {en}
@@ -3789,7 +3784,7 @@ declare namespace strategy {
          */
         progressColor?: string;
         /** {zh}
-         * @brief 播放完成部分进度条底色
+         * @brief 播放完成部分进度条底色。
          * @default 无
          */
         /** {en}
@@ -3797,7 +3792,7 @@ declare namespace strategy {
          */
         playedColor?: string;
         /** {zh}
-         * @brief 缓存部分进度条底色
+         * @brief 缓存部分进度条底色。
          * @default 无
          */
         /** {en}
@@ -3806,7 +3801,7 @@ declare namespace strategy {
          */
         cachedColor?: string;
         /** {zh}
-         * @brief 进度条滑块样式
+         * @brief 进度条滑块样式。
          * @default 无
          */
         /** {en}
@@ -3817,7 +3812,7 @@ declare namespace strategy {
             [propName: string]: any;
         };
         /** {zh}
-         * @brief 音量颜色
+         * @brief 音量颜色。
          * @default 无
          */
         /** {en}
@@ -3841,14 +3836,14 @@ declare namespace strategy {
      */
     enum Codec {
         /** {zh}
-         * @brief H.265 编码格式
+         * @brief H.265 编码格式。
          */
         /** {en}
          * @brief H.265.
          */
         H265 = "h265",
         /** {zh}
-         * @brief H.264 编码格式
+         * @brief H.264 编码格式。
          */
         /** {en}
          * @brief H.264.
@@ -3865,18 +3860,18 @@ declare namespace strategy {
      */
     enum Degradation {
         /** {zh}
-         * @brief 硬解不支持降级到软解
+         * @brief 硬解不支持时，优先降级到软解。
          */
         /** {en}
-         * @brief The player does not support falling back to software decoding.
+         * @brief When hardware decoding is not supported, prioritize downgrading to software decoding.
          */
         SoftFirst = "soft-first",
         /** {zh}
-         * @brief 硬解不支持降级到h264
+         * @brief 硬解不支持时，优先降级到 H.264 解码。
          * @hidden
          */
         /** {en}
-         * @brief The player does not support falling back to H.264.
+         * @brief When hardware decoding is not supported, prioritize downgrading to H.264 decoding.
          * @hidden
          */
         H264First = "h264-first"
@@ -3893,14 +3888,14 @@ declare namespace strategy {
      */
     enum DecodeType {
         /** {zh}
-         * @brief 软解
+         * @brief 软解。
          */
         /** {en}
          * @brief Software decoding.
          */
         Software = "software",
         /** {zh}
-         * @brief 硬解
+         * @brief 硬解。
          */
         /** {en}
          * @brief Hardware decoding.
@@ -4162,14 +4157,15 @@ declare namespace error {
     }
     /** {zh}
      * @detail error
+     * @brief 错误等级。
      */
     /** {en}
      * @detail error
+     * @brief Error level.
      */
     enum Level {
         /** {zh}
-         * @brief 严重
-         *
+         * @brief 严重。
          */
         /** {en}
          * @brief Fatal.
@@ -4177,7 +4173,7 @@ declare namespace error {
          */
         Fatal = "Fatal",
         /** {zh}
-         * @brief 报错
+         * @brief 报错。
          */
         /** {en}
          * @brief Error.
@@ -4545,7 +4541,7 @@ declare namespace error {
     /** {zh}
      * @list error
      * @detail error
-     * @brief 错误对象
+     * @brief 错误对象。
      * @name VeError
      * @id VeError
      */
@@ -4557,11 +4553,11 @@ declare namespace error {
      * @id VeError
      */
     class VeError<T extends string = TextKey> extends Error {
-        /**
+        /** {zh}
          * @brief 错误码。
          */
         /** {en}
-         * @brief The error code.
+         * @brief Error code.
          */
         readonly errorCode: ErrorCode;
         /** {zh}