@volcengine/veplayer 2.8.1 → 2.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@volcengine/veplayer",
3
- "version": "2.8.1",
3
+ "version": "2.8.2",
4
4
  "main": "./umd/veplayer.production.js",
5
5
  "module": "./esm/veplayer.production.js",
6
6
  "browser": "./umd/veplayer.production.js",
package/umd/index.d.ts CHANGED
@@ -433,6 +433,16 @@ declare enum Level {
433
433
  */
434
434
  Warn = "Warn"
435
435
  }
436
+ /** {zh}
437
+ * @detail error
438
+ * @id errorcode
439
+ * @hidden
440
+ */
441
+ /** {en}
442
+ * @detail error
443
+ * @id errorcode
444
+ * @hidden
445
+ */
436
446
  declare enum ErrorCode {
437
447
  /** {zh}
438
448
  * @brief 视频解析错误
@@ -1587,15 +1597,15 @@ interface Poster {
1587
1597
  */
1588
1598
  isEndedShow?: boolean;
1589
1599
  /** {zh}
1590
- * @brief 是否播放后再隐藏封面图。
1591
- * - `true`:播放后隐藏,未启播时一直显示封面图。
1592
- * - `false`:在 `play` 事件触发后隐藏封面图。
1600
+ * @brief 是否在播放后隐藏封面图。
1601
+ * - `true`:在播放器开始播放(即画面可见)后隐藏封面图,播放前始终显示,避免黑屏;
1602
+ * - `false`:在触发 `play` 事件时立即隐藏封面图,可能在画面显示前出现黑屏。
1593
1603
  * @default false
1594
1604
  */
1595
1605
  /** {en}
1596
- * @brief Whether to hide the cover image after `canplay` event.
1597
- * - `true`:hide the cover image after `canplay` event.
1598
- * - `false`:hide the cover image after `play` event.
1606
+ * @brief Whether to hide the poster image after playback starts.
1607
+ * - `true`:The poster image remains visible until video playback actually starts (i.e., video frames are rendered), preventing a black screen before playback.
1608
+ * - `false`:The poster image is hidden immediately when the `play` event is triggered, which may cause a brief black screen before video appears.
1599
1609
  * @default false
1600
1610
  */
1601
1611
  hideCanplay?: boolean;
@@ -1609,18 +1619,18 @@ interface Poster {
1609
1619
  */
1610
1620
  notHidden?: boolean;
1611
1621
  /** {zh}
1612
- * @brief 封面图填充方式。取值如下:
1613
- * - `fixWidth`:宽度方向填充,不会被拉伸压缩。
1614
- * - `fixHeight`:高度方向填充,不会被拉伸压缩。
1615
- * - `cover`:完全覆盖容器,多余部分会被裁剪。
1616
- * - `contain`:完全覆盖,与容器不匹配时会被拉伸压缩。
1622
+ * @brief 封面图的填充方式,取值如下所示。
1623
+ * - `fixWidth`:按宽度适配容器,高度等比缩放,图像不拉伸压缩;
1624
+ * - `fixHeight`:按高度适配容器,宽度等比缩放,图像不拉伸压缩;
1625
+ * - `cover`:等比缩放并裁剪,使封面图完整覆盖容器,不留黑边;
1626
+ * - `contain`:等比缩放并拉伸,使封面图完整覆盖容器,不留黑边,可能失真。
1617
1627
  */
1618
1628
  /** {en}
1619
- * @brief Cover image fill mode.
1620
- * - `fixWidth`:Fill the width of the container and crop the height if necessary.
1621
- * - `fixHeight`:Fill the height of the container and crop the width if necessary.
1622
- * - `cover`:Fill the entire container while keeping the original aspect ratio.
1623
- * - `contain`:Stretch the video to fill the container.
1629
+ * @brief Fill mode of the poster image. The available options are as follows:
1630
+ * - `fixWidth`:Scales the image to fit the container's width while maintaining aspect ratio. Height is scaled proportionally, which may leave vertical blank space.
1631
+ * - `fixHeight`:Scales the image to fit the container's height while maintaining aspect ratio. Width is scaled proportionally, which may leave horizontal blank space.
1632
+ * - `cover`:Scales the image proportionally and crops overflow to fully cover the container without black borders.
1633
+ * - `contain`:Scales the image to fully fit the container. May stretch non-proportionally to avoid black borders, potentially causing distortion.
1624
1634
  */
1625
1635
  fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
1626
1636
  }
@@ -2843,6 +2853,16 @@ declare namespace strategy {
2843
2853
  */
2844
2854
  Warn = "Warn"
2845
2855
  }
2856
+ /** {zh}
2857
+ * @detail error
2858
+ * @id errorcode
2859
+ * @hidden
2860
+ */
2861
+ /** {en}
2862
+ * @detail error
2863
+ * @id errorcode
2864
+ * @hidden
2865
+ */
2846
2866
  enum ErrorCode {
2847
2867
  /** {zh}
2848
2868
  * @brief 视频解析错误
@@ -4060,15 +4080,15 @@ declare namespace strategy {
4060
4080
  */
4061
4081
  isEndedShow?: boolean;
4062
4082
  /** {zh}
4063
- * @brief 是否播放后再隐藏封面图。
4064
- * - `true`:播放后隐藏,未启播时一直显示封面图。
4065
- * - `false`:在 `play` 事件触发后隐藏封面图。
4083
+ * @brief 是否在播放后隐藏封面图。
4084
+ * - `true`:在播放器开始播放(即画面可见)后隐藏封面图,播放前始终显示,避免黑屏;
4085
+ * - `false`:在触发 `play` 事件时立即隐藏封面图,可能在画面显示前出现黑屏。
4066
4086
  * @default false
4067
4087
  */
4068
4088
  /** {en}
4069
- * @brief Whether to hide the cover image after `canplay` event.
4070
- * - `true`:hide the cover image after `canplay` event.
4071
- * - `false`:hide the cover image after `play` event.
4089
+ * @brief Whether to hide the poster image after playback starts.
4090
+ * - `true`:The poster image remains visible until video playback actually starts (i.e., video frames are rendered), preventing a black screen before playback.
4091
+ * - `false`:The poster image is hidden immediately when the `play` event is triggered, which may cause a brief black screen before video appears.
4072
4092
  * @default false
4073
4093
  */
4074
4094
  hideCanplay?: boolean;
@@ -4082,18 +4102,18 @@ declare namespace strategy {
4082
4102
  */
4083
4103
  notHidden?: boolean;
4084
4104
  /** {zh}
4085
- * @brief 封面图填充方式。取值如下:
4086
- * - `fixWidth`:宽度方向填充,不会被拉伸压缩。
4087
- * - `fixHeight`:高度方向填充,不会被拉伸压缩。
4088
- * - `cover`:完全覆盖容器,多余部分会被裁剪。
4089
- * - `contain`:完全覆盖,与容器不匹配时会被拉伸压缩。
4105
+ * @brief 封面图的填充方式,取值如下所示。
4106
+ * - `fixWidth`:按宽度适配容器,高度等比缩放,图像不拉伸压缩;
4107
+ * - `fixHeight`:按高度适配容器,宽度等比缩放,图像不拉伸压缩;
4108
+ * - `cover`:等比缩放并裁剪,使封面图完整覆盖容器,不留黑边;
4109
+ * - `contain`:等比缩放并拉伸,使封面图完整覆盖容器,不留黑边,可能失真。
4090
4110
  */
4091
4111
  /** {en}
4092
- * @brief Cover image fill mode.
4093
- * - `fixWidth`:Fill the width of the container and crop the height if necessary.
4094
- * - `fixHeight`:Fill the height of the container and crop the width if necessary.
4095
- * - `cover`:Fill the entire container while keeping the original aspect ratio.
4096
- * - `contain`:Stretch the video to fill the container.
4112
+ * @brief Fill mode of the poster image. The available options are as follows:
4113
+ * - `fixWidth`:Scales the image to fit the container's width while maintaining aspect ratio. Height is scaled proportionally, which may leave vertical blank space.
4114
+ * - `fixHeight`:Scales the image to fit the container's height while maintaining aspect ratio. Width is scaled proportionally, which may leave horizontal blank space.
4115
+ * - `cover`:Scales the image proportionally and crops overflow to fully cover the container without black borders.
4116
+ * - `contain`:Scales the image to fully fit the container. May stretch non-proportionally to avoid black borders, potentially causing distortion.
4097
4117
  */
4098
4118
  fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
4099
4119
  }
@@ -4482,6 +4502,16 @@ declare namespace error {
4482
4502
  */
4483
4503
  Warn = "Warn"
4484
4504
  }
4505
+ /** {zh}
4506
+ * @detail error
4507
+ * @id errorcode
4508
+ * @hidden
4509
+ */
4510
+ /** {en}
4511
+ * @detail error
4512
+ * @id errorcode
4513
+ * @hidden
4514
+ */
4485
4515
  enum ErrorCode {
4486
4516
  /** {zh}
4487
4517
  * @brief 视频解析错误
@@ -2220,7 +2220,7 @@ var __publicField = (obj, key, value) => {
2220
2220
  error_report_stop: true,
2221
2221
  ext: {
2222
2222
  veplayer_version: "2.3.0",
2223
- flv_version: "3.0.21-rc.21",
2223
+ flv_version: "3.0.23-rc.6",
2224
2224
  hls_version: "3.0.21-rc.21",
2225
2225
  rts_version: "0.2.1-alpha.42"
2226
2226
  }