@volcengine/veplayer 2.7.0 → 2.7.1-rc.0

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/umd/veplayer.d.ts CHANGED
@@ -1214,7 +1214,38 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1214
1214
  /** {en}
1215
1215
  * @brief The URL of the player's cover image.
1216
1216
  */
1217
- poster?: string;
1217
+ poster?: string | {
1218
+ /** {zh}
1219
+ * @brief 封面图 URL 地址。
1220
+ * @default -
1221
+ */
1222
+ poster: string;
1223
+ /** {zh}
1224
+ * @brief 是否在播放结束之后显示封面图。
1225
+ * @default true
1226
+ */
1227
+ isEndedShow?: boolean;
1228
+ /** {zh}
1229
+ * @brief 是否播放后再隐藏封面图。
1230
+ * - `true`:播放后隐藏,未启播时一直显示封面图。
1231
+ * - `false`:在 `play` 事件触发后隐藏封面图。
1232
+ * @default false
1233
+ */
1234
+ hideCanplay?: boolean;
1235
+ /** {zh}
1236
+ * @brief 是否一直显示封面图。
1237
+ * @default false
1238
+ */
1239
+ notHidden?: boolean;
1240
+ /** {zh}
1241
+ * @brief 封面图填充方式。取值如下:
1242
+ * - `fixWidth`:宽度方向填充,不会被拉伸压缩。
1243
+ * - `fixHeight`:高度方向填充,不会被拉伸压缩。
1244
+ * - `cover`:完全覆盖容器,多余部分会被裁剪。
1245
+ * - `contain`:完全覆盖,与容器不匹配时会被拉伸压缩。
1246
+ */
1247
+ fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
1248
+ };
1218
1249
  /** {zh}
1219
1250
  * @brief 为播放器设置初始显示语言,语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
1220
1251
  */
@@ -3560,7 +3591,38 @@ declare namespace strategy {
3560
3591
  /** {en}
3561
3592
  * @brief The URL of the player's cover image.
3562
3593
  */
3563
- poster?: string;
3594
+ poster?: string | {
3595
+ /** {zh}
3596
+ * @brief 封面图 URL 地址。
3597
+ * @default -
3598
+ */
3599
+ poster: string;
3600
+ /** {zh}
3601
+ * @brief 是否在播放结束之后显示封面图。
3602
+ * @default true
3603
+ */
3604
+ isEndedShow?: boolean;
3605
+ /** {zh}
3606
+ * @brief 是否播放后再隐藏封面图。
3607
+ * - `true`:播放后隐藏,未启播时一直显示封面图。
3608
+ * - `false`:在 `play` 事件触发后隐藏封面图。
3609
+ * @default false
3610
+ */
3611
+ hideCanplay?: boolean;
3612
+ /** {zh}
3613
+ * @brief 是否一直显示封面图。
3614
+ * @default false
3615
+ */
3616
+ notHidden?: boolean;
3617
+ /** {zh}
3618
+ * @brief 封面图填充方式。取值如下:
3619
+ * - `fixWidth`:宽度方向填充,不会被拉伸压缩。
3620
+ * - `fixHeight`:高度方向填充,不会被拉伸压缩。
3621
+ * - `cover`:完全覆盖容器,多余部分会被裁剪。
3622
+ * - `contain`:完全覆盖,与容器不匹配时会被拉伸压缩。
3623
+ */
3624
+ fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
3625
+ };
3564
3626
  /** {zh}
3565
3627
  * @brief 为播放器设置初始显示语言,语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
3566
3628
  */
@@ -8983,7 +9045,38 @@ declare namespace live {
8983
9045
  /** {en}
8984
9046
  * @brief The URL of the player's cover image.
8985
9047
  */
8986
- poster?: string;
9048
+ poster?: string | {
9049
+ /** {zh}
9050
+ * @brief 封面图 URL 地址。
9051
+ * @default -
9052
+ */
9053
+ poster: string;
9054
+ /** {zh}
9055
+ * @brief 是否在播放结束之后显示封面图。
9056
+ * @default true
9057
+ */
9058
+ isEndedShow?: boolean;
9059
+ /** {zh}
9060
+ * @brief 是否播放后再隐藏封面图。
9061
+ * - `true`:播放后隐藏,未启播时一直显示封面图。
9062
+ * - `false`:在 `play` 事件触发后隐藏封面图。
9063
+ * @default false
9064
+ */
9065
+ hideCanplay?: boolean;
9066
+ /** {zh}
9067
+ * @brief 是否一直显示封面图。
9068
+ * @default false
9069
+ */
9070
+ notHidden?: boolean;
9071
+ /** {zh}
9072
+ * @brief 封面图填充方式。取值如下:
9073
+ * - `fixWidth`:宽度方向填充,不会被拉伸压缩。
9074
+ * - `fixHeight`:高度方向填充,不会被拉伸压缩。
9075
+ * - `cover`:完全覆盖容器,多余部分会被裁剪。
9076
+ * - `contain`:完全覆盖,与容器不匹配时会被拉伸压缩。
9077
+ */
9078
+ fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
9079
+ };
8987
9080
  /** {zh}
8988
9081
  * @brief 为播放器设置初始显示语言,语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
8989
9082
  */
@@ -14193,10 +14193,15 @@ var __publicField = (obj, key, value) => {
14193
14193
  * @param options 更多配置信息。
14194
14194
  */
14195
14195
  (options) => {
14196
+ var _a, _b;
14196
14197
  const { autoplay: autoplay2, ...rest } = options;
14197
14198
  const xgOptions = rest;
14198
14199
  if (xgOptions.poster) {
14199
- xgOptions.poster = escapeHtml(xgOptions.poster);
14200
+ if (typeof xgOptions.poster === "string") {
14201
+ xgOptions.poster = escapeHtml(xgOptions.poster);
14202
+ } else if (typeof ((_a = xgOptions.poster) == null ? void 0 : _a.poster) === "string") {
14203
+ xgOptions.poster.poster = escapeHtml((_b = xgOptions.poster) == null ? void 0 : _b.poster);
14204
+ }
14200
14205
  }
14201
14206
  xgOptions.icons = {
14202
14207
  ...DEFAULT_ICONS,
@@ -14448,7 +14453,7 @@ var __publicField = (obj, key, value) => {
14448
14453
  * @brief Retrieve the player SDK version number.
14449
14454
  */
14450
14455
  get playerVersion() {
14451
- return "2.7.0";
14456
+ return "2.7.1-rc.0";
14452
14457
  }
14453
14458
  /** {zh}
14454
14459
  * @brief 获取当前播放视频的清晰度唯一标识(definition)。
@@ -22591,7 +22596,7 @@ var __publicField = (obj, key, value) => {
22591
22596
  device_id: this._deviceId,
22592
22597
  error_report_stop: true,
22593
22598
  ext: {
22594
- veplayer_version: "2.7.0",
22599
+ veplayer_version: "2.7.1-rc.0",
22595
22600
  flv_version: "3.0.21-rc.21",
22596
22601
  hls_version: "3.0.21-rc.21",
22597
22602
  rts_version: "0.2.1-alpha.14"
@@ -1214,7 +1214,38 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1214
1214
  /** {en}
1215
1215
  * @brief The URL of the player's cover image.
1216
1216
  */
1217
- poster?: string;
1217
+ poster?: string | {
1218
+ /** {zh}
1219
+ * @brief 封面图 URL 地址。
1220
+ * @default -
1221
+ */
1222
+ poster: string;
1223
+ /** {zh}
1224
+ * @brief 是否在播放结束之后显示封面图。
1225
+ * @default true
1226
+ */
1227
+ isEndedShow?: boolean;
1228
+ /** {zh}
1229
+ * @brief 是否播放后再隐藏封面图。
1230
+ * - `true`:播放后隐藏,未启播时一直显示封面图。
1231
+ * - `false`:在 `play` 事件触发后隐藏封面图。
1232
+ * @default false
1233
+ */
1234
+ hideCanplay?: boolean;
1235
+ /** {zh}
1236
+ * @brief 是否一直显示封面图。
1237
+ * @default false
1238
+ */
1239
+ notHidden?: boolean;
1240
+ /** {zh}
1241
+ * @brief 封面图填充方式。取值如下:
1242
+ * - `fixWidth`:宽度方向填充,不会被拉伸压缩。
1243
+ * - `fixHeight`:高度方向填充,不会被拉伸压缩。
1244
+ * - `cover`:完全覆盖容器,多余部分会被裁剪。
1245
+ * - `contain`:完全覆盖,与容器不匹配时会被拉伸压缩。
1246
+ */
1247
+ fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
1248
+ };
1218
1249
  /** {zh}
1219
1250
  * @brief 为播放器设置初始显示语言,语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
1220
1251
  */
@@ -3560,7 +3591,38 @@ declare namespace strategy {
3560
3591
  /** {en}
3561
3592
  * @brief The URL of the player's cover image.
3562
3593
  */
3563
- poster?: string;
3594
+ poster?: string | {
3595
+ /** {zh}
3596
+ * @brief 封面图 URL 地址。
3597
+ * @default -
3598
+ */
3599
+ poster: string;
3600
+ /** {zh}
3601
+ * @brief 是否在播放结束之后显示封面图。
3602
+ * @default true
3603
+ */
3604
+ isEndedShow?: boolean;
3605
+ /** {zh}
3606
+ * @brief 是否播放后再隐藏封面图。
3607
+ * - `true`:播放后隐藏,未启播时一直显示封面图。
3608
+ * - `false`:在 `play` 事件触发后隐藏封面图。
3609
+ * @default false
3610
+ */
3611
+ hideCanplay?: boolean;
3612
+ /** {zh}
3613
+ * @brief 是否一直显示封面图。
3614
+ * @default false
3615
+ */
3616
+ notHidden?: boolean;
3617
+ /** {zh}
3618
+ * @brief 封面图填充方式。取值如下:
3619
+ * - `fixWidth`:宽度方向填充,不会被拉伸压缩。
3620
+ * - `fixHeight`:高度方向填充,不会被拉伸压缩。
3621
+ * - `cover`:完全覆盖容器,多余部分会被裁剪。
3622
+ * - `contain`:完全覆盖,与容器不匹配时会被拉伸压缩。
3623
+ */
3624
+ fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
3625
+ };
3564
3626
  /** {zh}
3565
3627
  * @brief 为播放器设置初始显示语言,语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
3566
3628
  */
@@ -8983,7 +9045,38 @@ declare namespace live {
8983
9045
  /** {en}
8984
9046
  * @brief The URL of the player's cover image.
8985
9047
  */
8986
- poster?: string;
9048
+ poster?: string | {
9049
+ /** {zh}
9050
+ * @brief 封面图 URL 地址。
9051
+ * @default -
9052
+ */
9053
+ poster: string;
9054
+ /** {zh}
9055
+ * @brief 是否在播放结束之后显示封面图。
9056
+ * @default true
9057
+ */
9058
+ isEndedShow?: boolean;
9059
+ /** {zh}
9060
+ * @brief 是否播放后再隐藏封面图。
9061
+ * - `true`:播放后隐藏,未启播时一直显示封面图。
9062
+ * - `false`:在 `play` 事件触发后隐藏封面图。
9063
+ * @default false
9064
+ */
9065
+ hideCanplay?: boolean;
9066
+ /** {zh}
9067
+ * @brief 是否一直显示封面图。
9068
+ * @default false
9069
+ */
9070
+ notHidden?: boolean;
9071
+ /** {zh}
9072
+ * @brief 封面图填充方式。取值如下:
9073
+ * - `fixWidth`:宽度方向填充,不会被拉伸压缩。
9074
+ * - `fixHeight`:高度方向填充,不会被拉伸压缩。
9075
+ * - `cover`:完全覆盖容器,多余部分会被裁剪。
9076
+ * - `contain`:完全覆盖,与容器不匹配时会被拉伸压缩。
9077
+ */
9078
+ fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
9079
+ };
8987
9080
  /** {zh}
8988
9081
  * @brief 为播放器设置初始显示语言,语言包不存在的情况下默认显示 'en' 语言包 。默认值为 `document.documentElement.getAttribute('lang') || navigator.language || 'zh-cn'`
8989
9082
  */
@@ -14193,10 +14193,15 @@ var __publicField = (obj, key, value) => {
14193
14193
  * @param options 更多配置信息。
14194
14194
  */
14195
14195
  (options) => {
14196
+ var _a, _b;
14196
14197
  const { autoplay: autoplay2, ...rest } = options;
14197
14198
  const xgOptions = rest;
14198
14199
  if (xgOptions.poster) {
14199
- xgOptions.poster = escapeHtml(xgOptions.poster);
14200
+ if (typeof xgOptions.poster === "string") {
14201
+ xgOptions.poster = escapeHtml(xgOptions.poster);
14202
+ } else if (typeof ((_a = xgOptions.poster) == null ? void 0 : _a.poster) === "string") {
14203
+ xgOptions.poster.poster = escapeHtml((_b = xgOptions.poster) == null ? void 0 : _b.poster);
14204
+ }
14200
14205
  }
14201
14206
  xgOptions.icons = {
14202
14207
  ...DEFAULT_ICONS,
@@ -14448,7 +14453,7 @@ var __publicField = (obj, key, value) => {
14448
14453
  * @brief Retrieve the player SDK version number.
14449
14454
  */
14450
14455
  get playerVersion() {
14451
- return "2.7.0";
14456
+ return "2.7.1-rc.0";
14452
14457
  }
14453
14458
  /** {zh}
14454
14459
  * @brief 获取当前播放视频的清晰度唯一标识(definition)。
@@ -22591,7 +22596,7 @@ var __publicField = (obj, key, value) => {
22591
22596
  device_id: this._deviceId,
22592
22597
  error_report_stop: true,
22593
22598
  ext: {
22594
- veplayer_version: "2.7.0",
22599
+ veplayer_version: "2.7.1-rc.0",
22595
22600
  flv_version: "3.0.21-rc.21",
22596
22601
  hls_version: "3.0.21-rc.21",
22597
22602
  rts_version: "0.2.1-alpha.14"