@volcengine/veplayer 2.8.1 → 2.9.0-rc.0

package/package.json

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

package/umd/index.d.ts

@@ -433,6 +433,16 @@ declare enum Level {
      */
     Warn = "Warn"
 }
+/** {zh}
+ * @detail error
+ * @id errorcode
+ * @hidden
+ */
+/** {en}
+ * @detail error
+ * @id errorcode
+ * @hidden
+ */
 declare enum ErrorCode {
     /** {zh}
      * @brief 视频解析错误
@@ -1587,15 +1597,15 @@ interface Poster {
      */
     isEndedShow?: boolean;
     /** {zh}
-     * @brief 是否播放后再隐藏封面图。
-     *   - `true`：播放后隐藏，未启播时一直显示封面图。
-     *   - `false`：在 `play` 事件触发后隐藏封面图。
+     * @brief 是否在播放后隐藏封面图。
+     *   - `true`：在播放器开始播放（即画面可见）后隐藏封面图，播放前始终显示，避免黑屏；
+     *   - `false`：在触发 `play` 事件时立即隐藏封面图，可能在画面显示前出现黑屏。
      * @default false
      */
     /** {en}
-     * @brief Whether to hide the cover image after `canplay` event.
-     * - `true`：hide the cover image after `canplay` event.
-     * - `false`：hide the cover image after `play` event.
+     * @brief Whether to hide the poster image after playback starts.
+     * - `true`：The poster image remains visible until video playback actually starts (i.e., video frames are rendered), preventing a black screen before playback.
+     * - `false`：The poster image is hidden immediately when the `play` event is triggered, which may cause a brief black screen before video appears.
      * @default false
      */
     hideCanplay?: boolean;
@@ -1609,18 +1619,18 @@ interface Poster {
      */
     notHidden?: boolean;
     /** {zh}
-     * @brief 封面图填充方式。取值如下：
-     * - `fixWidth`：宽度方向填充，不会被拉伸压缩。
-     * - `fixHeight`：高度方向填充，不会被拉伸压缩。
-     * - `cover`：完全覆盖容器，多余部分会被裁剪。
-     * - `contain`：完全覆盖，与容器不匹配时会被拉伸压缩。
+     * @brief 封面图的填充方式，取值如下所示。
+     * - `fixWidth`：按宽度适配容器，高度等比缩放，图像不拉伸压缩；
+     * - `fixHeight`：按高度适配容器，宽度等比缩放，图像不拉伸压缩；
+     * - `cover`：等比缩放并裁剪，使封面图完整覆盖容器，不留黑边；
+     * - `contain`：等比缩放并拉伸，使封面图完整覆盖容器，不留黑边，可能失真。
      */
     /** {en}
-     * @brief Cover image fill mode.
-     * - `fixWidth`：Fill the width of the container and crop the height if necessary.
-     * - `fixHeight`：Fill the height of the container and crop the width if necessary.
-     * - `cover`：Fill the entire container while keeping the original aspect ratio.
-     * - `contain`：Stretch the video to fill the container.
+     * @brief Fill mode of the poster image. The available options are as follows:
+     * - `fixWidth`：Scales the image to fit the container's width while maintaining aspect ratio. Height is scaled proportionally, which may leave vertical blank space.
+     * - `fixHeight`：Scales the image to fit the container's height while maintaining aspect ratio. Width is scaled proportionally, which may leave horizontal blank space.
+     * - `cover`：Scales the image proportionally and crops overflow to fully cover the container without black borders.
+     * - `contain`：Scales the image to fully fit the container. May stretch non-proportionally to avoid black borders, potentially causing distortion.
      */
     fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
 }
@@ -2843,6 +2853,16 @@ declare namespace strategy {
          */
         Warn = "Warn"
     }
+    /** {zh}
+     * @detail error
+     * @id errorcode
+     * @hidden
+     */
+    /** {en}
+     * @detail error
+     * @id errorcode
+     * @hidden
+     */
     enum ErrorCode {
         /** {zh}
          * @brief 视频解析错误
@@ -4060,15 +4080,15 @@ declare namespace strategy {
          */
         isEndedShow?: boolean;
         /** {zh}
-         * @brief 是否播放后再隐藏封面图。
-         *   - `true`：播放后隐藏，未启播时一直显示封面图。
-         *   - `false`：在 `play` 事件触发后隐藏封面图。
+         * @brief 是否在播放后隐藏封面图。
+         *   - `true`：在播放器开始播放（即画面可见）后隐藏封面图，播放前始终显示，避免黑屏；
+         *   - `false`：在触发 `play` 事件时立即隐藏封面图，可能在画面显示前出现黑屏。
          * @default false
          */
         /** {en}
-         * @brief Whether to hide the cover image after `canplay` event.
-         * - `true`：hide the cover image after `canplay` event.
-         * - `false`：hide the cover image after `play` event.
+         * @brief Whether to hide the poster image after playback starts.
+         * - `true`：The poster image remains visible until video playback actually starts (i.e., video frames are rendered), preventing a black screen before playback.
+         * - `false`：The poster image is hidden immediately when the `play` event is triggered, which may cause a brief black screen before video appears.
          * @default false
          */
         hideCanplay?: boolean;
@@ -4082,18 +4102,18 @@ declare namespace strategy {
          */
         notHidden?: boolean;
         /** {zh}
-         * @brief 封面图填充方式。取值如下：
-         * - `fixWidth`：宽度方向填充，不会被拉伸压缩。
-         * - `fixHeight`：高度方向填充，不会被拉伸压缩。
-         * - `cover`：完全覆盖容器，多余部分会被裁剪。
-         * - `contain`：完全覆盖，与容器不匹配时会被拉伸压缩。
+         * @brief 封面图的填充方式，取值如下所示。
+         * - `fixWidth`：按宽度适配容器，高度等比缩放，图像不拉伸压缩；
+         * - `fixHeight`：按高度适配容器，宽度等比缩放，图像不拉伸压缩；
+         * - `cover`：等比缩放并裁剪，使封面图完整覆盖容器，不留黑边；
+         * - `contain`：等比缩放并拉伸，使封面图完整覆盖容器，不留黑边，可能失真。
          */
         /** {en}
-         * @brief Cover image fill mode.
-         * - `fixWidth`：Fill the width of the container and crop the height if necessary.
-         * - `fixHeight`：Fill the height of the container and crop the width if necessary.
-         * - `cover`：Fill the entire container while keeping the original aspect ratio.
-         * - `contain`：Stretch the video to fill the container.
+         * @brief Fill mode of the poster image. The available options are as follows:
+         * - `fixWidth`：Scales the image to fit the container's width while maintaining aspect ratio. Height is scaled proportionally, which may leave vertical blank space.
+         * - `fixHeight`：Scales the image to fit the container's height while maintaining aspect ratio. Width is scaled proportionally, which may leave horizontal blank space.
+         * - `cover`：Scales the image proportionally and crops overflow to fully cover the container without black borders.
+         * - `contain`：Scales the image to fully fit the container. May stretch non-proportionally to avoid black borders, potentially causing distortion.
          */
         fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
     }
@@ -4482,6 +4502,16 @@ declare namespace error {
          */
         Warn = "Warn"
     }
+    /** {zh}
+     * @detail error
+     * @id errorcode
+     * @hidden
+     */
+    /** {en}
+     * @detail error
+     * @id errorcode
+     * @hidden
+     */
     enum ErrorCode {
         /** {zh}
          * @brief 视频解析错误