@volcengine/veplayer 2.6.1 → 2.6.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.
Files changed (40) hide show
  1. package/esm/index.d.ts +25 -100
  2. package/esm/veplayer.biz.live.development.css +2 -1
  3. package/esm/veplayer.biz.live.development.js +26 -5
  4. package/esm/veplayer.biz.live.production.css +1 -1
  5. package/esm/veplayer.biz.live.production.js +1 -1
  6. package/esm/veplayer.d.ts +147 -203
  7. package/esm/veplayer.development.css +2 -1
  8. package/esm/veplayer.development.js +29 -8
  9. package/esm/veplayer.live.d.ts +147 -203
  10. package/esm/veplayer.live.development.css +2 -1
  11. package/esm/veplayer.live.development.js +29 -8
  12. package/esm/veplayer.live.production.css +1 -1
  13. package/esm/veplayer.live.production.js +2 -2
  14. package/esm/veplayer.production.css +1 -1
  15. package/esm/veplayer.production.js +2 -2
  16. package/esm/veplayer.vod.d.ts +25 -100
  17. package/esm/veplayer.vod.development.js +2 -2
  18. package/esm/veplayer.vod.production.js +1 -1
  19. package/package.json +1 -1
  20. package/umd/index.d.ts +25 -100
  21. package/umd/veplayer.biz.live.development.css +2 -1
  22. package/umd/veplayer.biz.live.development.js +26 -5
  23. package/umd/veplayer.biz.live.production.css +1 -1
  24. package/umd/veplayer.biz.live.production.js +1 -1
  25. package/umd/veplayer.d.ts +147 -203
  26. package/umd/veplayer.development.css +2 -1
  27. package/umd/veplayer.development.js +29 -8
  28. package/umd/veplayer.live.d.ts +147 -203
  29. package/umd/veplayer.live.development.css +2 -1
  30. package/umd/veplayer.live.development.js +29 -8
  31. package/umd/veplayer.live.production.css +1 -1
  32. package/umd/veplayer.live.production.js +1 -1
  33. package/umd/veplayer.production.css +1 -1
  34. package/umd/veplayer.production.js +1 -1
  35. package/umd/veplayer.vod.d.ts +25 -100
  36. package/umd/veplayer.vod.development.js +2 -2
  37. package/umd/veplayer.vod.production.js +1 -1
  38. package/veplayer.d.ts +147 -203
  39. package/veplayer.live.d.ts +147 -203
  40. package/veplayer.vod.d.ts +25 -100
package/esm/index.d.ts CHANGED
@@ -127,7 +127,6 @@ declare class Definition implements XGDefinition {
127
127
  interface ExposedDefinition {
128
128
  /** {zh}
129
129
  * @brief 播放地址。
130
- * @default 无
131
130
  */
132
131
  /** {en}
133
132
  * @brief The playback address.
@@ -135,8 +134,6 @@ interface ExposedDefinition {
135
134
  url: string;
136
135
  /** {zh}
137
136
  * @brief 清晰度标识(唯一值)。
138
- * @default 无
139
- *
140
137
  */
141
138
  /** {en}
142
139
  * @brief The resolution ID. This value must be unique.
@@ -145,7 +142,6 @@ interface ExposedDefinition {
145
142
  definition: string;
146
143
  /** {zh}
147
144
  * @brief 清晰度展示名称。可设置多语言 `{text: {'zh-cn': '高清', 'en': 'HD'}}`。
148
- * @default 无
149
145
  */
150
146
  /** {en}
151
147
  * @brief The display name of the resolution. Multiple languages are supported, such as `{text: {'zh-cn': '高清', 'en': 'HD'}}`.
@@ -153,8 +149,6 @@ interface ExposedDefinition {
153
149
  text?: Record<Lang, string> | string;
154
150
  /** {zh}
155
151
  * @brief 为当前清晰度地址设置备路拉流地址,支持设置多个备路拉流地址。当前清晰度地址拉流失败时,会在当前清晰度地址和备路直播地址之间循环拉流,直到拉流成功。
156
- * @default 无
157
- *
158
152
  */
159
153
  /** {en}
160
154
  * @brief The backup pull stream address for the current resolution. You can set multiple backup addresses. When the player fails to pull a stream from the current address, it will loop between the current and the backup addresses until it successfully pulls a stream.
@@ -177,7 +171,6 @@ interface ExposedDefinition {
177
171
  interface ExposedSource {
178
172
  /** {zh}
179
173
  * @brief 线路标识(唯一值)。
180
- * @default 无
181
174
  */
182
175
  /** {en}
183
176
  * @brief The playback source ID. This value must be unique.
@@ -185,8 +178,6 @@ interface ExposedSource {
185
178
  name?: string;
186
179
  /** {zh}
187
180
  * @brief 线路展示名称。可设置多语言 `{text: {'zh-cn': '线路一', 'en': 'LineOne'}}`。
188
- * @default 无
189
- *
190
181
  */
191
182
  /** {en}
192
183
  * @brief The display name of the live stream source. Multiple languages are supported. For example, you set it to `{text: {'zh-cn': '线路一', 'en': 'LineOne'}}`.
@@ -195,8 +186,6 @@ interface ExposedSource {
195
186
  text?: Record<Lang, string> | string;
196
187
  /** {zh}
197
188
  * @brief 该线路下清晰度列表。
198
- * @default 无
199
- *
200
189
  */
201
190
  /** {en}
202
191
  * @brief A list of resolutions of the current source.
@@ -406,25 +395,24 @@ declare class OptionsIcon extends Plugin {
406
395
  */
407
396
  declare enum Level {
408
397
  /** {zh}
409
- * @brief 严重。
398
+ * @brief 发生严重错误,可能由于 CDN 拉取失败或 DRM 权限验证未通过,导致无法播放。
410
399
  */
411
400
  /** {en}
412
- * @brief Fatal.
413
- *
401
+ * @brief A critical error occurs, typically due to CDN fetching failure or DRM permission verification failure, resulting in playback inability.
414
402
  */
415
403
  Fatal = "Fatal",
416
404
  /** {zh}
417
- * @brief 报错。
405
+ * @brief 流异常或处于离线状态,致使播放失败。
418
406
  */
419
407
  /** {en}
420
- * @brief Error.
408
+ * @brief A stream anomaly or offline state causes playback to fail.
421
409
  */
422
410
  Error = "Error",
423
411
  /** {zh}
424
- * @brief 提示。
412
+ * @brief 出现警告信息,通常由日志配置错误或缺少 RTM 降级地址引起。
425
413
  */
426
414
  /** {en}
427
- * @brief Warn.
415
+ * @brief A warning is issued, usually due to incorrect log configuration or a missing RTM fallback address.
428
416
  */
429
417
  Warn = "Warn"
430
418
  }
@@ -877,7 +865,6 @@ type ErrorConfig = {
877
865
  showRefresh?: boolean;
878
866
  /** {zh}
879
867
  * @brief 自定义报错显示。
880
- * @default 无
881
868
  */
882
869
  /** {en}
883
870
  * @brief Custom error message.
@@ -886,7 +873,6 @@ type ErrorConfig = {
886
873
  errorTipsText?: string | Record<Lang, string>;
887
874
  /** {zh}
888
875
  * @brief 更多提示信息。
889
- * @default 无
890
876
  */
891
877
  /** {en}
892
878
  * @brief More tips.
@@ -987,7 +973,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
987
973
  id?: string;
988
974
  /** {zh}
989
975
  * @brief 指定播放器容器元素,VePlayer 将被插入在该容器中。id 和 el 需至少传入 1 个。如果同时传入,则优先将播放器插入 id 容器中。
990
- * @default 无
991
976
  */
992
977
  /** {en}
993
978
  * @brief The container element of the player. You should specify either `id` or `el`, or both. If both are specified, the `VePlayer` object will be inserted in the container specified by `id`.
@@ -1013,7 +998,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1013
998
  height?: number | string;
1014
999
  /** {zh}
1015
1000
  * @brief 为播放器配置直播拉流地址。您可手动拼接或使用地址生成器生成拉流地址,生成方法请参见[生成直播地址](https://www.volcengine.com/docs/6469/107759)。url 和 playList 需至少传入 1 个。
1016
- * @default 无
1017
1001
  */
1018
1002
  /** {en}
1019
1003
  * @brief The pull stream address. You can manually construct the address or use the address generator to generate one. To see how to generate an address, refer to [Generate live-stream addresses](https://docs.byteplus.com/en/byteplus-media-live/docs/generating-live-stream-addresses). You should specify either `url` or `playList`, or both.
@@ -1021,7 +1005,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1021
1005
  url?: string;
1022
1006
  /** {zh}
1023
1007
  * @brief 为播放器配置直播拉流地址列表。url 和 playlist 需至少传入 1 个。
1024
- * @default 无
1025
1008
  */
1026
1009
  /** {en}
1027
1010
  * @brief A list of live stream sources for the player. You should specify either `url` or `playList`, or both.
@@ -1029,7 +1012,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1029
1012
  playlist?: ExposedSource[];
1030
1013
  /** {zh}
1031
1014
  * @brief 当存在多个直播线路时,为播放器设置默认直播线路,不传则默认列表第一个。
1032
- * @default 无
1033
1015
  */
1034
1016
  /** {en}
1035
1017
  * @brief The default pull stream address for the player when there are multiple addresses available. If this parameter is not specified, the first address in the playlist will become the default address.
@@ -1037,7 +1019,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1037
1019
  defaultSource?: string;
1038
1020
  /** {zh}
1039
1021
  * @brief 为播放器设置默认直播清晰度,不传则默认列表第一个。
1040
- * @default 无
1041
1022
  */
1042
1023
  /** {en}
1043
1024
  * @brief The default resolution for the player when there are multiple resolutions available. If this parameter is not specified, the first resolution in the list will become the default resolution.
@@ -1045,7 +1026,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1045
1026
  defaultDefinition?: string;
1046
1027
  /** {zh}
1047
1028
  * @brief 为播放器设置备路拉流地址,支持设置多个备路拉流地址,在 `maxFallbackRound` 大于 `0` 时有效。当您使用配置的直播拉流地址拉流失败时,会在直播地址和备路直播地址之间循环拉流,直到拉流成功。
1048
- * @default 无
1049
1029
  */
1050
1030
  /** {en}
1051
1031
  * @brief The backup pull stream address(es) for the player. You can enter multiple backup addresses. If `maxFallbackRound` is greater than `0`, when an error occurs in the main address, the player automatically switches to the backup address.
@@ -1099,7 +1079,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1099
1079
  degradation?: Degradation | boolean;
1100
1080
  /** {zh}
1101
1081
  * @brief 为播放器设置封面图 URL。
1102
- * @default 无
1103
1082
  */
1104
1083
  /** {en}
1105
1084
  * @brief The URL of the player's cover image.
@@ -1115,7 +1094,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1115
1094
  /** {zh}
1116
1095
  * @brief 为播放器设置自定义的多语言词典,可设置每个语种的词典,格式为 { texts: { [key: string]: Object; } }。
1117
1096
  * 例如,{ texts: { 'zh-cn': { PIP: '画中画' }, en: { PIP: 'pip' } }} ,格式请参考[默认词典](https://www.volcengine.com/docs/6469/127529)。
1118
- * @default 无
1119
1097
  */
1120
1098
  /** {en}
1121
1099
  * @brief Configures a custom multilingual dictionary for the player. You can set the dictionary for each language in the format { texts: { [key: string]: Object; } }. For example, { texts: { 'zh-cn': { PIP: '画中画' }, en: { PIP: 'pip' } }}.
@@ -1125,7 +1103,7 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1125
1103
  texts: Record<Lang, Record<string, string>>;
1126
1104
  };
1127
1105
  /** {zh}
1128
- * @brief 为播放器设置是否自动播放, `muted` 设置为 `true` 为静音自动播放。
1106
+ * @brief 为播放器设置是否自动播放,`muted` 设置为 `true` 为静音自动播放。
1129
1107
  * @default { muted: true }
1130
1108
  * @type {{ muted: boolean } | boolean}
1131
1109
  */
@@ -1231,7 +1209,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1231
1209
  playsinline?: boolean;
1232
1210
  /** {zh}
1233
1211
  * @brief 为播放器设置 video 标签扩展属性,初始化时会设置在 videoElement 或 audioElement 对象上,请参考 [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#properties) 查看其支持的属性配置。
1234
- * @default 无
1235
1212
  */
1236
1213
  /** {en}
1237
1214
  * @brief Additional properties for the `video` element that will be applied when the `videoElement` or `audioElement` objects are initialized. Refer to [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#properties) for supported properties.
@@ -1309,7 +1286,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1309
1286
  marginControls?: boolean;
1310
1287
  /** {zh}
1311
1288
  * @brief 启用微信同层播放。
1312
- * @default 无
1313
1289
  */
1314
1290
  /** {en}
1315
1291
  * @brief Enable playing the video on the same player as WeChat.
@@ -1319,7 +1295,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1319
1295
  * @brief 是否启用微信全屏播放模式。
1320
1296
  * - `true`:启用
1321
1297
  * - `false`:停用
1322
- * @default 无
1323
1298
  */
1324
1299
  /** {en}
1325
1300
  * @brief Whether to enable full-screen playback in WeChat.
@@ -1332,7 +1307,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1332
1307
  * - `landscape`:横屏
1333
1308
  * - `portrait`:竖屏
1334
1309
  * - `landscape|portrait`:跟随手机自动旋转
1335
- * @default 无
1336
1310
  */
1337
1311
  /** {en}
1338
1312
  * @brief The orientation of the video when played on WeChat. The following values are supported:
@@ -1343,7 +1317,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1343
1317
  "x5-video-orientation"?: "landscape" | "portrait" | "landscape|portrait";
1344
1318
  /** {zh}
1345
1319
  * @brief 为播放器配置关键点样式。
1346
- * @default 无
1347
1320
  * @hidden 直播目前没用到
1348
1321
  */
1349
1322
  /** {en}
@@ -1353,7 +1326,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1353
1326
  commonStyle?: CommonStyle;
1354
1327
  /** {zh}
1355
1328
  * @brief 自定义插件列表。
1356
- * @default 无
1357
1329
  */
1358
1330
  /** {en}
1359
1331
  * @brief A list of custom plugins.
@@ -1396,10 +1368,10 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1396
1368
  */
1397
1369
  closeVideoDblclick?: boolean;
1398
1370
  /** {zh}
1399
- * @brief 支持传入 video dom,常应用于多播放器复用同一 video 场景。
1371
+ * @brief 支持传入 `video` DOM 元素,适用于多个播放器共享同一视频场景。
1400
1372
  */
1401
1373
  /** {en}
1402
- * @brief Supports passing in video DOM, commonly used for reusing the same video scene across multiple players.
1374
+ * @brief Supports passing in a `video` DOM element, suitable for scenarios where multiple players share the same video.
1403
1375
  */
1404
1376
  mediaElement?: HTMLVideoElement | null;
1405
1377
  }
@@ -1468,7 +1440,6 @@ interface Fullscreen {
1468
1440
  interface CommonStyle {
1469
1441
  /** {zh}
1470
1442
  * @brief 进度条底色。
1471
- * @default 无
1472
1443
  */
1473
1444
  /** {en}
1474
1445
  * @brief The background color of the progress bar.
@@ -1476,7 +1447,6 @@ interface CommonStyle {
1476
1447
  progressColor?: string;
1477
1448
  /** {zh}
1478
1449
  * @brief 播放完成部分进度条底色。
1479
- * @default 无
1480
1450
  */
1481
1451
  /** {en}
1482
1452
  * @brief The background color of the progress bar for the completed portion of video playback.
@@ -1484,7 +1454,6 @@ interface CommonStyle {
1484
1454
  playedColor?: string;
1485
1455
  /** {zh}
1486
1456
  * @brief 缓存部分进度条底色。
1487
- * @default 无
1488
1457
  */
1489
1458
  /** {en}
1490
1459
  * @brief
@@ -1493,7 +1462,6 @@ interface CommonStyle {
1493
1462
  cachedColor?: string;
1494
1463
  /** {zh}
1495
1464
  * @brief 进度条滑块样式。
1496
- * @default 无
1497
1465
  */
1498
1466
  /** {en}
1499
1467
  * @brief The style of the progress bar slider.
@@ -1504,7 +1472,6 @@ interface CommonStyle {
1504
1472
  };
1505
1473
  /** {zh}
1506
1474
  * @brief 音量颜色。
1507
- * @default 无
1508
1475
  */
1509
1476
  /** {en}
1510
1477
  * @brief The color of the volume slider.
@@ -1643,7 +1610,7 @@ declare class VePlayerBase {
1643
1610
  */
1644
1611
  get played(): TimeRanges;
1645
1612
  /** {zh}
1646
- * @brief 设置/获取视频当前的播放时间, 单位为 s。
1613
+ * @brief 设置/获取视频当前的播放时间,单位为 s。
1647
1614
  */
1648
1615
  /** {en}
1649
1616
  * @brief Sets or gets the current playback position of the video, in seconds.
@@ -1844,7 +1811,6 @@ declare class VePlayerBase {
1844
1811
  switch(target: string | {
1845
1812
  /** {zh}
1846
1813
  * @brief 清晰度的唯一标识。
1847
- * @default 无
1848
1814
  */
1849
1815
  /** {en}
1850
1816
  * @brief The resolution ID.
@@ -1852,7 +1818,6 @@ declare class VePlayerBase {
1852
1818
  definition?: string;
1853
1819
  /** {zh}
1854
1820
  * @brief 线路的唯一标识。
1855
- * @default 无
1856
1821
  */
1857
1822
  /** {en}
1858
1823
  * @brief The playback source ID.
@@ -1892,8 +1857,6 @@ declare class VePlayerBase {
1892
1857
  updatePlaylist(playlist: ExposedSource[] | string, target?: string | {
1893
1858
  /** {zh}
1894
1859
  * @brief 清晰度唯一标识。
1895
- * @default 无
1896
- *
1897
1860
  */
1898
1861
  /** {en}
1899
1862
  * @brief The resolution ID.
@@ -1902,8 +1865,6 @@ declare class VePlayerBase {
1902
1865
  definition?: string;
1903
1866
  /** {zh}
1904
1867
  * @brief 线路的唯一标识。
1905
- * @default 无
1906
- *
1907
1868
  */
1908
1869
  /** {en}
1909
1870
  * @brief The playback resource ID.
@@ -2104,7 +2065,6 @@ declare class VePlayerBase {
2104
2065
  Function | {
2105
2066
  /** {zh}
2106
2067
  * @brief 插件构造函数。
2107
- * @default 无
2108
2068
  */
2109
2069
  /** {en}
2110
2070
  * @brief The plugin constructor.
@@ -2113,7 +2073,6 @@ declare class VePlayerBase {
2113
2073
  plugin: Function;
2114
2074
  /** {zh}
2115
2075
  * @brief 插件配置参数。
2116
- * @default 无
2117
2076
  */
2118
2077
  /** {en}
2119
2078
  * @brief The plugin configurations.
@@ -2409,7 +2368,6 @@ declare namespace strategy {
2409
2368
  interface ExposedDefinition {
2410
2369
  /** {zh}
2411
2370
  * @brief 播放地址。
2412
- * @default 无
2413
2371
  */
2414
2372
  /** {en}
2415
2373
  * @brief The playback address.
@@ -2417,8 +2375,6 @@ declare namespace strategy {
2417
2375
  url: string;
2418
2376
  /** {zh}
2419
2377
  * @brief 清晰度标识(唯一值)。
2420
- * @default 无
2421
- *
2422
2378
  */
2423
2379
  /** {en}
2424
2380
  * @brief The resolution ID. This value must be unique.
@@ -2427,7 +2383,6 @@ declare namespace strategy {
2427
2383
  definition: string;
2428
2384
  /** {zh}
2429
2385
  * @brief 清晰度展示名称。可设置多语言 `{text: {'zh-cn': '高清', 'en': 'HD'}}`。
2430
- * @default 无
2431
2386
  */
2432
2387
  /** {en}
2433
2388
  * @brief The display name of the resolution. Multiple languages are supported, such as `{text: {'zh-cn': '高清', 'en': 'HD'}}`.
@@ -2435,8 +2390,6 @@ declare namespace strategy {
2435
2390
  text?: Record<Lang, string> | string;
2436
2391
  /** {zh}
2437
2392
  * @brief 为当前清晰度地址设置备路拉流地址,支持设置多个备路拉流地址。当前清晰度地址拉流失败时,会在当前清晰度地址和备路直播地址之间循环拉流,直到拉流成功。
2438
- * @default 无
2439
- *
2440
2393
  */
2441
2394
  /** {en}
2442
2395
  * @brief The backup pull stream address for the current resolution. You can set multiple backup addresses. When the player fails to pull a stream from the current address, it will loop between the current and the backup addresses until it successfully pulls a stream.
@@ -2459,7 +2412,6 @@ declare namespace strategy {
2459
2412
  interface ExposedSource {
2460
2413
  /** {zh}
2461
2414
  * @brief 线路标识(唯一值)。
2462
- * @default 无
2463
2415
  */
2464
2416
  /** {en}
2465
2417
  * @brief The playback source ID. This value must be unique.
@@ -2467,8 +2419,6 @@ declare namespace strategy {
2467
2419
  name?: string;
2468
2420
  /** {zh}
2469
2421
  * @brief 线路展示名称。可设置多语言 `{text: {'zh-cn': '线路一', 'en': 'LineOne'}}`。
2470
- * @default 无
2471
- *
2472
2422
  */
2473
2423
  /** {en}
2474
2424
  * @brief The display name of the live stream source. Multiple languages are supported. For example, you set it to `{text: {'zh-cn': '线路一', 'en': 'LineOne'}}`.
@@ -2477,8 +2427,6 @@ declare namespace strategy {
2477
2427
  text?: Record<Lang, string> | string;
2478
2428
  /** {zh}
2479
2429
  * @brief 该线路下清晰度列表。
2480
- * @default 无
2481
- *
2482
2430
  */
2483
2431
  /** {en}
2484
2432
  * @brief A list of resolutions of the current source.
@@ -2685,25 +2633,24 @@ declare namespace strategy {
2685
2633
  */
2686
2634
  enum Level {
2687
2635
  /** {zh}
2688
- * @brief 严重。
2636
+ * @brief 发生严重错误,可能由于 CDN 拉取失败或 DRM 权限验证未通过,导致无法播放。
2689
2637
  */
2690
2638
  /** {en}
2691
- * @brief Fatal.
2692
- *
2639
+ * @brief A critical error occurs, typically due to CDN fetching failure or DRM permission verification failure, resulting in playback inability.
2693
2640
  */
2694
2641
  Fatal = "Fatal",
2695
2642
  /** {zh}
2696
- * @brief 报错。
2643
+ * @brief 流异常或处于离线状态,致使播放失败。
2697
2644
  */
2698
2645
  /** {en}
2699
- * @brief Error.
2646
+ * @brief A stream anomaly or offline state causes playback to fail.
2700
2647
  */
2701
2648
  Error = "Error",
2702
2649
  /** {zh}
2703
- * @brief 提示。
2650
+ * @brief 出现警告信息,通常由日志配置错误或缺少 RTM 降级地址引起。
2704
2651
  */
2705
2652
  /** {en}
2706
- * @brief Warn.
2653
+ * @brief A warning is issued, usually due to incorrect log configuration or a missing RTM fallback address.
2707
2654
  */
2708
2655
  Warn = "Warn"
2709
2656
  }
@@ -3160,7 +3107,6 @@ declare namespace strategy {
3160
3107
  showRefresh?: boolean;
3161
3108
  /** {zh}
3162
3109
  * @brief 自定义报错显示。
3163
- * @default 无
3164
3110
  */
3165
3111
  /** {en}
3166
3112
  * @brief Custom error message.
@@ -3169,7 +3115,6 @@ declare namespace strategy {
3169
3115
  errorTipsText?: string | Record<Lang, string>;
3170
3116
  /** {zh}
3171
3117
  * @brief 更多提示信息。
3172
- * @default 无
3173
3118
  */
3174
3119
  /** {en}
3175
3120
  * @brief More tips.
@@ -3329,7 +3274,6 @@ declare namespace strategy {
3329
3274
  id?: string;
3330
3275
  /** {zh}
3331
3276
  * @brief 指定播放器容器元素,VePlayer 将被插入在该容器中。id 和 el 需至少传入 1 个。如果同时传入,则优先将播放器插入 id 容器中。
3332
- * @default 无
3333
3277
  */
3334
3278
  /** {en}
3335
3279
  * @brief The container element of the player. You should specify either `id` or `el`, or both. If both are specified, the `VePlayer` object will be inserted in the container specified by `id`.
@@ -3355,7 +3299,6 @@ declare namespace strategy {
3355
3299
  height?: number | string;
3356
3300
  /** {zh}
3357
3301
  * @brief 为播放器配置直播拉流地址。您可手动拼接或使用地址生成器生成拉流地址,生成方法请参见[生成直播地址](https://www.volcengine.com/docs/6469/107759)。url 和 playList 需至少传入 1 个。
3358
- * @default 无
3359
3302
  */
3360
3303
  /** {en}
3361
3304
  * @brief The pull stream address. You can manually construct the address or use the address generator to generate one. To see how to generate an address, refer to [Generate live-stream addresses](https://docs.byteplus.com/en/byteplus-media-live/docs/generating-live-stream-addresses). You should specify either `url` or `playList`, or both.
@@ -3363,7 +3306,6 @@ declare namespace strategy {
3363
3306
  url?: string;
3364
3307
  /** {zh}
3365
3308
  * @brief 为播放器配置直播拉流地址列表。url 和 playlist 需至少传入 1 个。
3366
- * @default 无
3367
3309
  */
3368
3310
  /** {en}
3369
3311
  * @brief A list of live stream sources for the player. You should specify either `url` or `playList`, or both.
@@ -3371,7 +3313,6 @@ declare namespace strategy {
3371
3313
  playlist?: ExposedSource[];
3372
3314
  /** {zh}
3373
3315
  * @brief 当存在多个直播线路时,为播放器设置默认直播线路,不传则默认列表第一个。
3374
- * @default 无
3375
3316
  */
3376
3317
  /** {en}
3377
3318
  * @brief The default pull stream address for the player when there are multiple addresses available. If this parameter is not specified, the first address in the playlist will become the default address.
@@ -3379,7 +3320,6 @@ declare namespace strategy {
3379
3320
  defaultSource?: string;
3380
3321
  /** {zh}
3381
3322
  * @brief 为播放器设置默认直播清晰度,不传则默认列表第一个。
3382
- * @default 无
3383
3323
  */
3384
3324
  /** {en}
3385
3325
  * @brief The default resolution for the player when there are multiple resolutions available. If this parameter is not specified, the first resolution in the list will become the default resolution.
@@ -3387,7 +3327,6 @@ declare namespace strategy {
3387
3327
  defaultDefinition?: string;
3388
3328
  /** {zh}
3389
3329
  * @brief 为播放器设置备路拉流地址,支持设置多个备路拉流地址,在 `maxFallbackRound` 大于 `0` 时有效。当您使用配置的直播拉流地址拉流失败时,会在直播地址和备路直播地址之间循环拉流,直到拉流成功。
3390
- * @default 无
3391
3330
  */
3392
3331
  /** {en}
3393
3332
  * @brief The backup pull stream address(es) for the player. You can enter multiple backup addresses. If `maxFallbackRound` is greater than `0`, when an error occurs in the main address, the player automatically switches to the backup address.
@@ -3441,7 +3380,6 @@ declare namespace strategy {
3441
3380
  degradation?: Degradation | boolean;
3442
3381
  /** {zh}
3443
3382
  * @brief 为播放器设置封面图 URL。
3444
- * @default 无
3445
3383
  */
3446
3384
  /** {en}
3447
3385
  * @brief The URL of the player's cover image.
@@ -3457,7 +3395,6 @@ declare namespace strategy {
3457
3395
  /** {zh}
3458
3396
  * @brief 为播放器设置自定义的多语言词典,可设置每个语种的词典,格式为 { texts: { [key: string]: Object; } }。
3459
3397
  * 例如,{ texts: { 'zh-cn': { PIP: '画中画' }, en: { PIP: 'pip' } }} ,格式请参考[默认词典](https://www.volcengine.com/docs/6469/127529)。
3460
- * @default 无
3461
3398
  */
3462
3399
  /** {en}
3463
3400
  * @brief Configures a custom multilingual dictionary for the player. You can set the dictionary for each language in the format { texts: { [key: string]: Object; } }. For example, { texts: { 'zh-cn': { PIP: '画中画' }, en: { PIP: 'pip' } }}.
@@ -3467,7 +3404,7 @@ declare namespace strategy {
3467
3404
  texts: Record<Lang, Record<string, string>>;
3468
3405
  };
3469
3406
  /** {zh}
3470
- * @brief 为播放器设置是否自动播放, `muted` 设置为 `true` 为静音自动播放。
3407
+ * @brief 为播放器设置是否自动播放,`muted` 设置为 `true` 为静音自动播放。
3471
3408
  * @default { muted: true }
3472
3409
  * @type {{ muted: boolean } | boolean}
3473
3410
  */
@@ -3573,7 +3510,6 @@ declare namespace strategy {
3573
3510
  playsinline?: boolean;
3574
3511
  /** {zh}
3575
3512
  * @brief 为播放器设置 video 标签扩展属性,初始化时会设置在 videoElement 或 audioElement 对象上,请参考 [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#properties) 查看其支持的属性配置。
3576
- * @default 无
3577
3513
  */
3578
3514
  /** {en}
3579
3515
  * @brief Additional properties for the `video` element that will be applied when the `videoElement` or `audioElement` objects are initialized. Refer to [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#properties) for supported properties.
@@ -3651,7 +3587,6 @@ declare namespace strategy {
3651
3587
  marginControls?: boolean;
3652
3588
  /** {zh}
3653
3589
  * @brief 启用微信同层播放。
3654
- * @default 无
3655
3590
  */
3656
3591
  /** {en}
3657
3592
  * @brief Enable playing the video on the same player as WeChat.
@@ -3661,7 +3596,6 @@ declare namespace strategy {
3661
3596
  * @brief 是否启用微信全屏播放模式。
3662
3597
  * - `true`:启用
3663
3598
  * - `false`:停用
3664
- * @default 无
3665
3599
  */
3666
3600
  /** {en}
3667
3601
  * @brief Whether to enable full-screen playback in WeChat.
@@ -3674,7 +3608,6 @@ declare namespace strategy {
3674
3608
  * - `landscape`:横屏
3675
3609
  * - `portrait`:竖屏
3676
3610
  * - `landscape|portrait`:跟随手机自动旋转
3677
- * @default 无
3678
3611
  */
3679
3612
  /** {en}
3680
3613
  * @brief The orientation of the video when played on WeChat. The following values are supported:
@@ -3685,7 +3618,6 @@ declare namespace strategy {
3685
3618
  "x5-video-orientation"?: "landscape" | "portrait" | "landscape|portrait";
3686
3619
  /** {zh}
3687
3620
  * @brief 为播放器配置关键点样式。
3688
- * @default 无
3689
3621
  * @hidden 直播目前没用到
3690
3622
  */
3691
3623
  /** {en}
@@ -3695,7 +3627,6 @@ declare namespace strategy {
3695
3627
  commonStyle?: CommonStyle;
3696
3628
  /** {zh}
3697
3629
  * @brief 自定义插件列表。
3698
- * @default 无
3699
3630
  */
3700
3631
  /** {en}
3701
3632
  * @brief A list of custom plugins.
@@ -3738,10 +3669,10 @@ declare namespace strategy {
3738
3669
  */
3739
3670
  closeVideoDblclick?: boolean;
3740
3671
  /** {zh}
3741
- * @brief 支持传入 video dom,常应用于多播放器复用同一 video 场景。
3672
+ * @brief 支持传入 `video` DOM 元素,适用于多个播放器共享同一视频场景。
3742
3673
  */
3743
3674
  /** {en}
3744
- * @brief Supports passing in video DOM, commonly used for reusing the same video scene across multiple players.
3675
+ * @brief Supports passing in a `video` DOM element, suitable for scenarios where multiple players share the same video.
3745
3676
  */
3746
3677
  mediaElement?: HTMLVideoElement | null;
3747
3678
  }
@@ -3810,7 +3741,6 @@ declare namespace strategy {
3810
3741
  interface CommonStyle {
3811
3742
  /** {zh}
3812
3743
  * @brief 进度条底色。
3813
- * @default 无
3814
3744
  */
3815
3745
  /** {en}
3816
3746
  * @brief The background color of the progress bar.
@@ -3818,7 +3748,6 @@ declare namespace strategy {
3818
3748
  progressColor?: string;
3819
3749
  /** {zh}
3820
3750
  * @brief 播放完成部分进度条底色。
3821
- * @default 无
3822
3751
  */
3823
3752
  /** {en}
3824
3753
  * @brief The background color of the progress bar for the completed portion of video playback.
@@ -3826,7 +3755,6 @@ declare namespace strategy {
3826
3755
  playedColor?: string;
3827
3756
  /** {zh}
3828
3757
  * @brief 缓存部分进度条底色。
3829
- * @default 无
3830
3758
  */
3831
3759
  /** {en}
3832
3760
  * @brief
@@ -3835,7 +3763,6 @@ declare namespace strategy {
3835
3763
  cachedColor?: string;
3836
3764
  /** {zh}
3837
3765
  * @brief 进度条滑块样式。
3838
- * @default 无
3839
3766
  */
3840
3767
  /** {en}
3841
3768
  * @brief The style of the progress bar slider.
@@ -3846,7 +3773,6 @@ declare namespace strategy {
3846
3773
  };
3847
3774
  /** {zh}
3848
3775
  * @brief 音量颜色。
3849
- * @default 无
3850
3776
  */
3851
3777
  /** {en}
3852
3778
  * @brief The color of the volume slider.
@@ -4196,25 +4122,24 @@ declare namespace error {
4196
4122
  */
4197
4123
  enum Level {
4198
4124
  /** {zh}
4199
- * @brief 严重。
4125
+ * @brief 发生严重错误,可能由于 CDN 拉取失败或 DRM 权限验证未通过,导致无法播放。
4200
4126
  */
4201
4127
  /** {en}
4202
- * @brief Fatal.
4203
- *
4128
+ * @brief A critical error occurs, typically due to CDN fetching failure or DRM permission verification failure, resulting in playback inability.
4204
4129
  */
4205
4130
  Fatal = "Fatal",
4206
4131
  /** {zh}
4207
- * @brief 报错。
4132
+ * @brief 流异常或处于离线状态,致使播放失败。
4208
4133
  */
4209
4134
  /** {en}
4210
- * @brief Error.
4135
+ * @brief A stream anomaly or offline state causes playback to fail.
4211
4136
  */
4212
4137
  Error = "Error",
4213
4138
  /** {zh}
4214
- * @brief 提示。
4139
+ * @brief 出现警告信息,通常由日志配置错误或缺少 RTM 降级地址引起。
4215
4140
  */
4216
4141
  /** {en}
4217
- * @brief Warn.
4142
+ * @brief A warning is issued, usually due to incorrect log configuration or a missing RTM fallback address.
4218
4143
  */
4219
4144
  Warn = "Warn"
4220
4145
  }
@@ -6,7 +6,8 @@
6
6
  z-index: 8;
7
7
  display: none;
8
8
  box-sizing: border-box;
9
- width: 165px;
9
+ width: fit-content;
10
+ max-width: 40%;
10
11
  height: 100%;
11
12
  padding: 10px;
12
13
  overflow-y: scroll;