@volcengine/veplayer 2.7.0-rc.0 → 2.7.1-rc.0

package/veplayer.d.ts

@@ -1214,7 +1214,38 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
     /** {en}
      * @brief The URL of the player's cover image.
      */
-    poster?: string;
+    poster?: string | {
+        /** {zh}
+         * @brief 封面图 URL 地址。
+         * @default -
+         */
+        poster: string;
+        /** {zh}
+         * @brief 是否在播放结束之后显示封面图。
+         * @default true
+         */
+        isEndedShow?: boolean;
+        /** {zh}
+         * @brief 是否播放后再隐藏封面图。
+         *        - `true`：播放后隐藏，未启播时一直显示封面图。
+         *        - `false`：在 `play` 事件触发后隐藏封面图。
+         * @default false
+         */
+        hideCanplay?: boolean;
+        /** {zh}
+         * @brief 是否一直显示封面图。
+         * @default false
+         */
+        notHidden?: boolean;
+        /** {zh}
+         * @brief 封面图填充方式。取值如下：
+         *        - `fixWidth`：宽度方向填充，不会被拉伸压缩。
+         *        - `fixHeight`：高度方向填充，不会被拉伸压缩。
+         *        - `cover`：完全覆盖容器，多余部分会被裁剪。
+         *        - `contain`：完全覆盖，与容器不匹配时会被拉伸压缩。
+         */
+        fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
+    };
     /** {zh}
      * @brief 为播放器设置初始显示语言，语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
      */
@@ -3560,7 +3591,38 @@ declare namespace strategy {
         /** {en}
          * @brief The URL of the player's cover image.
          */
-        poster?: string;
+        poster?: string | {
+            /** {zh}
+             * @brief 封面图 URL 地址。
+             * @default -
+             */
+            poster: string;
+            /** {zh}
+             * @brief 是否在播放结束之后显示封面图。
+             * @default true
+             */
+            isEndedShow?: boolean;
+            /** {zh}
+             * @brief 是否播放后再隐藏封面图。
+             *        - `true`：播放后隐藏，未启播时一直显示封面图。
+             *        - `false`：在 `play` 事件触发后隐藏封面图。
+             * @default false
+             */
+            hideCanplay?: boolean;
+            /** {zh}
+             * @brief 是否一直显示封面图。
+             * @default false
+             */
+            notHidden?: boolean;
+            /** {zh}
+             * @brief 封面图填充方式。取值如下：
+             *        - `fixWidth`：宽度方向填充，不会被拉伸压缩。
+             *        - `fixHeight`：高度方向填充，不会被拉伸压缩。
+             *        - `cover`：完全覆盖容器，多余部分会被裁剪。
+             *        - `contain`：完全覆盖，与容器不匹配时会被拉伸压缩。
+             */
+            fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
+        };
         /** {zh}
          * @brief 为播放器设置初始显示语言，语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
          */
@@ -6324,14 +6386,12 @@ interface StatsSnapShoot {
 /** {zh}
  * @list option
  * @kind property
- * @brief FLV 直播流播放信息。
  */
 /** {en}
  * @list option
  * @kind property
- * @brief FLV live stream information.
  */
-interface FlvStats {
+interface Stats$0 {
     /** {zh}
      * @brief 音频格式。
      * @hidden
@@ -6433,33 +6493,45 @@ interface FlvStats {
      */
     samplerate: number;
     /** {zh}
-     * @brief 总共收到的字节数。
+     * @hidden
      */
     /** {en}
-     * @brief The total number of bytes received.
+     * @hidden
      */
-    totalReceivedByte: number;
+    videoCodec: string;
     /** {zh}
-     * @brief 接收所有字节消耗时长。
+     * @brief 视频宽度。
      */
     /** {en}
-     * @brief The time consumed for receiving all bytes.
+     * @brief Video wight.
      */
-    totalReceivedCost: number;
+    width: number;
+}
+/** {zh}
+ * @list option
+ * @kind property
+ * @brief FLV 直播流播放信息。
+ */
+/** {en}
+ * @list option
+ * @kind property
+ * @brief FLV live stream information.
+ */
+interface FlvStats extends Stats$0 {
     /** {zh}
-     * @hidden
+     * @brief 总共收到的字节数。
      */
     /** {en}
-     * @hidden
+     * @brief The total number of bytes received.
      */
-    videoCodec: string;
+    totalReceivedByte: number;
     /** {zh}
-     * @brief 视频宽度。
+     * @brief 接收所有字节消耗时长。
      */
     /** {en}
-     * @brief Video wight.
+     * @brief The time consumed for receiving all bytes.
      */
-    width: number;
+    totalReceivedCost: number;
 }
 /** {zh}
  * @detail api
@@ -6602,6 +6674,14 @@ declare class VePlayerLive extends VePlayerBase {
      * @brief Obtain the playback information of FLV pull streaming.
      */
     getFLVStats(): FlvStats;
+    /** {zh}
+     * @brief 获取 HLS 拉流的播放信息。
+     * @returns
+     */
+    /** {en}
+     * @brief Obtain the playback information of HLS pull streaming.
+     */
+    getHLSStats(): Stats$0;
     updatePlaylist(playlist: ExposedSource[], target?: string | {
         /** {zh}
          * @brief 清晰度唯一标识。
@@ -8965,7 +9045,38 @@ declare namespace live {
         /** {en}
          * @brief The URL of the player's cover image.
          */
-        poster?: string;
+        poster?: string | {
+            /** {zh}
+             * @brief 封面图 URL 地址。
+             * @default -
+             */
+            poster: string;
+            /** {zh}
+             * @brief 是否在播放结束之后显示封面图。
+             * @default true
+             */
+            isEndedShow?: boolean;
+            /** {zh}
+             * @brief 是否播放后再隐藏封面图。
+             *        - `true`：播放后隐藏，未启播时一直显示封面图。
+             *        - `false`：在 `play` 事件触发后隐藏封面图。
+             * @default false
+             */
+            hideCanplay?: boolean;
+            /** {zh}
+             * @brief 是否一直显示封面图。
+             * @default false
+             */
+            notHidden?: boolean;
+            /** {zh}
+             * @brief 封面图填充方式。取值如下：
+             *        - `fixWidth`：宽度方向填充，不会被拉伸压缩。
+             *        - `fixHeight`：高度方向填充，不会被拉伸压缩。
+             *        - `cover`：完全覆盖容器，多余部分会被裁剪。
+             *        - `contain`：完全覆盖，与容器不匹配时会被拉伸压缩。
+             */
+            fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
+        };
         /** {zh}
          * @brief 为播放器设置初始显示语言，语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
          */
@@ -11944,14 +12055,12 @@ declare namespace live {
     /** {zh}
      * @list option
      * @kind property
-     * @brief FLV 直播流播放信息。
      */
     /** {en}
      * @list option
      * @kind property
-     * @brief FLV live stream information.
      */
-    interface FlvStats {
+    interface Stats$0 {
         /** {zh}
          * @brief 音频格式。
          * @hidden
@@ -12053,33 +12162,45 @@ declare namespace live {
          */
         samplerate: number;
         /** {zh}
-         * @brief 总共收到的字节数。
+         * @hidden
          */
         /** {en}
-         * @brief The total number of bytes received.
+         * @hidden
          */
-        totalReceivedByte: number;
+        videoCodec: string;
         /** {zh}
-         * @brief 接收所有字节消耗时长。
+         * @brief 视频宽度。
          */
         /** {en}
-         * @brief The time consumed for receiving all bytes.
+         * @brief Video wight.
          */
-        totalReceivedCost: number;
+        width: number;
+    }
+    /** {zh}
+     * @list option
+     * @kind property
+     * @brief FLV 直播流播放信息。
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     * @brief FLV live stream information.
+     */
+    interface FlvStats extends Stats$0 {
         /** {zh}
-         * @hidden
+         * @brief 总共收到的字节数。
          */
         /** {en}
-         * @hidden
+         * @brief The total number of bytes received.
          */
-        videoCodec: string;
+        totalReceivedByte: number;
         /** {zh}
-         * @brief 视频宽度。
+         * @brief 接收所有字节消耗时长。
          */
         /** {en}
-         * @brief Video wight.
+         * @brief The time consumed for receiving all bytes.
          */
-        width: number;
+        totalReceivedCost: number;
     }
     /** {zh}
      * @detail api
@@ -12222,6 +12343,14 @@ declare namespace live {
          * @brief Obtain the playback information of FLV pull streaming.
          */
         getFLVStats(): FlvStats;
+        /** {zh}
+         * @brief 获取 HLS 拉流的播放信息。
+         * @returns
+         */
+        /** {en}
+         * @brief Obtain the playback information of HLS pull streaming.
+         */
+        getHLSStats(): Stats$0;
         updatePlaylist(playlist: ExposedSource[], target?: string | {
             /** {zh}
              * @brief 清晰度唯一标识。

package/veplayer.live.d.ts

@@ -1214,7 +1214,38 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
     /** {en}
      * @brief The URL of the player's cover image.
      */
-    poster?: string;
+    poster?: string | {
+        /** {zh}
+         * @brief 封面图 URL 地址。
+         * @default -
+         */
+        poster: string;
+        /** {zh}
+         * @brief 是否在播放结束之后显示封面图。
+         * @default true
+         */
+        isEndedShow?: boolean;
+        /** {zh}
+         * @brief 是否播放后再隐藏封面图。
+         *        - `true`：播放后隐藏，未启播时一直显示封面图。
+         *        - `false`：在 `play` 事件触发后隐藏封面图。
+         * @default false
+         */
+        hideCanplay?: boolean;
+        /** {zh}
+         * @brief 是否一直显示封面图。
+         * @default false
+         */
+        notHidden?: boolean;
+        /** {zh}
+         * @brief 封面图填充方式。取值如下：
+         *        - `fixWidth`：宽度方向填充，不会被拉伸压缩。
+         *        - `fixHeight`：高度方向填充，不会被拉伸压缩。
+         *        - `cover`：完全覆盖容器，多余部分会被裁剪。
+         *        - `contain`：完全覆盖，与容器不匹配时会被拉伸压缩。
+         */
+        fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
+    };
     /** {zh}
      * @brief 为播放器设置初始显示语言，语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
      */
@@ -3560,7 +3591,38 @@ declare namespace strategy {
         /** {en}
          * @brief The URL of the player's cover image.
          */
-        poster?: string;
+        poster?: string | {
+            /** {zh}
+             * @brief 封面图 URL 地址。
+             * @default -
+             */
+            poster: string;
+            /** {zh}
+             * @brief 是否在播放结束之后显示封面图。
+             * @default true
+             */
+            isEndedShow?: boolean;
+            /** {zh}
+             * @brief 是否播放后再隐藏封面图。
+             *        - `true`：播放后隐藏，未启播时一直显示封面图。
+             *        - `false`：在 `play` 事件触发后隐藏封面图。
+             * @default false
+             */
+            hideCanplay?: boolean;
+            /** {zh}
+             * @brief 是否一直显示封面图。
+             * @default false
+             */
+            notHidden?: boolean;
+            /** {zh}
+             * @brief 封面图填充方式。取值如下：
+             *        - `fixWidth`：宽度方向填充，不会被拉伸压缩。
+             *        - `fixHeight`：高度方向填充，不会被拉伸压缩。
+             *        - `cover`：完全覆盖容器，多余部分会被裁剪。
+             *        - `contain`：完全覆盖，与容器不匹配时会被拉伸压缩。
+             */
+            fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
+        };
         /** {zh}
          * @brief 为播放器设置初始显示语言，语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
          */
@@ -6324,14 +6386,12 @@ interface StatsSnapShoot {
 /** {zh}
  * @list option
  * @kind property
- * @brief FLV 直播流播放信息。
  */
 /** {en}
  * @list option
  * @kind property
- * @brief FLV live stream information.
  */
-interface FlvStats {
+interface Stats$0 {
     /** {zh}
      * @brief 音频格式。
      * @hidden
@@ -6433,33 +6493,45 @@ interface FlvStats {
      */
     samplerate: number;
     /** {zh}
-     * @brief 总共收到的字节数。
+     * @hidden
      */
     /** {en}
-     * @brief The total number of bytes received.
+     * @hidden
      */
-    totalReceivedByte: number;
+    videoCodec: string;
     /** {zh}
-     * @brief 接收所有字节消耗时长。
+     * @brief 视频宽度。
      */
     /** {en}
-     * @brief The time consumed for receiving all bytes.
+     * @brief Video wight.
      */
-    totalReceivedCost: number;
+    width: number;
+}
+/** {zh}
+ * @list option
+ * @kind property
+ * @brief FLV 直播流播放信息。
+ */
+/** {en}
+ * @list option
+ * @kind property
+ * @brief FLV live stream information.
+ */
+interface FlvStats extends Stats$0 {
     /** {zh}
-     * @hidden
+     * @brief 总共收到的字节数。
      */
     /** {en}
-     * @hidden
+     * @brief The total number of bytes received.
      */
-    videoCodec: string;
+    totalReceivedByte: number;
     /** {zh}
-     * @brief 视频宽度。
+     * @brief 接收所有字节消耗时长。
      */
     /** {en}
-     * @brief Video wight.
+     * @brief The time consumed for receiving all bytes.
      */
-    width: number;
+    totalReceivedCost: number;
 }
 /** {zh}
  * @detail api
@@ -6602,6 +6674,14 @@ declare class VePlayerLive extends VePlayerBase {
      * @brief Obtain the playback information of FLV pull streaming.
      */
     getFLVStats(): FlvStats;
+    /** {zh}
+     * @brief 获取 HLS 拉流的播放信息。
+     * @returns
+     */
+    /** {en}
+     * @brief Obtain the playback information of HLS pull streaming.
+     */
+    getHLSStats(): Stats$0;
     updatePlaylist(playlist: ExposedSource[], target?: string | {
         /** {zh}
          * @brief 清晰度唯一标识。
@@ -8965,7 +9045,38 @@ declare namespace live {
         /** {en}
          * @brief The URL of the player's cover image.
          */
-        poster?: string;
+        poster?: string | {
+            /** {zh}
+             * @brief 封面图 URL 地址。
+             * @default -
+             */
+            poster: string;
+            /** {zh}
+             * @brief 是否在播放结束之后显示封面图。
+             * @default true
+             */
+            isEndedShow?: boolean;
+            /** {zh}
+             * @brief 是否播放后再隐藏封面图。
+             *        - `true`：播放后隐藏，未启播时一直显示封面图。
+             *        - `false`：在 `play` 事件触发后隐藏封面图。
+             * @default false
+             */
+            hideCanplay?: boolean;
+            /** {zh}
+             * @brief 是否一直显示封面图。
+             * @default false
+             */
+            notHidden?: boolean;
+            /** {zh}
+             * @brief 封面图填充方式。取值如下：
+             *        - `fixWidth`：宽度方向填充，不会被拉伸压缩。
+             *        - `fixHeight`：高度方向填充，不会被拉伸压缩。
+             *        - `cover`：完全覆盖容器，多余部分会被裁剪。
+             *        - `contain`：完全覆盖，与容器不匹配时会被拉伸压缩。
+             */
+            fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
+        };
         /** {zh}
          * @brief 为播放器设置初始显示语言，语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
          */
@@ -11944,14 +12055,12 @@ declare namespace live {
     /** {zh}
      * @list option
      * @kind property
-     * @brief FLV 直播流播放信息。
      */
     /** {en}
      * @list option
      * @kind property
-     * @brief FLV live stream information.
      */
-    interface FlvStats {
+    interface Stats$0 {
         /** {zh}
          * @brief 音频格式。
          * @hidden
@@ -12053,33 +12162,45 @@ declare namespace live {
          */
         samplerate: number;
         /** {zh}
-         * @brief 总共收到的字节数。
+         * @hidden
          */
         /** {en}
-         * @brief The total number of bytes received.
+         * @hidden
          */
-        totalReceivedByte: number;
+        videoCodec: string;
         /** {zh}
-         * @brief 接收所有字节消耗时长。
+         * @brief 视频宽度。
          */
         /** {en}
-         * @brief The time consumed for receiving all bytes.
+         * @brief Video wight.
          */
-        totalReceivedCost: number;
+        width: number;
+    }
+    /** {zh}
+     * @list option
+     * @kind property
+     * @brief FLV 直播流播放信息。
+     */
+    /** {en}
+     * @list option
+     * @kind property
+     * @brief FLV live stream information.
+     */
+    interface FlvStats extends Stats$0 {
         /** {zh}
-         * @hidden
+         * @brief 总共收到的字节数。
          */
         /** {en}
-         * @hidden
+         * @brief The total number of bytes received.
          */
-        videoCodec: string;
+        totalReceivedByte: number;
         /** {zh}
-         * @brief 视频宽度。
+         * @brief 接收所有字节消耗时长。
          */
         /** {en}
-         * @brief Video wight.
+         * @brief The time consumed for receiving all bytes.
          */
-        width: number;
+        totalReceivedCost: number;
     }
     /** {zh}
      * @detail api
@@ -12222,6 +12343,14 @@ declare namespace live {
          * @brief Obtain the playback information of FLV pull streaming.
          */
         getFLVStats(): FlvStats;
+        /** {zh}
+         * @brief 获取 HLS 拉流的播放信息。
+         * @returns
+         */
+        /** {en}
+         * @brief Obtain the playback information of HLS pull streaming.
+         */
+        getHLSStats(): Stats$0;
         updatePlaylist(playlist: ExposedSource[], target?: string | {
             /** {zh}
              * @brief 清晰度唯一标识。

package/veplayer.vod.d.ts

@@ -1083,7 +1083,38 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
     /** {en}
      * @brief The URL of the player's cover image.
      */
-    poster?: string;
+    poster?: string | {
+        /** {zh}
+         * @brief 封面图 URL 地址。
+         * @default -
+         */
+        poster: string;
+        /** {zh}
+         * @brief 是否在播放结束之后显示封面图。
+         * @default true
+         */
+        isEndedShow?: boolean;
+        /** {zh}
+         * @brief 是否播放后再隐藏封面图。
+         *        - `true`：播放后隐藏，未启播时一直显示封面图。
+         *        - `false`：在 `play` 事件触发后隐藏封面图。
+         * @default false
+         */
+        hideCanplay?: boolean;
+        /** {zh}
+         * @brief 是否一直显示封面图。
+         * @default false
+         */
+        notHidden?: boolean;
+        /** {zh}
+         * @brief 封面图填充方式。取值如下：
+         *        - `fixWidth`：宽度方向填充，不会被拉伸压缩。
+         *        - `fixHeight`：高度方向填充，不会被拉伸压缩。
+         *        - `cover`：完全覆盖容器，多余部分会被裁剪。
+         *        - `contain`：完全覆盖，与容器不匹配时会被拉伸压缩。
+         */
+        fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
+    };
     /** {zh}
      * @brief 为播放器设置初始显示语言，语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
      */
@@ -3387,7 +3418,38 @@ declare namespace strategy {
         /** {en}
          * @brief The URL of the player's cover image.
          */
-        poster?: string;
+        poster?: string | {
+            /** {zh}
+             * @brief 封面图 URL 地址。
+             * @default -
+             */
+            poster: string;
+            /** {zh}
+             * @brief 是否在播放结束之后显示封面图。
+             * @default true
+             */
+            isEndedShow?: boolean;
+            /** {zh}
+             * @brief 是否播放后再隐藏封面图。
+             *        - `true`：播放后隐藏，未启播时一直显示封面图。
+             *        - `false`：在 `play` 事件触发后隐藏封面图。
+             * @default false
+             */
+            hideCanplay?: boolean;
+            /** {zh}
+             * @brief 是否一直显示封面图。
+             * @default false
+             */
+            notHidden?: boolean;
+            /** {zh}
+             * @brief 封面图填充方式。取值如下：
+             *        - `fixWidth`：宽度方向填充，不会被拉伸压缩。
+             *        - `fixHeight`：高度方向填充，不会被拉伸压缩。
+             *        - `cover`：完全覆盖容器，多余部分会被裁剪。
+             *        - `contain`：完全覆盖，与容器不匹配时会被拉伸压缩。
+             */
+            fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
+        };
         /** {zh}
          * @brief 为播放器设置初始显示语言，语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
          */