@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
@@ -199,7 +199,6 @@ declare class Definition implements XGDefinition {
199
199
  interface ExposedDefinition {
200
200
  /** {zh}
201
201
  * @brief 播放地址。
202
- * @default 无
203
202
  */
204
203
  /** {en}
205
204
  * @brief The playback address.
@@ -207,8 +206,6 @@ interface ExposedDefinition {
207
206
  url: string;
208
207
  /** {zh}
209
208
  * @brief 清晰度标识(唯一值)。
210
- * @default 无
211
- *
212
209
  */
213
210
  /** {en}
214
211
  * @brief The resolution ID. This value must be unique.
@@ -217,7 +214,6 @@ interface ExposedDefinition {
217
214
  definition: string;
218
215
  /** {zh}
219
216
  * @brief 清晰度展示名称。可设置多语言 `{text: {'zh-cn': '高清', 'en': 'HD'}}`。
220
- * @default 无
221
217
  */
222
218
  /** {en}
223
219
  * @brief The display name of the resolution. Multiple languages are supported, such as `{text: {'zh-cn': '高清', 'en': 'HD'}}`.
@@ -225,8 +221,6 @@ interface ExposedDefinition {
225
221
  text?: Record<Lang, string> | string;
226
222
  /** {zh}
227
223
  * @brief 为当前清晰度地址设置备路拉流地址,支持设置多个备路拉流地址。当前清晰度地址拉流失败时,会在当前清晰度地址和备路直播地址之间循环拉流,直到拉流成功。
228
- * @default 无
229
- *
230
224
  */
231
225
  /** {en}
232
226
  * @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.
@@ -249,7 +243,6 @@ interface ExposedDefinition {
249
243
  interface ExposedSource {
250
244
  /** {zh}
251
245
  * @brief 线路标识(唯一值)。
252
- * @default 无
253
246
  */
254
247
  /** {en}
255
248
  * @brief The playback source ID. This value must be unique.
@@ -257,8 +250,6 @@ interface ExposedSource {
257
250
  name?: string;
258
251
  /** {zh}
259
252
  * @brief 线路展示名称。可设置多语言 `{text: {'zh-cn': '线路一', 'en': 'LineOne'}}`。
260
- * @default 无
261
- *
262
253
  */
263
254
  /** {en}
264
255
  * @brief The display name of the live stream source. Multiple languages are supported. For example, you set it to `{text: {'zh-cn': '线路一', 'en': 'LineOne'}}`.
@@ -267,8 +258,6 @@ interface ExposedSource {
267
258
  text?: Record<Lang, string> | string;
268
259
  /** {zh}
269
260
  * @brief 该线路下清晰度列表。
270
- * @default 无
271
- *
272
261
  */
273
262
  /** {en}
274
263
  * @brief A list of resolutions of the current source.
@@ -478,25 +467,24 @@ declare class OptionsIcon extends Plugin {
478
467
  */
479
468
  declare enum Level {
480
469
  /** {zh}
481
- * @brief 严重。
470
+ * @brief 发生严重错误,可能由于 CDN 拉取失败或 DRM 权限验证未通过,导致无法播放。
482
471
  */
483
472
  /** {en}
484
- * @brief Fatal.
485
- *
473
+ * @brief A critical error occurs, typically due to CDN fetching failure or DRM permission verification failure, resulting in playback inability.
486
474
  */
487
475
  Fatal = "Fatal",
488
476
  /** {zh}
489
- * @brief 报错。
477
+ * @brief 流异常或处于离线状态,致使播放失败。
490
478
  */
491
479
  /** {en}
492
- * @brief Error.
480
+ * @brief A stream anomaly or offline state causes playback to fail.
493
481
  */
494
482
  Error = "Error",
495
483
  /** {zh}
496
- * @brief 提示。
484
+ * @brief 出现警告信息,通常由日志配置错误或缺少 RTM 降级地址引起。
497
485
  */
498
486
  /** {en}
499
- * @brief Warn.
487
+ * @brief A warning is issued, usually due to incorrect log configuration or a missing RTM fallback address.
500
488
  */
501
489
  Warn = "Warn"
502
490
  }
@@ -949,7 +937,6 @@ type ErrorConfig = {
949
937
  showRefresh?: boolean;
950
938
  /** {zh}
951
939
  * @brief 自定义报错显示。
952
- * @default 无
953
940
  */
954
941
  /** {en}
955
942
  * @brief Custom error message.
@@ -958,7 +945,6 @@ type ErrorConfig = {
958
945
  errorTipsText?: string | Record<Lang, string>;
959
946
  /** {zh}
960
947
  * @brief 更多提示信息。
961
- * @default 无
962
948
  */
963
949
  /** {en}
964
950
  * @brief More tips.
@@ -1118,7 +1104,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1118
1104
  id?: string;
1119
1105
  /** {zh}
1120
1106
  * @brief 指定播放器容器元素,VePlayer 将被插入在该容器中。id 和 el 需至少传入 1 个。如果同时传入,则优先将播放器插入 id 容器中。
1121
- * @default 无
1122
1107
  */
1123
1108
  /** {en}
1124
1109
  * @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`.
@@ -1144,7 +1129,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1144
1129
  height?: number | string;
1145
1130
  /** {zh}
1146
1131
  * @brief 为播放器配置直播拉流地址。您可手动拼接或使用地址生成器生成拉流地址,生成方法请参见[生成直播地址](https://www.volcengine.com/docs/6469/107759)。url 和 playList 需至少传入 1 个。
1147
- * @default 无
1148
1132
  */
1149
1133
  /** {en}
1150
1134
  * @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.
@@ -1152,7 +1136,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1152
1136
  url?: string;
1153
1137
  /** {zh}
1154
1138
  * @brief 为播放器配置直播拉流地址列表。url 和 playlist 需至少传入 1 个。
1155
- * @default 无
1156
1139
  */
1157
1140
  /** {en}
1158
1141
  * @brief A list of live stream sources for the player. You should specify either `url` or `playList`, or both.
@@ -1160,7 +1143,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1160
1143
  playlist?: ExposedSource[];
1161
1144
  /** {zh}
1162
1145
  * @brief 当存在多个直播线路时,为播放器设置默认直播线路,不传则默认列表第一个。
1163
- * @default 无
1164
1146
  */
1165
1147
  /** {en}
1166
1148
  * @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.
@@ -1168,7 +1150,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1168
1150
  defaultSource?: string;
1169
1151
  /** {zh}
1170
1152
  * @brief 为播放器设置默认直播清晰度,不传则默认列表第一个。
1171
- * @default 无
1172
1153
  */
1173
1154
  /** {en}
1174
1155
  * @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.
@@ -1176,7 +1157,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1176
1157
  defaultDefinition?: string;
1177
1158
  /** {zh}
1178
1159
  * @brief 为播放器设置备路拉流地址,支持设置多个备路拉流地址,在 `maxFallbackRound` 大于 `0` 时有效。当您使用配置的直播拉流地址拉流失败时,会在直播地址和备路直播地址之间循环拉流,直到拉流成功。
1179
- * @default 无
1180
1160
  */
1181
1161
  /** {en}
1182
1162
  * @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.
@@ -1230,7 +1210,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1230
1210
  degradation?: Degradation | boolean;
1231
1211
  /** {zh}
1232
1212
  * @brief 为播放器设置封面图 URL。
1233
- * @default 无
1234
1213
  */
1235
1214
  /** {en}
1236
1215
  * @brief The URL of the player's cover image.
@@ -1246,7 +1225,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1246
1225
  /** {zh}
1247
1226
  * @brief 为播放器设置自定义的多语言词典,可设置每个语种的词典,格式为 { texts: { [key: string]: Object; } }。
1248
1227
  * 例如,{ texts: { 'zh-cn': { PIP: '画中画' }, en: { PIP: 'pip' } }} ,格式请参考[默认词典](https://www.volcengine.com/docs/6469/127529)。
1249
- * @default 无
1250
1228
  */
1251
1229
  /** {en}
1252
1230
  * @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' } }}.
@@ -1256,7 +1234,7 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1256
1234
  texts: Record<Lang, Record<string, string>>;
1257
1235
  };
1258
1236
  /** {zh}
1259
- * @brief 为播放器设置是否自动播放, `muted` 设置为 `true` 为静音自动播放。
1237
+ * @brief 为播放器设置是否自动播放,`muted` 设置为 `true` 为静音自动播放。
1260
1238
  * @default { muted: true }
1261
1239
  * @type {{ muted: boolean } | boolean}
1262
1240
  */
@@ -1362,7 +1340,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1362
1340
  playsinline?: boolean;
1363
1341
  /** {zh}
1364
1342
  * @brief 为播放器设置 video 标签扩展属性,初始化时会设置在 videoElement 或 audioElement 对象上,请参考 [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#properties) 查看其支持的属性配置。
1365
- * @default 无
1366
1343
  */
1367
1344
  /** {en}
1368
1345
  * @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.
@@ -1440,7 +1417,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1440
1417
  marginControls?: boolean;
1441
1418
  /** {zh}
1442
1419
  * @brief 启用微信同层播放。
1443
- * @default 无
1444
1420
  */
1445
1421
  /** {en}
1446
1422
  * @brief Enable playing the video on the same player as WeChat.
@@ -1450,7 +1426,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1450
1426
  * @brief 是否启用微信全屏播放模式。
1451
1427
  * - `true`:启用
1452
1428
  * - `false`:停用
1453
- * @default 无
1454
1429
  */
1455
1430
  /** {en}
1456
1431
  * @brief Whether to enable full-screen playback in WeChat.
@@ -1463,7 +1438,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1463
1438
  * - `landscape`:横屏
1464
1439
  * - `portrait`:竖屏
1465
1440
  * - `landscape|portrait`:跟随手机自动旋转
1466
- * @default 无
1467
1441
  */
1468
1442
  /** {en}
1469
1443
  * @brief The orientation of the video when played on WeChat. The following values are supported:
@@ -1474,7 +1448,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1474
1448
  "x5-video-orientation"?: "landscape" | "portrait" | "landscape|portrait";
1475
1449
  /** {zh}
1476
1450
  * @brief 为播放器配置关键点样式。
1477
- * @default 无
1478
1451
  * @hidden 直播目前没用到
1479
1452
  */
1480
1453
  /** {en}
@@ -1484,7 +1457,6 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1484
1457
  commonStyle?: CommonStyle;
1485
1458
  /** {zh}
1486
1459
  * @brief 自定义插件列表。
1487
- * @default 无
1488
1460
  */
1489
1461
  /** {en}
1490
1462
  * @brief A list of custom plugins.
@@ -1527,10 +1499,10 @@ interface VePlayerBaseOptions extends Omit<PlayerOptions, "autoplay" | "i18n"> {
1527
1499
  */
1528
1500
  closeVideoDblclick?: boolean;
1529
1501
  /** {zh}
1530
- * @brief 支持传入 video dom,常应用于多播放器复用同一 video 场景。
1502
+ * @brief 支持传入 `video` DOM 元素,适用于多个播放器共享同一视频场景。
1531
1503
  */
1532
1504
  /** {en}
1533
- * @brief Supports passing in video DOM, commonly used for reusing the same video scene across multiple players.
1505
+ * @brief Supports passing in a `video` DOM element, suitable for scenarios where multiple players share the same video.
1534
1506
  */
1535
1507
  mediaElement?: HTMLVideoElement | null;
1536
1508
  }
@@ -1599,7 +1571,6 @@ interface Fullscreen {
1599
1571
  interface CommonStyle {
1600
1572
  /** {zh}
1601
1573
  * @brief 进度条底色。
1602
- * @default 无
1603
1574
  */
1604
1575
  /** {en}
1605
1576
  * @brief The background color of the progress bar.
@@ -1607,7 +1578,6 @@ interface CommonStyle {
1607
1578
  progressColor?: string;
1608
1579
  /** {zh}
1609
1580
  * @brief 播放完成部分进度条底色。
1610
- * @default 无
1611
1581
  */
1612
1582
  /** {en}
1613
1583
  * @brief The background color of the progress bar for the completed portion of video playback.
@@ -1615,7 +1585,6 @@ interface CommonStyle {
1615
1585
  playedColor?: string;
1616
1586
  /** {zh}
1617
1587
  * @brief 缓存部分进度条底色。
1618
- * @default 无
1619
1588
  */
1620
1589
  /** {en}
1621
1590
  * @brief
@@ -1624,7 +1593,6 @@ interface CommonStyle {
1624
1593
  cachedColor?: string;
1625
1594
  /** {zh}
1626
1595
  * @brief 进度条滑块样式。
1627
- * @default 无
1628
1596
  */
1629
1597
  /** {en}
1630
1598
  * @brief The style of the progress bar slider.
@@ -1635,7 +1603,6 @@ interface CommonStyle {
1635
1603
  };
1636
1604
  /** {zh}
1637
1605
  * @brief 音量颜色。
1638
- * @default 无
1639
1606
  */
1640
1607
  /** {en}
1641
1608
  * @brief The color of the volume slider.
@@ -1811,7 +1778,7 @@ declare class VePlayerBase {
1811
1778
  */
1812
1779
  get played(): TimeRanges;
1813
1780
  /** {zh}
1814
- * @brief 设置/获取视频当前的播放时间, 单位为 s。
1781
+ * @brief 设置/获取视频当前的播放时间,单位为 s。
1815
1782
  */
1816
1783
  /** {en}
1817
1784
  * @brief Sets or gets the current playback position of the video, in seconds.
@@ -2012,7 +1979,6 @@ declare class VePlayerBase {
2012
1979
  switch(target: string | {
2013
1980
  /** {zh}
2014
1981
  * @brief 清晰度的唯一标识。
2015
- * @default 无
2016
1982
  */
2017
1983
  /** {en}
2018
1984
  * @brief The resolution ID.
@@ -2020,7 +1986,6 @@ declare class VePlayerBase {
2020
1986
  definition?: string;
2021
1987
  /** {zh}
2022
1988
  * @brief 线路的唯一标识。
2023
- * @default 无
2024
1989
  */
2025
1990
  /** {en}
2026
1991
  * @brief The playback source ID.
@@ -2060,8 +2025,6 @@ declare class VePlayerBase {
2060
2025
  updatePlaylist(playlist: ExposedSource[] | string, target?: string | {
2061
2026
  /** {zh}
2062
2027
  * @brief 清晰度唯一标识。
2063
- * @default 无
2064
- *
2065
2028
  */
2066
2029
  /** {en}
2067
2030
  * @brief The resolution ID.
@@ -2070,8 +2033,6 @@ declare class VePlayerBase {
2070
2033
  definition?: string;
2071
2034
  /** {zh}
2072
2035
  * @brief 线路的唯一标识。
2073
- * @default 无
2074
- *
2075
2036
  */
2076
2037
  /** {en}
2077
2038
  * @brief The playback resource ID.
@@ -2272,7 +2233,6 @@ declare class VePlayerBase {
2272
2233
  Function | {
2273
2234
  /** {zh}
2274
2235
  * @brief 插件构造函数。
2275
- * @default 无
2276
2236
  */
2277
2237
  /** {en}
2278
2238
  * @brief The plugin constructor.
@@ -2281,7 +2241,6 @@ declare class VePlayerBase {
2281
2241
  plugin: Function;
2282
2242
  /** {zh}
2283
2243
  * @brief 插件配置参数。
2284
- * @default 无
2285
2244
  */
2286
2245
  /** {en}
2287
2246
  * @brief The plugin configurations.
@@ -2582,7 +2541,6 @@ declare namespace strategy {
2582
2541
  interface ExposedDefinition {
2583
2542
  /** {zh}
2584
2543
  * @brief 播放地址。
2585
- * @default 无
2586
2544
  */
2587
2545
  /** {en}
2588
2546
  * @brief The playback address.
@@ -2590,8 +2548,6 @@ declare namespace strategy {
2590
2548
  url: string;
2591
2549
  /** {zh}
2592
2550
  * @brief 清晰度标识(唯一值)。
2593
- * @default 无
2594
- *
2595
2551
  */
2596
2552
  /** {en}
2597
2553
  * @brief The resolution ID. This value must be unique.
@@ -2600,7 +2556,6 @@ declare namespace strategy {
2600
2556
  definition: string;
2601
2557
  /** {zh}
2602
2558
  * @brief 清晰度展示名称。可设置多语言 `{text: {'zh-cn': '高清', 'en': 'HD'}}`。
2603
- * @default 无
2604
2559
  */
2605
2560
  /** {en}
2606
2561
  * @brief The display name of the resolution. Multiple languages are supported, such as `{text: {'zh-cn': '高清', 'en': 'HD'}}`.
@@ -2608,8 +2563,6 @@ declare namespace strategy {
2608
2563
  text?: Record<Lang, string> | string;
2609
2564
  /** {zh}
2610
2565
  * @brief 为当前清晰度地址设置备路拉流地址,支持设置多个备路拉流地址。当前清晰度地址拉流失败时,会在当前清晰度地址和备路直播地址之间循环拉流,直到拉流成功。
2611
- * @default 无
2612
- *
2613
2566
  */
2614
2567
  /** {en}
2615
2568
  * @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.
@@ -2632,7 +2585,6 @@ declare namespace strategy {
2632
2585
  interface ExposedSource {
2633
2586
  /** {zh}
2634
2587
  * @brief 线路标识(唯一值)。
2635
- * @default 无
2636
2588
  */
2637
2589
  /** {en}
2638
2590
  * @brief The playback source ID. This value must be unique.
@@ -2640,8 +2592,6 @@ declare namespace strategy {
2640
2592
  name?: string;
2641
2593
  /** {zh}
2642
2594
  * @brief 线路展示名称。可设置多语言 `{text: {'zh-cn': '线路一', 'en': 'LineOne'}}`。
2643
- * @default 无
2644
- *
2645
2595
  */
2646
2596
  /** {en}
2647
2597
  * @brief The display name of the live stream source. Multiple languages are supported. For example, you set it to `{text: {'zh-cn': '线路一', 'en': 'LineOne'}}`.
@@ -2650,8 +2600,6 @@ declare namespace strategy {
2650
2600
  text?: Record<Lang, string> | string;
2651
2601
  /** {zh}
2652
2602
  * @brief 该线路下清晰度列表。
2653
- * @default 无
2654
- *
2655
2603
  */
2656
2604
  /** {en}
2657
2605
  * @brief A list of resolutions of the current source.
@@ -2858,25 +2806,24 @@ declare namespace strategy {
2858
2806
  */
2859
2807
  enum Level {
2860
2808
  /** {zh}
2861
- * @brief 严重。
2809
+ * @brief 发生严重错误,可能由于 CDN 拉取失败或 DRM 权限验证未通过,导致无法播放。
2862
2810
  */
2863
2811
  /** {en}
2864
- * @brief Fatal.
2865
- *
2812
+ * @brief A critical error occurs, typically due to CDN fetching failure or DRM permission verification failure, resulting in playback inability.
2866
2813
  */
2867
2814
  Fatal = "Fatal",
2868
2815
  /** {zh}
2869
- * @brief 报错。
2816
+ * @brief 流异常或处于离线状态,致使播放失败。
2870
2817
  */
2871
2818
  /** {en}
2872
- * @brief Error.
2819
+ * @brief A stream anomaly or offline state causes playback to fail.
2873
2820
  */
2874
2821
  Error = "Error",
2875
2822
  /** {zh}
2876
- * @brief 提示。
2823
+ * @brief 出现警告信息,通常由日志配置错误或缺少 RTM 降级地址引起。
2877
2824
  */
2878
2825
  /** {en}
2879
- * @brief Warn.
2826
+ * @brief A warning is issued, usually due to incorrect log configuration or a missing RTM fallback address.
2880
2827
  */
2881
2828
  Warn = "Warn"
2882
2829
  }
@@ -3333,7 +3280,6 @@ declare namespace strategy {
3333
3280
  showRefresh?: boolean;
3334
3281
  /** {zh}
3335
3282
  * @brief 自定义报错显示。
3336
- * @default 无
3337
3283
  */
3338
3284
  /** {en}
3339
3285
  * @brief Custom error message.
@@ -3342,7 +3288,6 @@ declare namespace strategy {
3342
3288
  errorTipsText?: string | Record<Lang, string>;
3343
3289
  /** {zh}
3344
3290
  * @brief 更多提示信息。
3345
- * @default 无
3346
3291
  */
3347
3292
  /** {en}
3348
3293
  * @brief More tips.
@@ -3502,7 +3447,6 @@ declare namespace strategy {
3502
3447
  id?: string;
3503
3448
  /** {zh}
3504
3449
  * @brief 指定播放器容器元素,VePlayer 将被插入在该容器中。id 和 el 需至少传入 1 个。如果同时传入,则优先将播放器插入 id 容器中。
3505
- * @default 无
3506
3450
  */
3507
3451
  /** {en}
3508
3452
  * @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`.
@@ -3528,7 +3472,6 @@ declare namespace strategy {
3528
3472
  height?: number | string;
3529
3473
  /** {zh}
3530
3474
  * @brief 为播放器配置直播拉流地址。您可手动拼接或使用地址生成器生成拉流地址,生成方法请参见[生成直播地址](https://www.volcengine.com/docs/6469/107759)。url 和 playList 需至少传入 1 个。
3531
- * @default 无
3532
3475
  */
3533
3476
  /** {en}
3534
3477
  * @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.
@@ -3536,7 +3479,6 @@ declare namespace strategy {
3536
3479
  url?: string;
3537
3480
  /** {zh}
3538
3481
  * @brief 为播放器配置直播拉流地址列表。url 和 playlist 需至少传入 1 个。
3539
- * @default 无
3540
3482
  */
3541
3483
  /** {en}
3542
3484
  * @brief A list of live stream sources for the player. You should specify either `url` or `playList`, or both.
@@ -3544,7 +3486,6 @@ declare namespace strategy {
3544
3486
  playlist?: ExposedSource[];
3545
3487
  /** {zh}
3546
3488
  * @brief 当存在多个直播线路时,为播放器设置默认直播线路,不传则默认列表第一个。
3547
- * @default 无
3548
3489
  */
3549
3490
  /** {en}
3550
3491
  * @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.
@@ -3552,7 +3493,6 @@ declare namespace strategy {
3552
3493
  defaultSource?: string;
3553
3494
  /** {zh}
3554
3495
  * @brief 为播放器设置默认直播清晰度,不传则默认列表第一个。
3555
- * @default 无
3556
3496
  */
3557
3497
  /** {en}
3558
3498
  * @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.
@@ -3560,7 +3500,6 @@ declare namespace strategy {
3560
3500
  defaultDefinition?: string;
3561
3501
  /** {zh}
3562
3502
  * @brief 为播放器设置备路拉流地址,支持设置多个备路拉流地址,在 `maxFallbackRound` 大于 `0` 时有效。当您使用配置的直播拉流地址拉流失败时,会在直播地址和备路直播地址之间循环拉流,直到拉流成功。
3563
- * @default 无
3564
3503
  */
3565
3504
  /** {en}
3566
3505
  * @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.
@@ -3614,7 +3553,6 @@ declare namespace strategy {
3614
3553
  degradation?: Degradation | boolean;
3615
3554
  /** {zh}
3616
3555
  * @brief 为播放器设置封面图 URL。
3617
- * @default 无
3618
3556
  */
3619
3557
  /** {en}
3620
3558
  * @brief The URL of the player's cover image.
@@ -3630,7 +3568,6 @@ declare namespace strategy {
3630
3568
  /** {zh}
3631
3569
  * @brief 为播放器设置自定义的多语言词典,可设置每个语种的词典,格式为 { texts: { [key: string]: Object; } }。
3632
3570
  * 例如,{ texts: { 'zh-cn': { PIP: '画中画' }, en: { PIP: 'pip' } }} ,格式请参考[默认词典](https://www.volcengine.com/docs/6469/127529)。
3633
- * @default 无
3634
3571
  */
3635
3572
  /** {en}
3636
3573
  * @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' } }}.
@@ -3640,7 +3577,7 @@ declare namespace strategy {
3640
3577
  texts: Record<Lang, Record<string, string>>;
3641
3578
  };
3642
3579
  /** {zh}
3643
- * @brief 为播放器设置是否自动播放, `muted` 设置为 `true` 为静音自动播放。
3580
+ * @brief 为播放器设置是否自动播放,`muted` 设置为 `true` 为静音自动播放。
3644
3581
  * @default { muted: true }
3645
3582
  * @type {{ muted: boolean } | boolean}
3646
3583
  */
@@ -3746,7 +3683,6 @@ declare namespace strategy {
3746
3683
  playsinline?: boolean;
3747
3684
  /** {zh}
3748
3685
  * @brief 为播放器设置 video 标签扩展属性,初始化时会设置在 videoElement 或 audioElement 对象上,请参考 [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#properties) 查看其支持的属性配置。
3749
- * @default 无
3750
3686
  */
3751
3687
  /** {en}
3752
3688
  * @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.
@@ -3824,7 +3760,6 @@ declare namespace strategy {
3824
3760
  marginControls?: boolean;
3825
3761
  /** {zh}
3826
3762
  * @brief 启用微信同层播放。
3827
- * @default 无
3828
3763
  */
3829
3764
  /** {en}
3830
3765
  * @brief Enable playing the video on the same player as WeChat.
@@ -3834,7 +3769,6 @@ declare namespace strategy {
3834
3769
  * @brief 是否启用微信全屏播放模式。
3835
3770
  * - `true`:启用
3836
3771
  * - `false`:停用
3837
- * @default 无
3838
3772
  */
3839
3773
  /** {en}
3840
3774
  * @brief Whether to enable full-screen playback in WeChat.
@@ -3847,7 +3781,6 @@ declare namespace strategy {
3847
3781
  * - `landscape`:横屏
3848
3782
  * - `portrait`:竖屏
3849
3783
  * - `landscape|portrait`:跟随手机自动旋转
3850
- * @default 无
3851
3784
  */
3852
3785
  /** {en}
3853
3786
  * @brief The orientation of the video when played on WeChat. The following values are supported:
@@ -3858,7 +3791,6 @@ declare namespace strategy {
3858
3791
  "x5-video-orientation"?: "landscape" | "portrait" | "landscape|portrait";
3859
3792
  /** {zh}
3860
3793
  * @brief 为播放器配置关键点样式。
3861
- * @default 无
3862
3794
  * @hidden 直播目前没用到
3863
3795
  */
3864
3796
  /** {en}
@@ -3868,7 +3800,6 @@ declare namespace strategy {
3868
3800
  commonStyle?: CommonStyle;
3869
3801
  /** {zh}
3870
3802
  * @brief 自定义插件列表。
3871
- * @default 无
3872
3803
  */
3873
3804
  /** {en}
3874
3805
  * @brief A list of custom plugins.
@@ -3911,10 +3842,10 @@ declare namespace strategy {
3911
3842
  */
3912
3843
  closeVideoDblclick?: boolean;
3913
3844
  /** {zh}
3914
- * @brief 支持传入 video dom,常应用于多播放器复用同一 video 场景。
3845
+ * @brief 支持传入 `video` DOM 元素,适用于多个播放器共享同一视频场景。
3915
3846
  */
3916
3847
  /** {en}
3917
- * @brief Supports passing in video DOM, commonly used for reusing the same video scene across multiple players.
3848
+ * @brief Supports passing in a `video` DOM element, suitable for scenarios where multiple players share the same video.
3918
3849
  */
3919
3850
  mediaElement?: HTMLVideoElement | null;
3920
3851
  }
@@ -3983,7 +3914,6 @@ declare namespace strategy {
3983
3914
  interface CommonStyle {
3984
3915
  /** {zh}
3985
3916
  * @brief 进度条底色。
3986
- * @default 无
3987
3917
  */
3988
3918
  /** {en}
3989
3919
  * @brief The background color of the progress bar.
@@ -3991,7 +3921,6 @@ declare namespace strategy {
3991
3921
  progressColor?: string;
3992
3922
  /** {zh}
3993
3923
  * @brief 播放完成部分进度条底色。
3994
- * @default 无
3995
3924
  */
3996
3925
  /** {en}
3997
3926
  * @brief The background color of the progress bar for the completed portion of video playback.
@@ -3999,7 +3928,6 @@ declare namespace strategy {
3999
3928
  playedColor?: string;
4000
3929
  /** {zh}
4001
3930
  * @brief 缓存部分进度条底色。
4002
- * @default 无
4003
3931
  */
4004
3932
  /** {en}
4005
3933
  * @brief
@@ -4008,7 +3936,6 @@ declare namespace strategy {
4008
3936
  cachedColor?: string;
4009
3937
  /** {zh}
4010
3938
  * @brief 进度条滑块样式。
4011
- * @default 无
4012
3939
  */
4013
3940
  /** {en}
4014
3941
  * @brief The style of the progress bar slider.
@@ -4019,7 +3946,6 @@ declare namespace strategy {
4019
3946
  };
4020
3947
  /** {zh}
4021
3948
  * @brief 音量颜色。
4022
- * @default 无
4023
3949
  */
4024
3950
  /** {en}
4025
3951
  * @brief The color of the volume slider.
@@ -4521,25 +4447,24 @@ declare namespace error {
4521
4447
  */
4522
4448
  enum Level {
4523
4449
  /** {zh}
4524
- * @brief 严重。
4450
+ * @brief 发生严重错误,可能由于 CDN 拉取失败或 DRM 权限验证未通过,导致无法播放。
4525
4451
  */
4526
4452
  /** {en}
4527
- * @brief Fatal.
4528
- *
4453
+ * @brief A critical error occurs, typically due to CDN fetching failure or DRM permission verification failure, resulting in playback inability.
4529
4454
  */
4530
4455
  Fatal = "Fatal",
4531
4456
  /** {zh}
4532
- * @brief 报错。
4457
+ * @brief 流异常或处于离线状态,致使播放失败。
4533
4458
  */
4534
4459
  /** {en}
4535
- * @brief Error.
4460
+ * @brief A stream anomaly or offline state causes playback to fail.
4536
4461
  */
4537
4462
  Error = "Error",
4538
4463
  /** {zh}
4539
- * @brief 提示。
4464
+ * @brief 出现警告信息,通常由日志配置错误或缺少 RTM 降级地址引起。
4540
4465
  */
4541
4466
  /** {en}
4542
- * @brief Warn.
4467
+ * @brief A warning is issued, usually due to incorrect log configuration or a missing RTM fallback address.
4543
4468
  */
4544
4469
  Warn = "Warn"
4545
4470
  }
@@ -5272,7 +5197,6 @@ interface LoggerConfig {
5272
5197
  enable?: boolean;
5273
5198
  /** {zh}
5274
5199
  * @brief 应用 ID,登录[视频直播控制台 > SDK 管理](https://console.volcengine.com/live/main/sdk)查询。
5275
- * @default 无
5276
5200
  */
5277
5201
  /** {en}
5278
5202
  * @brief The SDK application ID. You can access it by logging in to the BytePlus MediaLive console and navigating to [SDK Management](https://console.byteplus.com/live/main/sdk).
@@ -5280,7 +5204,6 @@ interface LoggerConfig {
5280
5204
  appId?: string;
5281
5205
  /** {zh}
5282
5206
  * @brief 应用名称。
5283
- * @default 无
5284
5207
  */
5285
5208
  /** {en}
5286
5209
  * @brief The application name.
@@ -5290,7 +5213,6 @@ interface LoggerConfig {
5290
5213
  * @brief 用于识别单一用户的 ID,如不设置,会随机生成一个用户 ID 存在浏览器缓存中。
5291
5214
  * @listtip
5292
5215
  * 建议您使用与业务相关的用户 ID,以便在发生播放错误时快速定位排查问题。
5293
- * @default 无
5294
5216
  */
5295
5217
  /** {en}
5296
5218
  * @brief The ID used to identify a single user. If not set, a random user ID will be generated and stored in the browser cache.
@@ -5302,7 +5224,6 @@ interface LoggerConfig {
5302
5224
  * @brief 用于识别用户设备的 ID,如不设置,会随机生成一个用户 ID 存在浏览器缓存中。
5303
5225
  * @listtip
5304
5226
  * 建议您使用与业务相关的用户设备 ID,以便在发生播放错误时快速定位排查问题。
5305
- * @default 无
5306
5227
  */
5307
5228
  /** {en}
5308
5229
  * @brief The ID used to identify a user's device. If not set, a random device ID will be generated and stored in the browser cache.
@@ -5374,6 +5295,7 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
5374
5295
  */
5375
5296
  /** {en}
5376
5297
  * @brief Configurations for advertising
5298
+ * @hidden
5377
5299
  */
5378
5300
  ad?: AdConfig;
5379
5301
  /** {zh}
@@ -5392,15 +5314,13 @@ interface LiveVePlayerOptions extends VePlayerBaseOptions {
5392
5314
  logger?: LoggerConfig;
5393
5315
  /** {zh}
5394
5316
  * @brief 为播放器禁用内置插件列表,接入方法请参见[插件说明](https://www.volcengine.com/docs/6469/192826#禁用插件)。
5395
- * @default 无
5396
5317
  */
5397
5318
  /** {en}
5398
5319
  * @brief A list of built-in plug-ins to be disabled. For the access method, please refer to [Plugin descriptions](https://docs.byteplus.com/en/docs/byteplus-media-live/docs-d8idjfeza4#disabling-plugins).
5399
5320
  */
5400
5321
  ignores?: string[];
5401
5322
  /** {zh}
5402
- * @brief 为播放器替换插件图标,接入方法请参见[插件说明](https://www.volcengine.com/docs/6469/192826#替换插件图标)。
5403
- * @default 无
5323
+ * @brief 为播放器替换插件图标,接入方法请参见[插件说明](https://www.volcengine.com/docs/6469/192826)。
5404
5324
  */
5405
5325
  /** {en}
5406
5326
  * @brief The plug-in icon. For the access method, please refer to [Plugin descriptions](https://docs.byteplus.com/en/docs/byteplus-media-live/docs-d8idjfeza4#replacing-plugin-icons).
@@ -5644,6 +5564,7 @@ interface TimeShiftConfig {
5644
5564
  * @list option
5645
5565
  * @kind property
5646
5566
  * @brief Advertising schedule for a single ad break
5567
+ * @hidden
5647
5568
  */
5648
5569
  interface AdRule {
5649
5570
  /** {en}
@@ -5665,6 +5586,7 @@ interface AdRule {
5665
5586
  * @list option
5666
5587
  * @kind property
5667
5588
  * @brief Configurations for Google IMA SDK
5589
+ * @hidden
5668
5590
  */
5669
5591
  interface ImaConfig {
5670
5592
  /** {en}
@@ -5687,6 +5609,7 @@ interface ImaConfig {
5687
5609
  * @list option
5688
5610
  * @kind property
5689
5611
  * @brief Configurations for advertising
5612
+ * @hidden
5690
5613
  */
5691
5614
  interface AdConfig {
5692
5615
  /** {en}
@@ -5737,7 +5660,8 @@ interface Rtm {
5737
5660
  * @brief 配置 RTM 拉流失败降级地址,可配置 FLV 拉流地址或 HLS 的拉流地址。`enableFallback` 为 `true` 时生效。
5738
5661
  * - 指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,降级到 `fallbackUrl` 拉流地址。
5739
5662
  * - 未指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,根据当前 RTM 地址降级到对应的 FLV 或者 HLS 地址。
5740
- * @default
5663
+ * @listtip - v2.5.2 版本后未指定 `fallbackUrl` 且未开启自动转码的情况下,不会自动降级到 FLV 或者 HLS 地址。
5664
+ * - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM 拉流](https://www.volcengine.com/docs/6469/138655#rtm-%E6%8B%89%E6%B5%81)。
5741
5665
  */
5742
5666
  /** {en}
5743
5667
  * @brief The FLV or HLS addresses the player uses when failing to pull an RTM stream. This parameter takes effect when `enableFallback` is set to `true`.
@@ -5830,6 +5754,13 @@ interface Rtm {
5830
5754
  * @hidden
5831
5755
  */
5832
5756
  enableOriginSdpLogger?: boolean;
5757
+ /** {zh}
5758
+ * @brief RTM 协议缓冲区延迟,单位为秒。
5759
+ */
5760
+ /** {en}
5761
+ * @brief buffer delay to handle network jitter, in seconds。
5762
+ */
5763
+ delayHint?: number;
5833
5764
  }
5834
5765
  /** {zh}
5835
5766
  * @list option
@@ -5872,7 +5803,7 @@ interface Flv {
5872
5803
  * - `true`:开启;
5873
5804
  * - `false`:关闭
5874
5805
  * @default false
5875
- * @listtip 低延迟 FLV 拉流仅在 PC 端浏览器中生效。
5806
+ * @listtip v2.5.2 版本后支持 FLV H5 端低延迟拉流。
5876
5807
  */
5877
5808
  /** {en}
5878
5809
  * @brief Whether to enable low latency when playing an FLV address. For example, if you have enabled low latency, and set GOP to 2 seconds, the average latency will be around 2 seconds.
@@ -6043,7 +5974,7 @@ interface Hls {
6043
5974
  */
6044
5975
  interface RTMNetWorkInfo {
6045
5976
  /** {zh}
6046
- * @brief 最近一次网络评估周期内的下载速度, 单位为 bps。
5977
+ * @brief 最近一次网络评估周期内的下载速度,单位为 bps。
6047
5978
  */
6048
5979
  /** {en}
6049
5980
  * @brief The download speed within the latest network evaluation period, in units of bps.
@@ -6305,14 +6236,12 @@ interface StatsSnapShoot {
6305
6236
  /** {zh}
6306
6237
  * @list option
6307
6238
  * @kind property
6308
- * @brief FLV 直播流播放信息。
6309
6239
  */
6310
6240
  /** {en}
6311
6241
  * @list option
6312
6242
  * @kind property
6313
- * @brief FLV live stream information.
6314
6243
  */
6315
- interface FlvStats {
6244
+ interface Stats$0 {
6316
6245
  /** {zh}
6317
6246
  * @brief 音频格式。
6318
6247
  * @hidden
@@ -6414,33 +6343,45 @@ interface FlvStats {
6414
6343
  */
6415
6344
  samplerate: number;
6416
6345
  /** {zh}
6417
- * @brief 总共收到的字节数。
6346
+ * @hidden
6418
6347
  */
6419
6348
  /** {en}
6420
- * @brief The total number of bytes received.
6349
+ * @hidden
6421
6350
  */
6422
- totalReceivedByte: number;
6351
+ videoCodec: string;
6423
6352
  /** {zh}
6424
- * @brief 接收所有字节消耗时长。
6353
+ * @brief 视频宽度。
6425
6354
  */
6426
6355
  /** {en}
6427
- * @brief The time consumed for receiving all bytes.
6356
+ * @brief Video wight.
6428
6357
  */
6429
- totalReceivedCost: number;
6358
+ width: number;
6359
+ }
6360
+ /** {zh}
6361
+ * @list option
6362
+ * @kind property
6363
+ * @brief FLV 直播流播放信息。
6364
+ */
6365
+ /** {en}
6366
+ * @list option
6367
+ * @kind property
6368
+ * @brief FLV live stream information.
6369
+ */
6370
+ interface FlvStats extends Stats$0 {
6430
6371
  /** {zh}
6431
- * @hidden
6372
+ * @brief 总共收到的字节数。
6432
6373
  */
6433
6374
  /** {en}
6434
- * @hidden
6375
+ * @brief The total number of bytes received.
6435
6376
  */
6436
- videoCodec: string;
6377
+ totalReceivedByte: number;
6437
6378
  /** {zh}
6438
- * @brief 视频宽度。
6379
+ * @brief 接收所有字节消耗时长。
6439
6380
  */
6440
6381
  /** {en}
6441
- * @brief Video wight.
6382
+ * @brief The time consumed for receiving all bytes.
6442
6383
  */
6443
- width: number;
6384
+ totalReceivedCost: number;
6444
6385
  }
6445
6386
  /** {zh}
6446
6387
  * @detail api
@@ -6469,6 +6410,12 @@ declare class VePlayerLive extends VePlayerBase {
6469
6410
  * @brief Obtain the duration that has been played, excluding pause and waiting time, with the unit of seconds.
6470
6411
  */
6471
6412
  get playTime(): number;
6413
+ /** {en}
6414
+ * @hidden
6415
+ */
6416
+ /** {zh}
6417
+ * @hidden
6418
+ */
6472
6419
  get ad(): any;
6473
6420
  /** {zh}
6474
6421
  * @brief 调用此方法开启直播日志上报。
@@ -6576,6 +6523,14 @@ declare class VePlayerLive extends VePlayerBase {
6576
6523
  * @brief Obtain the playback information of FLV pull streaming.
6577
6524
  */
6578
6525
  getFLVStats(): FlvStats;
6526
+ /** {zh}
6527
+ * @brief 获取 HLS 拉流的播放信息。
6528
+ * @returns
6529
+ */
6530
+ /** {en}
6531
+ * @brief Obtain the playback information of HLS pull streaming.
6532
+ */
6533
+ getHLSStats(): Stats$0;
6579
6534
  }
6580
6535
  /** {zh}
6581
6536
  * @detail api
@@ -6823,25 +6778,24 @@ declare namespace live {
6823
6778
  */
6824
6779
  enum Level {
6825
6780
  /** {zh}
6826
- * @brief 严重。
6781
+ * @brief 发生严重错误,可能由于 CDN 拉取失败或 DRM 权限验证未通过,导致无法播放。
6827
6782
  */
6828
6783
  /** {en}
6829
- * @brief Fatal.
6830
- *
6784
+ * @brief A critical error occurs, typically due to CDN fetching failure or DRM permission verification failure, resulting in playback inability.
6831
6785
  */
6832
6786
  Fatal = "Fatal",
6833
6787
  /** {zh}
6834
- * @brief 报错。
6788
+ * @brief 流异常或处于离线状态,致使播放失败。
6835
6789
  */
6836
6790
  /** {en}
6837
- * @brief Error.
6791
+ * @brief A stream anomaly or offline state causes playback to fail.
6838
6792
  */
6839
6793
  Error = "Error",
6840
6794
  /** {zh}
6841
- * @brief 提示。
6795
+ * @brief 出现警告信息,通常由日志配置错误或缺少 RTM 降级地址引起。
6842
6796
  */
6843
6797
  /** {en}
6844
- * @brief Warn.
6798
+ * @brief A warning is issued, usually due to incorrect log configuration or a missing RTM fallback address.
6845
6799
  */
6846
6800
  Warn = "Warn"
6847
6801
  }
@@ -7300,7 +7254,6 @@ declare namespace live {
7300
7254
  interface ExposedDefinition {
7301
7255
  /** {zh}
7302
7256
  * @brief 播放地址。
7303
- * @default 无
7304
7257
  */
7305
7258
  /** {en}
7306
7259
  * @brief The playback address.
@@ -7308,8 +7261,6 @@ declare namespace live {
7308
7261
  url: string;
7309
7262
  /** {zh}
7310
7263
  * @brief 清晰度标识(唯一值)。
7311
- * @default 无
7312
- *
7313
7264
  */
7314
7265
  /** {en}
7315
7266
  * @brief The resolution ID. This value must be unique.
@@ -7318,7 +7269,6 @@ declare namespace live {
7318
7269
  definition: string;
7319
7270
  /** {zh}
7320
7271
  * @brief 清晰度展示名称。可设置多语言 `{text: {'zh-cn': '高清', 'en': 'HD'}}`。
7321
- * @default 无
7322
7272
  */
7323
7273
  /** {en}
7324
7274
  * @brief The display name of the resolution. Multiple languages are supported, such as `{text: {'zh-cn': '高清', 'en': 'HD'}}`.
@@ -7326,8 +7276,6 @@ declare namespace live {
7326
7276
  text?: Record<Lang, string> | string;
7327
7277
  /** {zh}
7328
7278
  * @brief 为当前清晰度地址设置备路拉流地址,支持设置多个备路拉流地址。当前清晰度地址拉流失败时,会在当前清晰度地址和备路直播地址之间循环拉流,直到拉流成功。
7329
- * @default 无
7330
- *
7331
7279
  */
7332
7280
  /** {en}
7333
7281
  * @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.
@@ -7350,7 +7298,6 @@ declare namespace live {
7350
7298
  interface ExposedSource {
7351
7299
  /** {zh}
7352
7300
  * @brief 线路标识(唯一值)。
7353
- * @default 无
7354
7301
  */
7355
7302
  /** {en}
7356
7303
  * @brief The playback source ID. This value must be unique.
@@ -7358,8 +7305,6 @@ declare namespace live {
7358
7305
  name?: string;
7359
7306
  /** {zh}
7360
7307
  * @brief 线路展示名称。可设置多语言 `{text: {'zh-cn': '线路一', 'en': 'LineOne'}}`。
7361
- * @default 无
7362
- *
7363
7308
  */
7364
7309
  /** {en}
7365
7310
  * @brief The display name of the live stream source. Multiple languages are supported. For example, you set it to `{text: {'zh-cn': '线路一', 'en': 'LineOne'}}`.
@@ -7368,8 +7313,6 @@ declare namespace live {
7368
7313
  text?: Record<Lang, string> | string;
7369
7314
  /** {zh}
7370
7315
  * @brief 该线路下清晰度列表。
7371
- * @default 无
7372
- *
7373
7316
  */
7374
7317
  /** {en}
7375
7318
  * @brief A list of resolutions of the current source.
@@ -7912,7 +7855,7 @@ declare namespace live {
7912
7855
  */
7913
7856
  autoHide: boolean;
7914
7857
  /** {zh}
7915
- * @brief 自动隐藏的延迟时间, 单位为 ms。
7858
+ * @brief 自动隐藏的延迟时间,单位为 ms。
7916
7859
  */
7917
7860
  /** {en}
7918
7861
  * @brief The latency of auto hiding, in milliseconds.
@@ -8651,7 +8594,6 @@ declare namespace live {
8651
8594
  showRefresh?: boolean;
8652
8595
  /** {zh}
8653
8596
  * @brief 自定义报错显示。
8654
- * @default 无
8655
8597
  */
8656
8598
  /** {en}
8657
8599
  * @brief Custom error message.
@@ -8660,7 +8602,6 @@ declare namespace live {
8660
8602
  errorTipsText?: string | Record<Lang, string>;
8661
8603
  /** {zh}
8662
8604
  * @brief 更多提示信息。
8663
- * @default 无
8664
8605
  */
8665
8606
  /** {en}
8666
8607
  * @brief More tips.
@@ -8820,7 +8761,6 @@ declare namespace live {
8820
8761
  id?: string;
8821
8762
  /** {zh}
8822
8763
  * @brief 指定播放器容器元素,VePlayer 将被插入在该容器中。id 和 el 需至少传入 1 个。如果同时传入,则优先将播放器插入 id 容器中。
8823
- * @default 无
8824
8764
  */
8825
8765
  /** {en}
8826
8766
  * @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`.
@@ -8846,7 +8786,6 @@ declare namespace live {
8846
8786
  height?: number | string;
8847
8787
  /** {zh}
8848
8788
  * @brief 为播放器配置直播拉流地址。您可手动拼接或使用地址生成器生成拉流地址,生成方法请参见[生成直播地址](https://www.volcengine.com/docs/6469/107759)。url 和 playList 需至少传入 1 个。
8849
- * @default 无
8850
8789
  */
8851
8790
  /** {en}
8852
8791
  * @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.
@@ -8854,7 +8793,6 @@ declare namespace live {
8854
8793
  url?: string;
8855
8794
  /** {zh}
8856
8795
  * @brief 为播放器配置直播拉流地址列表。url 和 playlist 需至少传入 1 个。
8857
- * @default 无
8858
8796
  */
8859
8797
  /** {en}
8860
8798
  * @brief A list of live stream sources for the player. You should specify either `url` or `playList`, or both.
@@ -8862,7 +8800,6 @@ declare namespace live {
8862
8800
  playlist?: ExposedSource[];
8863
8801
  /** {zh}
8864
8802
  * @brief 当存在多个直播线路时,为播放器设置默认直播线路,不传则默认列表第一个。
8865
- * @default 无
8866
8803
  */
8867
8804
  /** {en}
8868
8805
  * @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.
@@ -8870,7 +8807,6 @@ declare namespace live {
8870
8807
  defaultSource?: string;
8871
8808
  /** {zh}
8872
8809
  * @brief 为播放器设置默认直播清晰度,不传则默认列表第一个。
8873
- * @default 无
8874
8810
  */
8875
8811
  /** {en}
8876
8812
  * @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.
@@ -8878,7 +8814,6 @@ declare namespace live {
8878
8814
  defaultDefinition?: string;
8879
8815
  /** {zh}
8880
8816
  * @brief 为播放器设置备路拉流地址,支持设置多个备路拉流地址,在 `maxFallbackRound` 大于 `0` 时有效。当您使用配置的直播拉流地址拉流失败时,会在直播地址和备路直播地址之间循环拉流,直到拉流成功。
8881
- * @default 无
8882
8817
  */
8883
8818
  /** {en}
8884
8819
  * @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.
@@ -8932,7 +8867,6 @@ declare namespace live {
8932
8867
  degradation?: Degradation | boolean;
8933
8868
  /** {zh}
8934
8869
  * @brief 为播放器设置封面图 URL。
8935
- * @default 无
8936
8870
  */
8937
8871
  /** {en}
8938
8872
  * @brief The URL of the player's cover image.
@@ -8948,7 +8882,6 @@ declare namespace live {
8948
8882
  /** {zh}
8949
8883
  * @brief 为播放器设置自定义的多语言词典,可设置每个语种的词典,格式为 { texts: { [key: string]: Object; } }。
8950
8884
  * 例如,{ texts: { 'zh-cn': { PIP: '画中画' }, en: { PIP: 'pip' } }} ,格式请参考[默认词典](https://www.volcengine.com/docs/6469/127529)。
8951
- * @default 无
8952
8885
  */
8953
8886
  /** {en}
8954
8887
  * @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' } }}.
@@ -8958,7 +8891,7 @@ declare namespace live {
8958
8891
  texts: Record<Lang, Record<string, string>>;
8959
8892
  };
8960
8893
  /** {zh}
8961
- * @brief 为播放器设置是否自动播放, `muted` 设置为 `true` 为静音自动播放。
8894
+ * @brief 为播放器设置是否自动播放,`muted` 设置为 `true` 为静音自动播放。
8962
8895
  * @default { muted: true }
8963
8896
  * @type {{ muted: boolean } | boolean}
8964
8897
  */
@@ -9064,7 +8997,6 @@ declare namespace live {
9064
8997
  playsinline?: boolean;
9065
8998
  /** {zh}
9066
8999
  * @brief 为播放器设置 video 标签扩展属性,初始化时会设置在 videoElement 或 audioElement 对象上,请参考 [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#properties) 查看其支持的属性配置。
9067
- * @default 无
9068
9000
  */
9069
9001
  /** {en}
9070
9002
  * @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.
@@ -9142,7 +9074,6 @@ declare namespace live {
9142
9074
  marginControls?: boolean;
9143
9075
  /** {zh}
9144
9076
  * @brief 启用微信同层播放。
9145
- * @default 无
9146
9077
  */
9147
9078
  /** {en}
9148
9079
  * @brief Enable playing the video on the same player as WeChat.
@@ -9152,7 +9083,6 @@ declare namespace live {
9152
9083
  * @brief 是否启用微信全屏播放模式。
9153
9084
  * - `true`:启用
9154
9085
  * - `false`:停用
9155
- * @default 无
9156
9086
  */
9157
9087
  /** {en}
9158
9088
  * @brief Whether to enable full-screen playback in WeChat.
@@ -9165,7 +9095,6 @@ declare namespace live {
9165
9095
  * - `landscape`:横屏
9166
9096
  * - `portrait`:竖屏
9167
9097
  * - `landscape|portrait`:跟随手机自动旋转
9168
- * @default 无
9169
9098
  */
9170
9099
  /** {en}
9171
9100
  * @brief The orientation of the video when played on WeChat. The following values are supported:
@@ -9176,7 +9105,6 @@ declare namespace live {
9176
9105
  "x5-video-orientation"?: "landscape" | "portrait" | "landscape|portrait";
9177
9106
  /** {zh}
9178
9107
  * @brief 为播放器配置关键点样式。
9179
- * @default 无
9180
9108
  * @hidden 直播目前没用到
9181
9109
  */
9182
9110
  /** {en}
@@ -9186,7 +9114,6 @@ declare namespace live {
9186
9114
  commonStyle?: CommonStyle;
9187
9115
  /** {zh}
9188
9116
  * @brief 自定义插件列表。
9189
- * @default 无
9190
9117
  */
9191
9118
  /** {en}
9192
9119
  * @brief A list of custom plugins.
@@ -9229,10 +9156,10 @@ declare namespace live {
9229
9156
  */
9230
9157
  closeVideoDblclick?: boolean;
9231
9158
  /** {zh}
9232
- * @brief 支持传入 video dom,常应用于多播放器复用同一 video 场景。
9159
+ * @brief 支持传入 `video` DOM 元素,适用于多个播放器共享同一视频场景。
9233
9160
  */
9234
9161
  /** {en}
9235
- * @brief Supports passing in video DOM, commonly used for reusing the same video scene across multiple players.
9162
+ * @brief Supports passing in a `video` DOM element, suitable for scenarios where multiple players share the same video.
9236
9163
  */
9237
9164
  mediaElement?: HTMLVideoElement | null;
9238
9165
  }
@@ -9301,7 +9228,6 @@ declare namespace live {
9301
9228
  interface CommonStyle {
9302
9229
  /** {zh}
9303
9230
  * @brief 进度条底色。
9304
- * @default 无
9305
9231
  */
9306
9232
  /** {en}
9307
9233
  * @brief The background color of the progress bar.
@@ -9309,7 +9235,6 @@ declare namespace live {
9309
9235
  progressColor?: string;
9310
9236
  /** {zh}
9311
9237
  * @brief 播放完成部分进度条底色。
9312
- * @default 无
9313
9238
  */
9314
9239
  /** {en}
9315
9240
  * @brief The background color of the progress bar for the completed portion of video playback.
@@ -9317,7 +9242,6 @@ declare namespace live {
9317
9242
  playedColor?: string;
9318
9243
  /** {zh}
9319
9244
  * @brief 缓存部分进度条底色。
9320
- * @default 无
9321
9245
  */
9322
9246
  /** {en}
9323
9247
  * @brief
@@ -9326,7 +9250,6 @@ declare namespace live {
9326
9250
  cachedColor?: string;
9327
9251
  /** {zh}
9328
9252
  * @brief 进度条滑块样式。
9329
- * @default 无
9330
9253
  */
9331
9254
  /** {en}
9332
9255
  * @brief The style of the progress bar slider.
@@ -9337,7 +9260,6 @@ declare namespace live {
9337
9260
  };
9338
9261
  /** {zh}
9339
9262
  * @brief 音量颜色。
9340
- * @default 无
9341
9263
  */
9342
9264
  /** {en}
9343
9265
  * @brief The color of the volume slider.
@@ -9514,7 +9436,7 @@ declare namespace live {
9514
9436
  */
9515
9437
  get played(): TimeRanges;
9516
9438
  /** {zh}
9517
- * @brief 设置/获取视频当前的播放时间, 单位为 s。
9439
+ * @brief 设置/获取视频当前的播放时间,单位为 s。
9518
9440
  */
9519
9441
  /** {en}
9520
9442
  * @brief Sets or gets the current playback position of the video, in seconds.
@@ -9715,7 +9637,6 @@ declare namespace live {
9715
9637
  switch(target: string | {
9716
9638
  /** {zh}
9717
9639
  * @brief 清晰度的唯一标识。
9718
- * @default 无
9719
9640
  */
9720
9641
  /** {en}
9721
9642
  * @brief The resolution ID.
@@ -9723,7 +9644,6 @@ declare namespace live {
9723
9644
  definition?: string;
9724
9645
  /** {zh}
9725
9646
  * @brief 线路的唯一标识。
9726
- * @default 无
9727
9647
  */
9728
9648
  /** {en}
9729
9649
  * @brief The playback source ID.
@@ -9763,8 +9683,6 @@ declare namespace live {
9763
9683
  updatePlaylist(playlist: ExposedSource[] | string, target?: string | {
9764
9684
  /** {zh}
9765
9685
  * @brief 清晰度唯一标识。
9766
- * @default 无
9767
- *
9768
9686
  */
9769
9687
  /** {en}
9770
9688
  * @brief The resolution ID.
@@ -9773,8 +9691,6 @@ declare namespace live {
9773
9691
  definition?: string;
9774
9692
  /** {zh}
9775
9693
  * @brief 线路的唯一标识。
9776
- * @default 无
9777
- *
9778
9694
  */
9779
9695
  /** {en}
9780
9696
  * @brief The playback resource ID.
@@ -9975,7 +9891,6 @@ declare namespace live {
9975
9891
  Function | {
9976
9892
  /** {zh}
9977
9893
  * @brief 插件构造函数。
9978
- * @default 无
9979
9894
  */
9980
9895
  /** {en}
9981
9896
  * @brief The plugin constructor.
@@ -9984,7 +9899,6 @@ declare namespace live {
9984
9899
  plugin: Function;
9985
9900
  /** {zh}
9986
9901
  * @brief 插件配置参数。
9987
- * @default 无
9988
9902
  */
9989
9903
  /** {en}
9990
9904
  * @brief The plugin configurations.
@@ -10617,7 +10531,7 @@ declare namespace live {
10617
10531
  EMPTY_RTM_FALLBACK_PARAMETER = 211,
10618
10532
  /** {zh}
10619
10533
  * @brief 日志错误
10620
- * @solution 未正确配置质量日志参数, 请参考 https://www.volcengine.com/docs/6469/138655#日志上报 配置。
10534
+ * @solution 未正确配置质量日志参数,请参考 https://www.volcengine.com/docs/6469/138655#日志上报 配置。
10621
10535
  */
10622
10536
  /** {en}
10623
10537
  * @brief Log errors.
@@ -10783,7 +10697,6 @@ declare namespace live {
10783
10697
  enable?: boolean;
10784
10698
  /** {zh}
10785
10699
  * @brief 应用 ID,登录[视频直播控制台 > SDK 管理](https://console.volcengine.com/live/main/sdk)查询。
10786
- * @default 无
10787
10700
  */
10788
10701
  /** {en}
10789
10702
  * @brief The SDK application ID. You can access it by logging in to the BytePlus MediaLive console and navigating to [SDK Management](https://console.byteplus.com/live/main/sdk).
@@ -10791,7 +10704,6 @@ declare namespace live {
10791
10704
  appId?: string;
10792
10705
  /** {zh}
10793
10706
  * @brief 应用名称。
10794
- * @default 无
10795
10707
  */
10796
10708
  /** {en}
10797
10709
  * @brief The application name.
@@ -10801,7 +10713,6 @@ declare namespace live {
10801
10713
  * @brief 用于识别单一用户的 ID,如不设置,会随机生成一个用户 ID 存在浏览器缓存中。
10802
10714
  * @listtip
10803
10715
  * 建议您使用与业务相关的用户 ID,以便在发生播放错误时快速定位排查问题。
10804
- * @default 无
10805
10716
  */
10806
10717
  /** {en}
10807
10718
  * @brief The ID used to identify a single user. If not set, a random user ID will be generated and stored in the browser cache.
@@ -10813,7 +10724,6 @@ declare namespace live {
10813
10724
  * @brief 用于识别用户设备的 ID,如不设置,会随机生成一个用户 ID 存在浏览器缓存中。
10814
10725
  * @listtip
10815
10726
  * 建议您使用与业务相关的用户设备 ID,以便在发生播放错误时快速定位排查问题。
10816
- * @default 无
10817
10727
  */
10818
10728
  /** {en}
10819
10729
  * @brief The ID used to identify a user's device. If not set, a random device ID will be generated and stored in the browser cache.
@@ -10906,6 +10816,7 @@ declare namespace live {
10906
10816
  */
10907
10817
  /** {en}
10908
10818
  * @brief Configurations for advertising
10819
+ * @hidden
10909
10820
  */
10910
10821
  ad?: AdConfig;
10911
10822
  /** {zh}
@@ -10924,15 +10835,13 @@ declare namespace live {
10924
10835
  logger?: LoggerConfig;
10925
10836
  /** {zh}
10926
10837
  * @brief 为播放器禁用内置插件列表,接入方法请参见[插件说明](https://www.volcengine.com/docs/6469/192826#禁用插件)。
10927
- * @default 无
10928
10838
  */
10929
10839
  /** {en}
10930
10840
  * @brief A list of built-in plug-ins to be disabled. For the access method, please refer to [Plugin descriptions](https://docs.byteplus.com/en/docs/byteplus-media-live/docs-d8idjfeza4#disabling-plugins).
10931
10841
  */
10932
10842
  ignores?: string[];
10933
10843
  /** {zh}
10934
- * @brief 为播放器替换插件图标,接入方法请参见[插件说明](https://www.volcengine.com/docs/6469/192826#替换插件图标)。
10935
- * @default 无
10844
+ * @brief 为播放器替换插件图标,接入方法请参见[插件说明](https://www.volcengine.com/docs/6469/192826)。
10936
10845
  */
10937
10846
  /** {en}
10938
10847
  * @brief The plug-in icon. For the access method, please refer to [Plugin descriptions](https://docs.byteplus.com/en/docs/byteplus-media-live/docs-d8idjfeza4#replacing-plugin-icons).
@@ -11176,6 +11085,7 @@ declare namespace live {
11176
11085
  * @list option
11177
11086
  * @kind property
11178
11087
  * @brief Advertising schedule for a single ad break
11088
+ * @hidden
11179
11089
  */
11180
11090
  interface AdRule {
11181
11091
  /** {en}
@@ -11197,6 +11107,7 @@ declare namespace live {
11197
11107
  * @list option
11198
11108
  * @kind property
11199
11109
  * @brief Configurations for Google IMA SDK
11110
+ * @hidden
11200
11111
  */
11201
11112
  interface ImaConfig {
11202
11113
  /** {en}
@@ -11219,6 +11130,7 @@ declare namespace live {
11219
11130
  * @list option
11220
11131
  * @kind property
11221
11132
  * @brief Configurations for advertising
11133
+ * @hidden
11222
11134
  */
11223
11135
  interface AdConfig {
11224
11136
  /** {en}
@@ -11269,7 +11181,8 @@ declare namespace live {
11269
11181
  * @brief 配置 RTM 拉流失败降级地址,可配置 FLV 拉流地址或 HLS 的拉流地址。`enableFallback` 为 `true` 时生效。
11270
11182
  * - 指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,降级到 `fallbackUrl` 拉流地址。
11271
11183
  * - 未指定 `fallbackUrl`:当前环境不支持播放 RTM 或 RTM 拉流建联失败时,根据当前 RTM 地址降级到对应的 FLV 或者 HLS 地址。
11272
- * @default
11184
+ * @listtip - v2.5.2 版本后未指定 `fallbackUrl` 且未开启自动转码的情况下,不会自动降级到 FLV 或者 HLS 地址。
11185
+ * - 多线路和多清晰禁止插件内部自动降级, 具体降级方式查看 [RTM 拉流](https://www.volcengine.com/docs/6469/138655#rtm-%E6%8B%89%E6%B5%81)。
11273
11186
  */
11274
11187
  /** {en}
11275
11188
  * @brief The FLV or HLS addresses the player uses when failing to pull an RTM stream. This parameter takes effect when `enableFallback` is set to `true`.
@@ -11362,6 +11275,13 @@ declare namespace live {
11362
11275
  * @hidden
11363
11276
  */
11364
11277
  enableOriginSdpLogger?: boolean;
11278
+ /** {zh}
11279
+ * @brief RTM 协议缓冲区延迟,单位为秒。
11280
+ */
11281
+ /** {en}
11282
+ * @brief buffer delay to handle network jitter, in seconds。
11283
+ */
11284
+ delayHint?: number;
11365
11285
  }
11366
11286
  /** {zh}
11367
11287
  * @list option
@@ -11404,7 +11324,7 @@ declare namespace live {
11404
11324
  * - `true`:开启;
11405
11325
  * - `false`:关闭
11406
11326
  * @default false
11407
- * @listtip 低延迟 FLV 拉流仅在 PC 端浏览器中生效。
11327
+ * @listtip v2.5.2 版本后支持 FLV H5 端低延迟拉流。
11408
11328
  */
11409
11329
  /** {en}
11410
11330
  * @brief Whether to enable low latency when playing an FLV address. For example, if you have enabled low latency, and set GOP to 2 seconds, the average latency will be around 2 seconds.
@@ -11575,7 +11495,7 @@ declare namespace live {
11575
11495
  */
11576
11496
  interface RTMNetWorkInfo {
11577
11497
  /** {zh}
11578
- * @brief 最近一次网络评估周期内的下载速度, 单位为 bps。
11498
+ * @brief 最近一次网络评估周期内的下载速度,单位为 bps。
11579
11499
  */
11580
11500
  /** {en}
11581
11501
  * @brief The download speed within the latest network evaluation period, in units of bps.
@@ -11837,14 +11757,12 @@ declare namespace live {
11837
11757
  /** {zh}
11838
11758
  * @list option
11839
11759
  * @kind property
11840
- * @brief FLV 直播流播放信息。
11841
11760
  */
11842
11761
  /** {en}
11843
11762
  * @list option
11844
11763
  * @kind property
11845
- * @brief FLV live stream information.
11846
11764
  */
11847
- interface FlvStats {
11765
+ interface Stats$0 {
11848
11766
  /** {zh}
11849
11767
  * @brief 音频格式。
11850
11768
  * @hidden
@@ -11946,33 +11864,45 @@ declare namespace live {
11946
11864
  */
11947
11865
  samplerate: number;
11948
11866
  /** {zh}
11949
- * @brief 总共收到的字节数。
11867
+ * @hidden
11950
11868
  */
11951
11869
  /** {en}
11952
- * @brief The total number of bytes received.
11870
+ * @hidden
11953
11871
  */
11954
- totalReceivedByte: number;
11872
+ videoCodec: string;
11955
11873
  /** {zh}
11956
- * @brief 接收所有字节消耗时长。
11874
+ * @brief 视频宽度。
11957
11875
  */
11958
11876
  /** {en}
11959
- * @brief The time consumed for receiving all bytes.
11877
+ * @brief Video wight.
11960
11878
  */
11961
- totalReceivedCost: number;
11879
+ width: number;
11880
+ }
11881
+ /** {zh}
11882
+ * @list option
11883
+ * @kind property
11884
+ * @brief FLV 直播流播放信息。
11885
+ */
11886
+ /** {en}
11887
+ * @list option
11888
+ * @kind property
11889
+ * @brief FLV live stream information.
11890
+ */
11891
+ interface FlvStats extends Stats$0 {
11962
11892
  /** {zh}
11963
- * @hidden
11893
+ * @brief 总共收到的字节数。
11964
11894
  */
11965
11895
  /** {en}
11966
- * @hidden
11896
+ * @brief The total number of bytes received.
11967
11897
  */
11968
- videoCodec: string;
11898
+ totalReceivedByte: number;
11969
11899
  /** {zh}
11970
- * @brief 视频宽度。
11900
+ * @brief 接收所有字节消耗时长。
11971
11901
  */
11972
11902
  /** {en}
11973
- * @brief Video wight.
11903
+ * @brief The time consumed for receiving all bytes.
11974
11904
  */
11975
- width: number;
11905
+ totalReceivedCost: number;
11976
11906
  }
11977
11907
  /** {zh}
11978
11908
  * @detail api
@@ -12001,6 +11931,12 @@ declare namespace live {
12001
11931
  * @brief Obtain the duration that has been played, excluding pause and waiting time, with the unit of seconds.
12002
11932
  */
12003
11933
  get playTime(): number;
11934
+ /** {en}
11935
+ * @hidden
11936
+ */
11937
+ /** {zh}
11938
+ * @hidden
11939
+ */
12004
11940
  get ad(): any;
12005
11941
  /** {zh}
12006
11942
  * @brief 调用此方法开启直播日志上报。
@@ -12108,6 +12044,14 @@ declare namespace live {
12108
12044
  * @brief Obtain the playback information of FLV pull streaming.
12109
12045
  */
12110
12046
  getFLVStats(): FlvStats;
12047
+ /** {zh}
12048
+ * @brief 获取 HLS 拉流的播放信息。
12049
+ * @returns
12050
+ */
12051
+ /** {en}
12052
+ * @brief Obtain the playback information of HLS pull streaming.
12053
+ */
12054
+ getHLSStats(): Stats$0;
12111
12055
  }
12112
12056
  /** {zh}
12113
12057
  * @detail api