@volcengine/veplayer 1.8.6-rc.1 → 1.8.6-rc.3

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/index.d.ts CHANGED
@@ -48,23 +48,26 @@ export declare const enum POSITIONS {
48
48
  CONTROLS = "controls"
49
49
  }
50
50
  /**
51
- * @brief 发错错误时的UI表现配置
51
+ * @brief 播放器发生错误时的 UI 配置。
52
52
  * @list Options
53
53
  * @kind property
54
54
  */
55
+ /** {en}
56
+ * @brief 发错错误时的UI表现配置
57
+ */
55
58
  export interface ISdkErrorConfig {
56
59
  /** {zh}
57
- * @brief 报错时是否显示提示图片
60
+ * @brief 报错时是否展示提示图片。
58
61
  * @default true
59
62
  */
60
63
  errorImg?: boolean;
61
64
  /** {zh}
62
- * @brief 报错时是否展示
65
+ * @brief 报错时是否展示报错文案。
63
66
  * @default true
64
67
  */
65
68
  errorTips?: boolean;
66
69
  /** {zh}
67
- * @brief 报错时是否展示“刷新”按钮
70
+ * @brief 报错时是否展示刷新按钮。
68
71
  * @default ture
69
72
  */
70
73
  isNeedRefreshButton?: boolean;
@@ -75,12 +78,12 @@ export interface ISdkErrorConfig {
75
78
  */
76
79
  isNeedDemoteBack?: boolean;
77
80
  /** {zh}
78
- * @brief 报错后重试次数
81
+ * @brief 报错后重试次数。
79
82
  * @default 1
80
83
  */
81
84
  retryLoopNum?: number;
82
85
  /** {zh}
83
- * @brief 报错后提示文案
86
+ * @brief 不同语言对应的报错提示文案。
84
87
  * @default 播放发生错误,点击刷新试试吧
85
88
  */
86
89
  /** {en}
@@ -96,24 +99,36 @@ export interface ISdkErrorConfig {
96
99
  }
97
100
  /**
98
101
  * @list Options
99
- * @brief 错误文案配置
102
+ * @brief 报错文案配置。
100
103
  * @kind property
101
104
  */
105
+ /** {en}
106
+ * @brief 错误文案配置
107
+ */
102
108
  export interface TipsTextConfig {
103
109
  /**
104
- * @brief 中文错误文案
110
+ * @brief 中文错误文案。
105
111
  * @default 播放发生错误,点击刷新试试吧
106
112
  */
113
+ /** {en}
114
+ * @brief 中文错误文案
115
+ */
107
116
  zh?: HTMLElement | string;
108
117
  /**
109
- * @brief 英文错误文案
118
+ * @brief 英文错误文案。
110
119
  * @default An error occurred while playing, click refresh to try
111
120
  */
121
+ /** {en}
122
+ * @brief 英文错误文案
123
+ */
112
124
  en?: HTMLElement | string;
113
125
  /**
114
- * @brief 日文错误文案
126
+ * @brief 日文错误文案。
115
127
  * @default 再生中にエラーが発生しました。[更新]をクリックして試してください
116
128
  */
129
+ /** {en}
130
+ * @brief 日文错误文案
131
+ */
117
132
  jp?: HTMLElement | string;
118
133
  /**
119
134
  * @brief 香港繁体中文错误文案。
@@ -178,45 +193,97 @@ export interface IRtmConfig {
178
193
  backupStreamType: "hls" | "flv";
179
194
  }
180
195
  /**
181
- * @brief 弹幕相关设置
196
+ * @brief 弹幕配置。
182
197
  * @list Options
183
198
  * @kind property
184
199
  */
200
+ /** {en}
201
+ * @brief 弹幕相关设置
202
+ */
185
203
  export interface IDanmuConfig {
186
204
  /**
187
- * @brief 透明度, 枚举值[0, 33, 66, 99], 实际对应0, 0.33, 0.66, 1
205
+ * @brief 弹幕透明度。取值如下:
206
+ *
207
+ * - `0`:透明度 0。
208
+ * - `33`:透明度 33%。
209
+ * - `66`:透明度 66%。
210
+ * - `99`:透明度 100%。
188
211
  * @default 99
189
212
  */
213
+ /** {en}
214
+ * @brief 透明度, 枚举值[0, 33, 66, 99], 实际对应0, 0.33, 0.66, 1
215
+ */
190
216
  opacity?: number;
191
217
  /**
192
- * @brief 枚举值[0, 33, 66, 99] 实际对应1/4, 1/2, 3/4, 1
218
+ * @brief 弹幕区域大小。取值如下:
219
+ *
220
+ * - `0`:弹幕区域占全屏的 1/4。
221
+ * - `33`:弹幕区域占全屏的 1/2。
222
+ * - `66`:弹幕区域占全屏的 3/4。
223
+ * - `99`:弹幕区域占满全屏。
193
224
  * @default 99
194
225
  */
226
+ /** {en}
227
+ * @brief 枚举值[0, 33, 66, 99] 实际对应1/4, 1/2, 3/4, 1
228
+ */
195
229
  area?: number;
196
230
  /**
197
- * @brief 速度, 枚举值[0, 20, 40, 60, 80, 100], 实际对应1/4, 1/2,1,5/4,3/2,2
231
+ * @brief 弹幕滚动速度。取值如下:
232
+ *
233
+ * - `0`:弹幕速度为 1/4。
234
+ * - `20`:弹幕速度为 1/2。
235
+ * - `40`:弹幕速度为 1。
236
+ * - `60`:弹幕速度为 5/4。
237
+ * - `80`:弹幕速度为 3/2。
238
+ * - `100`:弹幕速度为 2。
198
239
  * @default 40
199
240
  */
241
+ /** {en}
242
+ * @brief 速度, 枚举值[0, 20, 40, 60, 80, 100], 实际对应1/4, 1/2,1,5/4,3/2,2
243
+ */
200
244
  speed?: number;
201
245
  /**
202
- * @brief 字体大小, 枚举值[0, 50, 100],实际对应14px 16px 20px
246
+ * @brief 弹幕字体大小。取值如下:
247
+ *
248
+ * - `0`:字体大小为 14 px。
249
+ * - `50`:字体大小为 16 px。
250
+ * - `100`:字体大小为 20 px。
203
251
  * @default 50
204
252
  */
253
+ /** {en}
254
+ * @brief 字体大小, 枚举值[0, 50, 100],实际对应14px 16px 20px
255
+ */
205
256
  fontSize?: number;
206
257
  /**
207
- * @brief 是否打开面板
258
+ * @brief 是否打开面板。取值如下:
259
+ *
260
+ * - `false`:关闭面板。
261
+ * - `true`:打开面板。
208
262
  * @default false
209
263
  */
264
+ /** {en}
265
+ * @brief 是否打开面板
266
+ */
210
267
  active?: boolean;
211
268
  /**
212
- * @brief 是否展示弹幕设置面板
269
+ * @brief 是否展示弹幕设置面板。取值如下:
270
+ *
271
+ * - `false`:不展示弹幕设置面板。
272
+ * - `true`:展示弹幕设置面板。
213
273
  * @default true
274
+ * @hidden
275
+ */
276
+ /** {en}
277
+ * @brief 是否展示弹幕设置面板
214
278
  */
215
279
  usePanel?: boolean;
216
280
  /**
217
- * @brief 弹幕列表
281
+ * @brief 弹幕列表。
218
282
  * @default -
219
283
  */
284
+ /** {en}
285
+ * @brief 弹幕列表
286
+ */
220
287
  danmuItems?: DanmuItem[];
221
288
  /**
222
289
  * @hidden
@@ -248,18 +315,25 @@ export interface Lang {
248
315
  [props: string]: string;
249
316
  }
250
317
  /**
251
- * @brief 弹幕项配置
318
+ * @brief 弹幕项
252
319
  * @list Options
253
320
  * @kind property
254
321
  * @export
255
322
  * @interface DanmuItem
256
323
  */
324
+ /** {en}
325
+ * @brief 弹幕项配置
326
+ */
257
327
  export interface DanmuItem {
258
328
  /**
259
329
  * 弹幕唯一id
260
330
  *
261
331
  * @type {string}
262
332
  * @memberof DanmuItem
333
+ * @brief 弹幕唯一 ID。
334
+ */
335
+ /** {en}
336
+ * @brief 弹幕唯一id
263
337
  */
264
338
  id: string;
265
339
  /**
@@ -267,11 +341,19 @@ export interface DanmuItem {
267
341
  *
268
342
  * @type {string}
269
343
  * @memberof DanmuItem
344
+ * @brief 弹幕文案。
345
+ */
346
+ /** {en}
347
+ * @brief 弹幕文案
270
348
  */
271
349
  txt: string;
272
350
  /**
273
351
  * 弹幕出现时间, 单位为ms
274
352
  * @default 0
353
+ * @brief 弹幕出现时间,单位为毫秒。
354
+ */
355
+ /** {en}
356
+ * @brief 弹幕出现时间, 单位为ms
275
357
  */
276
358
  start?: number;
277
359
  /**
@@ -287,10 +369,14 @@ export interface DanmuItem {
287
369
  *
288
370
  * @type {number}
289
371
  * @memberof DanmuItem
372
+ * @brief 弹幕持续显示时长,单位为毫秒。
373
+ */
374
+ /** {en}
375
+ * @brief 弹幕持续显示时间, 单位为ms
290
376
  */
291
377
  duration?: number;
292
378
  /**
293
- * @brief 弹幕样式
379
+ * @brief 弹幕样式。示例如下:`style : { color: '#ff9500', fontSize: '20px', padding: '2px 11px'}`
294
380
  * @example
295
381
  * ``` javascript
296
382
  * {
@@ -302,6 +388,9 @@ export interface DanmuItem {
302
388
  * @type {Partial<Record<Property, string>>}
303
389
  * @memberof DanmuItem
304
390
  */
391
+ /** {en}
392
+ * @brief 弹幕样式
393
+ */
305
394
  style?: CSSStyleDeclaration;
306
395
  }
307
396
  export interface ExternalItem {
@@ -311,10 +400,13 @@ export interface ExternalItem {
311
400
  lang?: Lang;
312
401
  }
313
402
  /**
314
- * @brief 外挂字幕配置
403
+ * @brief 外挂字幕配置。
315
404
  * @list Options
316
405
  * @kind property
317
406
  */
407
+ /** {en}
408
+ * @brief 外挂字幕配置
409
+ */
318
410
  export interface ISubtitleConfig {
319
411
  /**
320
412
  *
@@ -322,57 +414,88 @@ export interface ISubtitleConfig {
322
414
  */
323
415
  [propName: string]: any;
324
416
  /**
325
- * @brief 图标位置
417
+ * @brief 图标位置。
326
418
  * @default controlsRight
327
419
  */
420
+ /** {en}
421
+ * @brief 图标位置
422
+ */
328
423
  position?: string;
329
424
  /**
330
- * @brief 图标排列权重
425
+ * @brief 图标排列权重。
331
426
  * @default 6
332
427
  */
428
+ /** {en}
429
+ * @brief 图标排列权重
430
+ */
333
431
  index?: number;
334
432
  /**
335
- * @brief 字幕列表
433
+ * @brief 字幕列表。
336
434
  * @default -
337
435
  */
436
+ /** {en}
437
+ * @brief 字幕列表
438
+ */
338
439
  list?: Array<ISubTitleItem>;
339
440
  /**
340
- * @brief 是否默认打开
441
+ * @brief 是否默认打开字幕。
341
442
  * @default true
342
443
  */
444
+ /** {en}
445
+ * @brief 是否默认打开
446
+ */
343
447
  isDefaultOpen?: boolean;
344
448
  /**
345
- * @brief 是否显示图标
449
+ * @brief 是否显示图标。
346
450
  * @default true
347
451
  */
452
+ /** {en}
453
+ * @brief 是否显示图标
454
+ */
348
455
  isShowIcon?: boolean;
349
456
  /**
350
- * @brief 字幕渲染模式,外挂字幕或原生字幕
457
+ * @brief 字幕渲染模式,取值如下:
458
+ * - `"external"`:外挂字幕
459
+ * - `"native"`:原生字幕
351
460
  * @default external
352
461
  */
462
+ /** {en}
463
+ * @brief 字幕渲染模式,外挂字幕或原生字幕
464
+ */
353
465
  mode?: "external" | "native";
354
466
  /**
355
467
  * @brief 字幕更新模式,默认vod
356
468
  * @default vod
469
+ * @hidden
357
470
  */
358
471
  updateMode?: "vod" | "live";
359
472
  /**
360
- * @brief 字幕样式
473
+ * @brief 字幕样式。
361
474
  * @default -
362
475
  */
476
+ /** {en}
477
+ * @brief 字幕样式
478
+ */
363
479
  style?: ISubtitleStyle;
364
480
  }
365
481
  /**
366
482
  * @list Options
367
- * @brief 字幕样式配置
483
+ * @brief 字幕样式配置。
368
484
  * @kind property
369
485
  */
486
+ /** {en}
487
+ * @brief 字幕样式配置
488
+ */
370
489
  export interface ISubtitleStyle {
371
490
  /**
372
491
  * 是否跟随控制栏调整位置
373
492
  * @default true
374
493
  * @type {boolean | null}
375
494
  * @memberof ISubtitleStyle
495
+ * @brief 是否跟随控制栏调整位置。
496
+ */
497
+ /** {en}
498
+ * @brief 是否跟随控制栏调整位置
376
499
  */
377
500
  follow: boolean | null;
378
501
  /**
@@ -380,6 +503,12 @@ export interface ISubtitleStyle {
380
503
  * @default 'stroke'
381
504
  * @type {'stroke' | 'bg'}
382
505
  * @memberof ISubtitleStyle
506
+ * @brief 字体显示模式,默认如下;
507
+ * - `"stroke"`:空心字体。
508
+ * - `"bg"`:实心字体。
509
+ */
510
+ /** {en}
511
+ * @brief 字体显示模式,默认是描边
383
512
  */
384
513
  mode?: "stroke" | "bg";
385
514
  /**
@@ -387,6 +516,10 @@ export interface ISubtitleStyle {
387
516
  * @default 50
388
517
  * @type {number}
389
518
  * @memberof ISubtitleStyle
519
+ * @brief 是否跟随底部控制栏的高度。
520
+ */
521
+ /** {en}
522
+ * @brief 跟随底部控制栏的高度
390
523
  */
391
524
  followBottom?: number;
392
525
  /**
@@ -394,6 +527,10 @@ export interface ISubtitleStyle {
394
527
  * @default true
395
528
  * @type {boolean}
396
529
  * @memberof ISubtitleStyle
530
+ * @brief 是否跟随视频自动调整字号。
531
+ */
532
+ /** {en}
533
+ * @brief 是否跟随视频自动调整字号
397
534
  */
398
535
  fitVideo?: boolean;
399
536
  /**
@@ -401,6 +538,10 @@ export interface ISubtitleStyle {
401
538
  * @default 4
402
539
  * @type {number}
403
540
  * @memberof ISubtitleStyle
541
+ * @brief 字幕距离画面底部百分比。
542
+ */
543
+ /** {en}
544
+ * @brief 字幕距离画面底部百分比
404
545
  */
405
546
  offsetBottom?: number;
406
547
  /**
@@ -408,6 +549,10 @@ export interface ISubtitleStyle {
408
549
  * @default 49
409
550
  * @type {number}
410
551
  * @memberof ISubtitleStyle
552
+ * @brief 横屏视频适配基准字号。
553
+ */
554
+ /** {en}
555
+ * @brief 横屏视频适配基准字号
411
556
  */
412
557
  baseSizeX?: number;
413
558
  /**
@@ -415,6 +560,10 @@ export interface ISubtitleStyle {
415
560
  * @default 28
416
561
  * @type {number}
417
562
  * @memberof ISubtitleStyle
563
+ * @brief 竖屏视频适配基准字号。
564
+ */
565
+ /** {en}
566
+ * @brief 竖屏视频适配基准字号
418
567
  */
419
568
  baseSizeY?: number;
420
569
  /**
@@ -422,6 +571,10 @@ export interface ISubtitleStyle {
422
571
  * @default 16
423
572
  * @type {number}
424
573
  * @memberof ISubtitleStyle
574
+ * @brief PC 端最小字号.
575
+ */
576
+ /** {en}
577
+ * @brief pc端最小字号
425
578
  */
426
579
  minSize?: number;
427
580
  /**
@@ -429,6 +582,10 @@ export interface ISubtitleStyle {
429
582
  * @default 13
430
583
  * @type {number}
431
584
  * @memberof ISubtitleStyle
585
+ * @brief 移动端最小字号。
586
+ */
587
+ /** {en}
588
+ * @brief 移动端最小字号
432
589
  */
433
590
  minMobileSize?: number;
434
591
  /**
@@ -436,6 +593,13 @@ export interface ISubtitleStyle {
436
593
  * @default double
437
594
  * @type {'double' | 'single' | 'three'}
438
595
  * @memberof ISubtitleStyle
596
+ * @brief 最大显示行数。取值如下:
597
+ * - `"double"`:两行
598
+ * - `"single"`:一行
599
+ * - `"three"`:三行
600
+ */
601
+ /** {en}
602
+ * @brief 最大显示行数
439
603
  */
440
604
  line?: "double" | "single" | "three";
441
605
  /**
@@ -443,39 +607,61 @@ export interface ISubtitleStyle {
443
607
  * @default #fff
444
608
  * @type {string}
445
609
  * @memberof ISubtitleStyle
610
+ * @brief 字体颜色。可设为 16 位颜色值或 RGB 值。
611
+ */
612
+ /** {en}
613
+ * @brief 字体颜色, 16位颜色值或rgb值
446
614
  */
447
615
  fontColor?: string;
448
616
  }
449
617
  /**
450
618
  * @list Options
451
- * @brief 字幕项配置
619
+ * @brief 字幕项。
452
620
  * @kind property
453
621
  */
622
+ /** {en}
623
+ * @brief 字幕项配置
624
+ */
454
625
  export interface ISubTitleItem {
455
626
  /**
456
- * @brief 字幕语言
627
+ * @brief 字幕语言。
457
628
  * @default -
458
629
  */
630
+ /** {en}
631
+ * @brief 字幕语言
632
+ */
459
633
  language?: string | number;
460
634
  /**
461
- * @brief 字幕id
635
+ * @brief 字幕 ID。
462
636
  * @default -
463
637
  */
638
+ /** {en}
639
+ * @brief 字幕id
640
+ */
464
641
  id?: number | string;
465
642
  /**
466
- * @brief 是否是默认选择的字幕
643
+ * @brief 是否为默认选择的字幕。
467
644
  * @default false
468
645
  */
646
+ /** {en}
647
+ * @brief 是否是默认选择的字幕
648
+ */
469
649
  isDefault?: boolean;
470
650
  /**
471
- * @brief 字幕名称
651
+ * @brief 字幕名称。
472
652
  * @default -
473
653
  */
654
+ /** {en}
655
+ * @brief 字幕名称
656
+ */
474
657
  text?: string;
475
658
  /**
476
- * @brief 外挂字幕地址
659
+ * @brief 外挂字幕 URL 地址。
477
660
  * @default -
478
661
  */
662
+ /** {en}
663
+ * @brief 外挂字幕地址
664
+ */
479
665
  url?: string;
480
666
  /**
481
667
  * stringContent
@@ -490,30 +676,49 @@ export interface ISubTitleItem {
490
676
  * @default 无
491
677
  * @type {Array<Object>}
492
678
  * @memberof ISubTitleItem
679
+ * @brief 字幕内容列表。非 `url` 形式时使用。
680
+ */
681
+ /** {en}
682
+ * @brief 字幕内容列表,非url形式时使用
493
683
  */
494
684
  list?: IListItem[];
495
685
  }
496
686
  /**
497
- * @brief 字幕内容项配置
687
+ * @brief 字幕内容项。
498
688
  * @list Options
499
689
  * @kind property
500
690
  * @export
501
691
  * @interface IListItem
502
692
  */
693
+ /** {en}
694
+ * @brief 字幕内容项配置
695
+ */
503
696
  export interface IListItem {
504
697
  /**
505
698
  * 开始时间
506
699
  * @type {number}
700
+ * @brief 开始时间,单位为秒。
701
+ */
702
+ /** {en}
703
+ * @brief 开始时间
507
704
  */
508
705
  start: number;
509
706
  /**
510
707
  * 结束时间
511
708
  * @type {number}
709
+ * @brief 结束时间,单位为秒。
710
+ */
711
+ /** {en}
712
+ * @brief 结束时间
512
713
  */
513
714
  end: number;
514
715
  /**
515
716
  * 字幕数据列表
516
717
  * @type {Array<ITextItem>}
718
+ * @brief 字幕数据列表。
719
+ */
720
+ /** {en}
721
+ * @brief 字幕数据列表
517
722
  */
518
723
  list: Array<ITextItem>;
519
724
  /**
@@ -538,21 +743,37 @@ export interface ITextItem {
538
743
  /**
539
744
  * 开始时间
540
745
  * @type {number}
746
+ * @brief 开始时间,单位为秒。
747
+ */
748
+ /** {en}
749
+ * @brief 开始时间
541
750
  */
542
751
  start: number;
543
752
  /**
544
753
  * 结束时间
545
754
  * @type {number}
755
+ * @brief 结束时间,单位为秒。
756
+ */
757
+ /** {en}
758
+ * @brief 结束时间
546
759
  */
547
760
  end: number;
548
761
  /**
549
762
  * 字幕文案数组
550
763
  * @type {string[]}
764
+ * @brief 字幕文案数组。
765
+ */
766
+ /** {en}
767
+ * @brief 字幕文案数组
551
768
  */
552
769
  text: string[];
553
770
  /**
554
771
  * 字幕顺序
555
772
  * @type {number}
773
+ * @brief 字幕顺序。
774
+ */
775
+ /** {en}
776
+ * @brief 字幕顺序
556
777
  */
557
778
  index?: number;
558
779
  }
@@ -608,16 +829,22 @@ export interface IDefinitionDemotePlugin {
608
829
  demotePriority?: string[];
609
830
  }
610
831
  /**
611
- * @brief DASH 播放配置项
832
+ * @brief DASH 播放配置。
612
833
  * @list Options
613
834
  * @kind property
614
835
  */
836
+ /** {en}
837
+ * @brief DASH 播放配置项
838
+ */
615
839
  export interface IDashPluginConfig {
616
840
  /**
617
- * @brief 视频vid
841
+ * @brief 视频 ID。
618
842
  * @default -
619
843
  * @notice 播放加密视频时必选
620
844
  */
845
+ /** {en}
846
+ * @brief 视频vid
847
+ */
621
848
  vid?: string;
622
849
  /**
623
850
  * @hidden
@@ -626,7 +853,7 @@ export interface IDashPluginConfig {
626
853
  */
627
854
  playInfoType: "TOP";
628
855
  /**
629
- * @brief 清晰度映射文案
856
+ * @brief 清晰度映射文案。
630
857
  * @default -
631
858
  * @example
632
859
  * ``` javascript
@@ -638,11 +865,17 @@ export interface IDashPluginConfig {
638
865
  * }
639
866
  * ```
640
867
  */
868
+ /** {en}
869
+ * @brief 清晰度映射文案
870
+ */
641
871
  definitionText: Record<string, string>;
642
872
  /**
643
- * @brief 默认清晰度
873
+ * @brief 默认清晰度。
644
874
  * @default 列表第一个
645
875
  */
876
+ /** {en}
877
+ * @brief 默认清晰度
878
+ */
646
879
  defaultDefinition?: string;
647
880
  /**
648
881
  * @hidden
@@ -671,6 +904,10 @@ export interface IDashPluginConfig {
671
904
  /**
672
905
  * 预加载时间,单位ms
673
906
  * @default 50
907
+ * @brief 预加载时间,单位为毫秒。
908
+ */
909
+ /** {en}
910
+ * @brief 预加载时间,单位ms
674
911
  */
675
912
  preloadTime?: number;
676
913
  /**
@@ -717,10 +954,13 @@ export interface mp4OptsItem {
717
954
  url: string;
718
955
  }
719
956
  /**
720
- * @brief HLS加密播放配置
957
+ * @brief HLS 加密播放配置。
721
958
  * @list Options
722
959
  * @kind property
723
960
  */
961
+ /** {en}
962
+ * @brief HLS加密播放配置
963
+ */
724
964
  export interface IEncryptHlsPluginConfig {
725
965
  /** {zh}
726
966
  * @brief 获取播放地址的请求域名。
@@ -755,10 +995,13 @@ export interface IEncryptHlsPluginConfig {
755
995
  keyToken: string;
756
996
  }
757
997
  /**
758
- * @brief 质量日志配置
998
+ * @brief 质量日志上报配置。
759
999
  * @list Options
760
1000
  * @kind property
761
1001
  */
1002
+ /** {en}
1003
+ * @brief 质量日志配置
1004
+ */
762
1005
  export interface IVodLogOptsConfig {
763
1006
  /**
764
1007
  * @brief 视频点播应用 ID。您可在视频{@link https://console.volcengine.com/vod/region:vod+cn-north-1/sdk/app/ 点播控制台 > 点播SDK > 应用管理}页面获取应用 ID(App ID)。
@@ -788,6 +1031,9 @@ export interface IVodLogOptsConfig {
788
1031
  * @brief 自定义子标签。对应于质量平台上的自定义标签维度,与 `tag` 配合使用,可用于区分同一业务类型下更为细分的音视频类型,比如加密视频、非加密视频、音频等。
789
1032
  * @default -
790
1033
  */
1034
+ /** {en}
1035
+ * @brief 自定义子标签。对应于质量平台上的自定义标签维度,与 `tag` 配合使用,可用于区分同一业务类型下更为细分的音视频类型,比如加密视频、非加密视频、音频等。
1036
+ */
791
1037
  subtag?: string;
792
1038
  /**
793
1039
  * @brief 视频编码类型,取值如下
@@ -1058,34 +1304,52 @@ export declare type IPlayerOptions = {
1058
1304
  };
1059
1305
  };
1060
1306
  /**
1061
- * @brief 自动播放配置
1307
+ * @brief 自动播放配置。
1062
1308
  * @list Options
1063
1309
  * @kind property
1064
1310
  */
1311
+ /** {en}
1312
+ * @brief 自动播放配置
1313
+ */
1065
1314
  export interface IAutoplayPluginConfig {
1066
1315
  /**
1067
1316
  * @hidden
1068
1317
  */
1069
1318
  position?: string;
1070
1319
  /**
1071
- * @brief 有声音自动播放失败时是否降级成静音自动播放
1320
+ * @brief 是否开启降级静音自动播放。开启后,如果当前浏览器环境不支持有声音自动播放,则降级为静音自动播放。
1072
1321
  * @default false
1073
1322
  */
1323
+ /** {en}
1324
+ * @brief 有声音自动播放失败时是否降级成静音自动播放
1325
+ */
1074
1326
  enableDegradeMuteAutoplay?: boolean;
1075
1327
  /**
1076
1328
  * @brief 启用微信jsBridge方式的自动播放
1077
1329
  * @default false
1330
+ * @hidden
1331
+ */
1332
+ /** {en}
1333
+ * @hidden
1078
1334
  */
1079
1335
  enableWxJsBridgeAutoplay?: boolean;
1080
1336
  /**
1081
- * @brief 用户触发自动播放的目标dom
1337
+ * @brief 用户触发自动播放的目标 dom
1082
1338
  * @default window.document.body
1083
1339
  */
1340
+ /** {en}
1341
+ * @brief 用户触发自动播放的目标dom
1342
+ */
1084
1343
  userActionDom?: Node;
1085
1344
  /**
1086
- * @brief 开启任意点击/触摸的用户行为触发自动播放
1345
+ * @brief 是否开启任意用户行为触发自动播放。开启后,第一次用户的任意点击可以触发播放器的自动播放。取值如下:
1346
+ * - `true`:开启
1347
+ * - `false`:不开启
1087
1348
  * @default false
1088
1349
  */
1350
+ /** {en}
1351
+ * @brief 开启任意点击/触摸的用户行为触发自动播放
1352
+ */
1089
1353
  enableUserActionAutoplay?: boolean;
1090
1354
  }
1091
1355
  declare class PlayList {
@@ -1108,15 +1372,23 @@ declare class PlayList {
1108
1372
  destroy(): void;
1109
1373
  }
1110
1374
  /**
1375
+ * @brief 播放列表展示面板触发动作类型。
1376
+ */
1377
+ /** {en}
1111
1378
  * @brief 播放列表展示面板触发动作类型
1112
- *
1113
1379
  */
1114
1380
  export declare const enum TOGGLE_MODES {
1115
1381
  /**
1382
+ * @brief 鼠标点击。
1383
+ */
1384
+ /** {en}
1116
1385
  * @brief 鼠标点击
1117
1386
  */
1118
1387
  CLICK = "click",
1119
1388
  /**
1389
+ * @brief 鼠标悬浮。
1390
+ */
1391
+ /** {en}
1120
1392
  * @brief 鼠标悬浮
1121
1393
  */
1122
1394
  HOVER = "hover"
@@ -1129,96 +1401,155 @@ export declare const enum TOGGLE_MODES {
1129
1401
  */
1130
1402
  export interface IPlayListItem {
1131
1403
  /**
1132
- * @brief 视频地址
1133
1404
  * @notice `playAuthToken` 为空时,此参数必传。
1134
1405
  * @default -
1406
+ * @listtip `playAuthToken` 为空时,此参数必传。
1407
+ * @brief 视频地址。
1408
+ */
1409
+ /** {en}
1135
1410
  */
1136
1411
  url?: string;
1137
1412
  /**
1138
- * @brief 播放临时安全凭证,由业务的 AppServer 签发。
1139
1413
  * @notice `url` 为空时,此参数必传。
1140
1414
  * @default -
1415
+ * @listtip `url` 为空时,此参数必传。
1416
+ * @brief 播放临时安全凭证,由业务的 AppServer 签发。
1417
+ */
1418
+ /** {en}
1141
1419
  */
1142
1420
  playAuthToken?: string;
1143
1421
  /**
1144
- * @brief 视频的唯一 ID。不传则取视频所在列表数组的序号。
1145
1422
  * @default -
1423
+ * @brief 视频的唯一 ID。不传则取视频所在列表数组的序号。
1424
+ */
1425
+ /** {en}
1146
1426
  */
1147
1427
  vid: string;
1148
1428
  /**
1149
- * @brief 封面图地址。
1150
1429
  * @default -
1430
+ * @brief 视频封面图地址。
1431
+ */
1432
+ /** {en}
1151
1433
  */
1152
1434
  poster?: string;
1153
1435
  /**
1154
- * @brief 视频标题。
1155
1436
  * @default -
1437
+ * @brief 视频标题。
1438
+ */
1439
+ /** {en}
1156
1440
  */
1157
1441
  title?: string;
1158
1442
  /**
1159
- * @brief 视频时长,单位s
1443
+ * @brief 视频时长,单位为秒。
1160
1444
  * @default -
1161
1445
  */
1446
+ /** {en}
1447
+ * @brief 视频时长,单位s
1448
+ */
1162
1449
  duration?: number;
1163
1450
  }
1164
1451
  declare enum EPlayMode {
1165
1452
  /**
1453
+ * @brief 顺序播放。
1454
+ */
1455
+ /** {en}
1166
1456
  * @brief 顺序播放
1167
1457
  */
1168
1458
  ORDER = "order",
1169
1459
  /**
1460
+ * @brief 列表循环。
1461
+ */
1462
+ /** {en}
1170
1463
  * @brief 列表循环
1171
1464
  */
1172
1465
  LOOP = "loop"
1173
1466
  }
1174
1467
  /**
1175
1468
  * @list Options
1176
- * @brief 播放列表插件配置项
1469
+ * @brief 播放列表插件配置。
1177
1470
  * @kind property
1178
1471
  */
1472
+ /** {en}
1473
+ * @brief 播放列表插件配置项
1474
+ */
1179
1475
  export interface IPlayListConfig {
1180
1476
  /**
1181
- * @brief 图标位置
1477
+ * @brief 按钮位置。取值如下:
1478
+ *
1479
+ * - `controlsLeft`: 播控栏左侧
1480
+ * - `controlsRight`: 播控栏右侧
1481
+ * - `controlsCenter`: 播控栏中间
1482
+ * - `rootLeft`:播放器根节点左侧
1483
+ * - `rootRight`:播放器根节点右侧
1484
+ * - `rootTop`:播放器根节点顶部
1485
+ * - `root`:播放器根节点
1182
1486
  * @notice 此参数同时影响“打开/关闭播放列表”和“播放下一个”两个按钮的位置。
1487
+ * @default controlsLeft
1488
+ */
1489
+ /** {en}
1490
+ * @brief 图标位置
1183
1491
  * @default controlsLeft 控制栏左侧
1184
1492
  */
1185
1493
  position?: string;
1186
1494
  /**
1187
- * @brief 图标位置权重
1495
+ * @brief 按钮在所在区域的次序。默认值为 `2`,表示在播放按钮后。
1188
1496
  * @default 20
1189
1497
  */
1498
+ /** {en}
1499
+ * @brief 图标位置权重
1500
+ */
1190
1501
  index?: number;
1191
1502
  /**
1192
- * @brief 列表数据
1503
+ * @brief 播放列表数据。
1193
1504
  * @default []
1194
1505
  */
1506
+ /** {en}
1507
+ * @brief 列表数据
1508
+ */
1195
1509
  list: IPlayListItem[];
1196
1510
  /**
1197
- * @brief 循环模式
1198
- * - order:不循环播放,即列表中最后一个视频播放完成后就停止播放。
1199
- * - loop:列表循环,即列表中最后一个视频播放完成后将自动开始重新播放列表中的第一个视频。
1511
+ * @brief 循环模式,取值如下:
1512
+ *
1513
+ * - `order`: 不循环播放,即列表中最后一个视频播放完成后就停止播放。
1514
+ * - `loop`: 列表循环,即列表中最后一个视频播放完成后将自动开始重新播放列表中的第一个视频。
1200
1515
  * @default order
1201
1516
  */
1517
+ /** {en}
1518
+ * @brief 循环模式
1519
+ */
1202
1520
  mode?: EPlayMode;
1203
1521
  /**
1204
- * @brief 默认起始播放序号
1522
+ * @brief 默认起始的播放次序。
1205
1523
  * @default order
1206
1524
  */
1525
+ /** {en}
1526
+ * @brief 默认起始播放序号
1527
+ */
1207
1528
  defaultIndex?: number;
1208
1529
  /**
1209
- * @brief 列表点击之后是否隐藏列表
1530
+ * @brief 列表点击之后是否隐藏。
1210
1531
  * @default true
1211
1532
  */
1533
+ /** {en}
1534
+ * @brief 列表点击之后是否隐藏列表
1535
+ */
1212
1536
  isItemClickHide?: boolean;
1213
1537
  /**
1538
+ * @brief 列表行为触发模式。
1539
+ * @default click
1540
+ */
1541
+ /** {en}
1542
+ * @default click
1214
1543
  * @brief 列表行为触发模式
1215
- * @default click 点击
1216
1544
  */
1217
1545
  toggleMode?: TOGGLE_MODES;
1218
1546
  /**
1219
- * @brief 是否显示图标
1547
+ * @brief 是否显示播放列表按钮。
1220
1548
  * @default true
1221
1549
  */
1550
+ /** {en}
1551
+ * @brief 是否显示图标
1552
+ */
1222
1553
  isShowIcon?: boolean;
1223
1554
  }
1224
1555
  export declare class PlayListPlugin extends Plugin {
@@ -1328,95 +1659,94 @@ export interface IPlayInfoList {
1328
1659
  Width: number;
1329
1660
  }
1330
1661
  declare enum CodecType {
1331
- /**
1662
+ /** {zh}
1332
1663
  * @brief H.265
1333
1664
  */
1334
1665
  H265 = "h265",
1335
- /**
1666
+ /** {zh}
1336
1667
  * @brief H.264
1337
1668
  */
1338
1669
  H264 = "h264",
1339
- /**
1340
- * @brief 未知编码
1670
+ /** {zh}
1671
+ * @brief 未知编码格式
1341
1672
  */
1342
1673
  UNKNOWN = "unknown"
1343
1674
  }
1344
1675
  declare enum RTMCodec {
1345
1676
  H264 = "h264"
1346
1677
  }
1347
- /**
1348
- * @brief region 类型
1678
+ /** {zh}
1679
+ * @brief 区域类型:
1680
+ * - `'cn'`:中国内地
1681
+ * - `'mya'`:马来西亚
1682
+ * - `'sg'`:暂不生效
1683
+ * - `'va'`:暂不生效
1349
1684
  */
1350
1685
  export declare type TRegionType = "cn" | "mya" | "va" | "sg";
1351
- /**
1352
- * @brief 音乐循环模式
1353
- * - order 顺序播放
1354
- * - sloop 单曲循环
1355
- * - loop 列表循环
1356
- * - random 列表随机
1686
+ /** {zh}
1687
+ * @brief 音乐循环模式:
1688
+ * - `'order'`:顺序播放
1689
+ * - `'sloop'`:单曲循环
1690
+ * - `'loop'`:列表循环
1691
+ * - `'random'`:列表随机
1357
1692
  */
1358
1693
  export declare type PlayModeType = "order" | "sloop" | "loop" | "random";
1359
1694
  export interface IMusicListItem {
1360
- /**
1361
- * 音乐地址
1362
- *
1695
+ /** {zh}
1363
1696
  * @type {string}
1697
+ * @brief 音乐播放地址。
1364
1698
  */
1365
1699
  src: string;
1366
- /**
1367
- * 音乐唯一vid
1368
- *
1700
+ /** {zh}
1369
1701
  * @type {string | number}
1370
1702
  * @memberof IMusicListItem
1703
+ * @brief 音乐唯一 ID。
1371
1704
  */
1372
1705
  vid: string | number;
1373
- /**
1374
- * 音乐封面
1375
- *
1706
+ /** {zh}
1376
1707
  * @type {string}
1377
1708
  * @memberof IMusicListItem
1709
+ * @brief 音乐封面 URL 地址。
1378
1710
  */
1379
1711
  poster?: string;
1380
- /**
1381
- * 音乐标题
1382
- *
1712
+ /** {zh}
1383
1713
  * @type {string}
1384
1714
  * @memberof IMusicListItem
1715
+ * @brief 音乐标题。
1385
1716
  */
1386
1717
  title?: string;
1387
- /**
1718
+ /** {zh}
1388
1719
  * @hidden
1389
1720
  */
1390
1721
  [propName: string]: any;
1391
1722
  }
1392
- /**
1393
- * @brief 循环播放配置
1723
+ /** {zh}
1724
+ * @brief AB 循环播放配置。
1394
1725
  * @list Options
1395
1726
  * @kind property
1396
1727
  */
1397
1728
  export interface IABCycle {
1398
- /**
1399
- * AB循环段开始时间
1729
+ /** {zh}
1400
1730
  * @default 0
1401
1731
  *
1402
1732
  * @type {boolean}
1403
1733
  * @memberof IABCycle
1734
+ * @brief AB 循环段开始时间,单位为秒。
1404
1735
  */
1405
1736
  start: number;
1406
- /**
1407
- * AB循环段结束时间
1737
+ /** {zh}
1408
1738
  * @default 音乐结束时间点
1409
1739
  *
1410
1740
  * @type {boolean}
1411
1741
  * @memberof IABCycle
1742
+ * @brief AB 循环段开始时间,单位为秒。
1412
1743
  */
1413
1744
  end: number;
1414
- /**
1415
- * AB段是否循环播放
1745
+ /** {zh}
1416
1746
  * @default false
1417
- *
1418
1747
  * @type {boolean}
1419
1748
  * @memberof IABCycle
1749
+ * @brief AB 段是否循环播放。
1420
1750
  */
1421
1751
  loop?: boolean;
1422
1752
  /**
@@ -1424,113 +1754,105 @@ export interface IABCycle {
1424
1754
  */
1425
1755
  [propName: string]: any;
1426
1756
  }
1427
- /**
1757
+ /** {zh}
1428
1758
  * @list Options
1429
- * @brief 音乐播放模式配置
1759
+ * @brief 音乐播放模式配置。
1430
1760
  * @kind property
1431
1761
  */
1432
1762
  export interface IMusicConfig {
1433
- /**
1434
- * 是否启用离线下载播放
1763
+ /** {zh}
1435
1764
  * @default false
1436
1765
  *
1437
1766
  * @type {boolean}
1438
1767
  * @memberof IMusicConfig
1768
+ * @brief 是否启用离线下载播放。
1439
1769
  */
1440
1770
  offline?: boolean;
1441
- /**
1442
- * AB循环设置
1771
+ /** {zh}
1443
1772
  * @default null
1444
1773
  *
1445
1774
  * @type {IABCycle}
1446
1775
  * @memberof IMusicConfig
1776
+ * @brief AB 循环播放配置。
1447
1777
  */
1448
1778
  abCycle?: IABCycle | null;
1449
- /**
1450
- * 快进快退时间跨度
1779
+ /** {zh}
1451
1780
  * @default 15
1452
1781
  *
1453
1782
  * @type {number}
1454
1783
  * @memberof IMusicConfig
1784
+ * @brief 快进快退时间跨度,单位为秒。
1455
1785
  */
1456
1786
  timeScale?: number;
1457
- /**
1458
- * 循环模式
1787
+ /** {zh}
1459
1788
  * @default order
1460
1789
  *
1461
1790
  * @type {('order' | 'sloop' | 'loop' | 'random')}
1462
1791
  * @memberof IMusicConfig
1792
+ * @brief 循环模式。
1463
1793
  */
1464
1794
  mode?: PlayModeType;
1465
- /**
1466
- * 播放列表
1795
+ /** {zh}
1467
1796
  * @default []
1468
1797
  *
1469
1798
  * @type {Array<IMusicListItem>}
1470
1799
  * @memberof IMusicConfig
1800
+ * @brief 播放列表。
1471
1801
  */
1472
1802
  list?: Array<IMusicListItem>;
1473
- /**
1803
+ /** {zh}
1474
1804
  * @hidden
1475
1805
  */
1476
1806
  [propName: string]: any;
1477
1807
  }
1478
- /**
1808
+ /** {zh}
1479
1809
  * @list Options
1480
- * @brief 播放地址列表, 可配置多线路和多清晰度
1810
+ * @brief 播放地址列表,可配置多线路和多清晰度。
1481
1811
  * @kind property
1482
1812
  *
1483
1813
  * @export
1484
1814
  * @interface Stream
1485
1815
  */
1486
1816
  export interface Stream extends Partial<IPlayInfoList> {
1487
- /**
1488
- * url类型,可以选值为“rtm”/“flv”/“mp4”/“hls”
1489
- *
1817
+ /** {zh}
1490
1818
  * @type {('rtm' | 'flv' | 'mp4' | 'hls')}
1491
1819
  * @memberof IPlayerConfig
1820
+ * @brief URL 类型,取值为:
1821
+ * - `"rtm"`
1822
+ * - `"flv"`
1823
+ * - `"mp4"`
1824
+ * - `"hls"`
1492
1825
  */
1493
1826
  streamType?: string;
1494
- /**
1495
- * 播放地址
1827
+ /** {zh}
1828
+ * @brief 播放地址
1496
1829
  *
1497
1830
  * @type {string}
1498
1831
  * @memberof IPlayerConfig
1499
1832
  */
1500
1833
  url: string;
1501
- /**
1502
- * 清晰度key
1503
- *
1834
+ /** {zh}
1504
1835
  * @type {string}
1505
1836
  * @memberof Stream
1837
+ * @brief 清晰度 key
1506
1838
  */
1507
1839
  definition?: string;
1508
- /**
1509
- * 多语言词典中对应的key, 比如 definitionTextKey: HD_TEXT_KEY
1510
- *
1511
- * languages: {
1512
- * zh: {
1513
- * HD_TEXT_KEY: '高清'
1514
- * }
1515
- * }
1516
- *
1517
- * 则清晰度切换选项显示“高清”, 不设置则显示definition的值
1518
- *
1840
+ /** {zh}
1519
1841
  * @type {string}
1520
1842
  * @memberof Stream
1843
+ * @brief 多语言词典中对应的 key。比如设置 `definitionTextKey: HD_TEXT_KEY` 以及 `languages: {zh: {HD_TEXT_KEY: '高清'}}`,则清晰度切换选项显示 “高清”。不设置则显示 `definition` 的值。
1521
1844
  */
1522
1845
  definitionTextKey?: string;
1523
- /**
1846
+ /** {zh}
1524
1847
  * @brief 编码格式
1525
1848
  * @default unknown
1526
1849
  */
1527
1850
  codec?: CodecType;
1528
- /**
1529
- * 线路唯一id
1851
+ /** {zh}
1852
+ * @brief 线路唯一 ID
1530
1853
  */
1531
1854
  lineId?: number | string;
1532
- /**
1533
- * 多语言词典中对应的key, 比如 lineTextKey: LINE_ONE
1855
+ /** {zh}
1534
1856
  * @example
1535
1857
  * ```
1536
1858
  * languages: {
@@ -1543,14 +1865,15 @@ export interface Stream extends Partial<IPlayInfoList> {
1543
1865
  *
1544
1866
  * @type {string}
1545
1867
  * @memberof Stream
1868
+ * @brief 多语言词典中对应的 key。比如 `lineTextKey: LINE_ONE`。
1546
1869
  */
1547
1870
  lineTextKey?: string;
1548
- /**
1871
+ /** {zh}
1549
1872
  * @hidden
1550
1873
  */
1551
1874
  [propName: string]: any;
1552
1875
  }
1553
- /**
1876
+ /** {zh}
1554
1877
  * @hidden
1555
1878
  */
1556
1879
  export interface Condition {
@@ -1561,9 +1884,8 @@ export interface Condition {
1561
1884
  */
1562
1885
  [propName: string]: any;
1563
1886
  }
1564
- /**
1887
+ /** {zh}
1565
1888
  * @hidden
1566
- * @description 播放器当前状态
1567
1889
  */
1568
1890
  export interface Current {
1569
1891
  definition: string;
@@ -1576,10 +1898,13 @@ export interface Current {
1576
1898
  */
1577
1899
  [propName: string]: any;
1578
1900
  }
1579
- /**
1901
+ /** {zh}
1580
1902
  * @list Options
1581
1903
  * @kind property
1582
- * @brief 实例化参数配置项
1904
+ * @brief 播放器实例化配置。
1905
+ */
1906
+ /** {en}
1907
+ * @brief Player Instance Configuration
1583
1908
  */
1584
1909
  export interface IPlayerConfig extends IPlayerOptions {
1585
1910
  /** {zh}
@@ -1589,79 +1914,86 @@ export interface IPlayerConfig extends IPlayerOptions {
1589
1914
  */
1590
1915
  isLive?: boolean;
1591
1916
  /** {zh}
1592
- * @brief 播放器容器id,VePlayer将被插入在该容器中
1593
- * @notes `id`和`root`参数至少传入 1 个。
1917
+ * @brief 播放器容器 ID。播放器将被插入在该容器中。
1594
1918
  * @default -
1919
+ * @listtip `id` 和 `root` 参数需至少传入 1 个。如果都传入,则优先使用 `root` 参数。
1595
1920
  */
1596
1921
  id?: string;
1597
1922
  /** {zh}
1598
- * @brief 播放器容器DOM元素,VePlayer将被插入在该容器中
1923
+ * @brief 播放器容器 DOM 元素。VePlayer 将被插入该容器中。
1599
1924
  * @notes `id`和`root`参数至少传入 1 个。
1600
1925
  * @default -
1926
+ * @listtip `id` 和 `root` 参数需至少传入 1 个。如果都传入,则优先使用 `root` 参数。
1601
1927
  */
1602
1928
  root?: HTMLElement;
1603
1929
  /** {zh}
1604
- * @brief 视频地址
1930
+ * @brief 视频播放地址。
1605
1931
  * @default -
1606
1932
  */
1607
1933
  url?: string;
1608
- /**
1609
- * @brief 视频点播媒资中的视频vid,推荐填写,以方便跟踪播放质量
1934
+ /** {zh}
1935
+ * @brief 视频点播服务中的视频 ID。推荐填写,以方便跟踪该视频的播放质量。您将音视频上传至视频点播服务后,可通过以下方式获取 `Vid`:
1936
+ *
1937
+ * - 在视频点播控制台获取。
1938
+ * - 通过 [GetMediaList](https://www.volcengine.com/docs/4/69205) 接口获取 `Vid`。
1939
+ * - 如果您设置了媒资上传完成的回调事件,会在 [FileUploadComplete](https://www.volcengine.com/docs/4/4655) 中返回 `Vid`。
1610
1940
  * @default -
1611
1941
  */
1612
1942
  vid?: string;
1613
1943
  /** {zh}
1614
- * @brief vid播放配置项
1615
- * @notes 需要业务方服务端通过vid生成临时playAuthToken
1616
- *
1944
+ * @brief Vid 播放配置项。应用服务端需通过 `vid` 生成临时 `playAuthToken`,下发给客户端。
1617
1945
  * @type {IPlayAuthTokenConfig}
1618
1946
  * @memberof IPlayerConfig
1619
1947
  */
1620
1948
  getVideoByToken?: IPlayAuthTokenConfig;
1621
1949
  /** {zh}
1622
- * @brief 视频格式/协议类型。取值如下:
1623
- * - `mp4`
1624
- * - `hls`
1625
- * - `dash`
1626
- * - `flv`
1627
- * @notes 如果`url`参数视频地址不包含文件格式后缀,则`streamType`必传。
1950
+ * @brief 视频格式。取值如下:
1951
+ * - `mp4`
1952
+ * - `hls`
1953
+ * - `dash`
1954
+ * - `flv`
1955
+ * @listtip 如果 `url` 参数取值中不包含文件格式后缀,则 `streamType` 必填。
1628
1956
  */
1629
1957
  streamType?: "mp4" | "hls" | "dash" | "rtm" | "flv";
1630
1958
  /** {zh}
1631
- * @brief 播放器宽度,可以是数字或者css width 属性值,是数字时单位是`px`
1959
+ * @brief 播放器宽度。可传入数字或者 CSS `width` 属性值。如为数字,单位为 px
1632
1960
  * @default 100%
1633
1961
  */
1634
1962
  width?: number | string;
1635
1963
  /** {zh}
1636
- * @brief 播放器高度,可以是数字或者css width 属性值,是数字时单位是`px`
1964
+ * @brief 播放器高度。可传入数字或者 CSS `width` 属性值。如为数字,单位为 px
1637
1965
  * @default 100%
1638
1966
  */
1639
1967
  height?: number | string;
1640
1968
  /** {zh}
1641
- * @brief 默认音量
1969
+ * @brief 默认起播音量。取值范围为 [0,1]。
1642
1970
  * @default 0.6
1643
1971
  */
1644
1972
  volume?: number;
1645
1973
  /** {zh}
1646
- * @brief 是否自动播放。取值如下:
1647
- * - `true`:是
1648
- * - `false`:否
1974
+ * @brief 是否开启自动播放。取值如下:
1975
+ * - `true`:是
1976
+ * - `false`:否
1649
1977
  * @default false
1650
1978
  * @notice 受限制于浏览器策略,自动播放不一定能成功,取决于浏览器环境、用户行为、浏览器配置等,详细参考自动播放 @link https://www.volcengine.com/docs/4/68693#%E8%87%AA%E5%8A%A8%E6%92%AD%E6%94%BE
1979
+ * @listtip 受限于浏览器策略,自动播放不一定能成功,取决于浏览器环境、用户行为、浏览器配置等。详情请参考[自动播放](https://www.volcengine.com/docs/4/68693#%E8%87%AA%E5%8A%A8%E6%92%AD%E6%94%BE)。
1651
1980
  */
1652
1981
  autoplay?: boolean;
1982
+ /** {zh}
1983
+ * @brief 视频封面图片的 URL。
1984
+ */
1653
1985
  poster?: string | IPoster;
1654
1986
  /** {zh}
1655
1987
  * @brief 是否开启静音自动播放。取值如下:
1656
- * - `true`:是
1657
- * - `false`:否
1988
+ * - `true`:开启静音自动播放。
1989
+ * - `false`:关闭静音自动播放。
1658
1990
  * @default false
1659
1991
  */
1660
1992
  autoplayMuted?: boolean;
1661
1993
  /** {zh}
1662
- * @brief 有声音自动播放失败时是否降级成静音自动播放,默认不降级
1663
- * - `true`:是,降级
1664
- * - `false`:否,不降级
1994
+ * @brief 是否开启降级静音自动播放。开启后,有声音自动播放失败时,会降级成静音自动播放。取值如下:
1995
+ * - `true`:开启降级静音自动播放
1996
+ * - `false`:关闭降级静音自动播放
1665
1997
  * @default false
1666
1998
  */
1667
1999
  enableDegradeMuteAutoplay?: boolean;
@@ -1670,84 +2002,88 @@ export interface IPlayerConfig extends IPlayerOptions {
1670
2002
  * - `true`:是,降级
1671
2003
  * - `false`:否,不降级
1672
2004
  * @default false
2005
+ * @hidden
2006
+ */
2007
+ /** {en}
2008
+ * @hidden
1673
2009
  */
1674
2010
  enableWxJsBridgeAutoplay?: boolean;
1675
2011
  /** {zh}
1676
- * @brief 开启任意点击的用户行为触发自动播放,默认不开启
1677
- * - `true`:是,开启
1678
- * - `false`:否,不开启
2012
+ * @brief 是否开启任意用户行为触发自动播放。开启后,第一次用户的任意点击可以触发播放器的自动播放。取值如下:
2013
+ * - `true`:开启
2014
+ * - `false`:不开启
1679
2015
  * @default false
1680
2016
  */
1681
2017
  enableUserActionAutoplay?: boolean;
1682
2018
  /** {zh}
1683
- * @brief 是否开启循环播放。
1684
- * - `true`:是,开启
1685
- * - `false`:否,不开启
2019
+ * @brief 是否开启循环播放。取值如下:
2020
+ * - `true`:开启循环播放。
2021
+ * - `false`:关闭循环播放。
1686
2022
  * @default false
1687
2023
  */
1688
2024
  loop?: boolean;
1689
2025
  /** {zh}
1690
- * @brief 默认起播倍速。参考值 0.5/0.75/1/1.5/2
2026
+ * @brief 默认起播倍速。可设为 `0.5`、`0.75`、`1`、`1.5`、`2`。
1691
2027
  * @default 1
1692
2028
  */
1693
2029
  defaultPlaybackRate?: number;
1694
2030
  /** {zh}
1695
- * @brief 国际化语言。支持自定义,默认语言类型包括:
1696
- * - `zh` 或 `zh-cn`
1697
- * - `en`
1698
- * - `jp`
1699
- * - `zh-hk`
2031
+ * @brief 界面语言。取值如下:
2032
+ * - `zh` 或 `zh-cn`
2033
+ * - `en`
2034
+ * - `jp`
2035
+ * - `zh-hk`
1700
2036
  * @default zh
1701
2037
  */
1702
2038
  lang?: "zh" | "zh-cn" | "en" | "jp" | "zh-hk";
1703
2039
  /** {zh}
1704
- * @brief 自定义多语言词典。可设置每个语种的词典 `{ [key: string]: Object; }`。例如:
1705
- * ```javascript
1706
- * {
1707
- * zh: {
1708
- * PIP: '画中画'
1709
- * },
1710
- * en: {
1711
- * PIP: 'pip'
1712
- * }
1713
- * }
1714
- * ```
2040
+ * @brief 多语言词典。可设置每个语种的词典,例如:
2041
+ * ```javascript
2042
+ * { zh: { PIP: '画中画' }, en: { PIP: 'pip' }}
2043
+ * ```
1715
2044
  * @notice
1716
2045
  * @see 了解更多,请参见{@link https://www.volcengine.com/docs/6469/127529 默认词典}。
2046
+ * @listtip 了解更多,请参见[默认词典](https://www.volcengine.com/docs/6469/127529)。
1717
2047
  */
1718
2048
  languages?: {
1719
2049
  [key: string]: Record<string, any>;
1720
2050
  };
1721
2051
  /** {zh}
1722
- * @brief 画中画配置
2052
+ * @brief 画中画配置。
1723
2053
  * @default PC: {position: 'controlsRight', index: 2.5, showIcon: true}; mobile:false
1724
2054
  * @notice 画中画功能由浏览器提供,如果本身浏览器不支持,即使有该配置也不显示画中画按钮
2055
+ * @listtip 画中画功能由浏览器提供。如果浏览器不支持,即使传入此配置也不会显示画中画按钮。
1725
2056
  */
1726
2057
  pip?: IPIPConfig | boolean;
1727
2058
  /** {zh}
1728
- * @brief 全屏相关配置
2059
+ * @brief 全屏配置。
1729
2060
  * @default {position: 'controlsRight', index: 0, rotateFullscreen: false, useCssFullscreen: false, target: null, switchCallback: null, disable: false, needBackIcon: false }
1730
2061
  */
1731
2062
  fullscreen?: IFullscreenConfig;
1732
2063
  /** {zh}
1733
2064
  * @breif 是否总是显示清晰度切换控件,即只有一个清晰度时也显示清晰度切换控件
1734
2065
  * @default false
2066
+ * @brief 是否总是显示清晰度切换控件,即只有单个清晰度时也显示清晰度切换控件。
1735
2067
  */
1736
2068
  alwaysShowDefinition?: boolean;
1737
2069
  /** {zh}
1738
2070
  * @breif url对应视频的清晰度文案,仅`alwaysShowDefinition`为`true`时有效
1739
2071
  * @default HD
2072
+ * @listtip 仅 `alwaysShowDefinition` 为 `true` 时有效。
2073
+ * @brief `url` 参数对应视频的清晰度文案。
1740
2074
  */
1741
2075
  definitionText?: string;
1742
2076
  /** {zh}
1743
- * @brief url对应视频的清晰度文案的多语言key,对应参数 languages 中相对应的文案,仅alwaysShowDefinition为true时有效,优先级高于definitionText
2077
+ * @brief `url` 参数对应视频的清晰度文案的多语言 key,对应参数 `languages` 中的文案。
1744
2078
  * @default -
2079
+ * @listtip 仅 `alwaysShowDefinition` 为 `true` 时有效,优先级高于 `definitionText`。
1745
2080
  */
1746
2081
  definitionTextKey?: string;
1747
2082
  /** {zh}
1748
- * @brief 视频编码方式
1749
- * 软解useSoftDecoding设置为true时,提供codec可提升软解初始效率
2083
+ * @brief 视频编码格式。
1750
2084
  * @notice 在已知视频编码方式的情况下推荐传入,以方便日志分析
2085
+ * @listtip - 在已知视频编码方式的情况下推荐传入,以便日志分析。
2086
+ * - 在 `useSoftDecoding` 参数为 `true`(开启 H.265 兼容降级模式)时,建议传入,可提升软解初始效率。
1751
2087
  */
1752
2088
  codec?: `${CodecType}`;
1753
2089
  /** {zh}
@@ -1763,7 +2099,7 @@ export interface IPlayerConfig extends IPlayerOptions {
1763
2099
  */
1764
2100
  region?: TRegionType;
1765
2101
  /** {zh}
1766
- * @brief 插件加载公共路径,用于指定插件的加载路径,或者本地文件服务加载插件
2102
+ * @brief 插件加载的路径。您可从 [SDK 离线包](https://www.volcengine.com/docs/4/67077#%E5%BC%95%E5%85%A5%E4%BE%9D%E8%B5%96)中获取插件,然后将插件文件放置于应用服务器上,再在初始化播放器时指定插件地址。
1767
2103
  * @default https://lf-unpkg.volccdn.com/obj/vcloudfe/sdk/@volcengine/veplayer/${version}/plugin
1768
2104
  * @notice 可将插件文件夹置于业务方服务器上,指定插件的地址即可
1769
2105
  */
@@ -1774,84 +2110,78 @@ export interface IPlayerConfig extends IPlayerOptions {
1774
2110
  */
1775
2111
  pluginPublicPath?: string;
1776
2112
  /**
1777
- * @brief 开始播放时间
1778
- * @default -
2113
+ * @brief 起播时间,单位为秒。
2114
+ * @default 0
1779
2115
  */
1780
2116
  startTime?: number;
1781
2117
  /** {zh}
1782
- * @brief 为播放器设置是否启用内联播放模式。playsinline 属性是 HTML5 视频标签的一个属性,用于指定视频是否应在页面文档内播放。
1783
- * - `true`:启用,表示视频将在页面文档内播放;
1784
- * - `false`:停用,默认浏览器播放行为。</br>
1785
- *
1786
- * 该配置项只在移动端生效,当取值为 true 的时候,会在初始化 video 或 audio 对象的时候,将 playsinline、webkit-playsinline、x5-playsinline 三个属性设置为 true,请参考 [New Policies for iOS](https://webkit.org/blog/6784/new-video-policies-for-ios/) 了解内联模式相关知识。
1787
- * @listtip
1788
- * - iOS 10 及以上系统 Safari 浏览器支持配置内联播放模式;
1789
- * - iOS 10 以下系统 Safari 浏览器不支持配置内联播放模式 ,默认播放即进入系统全屏。
2118
+ * @brief 是否启用内联播放模式。`playsinline` 属性是 HTML5 视频标签的一个属性,用于指定视频是否应在页面文档内播放。
2119
+ * - `true`:启用内联播放模式,表示视频将在页面文档内播放。
2120
+ * - `false`:禁用内联播放模式。</br>
2121
+ * @listtip 此参数仅在在移动端生效。此参数取值为 `true` 时,会在初始化 `video` 或 `audio` 对象的时候,将 `playsinline`、`webkit-playsinline`、`x5-playsinline` 三个属性设置为 `true`,请参考 [New Policies for iOS](https://webkit.org/blog/6784/new-video-policies-for-ios/) 了解内联播放模式相关知识。iOS 上内联播放模式的支持情况如下:
2122
+ * - iOS 10 及以上系统 Safari 浏览器支持配置内联播放模式。
2123
+ * - iOS 10 以下系统 Safari 浏览器不支持配置内联播放模式,默认播放即进入系统全屏。
1790
2124
  * @default true
1791
2125
  */
1792
2126
  playsinline?: boolean;
1793
2127
  /** {zh}
1794
- * @brief 为播放器设置 video 标签扩展属性,初始化时会设置在 videoElement 或 audioElement 对象上,请参考 [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#properties) 查看其支持的属性配置。
2128
+ * @brief `video` 标签扩展属性。播放器初始化时会设置在 `videoElement``audioElement` 对象上。请参考 [HTMLMediaElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#properties) 查看支持的属性。
1795
2129
  * @default 无
1796
2130
  */
1797
2131
  videoAttributes?: Partial<HTMLVideoElement>;
1798
2132
  /** {zh}
1799
- * @brief 为播放器设置是否启用流式布局,启用流式布局后播放器会根据屏幕的宽度进行调整,保持在不同屏幕尺寸上都有良好的显示效果。
1800
- * - `true`:启用
1801
- * - `false`:停用
1802
- * @listtip
1803
- * 启用流式布局时:
1804
- * - 如果 `width` 和 `height` `Number` 类型,则按照其数值计算播放器宽高比;
1805
- * - 如果 `width` 和 `height` 不是 `Number` 类型,默认使用 16:9 比例。
2133
+ * @brief 是否启用流式布局。启用流式布局后,播放器会根据屏幕宽度进行自适应调整,以确保在不同屏幕尺寸上都能呈现良好的显示效果。取值如下:
2134
+ * - `true`:启用流式布局
2135
+ * - `false`:停用流式布局
2136
+ * @listtip 启用流式布局时,播放器的宽高比与 `width` 和 `height` 的取值有关,具体如下:
2137
+ * - 如果 `width` 和 `height` 是 `Number` 类型,则按照其数值计算播放器宽高比。
2138
+ * - 如果 `width` 和 `height` 不是 `Number` 类型,默认使用 16:9 比例。
1806
2139
  * @default false
1807
2140
  */
1808
2141
  fluid?: boolean;
1809
2142
  /** {zh}
1810
- * @brief 为播放器设置尺寸适配方式,在视频资源初始化之后,根据获取到的 videoWidth 和 videoHeight 值对播放器容器宽高比例进行调整,可选项有:
1811
- * - `fixed`: 保持容器宽/高,不做适配;
1812
- * - `fixWidth`: 保持容器宽度,适配高度;
1813
- * - `fixHeight`: 保持容器高度,适配宽度。
1814
- *
2143
+ * @brief 尺寸适配方式。在视频资源初始化之后,根据获取到的 `videoWidth``videoHeight` 的值对播放器容器宽高比进行调整。取值如下:
2144
+ * - `fixed`: 保持容器宽高比,不进行适配。
2145
+ * - `fixWidth`: 保持容器宽度,仅适配高度。
2146
+ * - `fixHeight`: 保持容器高度,仅适配宽度。
1815
2147
  * @default fixed
1816
2148
  */
1817
2149
  fitVideoSize?: "fixWidth" | "fixHeight" | "fixed";
1818
2150
  /** {zh}
1819
- * @brief 为播放器设置视频画面填充模式,可选项有:
1820
- * - `fillwidth`: 填充宽度,高度溢出则裁剪高度;
1821
- * - `fillHeight`: 填充高度,宽度溢出则裁剪宽度;
1822
- * - `fill`: 拉伸视频以填充容器;
1823
- * - `cover`: 保持其宽高比的同时填充元素的整个内容框;
1824
- * - `auto`: 使用浏览器默认的视频画面填充模式。
2151
+ * @brief 视频画面填充模式。取值如下:
2152
+ * - `fillwidth`: 填充宽度,高度溢出则裁剪高度。
2153
+ * - `fillHeight`: 填充高度,宽度溢出则裁剪宽度。
2154
+ * - `fill`: 拉伸视频以填充容器。
2155
+ * - `cover`: 保持视频宽高比的同时填充元素的整个内容框。
2156
+ * - `auto`: 使用浏览器默认的视频画面填充模式。
1825
2157
  * @default auto
1826
2158
  */
1827
2159
  videoFillMode?: "auto" | "fillHeight" | "fillWidth" | "fill" | "cover";
1828
2160
  /** {zh}
1829
- * @brief 是否开启画面和控制栏分离模式。设置为开启时,控制栏将会常驻,与视频画面不重叠。
1830
- * - `true`:开启
1831
- * - `false`:关闭
2161
+ * @brief 是否开启画面和控制栏分离模式。开启时,控制栏将会常驻,与视频画面不重叠。
2162
+ * - `true`:开启
2163
+ * - `false`:关闭
1832
2164
  * @default false
1833
2165
  */
1834
2166
  marginControls?: boolean;
1835
2167
  /** {zh}
1836
- * @brief 启用x5内核浏览器的同层播放。
2168
+ * @brief 是否启用 X5 内核浏览器的同层播放。
1837
2169
  * @default 无
1838
2170
  */
1839
2171
  "x5-video-player-type"?: string;
1840
2172
  /** {zh}
1841
- * @brief 是否启用x5内核浏览器的全屏播放模式。
1842
- * - `true`:启用
1843
- * - `false`:停用
2173
+ * @brief 是否启用 X5 内核浏览器的全屏播放模式。
2174
+ * - `true`:启用
2175
+ * - `false`:停用
1844
2176
  * @default 无
1845
2177
  */
1846
2178
  "x5-video-player-fullscreen"?: boolean;
1847
2179
  /** {zh}
1848
- * @brief x5内核浏览器的横竖屏控制,支持如下取值:
1849
- * - `landscape`:横屏
1850
- * - `portrait`:竖屏
1851
- * - `landscape|portrait`:跟随手机自动旋转
1852
- * @default
1853
- * - mobile:`landscape|portrait`
1854
- * - pc:-
2180
+ * @brief X5 内核浏览器的横竖屏控制。取值如下:
2181
+ * - `landscape`:横屏
2182
+ * - `portrait`:竖屏
2183
+ * - `landscape|portrait`:跟随手机自动旋转
2184
+ * @default `landscape|portrait`(移动端)
1855
2185
  */
1856
2186
  "x5-video-orientation"?: "landscape" | "portrait" | "landscape|portrait";
1857
2187
  /** {zh}
@@ -1861,8 +2191,10 @@ export interface IPlayerConfig extends IPlayerOptions {
1861
2191
  */
1862
2192
  commonStyle?: ICommonStyle;
1863
2193
  /** {zh}
1864
- * @brief 是否启用音乐播放器模式
1865
- * @default `false`
2194
+ * @brief 是否开启音乐播放模式。开启后,您可还通过 `music` 参数对音乐播放器进行配置。取值如下:
2195
+ * - `true`:开启音乐播放模式
2196
+ * - `false`:停用音乐播放模式
2197
+ * @default false
1866
2198
  */
1867
2199
  isMusic?: boolean;
1868
2200
  /** {zh}
@@ -1875,36 +2207,39 @@ export interface IPlayerConfig extends IPlayerOptions {
1875
2207
  */
1876
2208
  enableContextmenu?: boolean;
1877
2209
  /** {zh}
1878
- * @brief 是否关闭video上的阻止事件传播
1879
- * @default `false`
2210
+ * @brief 是否关闭 `video` 标签的事件冒泡。取值如下:
2211
+ *
2212
+ * - `true`:关闭。
2213
+ * - `false`:开启。
2214
+ * @default false
1880
2215
  */
1881
2216
  closeVideoStopPropagation?: boolean;
1882
2217
  /** {zh}
1883
- * @brief 右键菜单是否可用
1884
- * @default `false`
2218
+ * @brief 是否开启右键菜单。取值如下:
2219
+ * - `true`:是。
2220
+ * - `false`:否。
2221
+ * @default false
1885
2222
  */
1886
2223
  enableMenu?: boolean;
1887
2224
  /** {zh}
1888
- * @brief 是否开启hls的MSE模式,
2225
+ * @brief 是否开启 HLS 视频的 MSE 模式。仅移动端生效。默认情况下,在移动端使用原生`video 播放 HLS 视频。开启后,将采用 MSE 方式播放 HLS 视频,实现更好的兼容性、能控制缓存、节省流量。
1889
2226
  * @notice 仅移动端生效,开启后采用MSE方式播放HLS,默认在移动端使用原生video播放hls
1890
2227
  */
1891
2228
  enableHlsMSE?: boolean;
1892
2229
  /** {zh}
1893
- * @brief 在PC Safari上是否使用hls插件播放
1894
- * - true: 使用;
1895
- * - false: 不使用
1896
- * @default `true`
2230
+ * @brief 在 PC Safari 上是否 HLS 插件播放视频。取值如下:
2231
+ * - `true`:使用 HLS 插件。SDK 会自动加载 HLS 插件。
2232
+ * - `false`:不使用 HLS 插件。
2233
+ * @default true
1897
2234
  */
1898
2235
  useHlsPluginForSafari?: boolean;
1899
2236
  /** {zh}
1900
- * @brief 是否开启mp4的MSE模式,开启后采用MSE方式播放MP4
1901
- * mp4的MSE模式具有精确的seek加载、视频的无缝切换、流量节省等功能
1902
- * @default `false`
2237
+ * @brief 是否开启 MP4 视频的 MSE 模式。开启后,将采用 MSE 方式播放 MP4,实现精确的 Seek 加载、视频的无缝切换、流量节省等功能。
2238
+ * @default false
1903
2239
  */
1904
2240
  enableMp4MSE?: boolean;
1905
2241
  /** {zh}
1906
- * @brief 播放列表
1907
- * @notes url和playList必填一个,二者都传入时, url必须在playList中。
2242
+ * @brief 播放地址列表。
1908
2243
  * @default -
1909
2244
  */
1910
2245
  playList?: Stream[];
@@ -1914,7 +2249,7 @@ export interface IPlayerConfig extends IPlayerOptions {
1914
2249
  */
1915
2250
  plugins?: any[];
1916
2251
  /** {zh}
1917
- * @brief 忽略加载的插件,用于禁用默认加载的插件,传入插件名称数组,名称不区分大小写
2252
+ * @brief 用于禁用插件。VePlayer 内置了一些常用的功能插件。如需禁用某一内置插件,可传入插件名称(不区分大小写)。
1918
2253
  * @default []
1919
2254
  */
1920
2255
  ignores?: string[];
@@ -1929,9 +2264,17 @@ export interface IPlayerConfig extends IPlayerOptions {
1929
2264
  */
1930
2265
  isMobile?: boolean;
1931
2266
  /** {zh}
1932
- * @brief umd插件依赖备用地址
1933
- * 用于依赖的插件所在CDN发生网络错误时的进行安全降级的备用地址,可以是相对地址
1934
- * 支持的依赖有hls(非加密hls播放)、flv(flv播放)、XGVideo(软解播放)、hlsEncrypt(加密hls播放)、dash(dash播放)、mp4Encrypt(加密np4播放)、danmujs(弹幕)、danmuMask(蒙版弹幕)、subtitle(外挂字幕)
2267
+ * @brief UMD 依赖备用地址。用于依赖的 CDN 发生网络错误时的降级备用地址。支持的依赖如下:
2268
+ *
2269
+ * - `hls`:非加密 HLS 播放。
2270
+ * - `flv`:FLV 播放。
2271
+ * - `XGVideo`:软解播放。
2272
+ * - `hlsEncrypt`:加密 HLS 播放。
2273
+ * - `dash`:DASH 播放。
2274
+ * - `mp4Encrypt`:加密 MP4 播放。
2275
+ * - `danmujs`:弹幕。
2276
+ * - `danmuMask`:蒙版弹幕。
2277
+ * - `subtitle`:外挂字幕。
1935
2278
  * @example 以配置hls插件的备用地址为例
1936
2279
  * ```
1937
2280
  * const playerSdkIns = new VePlayer({
@@ -1947,18 +2290,28 @@ export interface IPlayerConfig extends IPlayerOptions {
1947
2290
  */
1948
2291
  umdUrlMap?: Record<string, string>;
1949
2292
  /**
1950
- * @brief 唯一id,用于私有DRM加密
2293
+ * @brief 唯一 ID,用于[私有加密方案](https://www.volcengine.com/docs/4/106524)。
1951
2294
  * @default -
1952
2295
  */
2296
+ /** {en}
2297
+ */
1953
2298
  unionId?: string;
1954
2299
  /** {zh}
1955
- * @brief 是否启用软解
1956
- * @default `false`
2300
+ * @brief 是否启用软解。取值如下:
2301
+ *
2302
+ * - `true`:启用。
2303
+ * - `false`:不启用。
2304
+ * @default false
2305
+ * @listtip - 移动端浏览器不支持 FLV 格式,如果需要播放该格式的视频,请开启软解。
2306
+ * - 软解播放的解码操作依赖设备 CPU,播放高码率、高分辨率的视频时,对 CPU 占用率较高。
1957
2307
  */
1958
2308
  useSoftDecoding?: boolean;
1959
2309
  /** {zh}
1960
- * @brief 是否开H265播放降级,即H.265硬解不支持时自动降级为软解
1961
- * @default `false`
2310
+ * @brief 是否开启 H.265 自动降级模式。开启 H.265 兼容模式后,VePlayer 会在不支持 H.265 硬解的浏览器环境下,自动降级为兼容模式。取值如下:
2311
+ *
2312
+ * - `true`:开启 H.265 自动降级模式。
2313
+ * - `false`:不开启 H.265 自动降级模式。
2314
+ * @default false
1962
2315
  */
1963
2316
  enableH265Degrade?: boolean;
1964
2317
  /** {zh}
@@ -1968,7 +2321,7 @@ export interface IPlayerConfig extends IPlayerOptions {
1968
2321
  */
1969
2322
  onMediaExpired?: () => Promise<IPlayerConfig>;
1970
2323
  /** {zh}
1971
- * @brief playAuthToken过期时的回调函数,用来更新playAuthToken
2324
+ * @brief `playAuthToken` 过期时的回调函数,可用来更新 `playAuthToken`。
1972
2325
  * @default -
1973
2326
  */
1974
2327
  onTokenExpired?: () => Promise<IPlayAuthTokenConfig>;
@@ -1993,7 +2346,13 @@ export interface IPlayerConfig extends IPlayerOptions {
1993
2346
  */
1994
2347
  disableVodLogOptsCheck?: boolean;
1995
2348
  /** {zh}
1996
- * @brief 播放器报错展示配置, 可以配置播放异常时的播放器显示的异常文案、图片,以及是否提供刷新按钮等
2349
+ * @hidden
2350
+ * @brief 是否打开日志打印
2351
+ * @default false
2352
+ */
2353
+ debug?: boolean;
2354
+ /** {zh}
2355
+ * @brief 播放器报错信息。支持配置播放异常时显示的异常文案、图片以及是否提供刷新按钮等。
1997
2356
  * @default -
1998
2357
  */
1999
2358
  sdkErrorPlugin?: ISdkErrorConfig;
@@ -2001,188 +2360,201 @@ export interface IPlayerConfig extends IPlayerOptions {
2001
2360
  * @brief rtm配置,配置rtm拉流参数
2002
2361
  * @notes 传入rtm流url时才生效
2003
2362
  * @default -
2363
+ * @hidden
2004
2364
  */
2005
2365
  rtm?: IRtmConfig;
2006
- /**
2007
- * @brief 弹幕及面板配置,可配置弹幕的一些参数,如弹幕文字大小、透明度、展示区域等
2366
+ /** {zh}
2367
+ * @brief 弹幕及面板配置。支持配置弹幕文字大小、透明度、展示区域等参数。
2008
2368
  * @default -
2009
2369
  */
2010
2370
  DanmuPlugin?: IDanmuConfig | boolean;
2011
- /**
2371
+ /** {zh}
2012
2372
  * @brief 清晰度自动降级配置
2013
2373
  * @hidden
2014
2374
  * @notes 需要先引入DefinitionDemotePlugin插件,plugins: [VePlayer.DefinitionDemotePlugin]
2015
2375
  */
2016
2376
  DefinitionDemotePlugin?: IDefinitionDemotePlugin;
2017
- /**
2377
+ /** {zh}
2018
2378
  * @hidden
2019
2379
  * @brief DASH 播放配置项
2020
2380
  * @default -
2021
2381
  */
2022
2382
  DASHPlugin?: Partial<IDashPluginConfig>;
2023
- /**
2024
- * @brief HLS 加密播放配置项
2383
+ /** {zh}
2384
+ * @brief HLS 加密播放配置。
2025
2385
  * @default -
2026
2386
  */
2027
2387
  EncryptHlsPlugin?: Partial<IEncryptHlsPluginConfig> | boolean;
2028
- /**
2029
- * @brief 质量日志配置项
2388
+ /** {zh}
2389
+ * @brief 质量日志上报配置
2030
2390
  * @default -
2031
2391
  */
2032
2392
  vodLogOpts?: Partial<IVodLogOptsConfig>;
2033
- /**
2393
+ /** {zh}
2034
2394
  * @hidden
2035
2395
  * @brief mp4加密播放配置项
2036
2396
  * @default -
2037
2397
  */
2038
2398
  Mp4EncryptPlayer?: Partial<IMp4EncryptPlayerConfig> | boolean;
2039
- /**
2399
+ /** {zh}
2040
2400
  * @hidden
2041
2401
  * @brief 自适应码率配置项
2042
2402
  * @default -
2043
2403
  */
2044
2404
  autoBitrateOpts?: IAutoBitrateOptsConfig;
2045
- /**
2046
- * @brief 外挂字幕配置项
2405
+ /** {zh}
2406
+ * @brief 外挂字幕配置。
2047
2407
  * @default -
2048
2408
  */
2049
2409
  Subtitle?: ISubtitleConfig;
2050
- /**
2051
- * 记忆播放配置项
2410
+ /** {zh}
2052
2411
  * @type {IMemoryPlayConfig}
2053
2412
  * @memberof IPlayerConfig
2413
+ * @brief 记忆播放配置。
2054
2414
  */
2055
2415
  MemoryPlay?: IMemoryPlayConfig | boolean;
2056
- /**
2057
- * 音乐播放器配置项
2416
+ /** {zh}
2058
2417
  * @type {IMusicConfig}
2059
2418
  * @memberof IPlayerConfig
2419
+ * @brief 音乐播放器配置。
2060
2420
  */
2061
2421
  music?: IMusicConfig;
2062
- /**
2063
- * 自动播放配置
2422
+ /** {zh}
2064
2423
  * @type {IMusicConfig}
2065
2424
  * @memberof IPlayerConfig
2425
+ * @brief 自动播放配置。
2066
2426
  */
2067
2427
  AutoplayPlugin?: IAutoplayPluginConfig;
2068
- /**
2069
- * 播放列表配置
2428
+ /** {zh}
2070
2429
  * @type { IPlayListConfig }
2071
2430
  * @memberof IPlayerConfig
2431
+ * @brief 播放列表配置。
2072
2432
  */
2073
2433
  playListPlugin?: IPlayListConfig;
2074
2434
  }
2075
- /**
2076
- * @brief初始配置
2435
+ /** {zh}
2077
2436
  * @hidden
2078
2437
  */
2079
2438
  export interface IDefaultConfig {
2080
- /**
2081
- * “点播”还是“直播”
2439
+ /** {zh}
2440
+ * @brief “点播”还是“直播”
2082
2441
  *
2083
2442
  * @type {('live' | 'vod')}
2084
2443
  * @memberof IPlayerConfig
2085
2444
  */
2086
2445
  type?: "live" | "vod";
2087
- /**
2088
- * 是否是直播
2446
+ /** {zh}
2447
+ * @brief 是否是直播
2089
2448
  *
2090
2449
  * @type {boolean}
2091
2450
  * @memberof IPlayerConfig
2092
2451
  */
2093
2452
  isLive?: boolean;
2094
- /**
2095
- * 线路唯一key
2453
+ /** {zh}
2454
+ * @brief 线路唯一key
2096
2455
  *
2097
2456
  * @type {(number | string)}
2098
2457
  * @memberof Stream
2099
2458
  */
2100
2459
  lineId?: number | string;
2101
- /**
2102
- * 清晰度选择
2460
+ /** {zh}
2461
+ * @brief 清晰度选择
2103
2462
  *
2104
2463
  * @type {string}
2105
2464
  * @memberof Stream
2106
2465
  */
2107
2466
  definition?: string;
2108
- /**
2109
- * 开始播放时间
2467
+ /** {zh}
2468
+ * @brief 开始播放时间
2110
2469
  *
2111
2470
  * @type {number}
2112
2471
  * @memberof IDefaultConfig
2113
2472
  */
2114
2473
  startTime?: number;
2115
- /**
2116
- * 音量
2474
+ /** {zh}
2475
+ * @brief 音量
2117
2476
  *
2118
2477
  * @type {number}
2119
2478
  * @memberof IDefaultConfig
2120
2479
  */
2121
2480
  volume?: number;
2122
- /**
2123
- * 弹幕插件配置
2481
+ /** {zh}
2482
+ * @brief 弹幕插件配置
2124
2483
  *
2125
2484
  * @type {*}
2126
2485
  * @memberof IDefaultConfig
2127
2486
  */
2128
2487
  DanmuPlugin?: any;
2129
- /**
2130
- * 字幕插件配置
2488
+ /** {zh}
2489
+ * @brief 字幕插件配置
2131
2490
  *
2132
2491
  * @type {*}
2133
2492
  * @memberof IDefaultConfig
2134
2493
  */
2135
2494
  LiveSubtitlesIconPlugin?: any;
2136
2495
  }
2137
- /**
2138
- * @brief vid播放配置信息
2496
+ /** {zh}
2497
+ * @brief Vid 播放配置。
2139
2498
  * @list Options
2140
2499
  * @kind property
2141
2500
  */
2142
2501
  export interface IPlayAuthTokenConfig {
2143
2502
  /** {zh}
2144
- * @brief 服务端生成的临时播放凭证。
2503
+ * @brief 应用服务端生成的临时播放凭证。
2145
2504
  * @default -
2146
2505
  */
2147
2506
  playAuthToken: string;
2148
2507
  /** {zh}
2149
- * @brief 默认清晰度
2508
+ * @brief 默认清晰度。对应 [GetPlayInfo](https://www.volcengine.com/docs/4/2918) 接口返回的 `Definition`。为空时默认为接口返回的最高清晰度。
2150
2509
  * @default -
2151
- * @notes 为空时默认为最大码率的清晰度
2152
2510
  */
2153
2511
  defaultDefinition?: string;
2154
2512
  /** {zh}
2155
2513
  * @brief 获取播放地址的请求域名。
2156
2514
  * @default`https://vod.volcengineapi.com`
2515
+ * @default https://vod.volcengineapi.com
2157
2516
  */
2158
2517
  /** {en}
2159
2518
  * @brief Get the requested domain name of the playback address
2160
- * @default `https://vod.byteplusapi.com`
2519
+ * @default https://vod.byteplusapi.com
2161
2520
  */
2162
2521
  playDomain?: string;
2163
2522
  /** {zh}
2164
- * @brief 是否启用控制台设置的封面图
2165
- * @default `false`
2523
+ * @brief 是否使用您在视频点播控制台上设置的封面图。 取值如下:
2524
+ *
2525
+ * - `false`:否。
2526
+ * - `true`:是。
2527
+ * @default false
2528
+ * @listtip 请确保您已在视频点播控制台中生成和设置封面图,详见[封面图和封面候选](https://www.volcengine.com/docs/4/5335)。
2166
2529
  */
2167
2530
  needPoster?: boolean;
2168
2531
  /** {zh}
2169
- * @brief 是否启用控制台设置的截图中的雪碧图
2170
- * @default `false`
2532
+ * @brief 是否使用您在视频点播控制台上生成的雪碧图。取值如下:
2533
+ *
2534
+ * - `false`:否。
2535
+ * - `true`:是。
2536
+ * @default false
2537
+ * @listtip 请确保您已通过视频点播媒体处理服务生成雪碧图,详见[雪碧图](https://www.volcengine.com/docs/4/1171758)。
2171
2538
  */
2172
2539
  needThumbs?: boolean;
2173
2540
  /** {zh}
2174
- * @brief 是否启用控制台设置的蒙版弹幕
2175
- * @default `false`
2541
+ * @brief 是否使用您在视频点播控制台上生成的蒙版弹幕。取值如下:
2542
+ *
2543
+ * - `false`:否。
2544
+ * - `true`:是。
2545
+ * @default false
2546
+ * @listtip 请确保您已通过视频点播媒体处理服务生成蒙版弹幕。
2176
2547
  */
2177
2548
  needBarrageMask?: boolean;
2178
2549
  /** {zh}
2179
- * @brief 是否需要多清晰度
2180
- * @default `true`
2550
+ * @brief 是否需要获取展示多个清晰度。
2551
+ * @default true
2181
2552
  */
2182
2553
  needDefinitionList?: boolean;
2183
2554
  /** {zh}
2184
2555
  * @briefhls标准加密播放所需要的keyToken
2185
2556
  * @default -
2557
+ * @brief 用于 HLS 标准加密播放的 keyToken。
2186
2558
  */
2187
2559
  keyToken?: string;
2188
2560
  /** {zh}
@@ -2192,11 +2564,10 @@ export interface IPlayAuthTokenConfig {
2192
2564
  */
2193
2565
  getKeyType?: string;
2194
2566
  /** {zh}
2195
- * @brief 获取`PrivateDrmAuthToken`的异步回调,
2196
- * 回调入参:
2197
- * - `playAuthIds`: 视频的密钥 KeyID,对应OpenAPI GetPlayInfo{@link https://www.volcengine.com/docs/4/2918#%E8%AF%B7%E6%B1%82%E8%AF%B4%E6%98%8E} 返回视频信息中的PlayAuthId,当有多个KeyID时以英文逗号相连
2198
- * - `vid`: 视频vid
2199
- * - `unionInfo`: 由`unionId`生成的`unionInfo`,以用来加密`PrivateDrmAuthToken`
2567
+ * @brief 获取 `PrivateDrmAuthToken` 的异步回调,回调入参为:
2568
+ * - `playAuthIds`: 视频的密钥 ID,对应 [GetPlayInfo](https://www.volcengine.com/docs/4/2918) 接口返回的 `PlayAuthId`。有多个 Key ID 时以英文逗号隔开。
2569
+ * - `vid`: 视频 ID
2570
+ * - `unionInfo`: 由 `unionId` 生成的 `unionInfo`,用来加密`PrivateDrmAuthToken`。
2200
2571
  * @default -
2201
2572
  */
2202
2573
  getDrmAuthToken?: (playAuthIds: string, vid: string, unionInfo: string) => Promise<string>;
@@ -2208,8 +2579,7 @@ export interface IPlayAuthTokenConfig {
2208
2579
  */
2209
2580
  reqParams?: Record<string, number | string | boolean>;
2210
2581
  /** {zh}
2211
- * @brief 定义清晰度的映射
2212
- *
2582
+ * @brief 定义清晰度的映射。
2213
2583
  * @example 如:
2214
2584
  * ``` javascript
2215
2585
  * {
@@ -2235,78 +2605,73 @@ export interface IPlayAuthTokenConfig {
2235
2605
  */
2236
2606
  definitionMap?: Record<string, string | definitionItem>;
2237
2607
  /** {zh}
2238
- * @brief 点播服务502错误时重试次数
2608
+ * @brief 点播服务发生 502 错误时的重试次数。
2239
2609
  * @default 1
2240
2610
  */
2241
2611
  retryCount?: number;
2242
2612
  }
2243
- /**
2244
- * 清晰度定义
2245
- *
2613
+ /** {zh}
2246
2614
  * @list Options
2247
2615
  * @export
2248
2616
  * @interface definitionItem
2617
+ * @brief 清晰度定义。
2249
2618
  */
2250
2619
  export interface definitionItem {
2251
- /**
2252
- * 清晰度
2253
- *
2620
+ /** {zh}
2254
2621
  * @type {string}
2255
2622
  * @memberof definitionItem
2623
+ * @brief 清晰度。
2256
2624
  */
2257
2625
  definition?: string;
2258
- /**
2259
- * 清晰度多语言key
2260
- *
2626
+ /** {zh}
2261
2627
  * @type {string}
2262
2628
  * @memberof definitionItem
2629
+ * @brief 清晰度多语言 Key
2263
2630
  */
2264
2631
  definitionTextKey?: string;
2265
2632
  }
2266
2633
  export interface IAutoBitrateOptsConfig {
2267
- /**
2268
- * 是否开启功能,默认为false
2269
- *
2634
+ /** {zh}
2635
+ * @brief 是否开启功能,默认为false
2270
2636
  * @type {boolean}
2271
2637
  * @memberof IAutoBitrateOptsConfig
2272
2638
  */
2273
2639
  isOpenAutoDefi?: boolean;
2274
- /**
2275
- * 自动切换清晰度对应显示文案
2640
+ /** {zh}
2641
+ * @brief 自动切换清晰度对应显示文案
2276
2642
  *
2277
2643
  * @type {string}
2278
2644
  * @memberof IAutoBitrateOptsConfig
2279
2645
  */
2280
2646
  autoDefiText?: string;
2281
- /**
2282
- * 起播是否调整到自动切换, 默认为false
2283
- *
2647
+ /** {zh}
2648
+ * @brief 起播是否调整到自动切换, 默认为false
2284
2649
  * @type {boolean}
2285
2650
  * @memberof IAutoBitrateOptsConfig
2286
2651
  */
2287
2652
  isPlayAutoDefi?: boolean;
2288
- /**
2289
- * 调用算法频率
2653
+ /** {zh}
2654
+ * @brief 调用算法频率
2290
2655
  *
2291
2656
  * @type {boolean}
2292
2657
  * @memberof IAutoBitrateOptsConfig
2293
2658
  */
2294
2659
  interval?: number;
2295
- /**
2296
- * 多久后算消费视频,单位秒
2660
+ /** {zh}
2661
+ * @brief 多久后算消费视频,单位秒
2297
2662
  *
2298
2663
  * @type {number}
2299
2664
  * @memberof IAutoBitrateOptsConfig
2300
2665
  */
2301
2666
  noStallCheckTime?: number;
2302
- /**
2667
+ /** {zh}
2303
2668
  * 算法 方法选择见文档,默认使用31即可,目前31策略卡顿收益很高
2304
2669
  *
2305
2670
  * @type {number}
2306
2671
  * @memberof IAutoBitrateOptsConfig
2307
2672
  */
2308
2673
  method?: number;
2309
- /**
2674
+ /** {zh}
2310
2675
  * 算法模块, CDN方式为window.DashAbralgo
2311
2676
  *
2312
2677
  * @type {any}
@@ -2314,14 +2679,14 @@ export interface IAutoBitrateOptsConfig {
2314
2679
  */
2315
2680
  module?: any;
2316
2681
  }
2317
- /**
2318
- * @brief 记忆播放配置项
2682
+ /** {zh}
2683
+ * @brief 记忆播放配置。
2319
2684
  * @kind property
2320
2685
  * @list Options
2321
2686
  * @interface IMemoryPlayConfig
2322
2687
  */
2323
2688
  export interface IMemoryPlayConfig {
2324
- /**
2689
+ /** {zh}
2325
2690
  * @brief 存储标识id
2326
2691
  * @default options.vid || options.url
2327
2692
  *
@@ -2329,57 +2694,58 @@ export interface IMemoryPlayConfig {
2329
2694
  * @memberof IMemoryPlayConfig
2330
2695
  */
2331
2696
  memoryId: number | string;
2332
- /**
2697
+ /** {zh}
2333
2698
  * @brief 设置时间函数
2334
2699
  * @default -
2335
2700
  *
2336
2701
  * @type {(id: number | string, time: number) => unknown}
2337
2702
  * @memberof IMemoryPlayConfig
2338
2703
  */
2339
- saveTime: (id: number | string, time: number) => unknown;
2340
- /**
2704
+ saveTime?: (id: number | string, time: number) => unknown;
2705
+ /** {zh}
2341
2706
  * @brief 获取最后一次播放时间函数
2342
2707
  * @default -
2343
2708
  */
2344
- getTime: (id: number | string) => number | Promise<number>;
2709
+ getTime?: (id: number | string) => number | Promise<number>;
2345
2710
  }
2346
- /**
2711
+ /** {zh}
2347
2712
  * @brief 插件按钮位置
2348
2713
  */
2349
2714
  export declare const enum POSITIONS {
2350
- /**
2715
+ /** {zh}
2351
2716
  * @brief 播放器根节点
2352
2717
  */
2353
2718
  ROOT = "root",
2354
- /**
2719
+ /** {zh}
2355
2720
  * @brief 播放器根节点左侧
2356
2721
  */
2357
2722
  ROOT_LEFT = "rootLeft",
2358
- /**
2723
+ /** {zh}
2359
2724
  * @brief 播放器根节点右侧
2360
2725
  */
2361
2726
  ROOT_RIGHT = "rootRight",
2362
- /**
2727
+ /** {zh}
2363
2728
  * @brief 播放器根节点顶部
2364
2729
  */
2365
2730
  ROOT_TOP = "rootTop",
2366
- /**
2731
+ /** {zh}
2367
2732
  * @brief 播控栏左侧
2368
2733
  */
2369
2734
  CONTROLS_LEFT = "controlsLeft",
2370
- /**
2735
+ /** {zh}
2371
2736
  * @brief 播控栏左侧
2372
2737
  */
2373
2738
  CONTROLS_RIGTH = "controlsRight",
2374
- /**
2739
+ /** {zh}
2375
2740
  * @brief 播控栏右侧
2376
2741
  */
2377
2742
  CONTROLS_RIGHT = "controlsRight",
2378
- /**
2743
+ /** {zh}
2379
2744
  * @brief 播控栏中间
2380
2745
  */
2381
2746
  CONTROLS_CENTER = "controlsCenter",
2382
- /** @hidden
2747
+ /** {zh}
2748
+ * @hidden
2383
2749
  * @brief 播控栏左侧
2384
2750
  */
2385
2751
  CONTROLS = "controls"
@@ -2388,162 +2754,168 @@ export interface IIconPluginConfig {
2388
2754
  position?: POSITIONS;
2389
2755
  index?: number;
2390
2756
  }
2391
- /**
2392
- * @brief 画中画配置项
2757
+ /** {zh}
2758
+ * @brief 画中画配置。
2393
2759
  * @list Options
2394
2760
  * @kind property
2395
2761
  */
2396
2762
  export interface IPIPConfig extends IIconPluginConfig {
2397
2763
  /** {zh}
2398
- * @brief 是否显示画中画按钮
2399
- * - `true`:是,显示
2400
- * - `false`:否,不显示
2401
- * @default `false`
2764
+ * @brief 是否显示画中画按钮。取值如下:
2765
+ * - `true`:显示画中画按钮。
2766
+ * - `false`:不显示画中画按钮。
2767
+ * @default false
2402
2768
  */
2403
2769
  showIcon?: boolean;
2404
2770
  /** {zh}
2405
- * @brief 是否优先采用文档画中画,仅浏览器支持 DocumentPictureInPicture 才生效
2771
+ * @brief 是否优先使用[网页画中画](https://developer.mozilla.org/en-US/docs/Web/API/DocumentPictureInPicture)。
2406
2772
  * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/DocumentPictureInPicture DocumentPictureInPicture}
2407
2773
  * - `true`:是,优先使用文档画中画
2408
2774
  * - `false`:否
2409
- * @default `false`
2775
+ * @default false
2776
+ * @listtip 仅浏览器支持 `DocumentPictureInPicture` 时才生效。
2410
2777
  */
2411
2778
  preferDocument?: boolean;
2412
2779
  /** {zh}
2413
- * @brief 文档画中画窗口的宽度
2780
+ * @brief 网页画中画模式下窗口的宽度。
2414
2781
  * @default -
2415
2782
  */
2416
2783
  width?: number;
2417
2784
  /** {zh}
2418
- * @brief 文档画中画窗口的高度
2785
+ * @brief 网页画中画模式下窗口的高度。
2419
2786
  * @default -
2420
2787
  */
2421
2788
  height?: number;
2422
2789
  /** {zh}
2423
- * @brief 文档画中画窗口的根节点
2790
+ * @brief 网页画中画模式下窗口的根节点。
2424
2791
  * @default -
2425
2792
  */
2426
2793
  docPiPNode?: HTMLElement;
2427
2794
  /** {zh}
2428
- * @brief 文档画中画窗口的css style
2795
+ * @brief 文档画中画窗口的 css style
2429
2796
  * @default -
2430
2797
  */
2431
2798
  docPiPStyle?: ((...arg: any) => string) | string;
2432
2799
  }
2433
- /**
2434
- * @brief 全屏配置
2800
+ /** {zh}
2801
+ * @brief 全屏配置。
2435
2802
  * @list Options
2436
2803
  * @kind property
2437
2804
  */
2438
2805
  export interface IFullscreenConfig {
2439
2806
  /** {zh}
2440
- * @brief 是否使用页面全屏代替全屏功能。取值如下:
2441
- - `true`:页面全屏;
2442
- - `false`:系统全屏。
2443
- * @default `false`
2807
+ * @brief 是否使用页面全屏代替系统全屏。取值如下:
2808
+ * - `true`:页面全屏。
2809
+ * - `false`:系统全屏。
2810
+ * @default false
2444
2811
  */
2445
2812
  useCssFullscreen?: boolean;
2446
2813
  /** {zh}
2447
2814
  * @brief 是否使用旋转横屏。取值如下:
2448
- * - `false`:否。
2449
- * - `true`:是,即全屏将会在竖屏状态下把 dom 旋转 90 度实现横屏效果。
2450
- * @default `false`
2815
+ * - `false`:否。
2816
+ * - `true`:是,即全屏后,如在竖屏状态下,播放器会把 `dom` 旋转 90 度实现横屏效果。
2817
+ * @default false
2451
2818
  * @notice
2452
2819
  * - 该配置优先于 `useCssFullscreen` 配置。
2453
2820
  * - 该配置一般在移动端使用。
2821
+ * @listtip - 该参数的优先级高于 `useCssFullscreen` 参数。
2822
+ * - 该参数一般用于移动端。
2454
2823
  */
2455
2824
  rotateFullscreen?: boolean;
2456
2825
  /** {zh}
2457
- * @brief 自定义全屏作用的dom,默认是播放器根节点, 该配置项必须是player.root的父辈节点,使用场景是解决全屏下和player.root同级的dom需要显示的场景
2826
+ * @brief 自定义全屏功能的 `dom`。默认是播放器根节点。该参数必须是 `player.root` 的父辈节点,适用于解决全屏时和 `player.root` 同级的 `dom`需要显示的场景。
2458
2827
  * @default `null`
2459
2828
  */
2460
2829
  target?: HTMLElement;
2461
2830
  /** {zh}
2462
- * @brief 是否禁用全凭按钮功能,禁用后不渲染全屏按钮
2463
- * - `true`:禁用;
2464
- * - `false`:不禁用。
2465
- * @default `false`
2831
+ * @brief 是否禁用全屏按钮。
2832
+ * - `true`:禁用。不渲染全屏按钮。
2833
+ * - `false`:不禁用。
2834
+ * @default false
2466
2835
  */
2467
2836
  disable?: boolean;
2468
2837
  /** {zh}
2469
- * @brief 全屏的时候是否使用右上角返回按钮
2470
- * - `true`:显示;
2471
- * - `false`:不显示。
2472
- * @default `false`
2838
+ * @brief 全屏的时候是否显示右上角返回按钮。取值如下:
2839
+ *
2840
+ * - `false`:不显示右上角返回按钮。
2841
+ * - `true`:显示右上角返回按钮。
2842
+ * @default false
2473
2843
  * @notice 该配置一般在移动端开启
2844
+ * @listtip 此参数一般用于移动端。
2474
2845
  */
2475
2846
  needBackIcon?: boolean;
2476
2847
  /** {zh}
2477
- * @brief 全屏切换自定义实现,该函数配置相当于完全替代插件内部的切换逻辑
2848
+ * @brief 全屏切换自定义实现。该函数配置相当于完全替代插件内部的切换逻辑。
2478
2849
  * @default `null`
2479
2850
  */
2480
2851
  switchCallback?: (...arg: any) => any;
2481
2852
  }
2482
- /**
2853
+ /** {zh}
2483
2854
  * @list Options
2484
2855
  * @kind property
2856
+ * @brief 播放器关键点样式。
2485
2857
  */
2486
2858
  export interface ICommonStyle {
2487
2859
  /** {zh}
2488
- * @brief 进度条底色
2860
+ * @brief 进度条底色。
2489
2861
  * @default 无
2490
2862
  */
2491
2863
  progressColor?: string;
2492
2864
  /** {zh}
2493
- * @brief 播放完成部分进度条底色
2865
+ * @brief 播放完成部分进度条底色。
2494
2866
  * @default 无
2495
2867
  */
2496
2868
  playedColor?: string;
2497
2869
  /** {zh}
2498
- * @brief 缓存部分进度条底色
2870
+ * @brief 缓存部分进度条底色。
2499
2871
  * @default 无
2500
2872
  */
2501
2873
  cachedColor?: string;
2502
2874
  /** {zh}
2503
- * @brief 进度条滑块样式
2875
+ * @brief 进度条滑块样式。
2504
2876
  * @default 无
2505
2877
  */
2506
2878
  sliderBtnStyle?: CSSStyleDeclaration;
2507
2879
  /** {zh}
2508
- * @brief 音量颜色
2880
+ * @brief 音量颜色。
2509
2881
  * @default 无
2510
2882
  */
2511
2883
  volumeColor?: string;
2512
2884
  }
2513
- /**
2885
+ /** {zh}
2514
2886
  * @list Options
2515
2887
  * @brief 封面配置
2516
2888
  * @kind property
2517
2889
  */
2518
2890
  export interface IPoster {
2519
2891
  /** {zh}
2520
- * @brief 封面图地址
2892
+ * @brief 封面图 URL 地址。
2521
2893
  * @default -
2522
2894
  */
2523
2895
  poster: string;
2524
- /**
2525
- * @brief 是否在播放结束之后显示
2526
- * @default `true`
2896
+ /** {zh}
2897
+ * @brief 是否在播放结束之后显示封面图。
2898
+ * @default true
2527
2899
  */
2528
2900
  isEndedShow?: boolean;
2529
- /**
2530
- * @brief 是否播放后隐藏
2531
- * - `true`:播放后才隐藏,在视频地址更新后会重新显示poster
2532
- * - `false`:在play事件触发后隐藏poster
2533
- * @default `false`
2901
+ /** {zh}
2902
+ * @brief 是否播放后隐藏封面图。
2903
+ * - `true`:播放后隐藏,在视频地址更新后会重新显示封面图。
2904
+ * - `false`:在 `play` 事件触发后隐藏封面图。
2905
+ * @default false
2534
2906
  */
2535
2907
  hideCanplay?: boolean;
2536
- /**
2537
- * @brief 是否一直显示
2538
- * @default `false`
2908
+ /** {zh}
2909
+ * @brief 是否一直显示封面图。
2910
+ * @default false
2539
2911
  */
2540
2912
  notHidden?: boolean;
2541
- /**
2542
- * @brief 封面图填充方式
2543
- * - `fixWidth`:宽度方向填充,不会被拉伸压缩
2544
- * - `fixHeight`:高度方向完全填充,不会被拉伸压缩
2545
- * - `cover`:方式完全覆盖容器,多余但部分会被裁剪
2546
- * - `contain`:完全覆盖,与容器不匹配时会被拉伸压缩
2913
+ /** {zh}
2914
+ * @brief 封面图填充方式。取值如下:
2915
+ * - `fixWidth`:宽度方向填充,不会被拉伸压缩。
2916
+ * - `fixHeight`:高度方向填充,不会被拉伸压缩。
2917
+ * - `cover`:完全覆盖容器,多余部分会被裁剪。
2918
+ * - `contain`:完全覆盖,与容器不匹配时会被拉伸压缩。
2547
2919
  */
2548
2920
  fillMode?: "fixWidth" | "fixHeight" | "cover" | "contain";
2549
2921
  }
@@ -2795,41 +3167,41 @@ export declare type PlayerCore = Player & {
2795
3167
  vodLogger?: VodLogger;
2796
3168
  };
2797
3169
  declare class VePlayer {
2798
- /**
3170
+ /** {zh}
2799
3171
  * @brief 播放相关配置数据
2800
3172
  * @hidden
2801
3173
  * @type {PlayerData}
2802
3174
  * @memberof VePlayer
2803
3175
  */
2804
3176
  playerData: PlayerData;
2805
- /**
2806
- * @brief 播放器内核实例, 详情参考{@link https://www.volcengine.com/docs/4/109909#%E6%92%AD%E6%94%BE%E5%99%A8%E5%86%85%E6%A0%B8 播放内核}
3177
+ /** {zh}
3178
+ * @brief 播放器内核实例,详情参考{@link https://www.volcengine.com/docs/4/1249083 播放器内核}
2807
3179
  * @type {*}
2808
3180
  * @memberof VePlayer
2809
3181
  */
2810
3182
  player: PlayerCore;
2811
- /**
3183
+ /** {zh}
2812
3184
  * @hidden
2813
3185
  *
2814
3186
  * @type {*}
2815
3187
  * @memberof VePlayer
2816
3188
  */
2817
3189
  mountingDom: any;
2818
- /**
3190
+ /** {zh}
2819
3191
  * @hidden
2820
3192
  *
2821
3193
  * @type {*}
2822
3194
  * @memberof VePlayer
2823
3195
  */
2824
3196
  playerContainer: any;
2825
- /**
3197
+ /** {zh}
2826
3198
  * @hidden
2827
3199
  *
2828
3200
  * @type {*}
2829
3201
  * @memberof VePlayer
2830
3202
  */
2831
3203
  mobilePanel: any;
2832
- /**
3204
+ /** {zh}
2833
3205
  *
2834
3206
  * @private
2835
3207
  * @type {*}
@@ -2915,7 +3287,9 @@ declare class VePlayer {
2915
3287
  */
2916
3288
  static veStrategy: typeof VeStrategy;
2917
3289
  /**
2918
- * @brief sdk版本
3290
+ * @brief SDK 版本
3291
+ * @type {*}
3292
+ * @memberof VePlayer
2919
3293
  */
2920
3294
  static sdkVersion: string;
2921
3295
  /**
@@ -2927,9 +3301,9 @@ declare class VePlayer {
2927
3301
  targetProfileLevel?: string;
2928
3302
  }) => Promise<boolean>;
2929
3303
  private vodLogCommon;
2930
- /**
2931
- * @brief 构造函数
2932
- * @param configs sdk配置
3304
+ /** {zh}
3305
+ * @brief 构造函数。
3306
+ * @param configs 播放器实例化配置。
2933
3307
  */
2934
3308
  constructor(configs: IPlayerConfig);
2935
3309
  /**
@@ -2987,59 +3361,55 @@ declare class VePlayer {
2987
3361
  * @memberof VePlayer
2988
3362
  */
2989
3363
  getUrlTimestamp(url: string): void;
2990
- /**
2991
- * @brief 监听sdk事件
2992
- *
2993
- * @param action 监听的事件名
2994
- * @param {(...args: any[]) => void} func
3364
+ /** {zh}
3365
+ * @brief 监听事件。
2995
3366
  * @memberof VePlayer
3367
+ * @param action 事件名。
3368
+ * @param func 回调函数。
2996
3369
  */
2997
3370
  on(action: string, func: (...args: any[]) => void): void;
2998
- /**
2999
- * @brief 触发sdk事件
3000
- *
3001
- * @param {string} action 监听的事件名
3002
- * @param {*} [payload]
3371
+ /** {zh}
3372
+ * @brief 触发事件。
3003
3373
  * @memberof VePlayer
3374
+ * @param action 事件名。
3375
+ * @param payload 事件数据。
3004
3376
  */
3005
3377
  emit(action: string, payload?: any): void;
3006
- /**
3007
- * 监听sdk事件,事件处理函数只执行一次
3008
- *
3009
- * @param {string} action
3010
- * @param {(...args: any[]) => void} func
3378
+ /** {zh}
3011
3379
  * @memberof VePlayer
3380
+ * @brief 监听事件。事件处理函数只执行一次。
3381
+ * @param action 事件名。
3382
+ * @param func 回调函数。
3012
3383
  */
3013
3384
  once(action: string, func: (...args: any[]) => void): void;
3014
- /**
3015
- * 解绑事件监听
3016
- *
3017
- * @param {string} action
3018
- * @param {(...args: any[]) => void} func
3385
+ /** {zh}
3019
3386
  * @memberof VePlayer
3387
+ * @brief 解绑事件监听。
3388
+ * @param action 事件名。
3389
+ * @param func 回调函数。
3020
3390
  */
3021
3391
  off(action: string, func: (...args: any[]) => void): void;
3022
- /**
3392
+ /** {zh}
3023
3393
  * @hidden
3024
3394
  *
3025
3395
  * @memberof VePlayer
3026
3396
  */
3027
3397
  renderDom(): void;
3028
- /**
3398
+ /** {zh}
3029
3399
  * @hidden
3030
3400
  *
3031
3401
  * @return {*}
3032
3402
  * @memberof VePlayer
3033
3403
  */
3034
3404
  renderPoster(): void;
3035
- /**
3405
+ /** {zh}
3036
3406
  * @hidden
3037
3407
  *
3038
3408
  * @return {*}
3039
3409
  * @memberof VePlayer
3040
3410
  */
3041
3411
  createPlayer(): Promise<PlayerCore>;
3042
- /**
3412
+ /** {zh}
3043
3413
  * @hidden
3044
3414
  *
3045
3415
  * @param {IPlayerConfig} finalOptions
@@ -3047,14 +3417,14 @@ declare class VePlayer {
3047
3417
  * @memberof VePlayer
3048
3418
  */
3049
3419
  setPluginConfig(finalOptions: IPlayerConfig): void;
3050
- /**
3420
+ /** {zh}
3051
3421
  * @hidden
3052
3422
  *
3053
3423
  * @param {string} url 地址
3054
3424
  * @memberof VePlayer
3055
3425
  */
3056
3426
  detectCodec(url: string): Promise<void>;
3057
- /**
3427
+ /** {zh}
3058
3428
  * @hidden
3059
3429
  *
3060
3430
  * @param {*} options
@@ -3062,7 +3432,7 @@ declare class VePlayer {
3062
3432
  * @memberof VePlayer
3063
3433
  */
3064
3434
  setDefaultConfigOptions(options: any): void;
3065
- /**
3435
+ /** {zh}
3066
3436
  * @brief 获取当前播放视频数据
3067
3437
  * @hidden
3068
3438
  * @return {any}
@@ -3131,32 +3501,32 @@ declare class VePlayer {
3131
3501
  * @memberof VePlayer
3132
3502
  */
3133
3503
  private _bindPlayerEvents;
3134
- /**
3504
+ /** {zh}
3135
3505
  * @private
3136
3506
  * @return {*}
3137
3507
  * @memberof VePlayer
3138
3508
  */
3139
3509
  private onMediaExpiredAction;
3140
- /**
3510
+ /** {zh}
3141
3511
  * @hidden
3142
3512
  *
3143
3513
  * @memberof VePlayer
3144
3514
  */
3145
3515
  private onTokenExpiredAction;
3146
- /**
3516
+ /** {zh}
3147
3517
  *
3148
3518
  *
3149
3519
  * @private
3150
3520
  * @memberof VePlayer
3151
3521
  */
3152
3522
  private _bindSdkEvents;
3153
- /**
3523
+ /** {zh}
3154
3524
  * @hidden
3155
3525
  *
3156
3526
  * @memberof VePlayer
3157
3527
  */
3158
3528
  private _mountingExtendMethods;
3159
- /**
3529
+ /** {zh}
3160
3530
  *
3161
3531
  *
3162
3532
  * @private
@@ -3164,17 +3534,15 @@ declare class VePlayer {
3164
3534
  * @memberof VePlayer
3165
3535
  */
3166
3536
  private _offPlayerEvents;
3167
- /**
3168
- * @hidden
3169
- * 切换插件展示
3170
- *
3171
- * @param {*} pluginName
3172
- * @param {*} IsShow
3537
+ /** {zh}
3538
+ * @hidden 切换插件展示
3173
3539
  * @return {*}
3174
3540
  * @memberof VePlayer
3541
+ * @param {*} pluginName
3542
+ * @param {*} IsShow
3175
3543
  */
3176
3544
  changePluginsIcon(pluginName: any, IsShow: any): void;
3177
- /**
3545
+ /** {zh}
3178
3546
  * @hidden
3179
3547
  *
3180
3548
  * @brief 对外提供获取SDK插件实例的方法
@@ -3183,79 +3551,78 @@ declare class VePlayer {
3183
3551
  * @memberof VePlayer
3184
3552
  */
3185
3553
  getSdkPlugin(name: any): any;
3186
- /**
3187
- * @brief 更换playAuthToken的方法
3188
- * @notes 这里指同一个视频切换视频源,不能用来切换不同类型的视频
3189
- * @param { IPlayAuthTokenConfig } config authToken配置
3190
- * @param { boolean } isNewVideo 是否是新视频,默认true。若未false即表示同一个视频切换token播放,会在切换前时间点继续播放
3554
+ /** {zh}
3555
+ * @brief 播放时更换 `playAuthToken`,以更换视频源。
3191
3556
  * @memberof VePlayer
3557
+ * @param config `playAuthToken` 配置。
3558
+ * @param isNewVideo 是否为新视频。为 `false` 时,更换后,会从更换前的时间点继续播放。
3192
3559
  */
3193
3560
  switchAuthToken(config: IPlayAuthTokenConfig, isNewVideo?: boolean): Promise<void>;
3194
- /**
3195
- * @brief 更新playAuthToken的方法,用来更新视频地址
3196
- * @param { IPlayAuthTokenConfig } config playAuthToken配置
3561
+ /** {zh}
3562
+ * @brief 更新 `playAuthToken`。
3197
3563
  * @memberof VePlayer
3564
+ * @notes 播放前 `playAuthToken` 过期(收到 `play_auth_token_expired` 事件或者 `onTokenExpired` 回调触发)时,调用此方法更新 `playAuthToken`。
3565
+ * @param config `playAuthToken` 配置。
3198
3566
  */
3199
3567
  updateAuthToken(config: IPlayAuthTokenConfig): Promise<void>;
3200
- /**
3201
- * @brief 返回当前视频的地址
3568
+ /** {zh}
3569
+ * @brief 返回当前视频的地址
3202
3570
  * @memberof VePlayer
3203
3571
  */
3204
3572
  get src(): any;
3205
- /**
3206
- * @brief 设置当前视频的地址
3573
+ /** {zh}
3574
+ * @brief 设置当前视频的地址
3207
3575
  * @notes 会重新拉取新的视频,从0开始起播
3208
3576
  * @memberof VePlayer
3209
3577
  */
3210
3578
  set src(url: any);
3211
- /**
3212
- * 切换视频url
3213
- * @param {string} url 同一个视频,更新视频地址
3214
- * @notes 切换后从切换前的时间点继续播放
3579
+ /** {zh}
3580
+ * @notes 更换后,会从更换前的时间点继续播放。
3215
3581
  * @return {Promise<void>}
3216
3582
  * @memberof VePlayer
3583
+ * @brief 播放时更换视频 URL,以更换视频源。
3584
+ * @param url 视频播放地址。
3217
3585
  */
3218
3586
  switchURL(url: string): Promise<void>;
3219
- /**
3220
- * 重建播放下一个
3221
- *
3222
- * @param {playerConfig} config
3223
- * @param { boolean } isNewVideo 是否是新视频,默认true。若为false即表示同一个视频切换token播放,会在切换前时间点继续播放
3587
+ /** {zh}
3224
3588
  * @memberof VePlayer
3589
+ * @brief 针对不同格式的视频,重建播放器内核播放下一个视频。
3590
+ * @hidden
3591
+ * @param config 播放器配置。
3592
+ * @param isNewVideo 是否为新视频,默认为 `true`。为 `false` 时表示是同一个视频更换 token。更换后,会从更换前的时间点继续播放。
3225
3593
  */
3226
3594
  next(config: IPlayerConfig, isNewVideo?: boolean): Promise<void>;
3227
- /**
3228
- * 切换视频源
3229
- *
3230
- * @param {IPlayerConfig} config
3231
- * @param { boolean } isNewVideo 是否是新视频,默认true。若为false即表示同一个视频切换地址播放,会在切换前的时间点继续播放
3232
- * @brief 默认切换后是暂停状态,如果设置了自动播放,则会自动播放
3595
+ /** {zh}
3596
+ * @brief 播放下一视频。
3233
3597
  * @return{Promise<any>}
3234
3598
  * @memberof VePlayer
3599
+ * @notes 成功更换视频源后,默认是暂停状态,如果设置了自动播放,则会自动播放。
3600
+ * @param config 播放器实例化配置。
3601
+ * @param isNewVideo 是否为新视频。为 `false` 时,更换后,会从更换前的时间点继续播放。
3235
3602
  */
3236
3603
  playNext(config: IPlayerConfig, isNewVideo?: boolean): Promise<any>;
3237
- /**
3604
+ /** {zh}
3238
3605
  * @hidden
3239
3606
  *
3240
3607
  * @return {*}
3241
3608
  * @memberof VePlayer
3242
3609
  */
3243
3610
  resetUrlState(url: any): void;
3244
- /**
3245
- * 销毁xgplayer实例
3611
+ /** {zh}
3612
+ * @brief 销毁xgplayer实例
3246
3613
  *
3247
3614
  * @private
3248
3615
  * @memberof VePlayer
3249
3616
  */
3250
3617
  private _destroyPlayer;
3251
- /**
3618
+ /** {zh}
3252
3619
  * @hidden
3253
3620
  *
3254
3621
  * @return {*}
3255
3622
  * @memberof VePlayer
3256
3623
  */
3257
3624
  getPlayerInstance(): PlayerCore;
3258
- /**
3625
+ /** {zh}
3259
3626
  * @hidden
3260
3627
  *
3261
3628
  * @return {*}
@@ -3267,152 +3634,153 @@ declare class VePlayer {
3267
3634
  codecType?: CodecType;
3268
3635
  plugins?: any[];
3269
3636
  }>;
3270
- /**
3637
+ /** {zh}
3271
3638
  * @hidden
3272
3639
  *
3273
3640
  * @brief 获取h265软解播放时的播放列表
3274
3641
  * @memberof VePlayer
3275
3642
  */
3276
3643
  setH265SoftPlayList(): void;
3277
- /**
3278
- * 初始化多语言词典
3644
+ /** {zh}
3645
+ * @brief 初始化多语言词典
3279
3646
  *
3280
3647
  * @param {*} languages
3281
3648
  * @memberof VePlayer
3282
3649
  */
3283
3650
  private _initI18N;
3284
- /**
3285
- * 获取音乐播放模式
3651
+ /** {zh}
3652
+ * @brief 获取音乐播放模式
3286
3653
  * @notes 仅音乐播放模式有效
3287
3654
  * @return {PlayModeType}
3288
3655
  * @memberof VePlayer
3289
3656
  */
3290
3657
  get musicMode(): PlayModeType;
3291
- /**
3292
- * 设置音乐播放模式
3658
+ /** {zh}
3659
+ * @brief 设置音乐播放模式
3293
3660
  * @notes 仅音乐播放模式有效
3294
3661
  * @memberof VePlayer
3295
3662
  * @param {PlayModeType} val 模式值
3296
3663
  */
3297
3664
  set musicMode(val: PlayModeType);
3298
- /**
3299
- * 获取音乐播放快进快退时间跨度
3665
+ /** {zh}
3666
+ * @brief 获取音乐播放快进快退时间跨度
3300
3667
  * @notes 仅音乐播放模式有效
3301
3668
  * @return {number}
3302
3669
  * @memberof VePlayer
3303
3670
  */
3304
3671
  get musicTimeScale(): number;
3305
- /**
3306
- * 设置音乐播放快进快退时间跨度
3672
+ /** {zh}
3673
+ * @brief 设置音乐播放快进快退时间跨度
3307
3674
  * @notes 仅音乐播放模式有效
3308
3675
  * @param {number} scale 时间跨度
3309
3676
  * @memberof VePlayer
3310
3677
  */
3311
3678
  set musicTimeScale(scale: number);
3312
- /**
3313
- * 获取音乐播放列表
3679
+ /** {zh}
3680
+ * @brief 获取音乐播放列表
3314
3681
  * @notes 仅音乐播放模式有效
3315
3682
  * @return {IMusicListItem[]}
3316
3683
  * @memberof VePlayer
3317
3684
  */
3318
3685
  get musicList(): IMusicListItem[];
3319
- /**
3320
- * 设置音乐播放列表
3686
+ /** {zh}
3687
+ * @brief 设置音乐播放列表
3321
3688
  * @notes 仅音乐播放模式有效
3322
3689
  * @param {IMusicListItem[]} list 播放列表
3323
3690
  * @memberof VePlayer
3324
3691
  */
3325
3692
  set musicList(list: IMusicListItem[]);
3326
- /**
3327
- * 向播放列表中加入歌曲
3328
- * @notes 仅音乐播放模式有效
3329
- * @param {IMusicListItem} meta 歌曲信息
3693
+ /** {zh}
3694
+ * @notes 仅音乐播放模式开启时(`isMusic` 为 `true` 时)有效。
3330
3695
  * @memberof VePlayer
3696
+ * @brief 向播放列表中加入歌曲。
3697
+ * @param meta 歌曲信息。
3331
3698
  */
3332
3699
  musicAdd(meta: IMusicListItem): void;
3333
- /**
3334
- * 随机获取播放列表中某一首歌曲
3335
- * @notes 仅音乐播放模式有效
3700
+ /** {zh}
3701
+ * @notes 仅音乐播放模式开启时(`isMusic` 为 `true` 时)有效。
3336
3702
  * @return {IMusicListItem} 歌曲信息
3337
3703
  * @memberof VePlayer
3704
+ * @brief 随机获取播放列表中的一首歌曲。
3338
3705
  */
3339
3706
  musicRandom(): IMusicListItem;
3340
- /**
3707
+ /** {zh}
3341
3708
  * 播放播放列表的下一首歌曲
3342
- * @notes 仅音乐播放模式有效
3709
+ * @notes 仅音乐播放模式开启时(`isMusic` 为 `true` 时)有效。
3343
3710
  * @memberof VePlayer
3711
+ * @brief 播放播放列表中的下一首歌曲。
3344
3712
  */
3345
3713
  musicNext(): void;
3346
- /**
3714
+ /** {zh}
3347
3715
  * 播放播放列表的上一首歌曲
3348
- * @notes 仅音乐播放模式有效
3716
+ * @notes 仅音乐播放模式开启时(`isMusic` 为 `true` 时)有效。
3349
3717
  * @memberof VePlayer
3718
+ * @brief 播放播放列表中的上一首歌曲。
3350
3719
  */
3351
3720
  musicPrev(): void;
3352
- /**
3353
- * 播放播放列表的第n首歌曲
3354
- * @notes 仅音乐播放模式有效
3355
- * @param {number} index 播放列表中的序号
3721
+ /** {zh}
3722
+ * @notes 仅音乐播放模式开启时(`isMusic` 为 `true` 时)有效。
3356
3723
  * @memberof VePlayer
3724
+ * @brief 播放播放列表中的指定歌曲。
3725
+ * @param index 播放列表中的序号。
3357
3726
  */
3358
3727
  musicSetIndex(index: number): void;
3359
- /**
3360
- * 歌曲快进
3361
- * @notes 仅音乐播放模式有效
3728
+ /** {zh}
3729
+ * @notes 仅音乐播放模式开启时(`isMusic` 为 `true` 时)有效。
3362
3730
  * @memberof VePlayer
3731
+ * @brief 歌曲快进。
3363
3732
  */
3364
3733
  musicForward(): void;
3365
- /**
3366
- * 歌曲后退
3367
- * @notes 仅音乐播放模式有效
3734
+ /** {zh}
3735
+ * @notes 仅音乐播放模式开启时(`isMusic` 为 `true` 时)有效。
3368
3736
  * @memberof VePlayer
3737
+ * @brief 歌曲后退。
3369
3738
  */
3370
3739
  musicBackward(): void;
3371
- /**
3372
- * 从播放列表移除指定歌曲
3373
- * @notes 仅音乐播放模式有效
3374
- * @param {string | number} vid 歌曲vid
3740
+ /** {zh}
3741
+ * @notes 仅音乐播放模式开启时(`isMusic` 为 `true` 时)有效。
3375
3742
  * @memberof VePlayer
3743
+ * @brief 移除播放列表中的指定歌曲。
3744
+ * @param vid 待移除歌曲的 `vid`。
3376
3745
  */
3377
3746
  musicRemove(vid: string | number): void;
3378
- /**
3379
- * 设置ab循环
3380
- * @param { number | IABCycle } start
3381
- * @param { number } [end]
3382
- * @param { boolean } [loop]
3383
- * @param {{ [propName: string]: any }} [ext]
3747
+ /** {zh}
3384
3748
  * @memberof VePlayer
3749
+ * @notes 仅音乐播放模式开启时(`isMusic` 为 `true` 时)有效。
3750
+ * @brief 设置 AB 循环,即设置播放区域任意位置循环播放。
3751
+ * @param start AB 循环段起始位置,单位为秒。
3752
+ * @param end AB 循环段结束位置,单位为秒。
3753
+ * @param loop 是否循环播放。
3385
3754
  */
3386
3755
  musicSetAbCycle(start: number | IABCycle, end?: number, loop?: boolean, ext?: {
3387
3756
  [propName: string]: any;
3388
3757
  }): void;
3389
- /**
3390
- * 移除ab循环
3758
+ /** {zh}
3391
3759
  * @memberof VePlayer
3760
+ * @brief 移除 AB 循环。
3392
3761
  */
3393
3762
  musicRemoveAbCycle(): void;
3394
- /**
3395
- * 获取质量日志上报的用户id
3763
+ /** {zh}
3396
3764
  * @return {string | undefined}
3397
3765
  * @memberof VePlayer
3766
+ * @notes 获取用户 ID 后,您可进入视频点播控制台[单点追查](https://console.volcengine.com/vod/quality_control/SingleTracing/?Tab=play)页面,根据用户 ID 查询该用户的播放日志。
3767
+ * @brief 获取质量日志上报的用户 ID。
3398
3768
  */
3399
3769
  getLogUserId(): string;
3400
- /**
3401
- * 获取当前配置的region
3770
+ /** {zh}
3771
+ * @brief 获取当前配置的 region
3402
3772
  * @return {TRegionType}
3403
3773
  * @memberof VePlayer
3404
3774
  */
3405
3775
  get region(): TRegionType;
3406
- /**
3407
- * @brief 获取当前播放器内核的插件实例
3408
- * @param { string } pluginName 插件名
3409
- * @return { null | BasePlugin } plugin
3776
+ /** {zh}
3777
+ * @brief 获取插件实例。
3778
+ * @param pluginName 插件名。
3410
3779
  */
3411
3780
  getPlugin(pluginName: string): null | BasePlugin;
3412
- /**
3413
- * 销毁当前播放器SDK实例
3414
- *
3781
+ /** {zh}
3415
3782
  * @memberof VePlayer
3783
+ * @brief 销毁当前播放器实例。
3416
3784
  */
3417
3785
  destroy(): Promise<void>;
3418
3786
  }
@@ -4079,210 +4447,210 @@ export declare class SdkPlugin {
4079
4447
  __destroy(): void;
4080
4448
  }
4081
4449
  export declare const Events: {
4082
- /**
4083
- * 弹幕配置发生变化
4450
+ /** {zh}
4451
+ * @brief 弹幕配置发生变化。
4084
4452
  */
4085
4453
  DANMU_CHANGE: string;
4086
- /**
4454
+ /** {zh}
4087
4455
  * @hidden
4088
4456
  */
4089
4457
  TIME_SHIFT_CHANGE: string;
4090
- /**
4458
+ /** {zh}
4091
4459
  * @hidden
4092
4460
  */
4093
4461
  AI_SUBTITLE_LANG_CHANGE: string;
4094
- /**
4462
+ /** {zh}
4095
4463
  * @hidden
4096
4464
  */
4097
4465
  AI_SUBTITLE_MATCH: string;
4098
- /**
4099
- * 取消静音
4466
+ /** {zh}
4467
+ * @brief 取消静音。
4100
4468
  */
4101
4469
  CANCEL_UNMUTE: string;
4102
- /**
4103
- * 刷新按钮点击
4470
+ /** {zh}
4471
+ * @brief 刷新按钮被点击。
4104
4472
  */
4105
4473
  REFRESH_CLICK: string;
4106
- /**
4107
- * 报错时触发降级
4474
+ /** {zh}
4475
+ * @brief 报错时触发降级。
4108
4476
  */
4109
4477
  PLAY_BACKUP_CHANGE: string;
4110
- /**
4111
- * 报错时触发所有降级结束
4478
+ /** {zh}
4479
+ * @brief 报错时触发的降级结束。
4112
4480
  */
4113
4481
  PLAY_BACKUP_CHANGE_FINISH: string;
4114
- /**
4115
- * 报错时触发重试
4482
+ /** {zh}
4483
+ * @brief 报错时触发重试。
4116
4484
  */
4117
4485
  PLAY_ERROR_BUTTON_CLICK: string;
4118
- /**
4119
- * 播放url改变
4486
+ /** {zh}
4487
+ * @brief 播放 URL 改变。
4120
4488
  */
4121
4489
  PlAY_URL_CHANGE: string;
4122
- /**
4123
- * 展示报错
4490
+ /** {zh}
4491
+ * @brief 展示报错。
4124
4492
  */
4125
4493
  SHOW_PLAY_ERROR: string;
4126
- /**
4494
+ /** {zh}
4127
4495
  * @hidden
4128
4496
  */
4129
4497
  PLAYER_EXTEND_BUTTON: string;
4130
- /**
4131
- * 长时间waiting
4498
+ /** {zh}
4499
+ * @brief 长时间等待。
4132
4500
  */
4133
4501
  LONG_WAITING: string;
4134
- /**
4135
- * 频繁waiting
4502
+ /** {zh}
4503
+ * @brief 频繁等待。
4136
4504
  */
4137
4505
  OFTEN_WAITING: string;
4138
- /**
4139
- * 清晰度降级
4506
+ /** {zh}
4507
+ * @brief 清晰度降级。
4140
4508
  */
4141
4509
  DEFINITION_DEMOTE: string;
4142
- /**
4143
- *@hidden
4510
+ /** {zh}
4511
+ * @hidden
4144
4512
  */
4145
4513
  LARKWINDOW_CHANGE: string;
4146
- /**
4514
+ /** {zh}
4147
4515
  * @hidden
4148
4516
  */
4149
4517
  PANEL_MODE_CHANGE: string;
4150
- /**
4151
- * 清晰度切换
4518
+ /** {zh}
4519
+ * @brief 清晰度切换。
4152
4520
  */
4153
4521
  INNER_DEFINITION_CHANGE: string;
4154
- /**
4155
- * 线路切换
4522
+ /** {zh}
4523
+ * @brief 线路切换。
4156
4524
  */
4157
4525
  LINE_CHANGE: string;
4158
- /**
4159
- * playAuthToken获取url失败
4526
+ /** {zh}
4527
+ * @brief `playAuthToken` 获取 URL 失败。
4160
4528
  */
4161
4529
  GET_PLAY_URL_ERR: string;
4162
- /**
4163
- * 资源过期
4530
+ /** {zh}
4531
+ * @brief 资源过期。
4164
4532
  */
4165
4533
  MEDIA_EXPIRED: string;
4166
- /**
4167
- * 开启镜像
4534
+ /** {zh}
4535
+ * @brief 镜像开启。
4168
4536
  */
4169
4537
  MIRROR_CHANGE: string;
4170
- /**
4171
- * 音乐播放器快进快退跨度
4538
+ /** {zh}
4539
+ * @brief 音乐播放器快进或快退。
4172
4540
  */
4173
4541
  TIME_SCALE_CHANGE: string;
4174
- /**
4175
- * 音乐播放器播放模式改变
4542
+ /** {zh}
4543
+ * @brief 音乐播放模式切换。
4176
4544
  */
4177
4545
  MUSIC_MODE_CHANGE: string;
4178
- /**
4179
- * 音乐播放器切换音乐
4546
+ /** {zh}
4547
+ * @brief 音乐播放模式下切换音乐。
4180
4548
  */
4181
4549
  MUSIC_CHANGE: string;
4182
- /**
4183
- * 音乐播放列表发生变化
4550
+ /** {zh}
4551
+ * @brief 音乐播放列表发生变化。
4184
4552
  */
4185
4553
  MUSIC_LIST_CHANGE: string;
4186
- /**
4187
- * 自动播放成功
4554
+ /** {zh}
4555
+ * @brief 自动播放成功。
4188
4556
  */
4189
4557
  AUTOPLAY_SUCCESS: string;
4190
- /**
4191
- * 自动播放失败
4558
+ /** {zh}
4559
+ * @brief 自动播放失败。
4192
4560
  */
4193
4561
  AUTOPLAY_FAILED: string;
4194
- /**
4195
- * 右键菜单事件,事件data中包含具体信息
4562
+ /** {zh}
4563
+ * @brief 右键菜单事件。事件 `data` 中包含具体信息。
4196
4564
  */
4197
4565
  MENU_LOG: string;
4198
- /**
4199
- * 点击了右键菜单的反馈按钮
4566
+ /** {zh}
4567
+ * @brief 点击了右键菜单的反馈按钮。
4200
4568
  */
4201
4569
  MENU_REPORT: string;
4202
- /**
4203
- * 播放列表更新
4570
+ /** {zh}
4571
+ * @brief 播放列表更新。
4204
4572
  */
4205
4573
  PLAY_LIST_CHANGE: string;
4206
- /**
4207
- * 播放列表播放项变更
4574
+ /** {zh}
4575
+ * @brief 播放列表播放项变更。
4208
4576
  */
4209
4577
  PLAY_LIST_ITEM_CHANGE: string;
4210
4578
  /** {zh}
4211
- * 播放器完成实例化
4579
+ * @brief 播放器实例创建完成时触发。
4212
4580
  */
4213
4581
  /** {en}
4214
- * The player is instantiated.
4582
+ * @brief The player is instantiated.
4215
4583
  */
4216
4584
  READY: string;
4217
4585
  /** {zh}
4218
- * 播放器创建video完成,可以开始播放
4586
+ * @brief 播放器创建 `video` 完成时触发,表示可以开始播放。
4219
4587
  */
4220
4588
  /** {en}
4221
- * The player has created the video and the playback is ready to start.
4589
+ * @brief The player has created the video and the playback is ready to start.
4222
4590
  */
4223
4591
  COMPLETE: string;
4224
4592
  /** {zh}
4225
- * 播放资源发生变化
4593
+ * @brief 播放资源发生变化。
4226
4594
  */
4227
4595
  /** {en}
4228
- * The playback address changes.
4596
+ * @brief The playback address changes.
4229
4597
  */
4230
4598
  URL_CHANGE: string;
4231
4599
  /** {zh}
4232
- * 播放器聚焦
4600
+ * @brief 播放器聚焦。
4233
4601
  */
4234
4602
  /** {en}
4235
- * The player has focus.
4603
+ * @brief The player has focus.
4236
4604
  */
4237
4605
  PLAYER_FOCUS: string;
4238
4606
  /** {zh}
4239
- * 播放器失焦
4607
+ * @brief 播放器失焦。
4240
4608
  */
4241
4609
  /** {en}
4242
- * The player loses focus.
4610
+ * @brief The player loses focus.
4243
4611
  */
4244
4612
  PLAYER_BLUR: string;
4245
4613
  /** {zh}
4246
- * 系统全屏状态切换
4614
+ * @brief 系统全屏状态切换。
4247
4615
  */
4248
4616
  /** {en}
4249
- * The player switches to or from full-window mode, in which the player covers the entire desktop.
4617
+ * @brief The player switches to or from full-window mode, in which the player covers the entire desktop.
4250
4618
  */
4251
4619
  FULLSCREEN_CHANGE: string;
4252
4620
  /** {zh}
4253
- * 网页样式全屏状态切换
4621
+ * @brief 网页全屏状态切换。
4254
4622
  */
4255
4623
  /** {en}
4256
- * The player switches to or from full-screen mode, in which the player covers the browser window.
4624
+ * @brief The player switches to or from full-screen mode, in which the player covers the browser window.
4257
4625
  */
4258
4626
  CSS_FULLSCREEN_CHANGE: string;
4259
- /**
4260
- * @brief 画中画播放模式切换
4627
+ /** {zh}
4628
+ * @brief 画中画模式切换。
4261
4629
  */
4262
4630
  MINI_STATE_CHANGE: string;
4263
4631
  /** {zh}
4264
- * 播放器销毁
4632
+ * @brief 播放器销毁。
4265
4633
  */
4266
4634
  /** {en}
4267
- * The player is destroyed.
4635
+ * @brief The player is destroyed.
4268
4636
  */
4269
4637
  DESTROY: string;
4270
4638
  /** {zh}
4271
- * 播放器重新播放
4639
+ * @brief 播放器重新播放。
4272
4640
  */
4273
4641
  /** {en}
4274
- * Replay starts.
4642
+ * @brief Replay starts.
4275
4643
  */
4276
4644
  REPLAY: string;
4277
- /**
4278
- * @brief 重试
4645
+ /** {zh}
4646
+ * @brief 播放器重试。
4279
4647
  */
4280
4648
  RETRY: string;
4281
4649
  /** {zh}
4282
- * 清晰度发生变化
4650
+ * @brief 清晰度发生变化
4283
4651
  */
4284
4652
  /** {en}
4285
- * The video resolution changes.
4653
+ * @brief The video resolution changes.
4286
4654
  */
4287
4655
  DEFINITION_CHANGE: string;
4288
4656
  /** {zh}
@@ -4300,274 +4668,273 @@ export declare const Events: {
4300
4668
  */
4301
4669
  AFTER_DEFINITION_CHANGE: string;
4302
4670
  /** {zh}
4303
- * 播放器容器尺寸发生变化
4671
+ * @brief 播放器容器尺寸发生变化。
4304
4672
  */
4305
4673
  /** {en}
4306
- * The size of the player container changes.
4674
+ * @brief The size of the player container changes.
4307
4675
  */
4308
4676
  VIDEO_RESIZE: string;
4309
4677
  /** {zh}
4310
- * 画中画状态切换
4678
+ * @brief 画中画状态切换。
4311
4679
  */
4312
4680
  /** {en}
4313
- * The player switches to or from Picture-in-Picture (PIP) mode.
4681
+ * @brief The player switches to or from Picture-in-Picture (PIP) mode.
4314
4682
  */
4315
4683
  PIP_CHANGE: string;
4316
4684
  /** {zh}
4317
- * 播放器被旋转
4685
+ * @brief 播放器发生旋转。
4318
4686
  */
4319
4687
  /** {en}
4320
- * The player is rotated.
4688
+ * @brief The player is rotated.
4321
4689
  */
4322
4690
  ROTATE: string;
4323
4691
  /** {zh}
4324
- * 播放器内置快捷键事件触发
4692
+ * @brief 播放器内置快捷键事件被触发。
4325
4693
  */
4326
4694
  /** {en}
4327
4695
  * A built-in shortcut event occurs within the player.
4328
4696
  */
4329
4697
  SHORTCUT: string;
4330
4698
  /** {zh}
4331
- * SEI 信息解析
4699
+ * @brief SEI 信息解析。
4332
4700
  */
4333
4701
  /** {en}
4334
- * The player parses the SEI information.
4702
+ * @brief The player parses the SEI information.
4335
4703
  */
4336
4704
  SEI_PARSED: string;
4337
4705
  /** {zh}
4338
- * 内置插件用户行为触发,所有内置插件用户行为交互都会下发该事件,可用于用户行为埋点
4706
+ * @brief 内置插件用户行为触发。所有内置插件用户行为交互都会下发该事件,可用于用户行为埋点。
4339
4707
  */
4340
4708
  /** {en}
4341
- * A user event occurs within a built-in plug-in. This event applies to all built-in plug-ins and can be used for tracking user behaviors.
4709
+ * @brief A user event occurs within a built-in plug-in. This event applies to all built-in plug-ins and can be used for tracking user behaviors.
4342
4710
  */
4343
4711
  USER_ACTION: string;
4344
4712
  /** {zh}
4345
- * 自动播放成功
4713
+ * @brief 自动播放成功时触发。
4346
4714
  */
4347
4715
  /** {en}
4348
- * Autoplay starts successfully.
4716
+ * @brief Autoplay starts successfully.
4349
4717
  */
4350
4718
  AUTOPLAY_STARTED: string;
4351
4719
  /** {zh}
4352
- * 自动播放失败
4720
+ * @brief 自动播放失败时触发。
4353
4721
  */
4354
4722
  /** {en}
4355
- * Autoplay fails to start.
4723
+ * @brief Autoplay fails to start.
4356
4724
  */
4357
4725
  AUTOPLAY_PREVENTED: string;
4358
- /**
4359
- * 播放器完成创建
4726
+ /** {zh}
4727
+ * @brief 播放器完成创建。
4360
4728
  */
4361
4729
  PLAYER_CREATED_FINISH: string;
4362
- /**
4363
- * 播放器重建
4730
+ /** {zh}
4731
+ * @brief 播放器重建。
4364
4732
  */
4365
4733
  PLAYER_REBUILD: string;
4366
- /**
4367
- * 硬解不支持
4734
+ /** {zh}
4735
+ * @brief 硬解不支持时触发。
4368
4736
  */
4369
4737
  NOT_SUPPORT_HARDWARE_DECODER: string;
4370
- /**
4371
- * 软解不支持
4738
+ /** {zh}
4739
+ * @brief 软解不支持时触发。
4372
4740
  */
4373
4741
  NOT_SUPPORT_SOFT_DECODER: string;
4374
- /**
4375
- * playAuthToken 过期
4742
+ /** {zh}
4743
+ * @brief `playAuthToken` 过期
4376
4744
  */
4377
4745
  TOKEN_EXPIRED: string;
4378
- /**
4379
- * umd 加载失败
4746
+ /** {zh}
4747
+ * @brief UMD 加载失败。
4380
4748
  */
4381
4749
  UMD_LOAD_FAIL: string;
4382
- /**
4383
- * @brief 在播放被终止时触发。例如:当播放中的视频重新开始播放。
4750
+ /** {zh}
4751
+ * @brief 在播放被终止时触发。例如当播放中的视频重新开始播放。
4384
4752
  */
4385
4753
  ABORT: string;
4386
4754
  /** {zh}
4387
- * @brief在媒体数据已经有足够的数据(至少播放数帧)可供播放时触发。
4388
- **/
4755
+ * @brief 视频缓冲足够数据、可以播放时触发。
4756
+ */
4389
4757
  CANPLAY: string;
4390
4758
  /** {zh}
4391
- * @brief表明媒体可以在保持当前的下载速度的情况下不被中断地播放完毕。
4392
- * @notice 手动设置currentTime会使得firefox触发一次canplaythrough事件,其他浏览器或许不会如此。
4759
+ * @brief 视频可以流畅播放时触发。
4393
4760
  */
4394
4761
  CANPLAY_THROUGH: string;
4395
4762
  /** {zh}
4396
- * @brief表明媒体的长度发生了改变。例如:在媒体已被加载足够的长度从而得知总长度时会触发这个事件。
4763
+ * @brief 视频时长发生变化时触发。
4397
4764
  */
4398
4765
  DURATION_CHANGE: string;
4399
- /**
4400
- * @brief 媒体被清空(初始化)时触发
4766
+ /** {zh}
4767
+ * @brief 媒体被清空(初始化)时触发。
4401
4768
  */
4402
4769
  EMPITED: string;
4403
4770
  /** {zh}
4404
- * 视频播放完毕
4771
+ * @brief 视频播放完毕时触发。
4405
4772
  */
4406
4773
  /** {en}
4407
- * Video playback ends.
4774
+ * @brief Video playback ends.
4408
4775
  */
4409
4776
  ENDED: string;
4410
4777
  /** {zh}
4411
- * 发生错误
4778
+ * @brief 发生错误时触发。
4412
4779
  */
4413
4780
  ERROR: string;
4414
4781
  /** {zh}
4415
- * @brief媒体的第一帧已经加载完毕
4782
+ * @brief 视频起播数据加载完成时触发。
4416
4783
  */
4417
4784
  LOADED_DATA: string;
4418
- /**
4419
- * 媒体的元数据已经加载完毕,playerSdkIns.player.video 可获取所有的video属性
4785
+ /** {zh}
4786
+ * @brief 媒体的元数据已加载完毕,`playerSdkIns.player.video` 可获取所有的 `video` 属性。
4420
4787
  */
4421
4788
  LOADED_META_DATA: string;
4422
4789
  /** {zh}
4423
- * 媒体内容开始加载
4790
+ * @brief 媒体内容开始加载时触发。
4424
4791
  */
4425
4792
  LOAD_START: string;
4426
4793
  /** {zh}
4427
- * 视频暂停播放
4794
+ * @brief 视频暂停播放时触发。
4428
4795
  */
4429
4796
  /** {en}
4430
- * Video playback pauses.
4797
+ * @brief Video playback pauses.
4431
4798
  */
4432
4799
  PAUSE: string;
4433
4800
  /** {zh}
4434
- * @brief 视频开始播放
4801
+ * @brief 视频开始播放时触发。
4435
4802
  */
4436
4803
  /** {en}
4437
4804
  * @brief Video playback starts.
4438
4805
  */
4439
4806
  PLAY: string;
4440
4807
  /** {zh}
4441
- * 恢复播放(包括暂停后恢复播放或卡顿后恢复播放)
4808
+ * @brief 恢复播放时触发,包括暂停后恢复播放或卡顿后恢复播放。
4442
4809
  */
4443
4810
  /** {en}
4444
- * Video playback resumes after a pause or freeze.
4811
+ * @brief Video playback resumes after a pause or freeze.
4445
4812
  */
4446
4813
  PLAYING: string;
4447
- /**
4448
- * 媒体下载进度,即已缓存播放数据进度
4814
+ /** {zh}
4815
+ * @brief 报告媒体下载进度,即已缓存播放数据进度。
4449
4816
  */
4450
4817
  PROGRESS: string;
4451
- /**
4452
- * 播放速率变化
4818
+ /** {zh}
4819
+ * @brief 播放速率变化时触发。
4453
4820
  */
4454
4821
  RATE_CHANGE: string;
4455
- /**
4456
- * 在跳跃(seek)操作完成时触发
4822
+ /** {zh}
4823
+ * @brief Seek 操作完成时触发。
4457
4824
  */
4458
4825
  SEEKED: string;
4459
- /**
4460
- * 在跳跃(seek)操作开始时触发
4826
+ /** {zh}
4827
+ * @brief Seek 操作开始时触发。
4461
4828
  */
4462
4829
  SEEKING: string;
4463
- /**
4464
- * 在尝试获取媒体数据,但数据不可用时触发。
4830
+ /** {zh}
4831
+ * @brief 在尝试获取媒体数据、但数据不可用时触发。
4465
4832
  */
4466
4833
  STALLED: string;
4467
- /**
4468
- * 在媒体资源加载终止时触发,这可能是因为下载已完成或因为其他原因暂停。
4834
+ /** {zh}
4835
+ * @brief 媒体资源加载终止时触发。这可能是因为下载已完成或因为其他原因暂停。
4469
4836
  */
4470
4837
  SUSPEND: string;
4471
4838
  /** {zh}
4472
- * 视频播放时间更新
4839
+ * @brief 视频播放时间更新时触发。
4473
4840
  */
4474
4841
  /** {en}
4475
- * The video playback time is updated.
4842
+ * @brief The video playback time is updated.
4476
4843
  */
4477
4844
  TIME_UPDATE: string;
4478
4845
  /** {zh}
4479
- * 视频音量发生变化
4846
+ * @brief 视频音量发生变化时触发。
4480
4847
  */
4481
4848
  /** {en}
4482
- * The video volume changes.
4849
+ * @brief The video volume changes.
4483
4850
  */
4484
4851
  VOLUME_CHANGE: string;
4485
4852
  /** {zh}
4486
- * 等待加载数据
4853
+ * @brief 等待加载数据时触发。
4487
4854
  */
4488
4855
  /** {en}
4489
- * The player is loading data.
4856
+ * @brief The player is loading data.
4490
4857
  */
4491
4858
  WAITING: string;
4492
4859
  };
4493
4860
  export declare const Event: {
4494
4861
  SDKEvents: {
4495
4862
  /** {zh}
4496
- * 播放器完成实例化
4863
+ * @brief 播放器实例创建完成时触发。
4497
4864
  */
4498
4865
  /** {en}
4499
- * The player is instantiated.
4866
+ * @brief The player is instantiated.
4500
4867
  */
4501
4868
  READY: string;
4502
4869
  /** {zh}
4503
- * 播放器创建video完成,可以开始播放
4870
+ * @brief 播放器创建 `video` 完成时触发,表示可以开始播放。
4504
4871
  */
4505
4872
  /** {en}
4506
- * The player has created the video and the playback is ready to start.
4873
+ * @brief The player has created the video and the playback is ready to start.
4507
4874
  */
4508
4875
  COMPLETE: string;
4509
4876
  /** {zh}
4510
- * 播放资源发生变化
4877
+ * @brief 播放资源发生变化。
4511
4878
  */
4512
4879
  /** {en}
4513
- * The playback address changes.
4880
+ * @brief The playback address changes.
4514
4881
  */
4515
4882
  URL_CHANGE: string;
4516
4883
  /** {zh}
4517
- * 播放器聚焦
4884
+ * @brief 播放器聚焦。
4518
4885
  */
4519
4886
  /** {en}
4520
- * The player has focus.
4887
+ * @brief The player has focus.
4521
4888
  */
4522
4889
  PLAYER_FOCUS: string;
4523
4890
  /** {zh}
4524
- * 播放器失焦
4891
+ * @brief 播放器失焦。
4525
4892
  */
4526
4893
  /** {en}
4527
- * The player loses focus.
4894
+ * @brief The player loses focus.
4528
4895
  */
4529
4896
  PLAYER_BLUR: string;
4530
4897
  /** {zh}
4531
- * 系统全屏状态切换
4898
+ * @brief 系统全屏状态切换。
4532
4899
  */
4533
4900
  /** {en}
4534
- * The player switches to or from full-window mode, in which the player covers the entire desktop.
4901
+ * @brief The player switches to or from full-window mode, in which the player covers the entire desktop.
4535
4902
  */
4536
4903
  FULLSCREEN_CHANGE: string;
4537
4904
  /** {zh}
4538
- * 网页样式全屏状态切换
4905
+ * @brief 网页全屏状态切换。
4539
4906
  */
4540
4907
  /** {en}
4541
- * The player switches to or from full-screen mode, in which the player covers the browser window.
4908
+ * @brief The player switches to or from full-screen mode, in which the player covers the browser window.
4542
4909
  */
4543
4910
  CSS_FULLSCREEN_CHANGE: string;
4544
- /**
4545
- * @brief 画中画播放模式切换
4911
+ /** {zh}
4912
+ * @brief 画中画模式切换。
4546
4913
  */
4547
4914
  MINI_STATE_CHANGE: string;
4548
4915
  /** {zh}
4549
- * 播放器销毁
4916
+ * @brief 播放器销毁。
4550
4917
  */
4551
4918
  /** {en}
4552
- * The player is destroyed.
4919
+ * @brief The player is destroyed.
4553
4920
  */
4554
4921
  DESTROY: string;
4555
4922
  /** {zh}
4556
- * 播放器重新播放
4923
+ * @brief 播放器重新播放。
4557
4924
  */
4558
4925
  /** {en}
4559
- * Replay starts.
4926
+ * @brief Replay starts.
4560
4927
  */
4561
4928
  REPLAY: string;
4562
- /**
4563
- * @brief 重试
4929
+ /** {zh}
4930
+ * @brief 播放器重试。
4564
4931
  */
4565
4932
  RETRY: string;
4566
4933
  /** {zh}
4567
- * 清晰度发生变化
4934
+ * @brief 清晰度发生变化
4568
4935
  */
4569
4936
  /** {en}
4570
- * The video resolution changes.
4937
+ * @brief The video resolution changes.
4571
4938
  */
4572
4939
  DEFINITION_CHANGE: string;
4573
4940
  /** {zh}
@@ -4585,213 +4952,213 @@ export declare const Event: {
4585
4952
  */
4586
4953
  AFTER_DEFINITION_CHANGE: string;
4587
4954
  /** {zh}
4588
- * 播放器容器尺寸发生变化
4955
+ * @brief 播放器容器尺寸发生变化。
4589
4956
  */
4590
4957
  /** {en}
4591
- * The size of the player container changes.
4958
+ * @brief The size of the player container changes.
4592
4959
  */
4593
4960
  VIDEO_RESIZE: string;
4594
4961
  /** {zh}
4595
- * 画中画状态切换
4962
+ * @brief 画中画状态切换。
4596
4963
  */
4597
4964
  /** {en}
4598
- * The player switches to or from Picture-in-Picture (PIP) mode.
4965
+ * @brief The player switches to or from Picture-in-Picture (PIP) mode.
4599
4966
  */
4600
4967
  PIP_CHANGE: string;
4601
4968
  /** {zh}
4602
- * 播放器被旋转
4969
+ * @brief 播放器发生旋转。
4603
4970
  */
4604
4971
  /** {en}
4605
- * The player is rotated.
4972
+ * @brief The player is rotated.
4606
4973
  */
4607
4974
  ROTATE: string;
4608
4975
  /** {zh}
4609
- * 播放器内置快捷键事件触发
4976
+ * @brief 播放器内置快捷键事件被触发。
4610
4977
  */
4611
4978
  /** {en}
4612
4979
  * A built-in shortcut event occurs within the player.
4613
4980
  */
4614
4981
  SHORTCUT: string;
4615
4982
  /** {zh}
4616
- * SEI 信息解析
4983
+ * @brief SEI 信息解析。
4617
4984
  */
4618
4985
  /** {en}
4619
- * The player parses the SEI information.
4986
+ * @brief The player parses the SEI information.
4620
4987
  */
4621
4988
  SEI_PARSED: string;
4622
4989
  /** {zh}
4623
- * 内置插件用户行为触发,所有内置插件用户行为交互都会下发该事件,可用于用户行为埋点
4990
+ * @brief 内置插件用户行为触发。所有内置插件用户行为交互都会下发该事件,可用于用户行为埋点。
4624
4991
  */
4625
4992
  /** {en}
4626
- * A user event occurs within a built-in plug-in. This event applies to all built-in plug-ins and can be used for tracking user behaviors.
4993
+ * @brief A user event occurs within a built-in plug-in. This event applies to all built-in plug-ins and can be used for tracking user behaviors.
4627
4994
  */
4628
4995
  USER_ACTION: string;
4629
4996
  /** {zh}
4630
- * 自动播放成功
4997
+ * @brief 自动播放成功时触发。
4631
4998
  */
4632
4999
  /** {en}
4633
- * Autoplay starts successfully.
5000
+ * @brief Autoplay starts successfully.
4634
5001
  */
4635
5002
  AUTOPLAY_STARTED: string;
4636
5003
  /** {zh}
4637
- * 自动播放失败
5004
+ * @brief 自动播放失败时触发。
4638
5005
  */
4639
5006
  /** {en}
4640
- * Autoplay fails to start.
5007
+ * @brief Autoplay fails to start.
4641
5008
  */
4642
5009
  AUTOPLAY_PREVENTED: string;
4643
- /**
4644
- * 播放器完成创建
5010
+ /** {zh}
5011
+ * @brief 播放器完成创建。
4645
5012
  */
4646
5013
  PLAYER_CREATED_FINISH: string;
4647
- /**
4648
- * 播放器重建
5014
+ /** {zh}
5015
+ * @brief 播放器重建。
4649
5016
  */
4650
5017
  PLAYER_REBUILD: string;
4651
- /**
4652
- * 硬解不支持
5018
+ /** {zh}
5019
+ * @brief 硬解不支持时触发。
4653
5020
  */
4654
5021
  NOT_SUPPORT_HARDWARE_DECODER: string;
4655
- /**
4656
- * 软解不支持
5022
+ /** {zh}
5023
+ * @brief 软解不支持时触发。
4657
5024
  */
4658
5025
  NOT_SUPPORT_SOFT_DECODER: string;
4659
- /**
4660
- * playAuthToken 过期
5026
+ /** {zh}
5027
+ * @brief `playAuthToken` 过期
4661
5028
  */
4662
5029
  TOKEN_EXPIRED: string;
4663
- /**
4664
- * umd 加载失败
5030
+ /** {zh}
5031
+ * @brief UMD 加载失败。
4665
5032
  */
4666
5033
  UMD_LOAD_FAIL: string;
4667
5034
  };
4668
5035
  PluginEvents: {
4669
- /**
4670
- * 弹幕配置发生变化
5036
+ /** {zh}
5037
+ * @brief 弹幕配置发生变化。
4671
5038
  */
4672
5039
  DANMU_CHANGE: string;
4673
- /**
5040
+ /** {zh}
4674
5041
  * @hidden
4675
5042
  */
4676
5043
  TIME_SHIFT_CHANGE: string;
4677
- /**
5044
+ /** {zh}
4678
5045
  * @hidden
4679
5046
  */
4680
5047
  AI_SUBTITLE_LANG_CHANGE: string;
4681
- /**
5048
+ /** {zh}
4682
5049
  * @hidden
4683
5050
  */
4684
5051
  AI_SUBTITLE_MATCH: string;
4685
- /**
4686
- * 取消静音
5052
+ /** {zh}
5053
+ * @brief 取消静音。
4687
5054
  */
4688
5055
  CANCEL_UNMUTE: string;
4689
- /**
4690
- * 刷新按钮点击
5056
+ /** {zh}
5057
+ * @brief 刷新按钮被点击。
4691
5058
  */
4692
5059
  REFRESH_CLICK: string;
4693
- /**
4694
- * 报错时触发降级
5060
+ /** {zh}
5061
+ * @brief 报错时触发降级。
4695
5062
  */
4696
5063
  PLAY_BACKUP_CHANGE: string;
4697
- /**
4698
- * 报错时触发所有降级结束
5064
+ /** {zh}
5065
+ * @brief 报错时触发的降级结束。
4699
5066
  */
4700
5067
  PLAY_BACKUP_CHANGE_FINISH: string;
4701
- /**
4702
- * 报错时触发重试
5068
+ /** {zh}
5069
+ * @brief 报错时触发重试。
4703
5070
  */
4704
5071
  PLAY_ERROR_BUTTON_CLICK: string;
4705
- /**
4706
- * 播放url改变
5072
+ /** {zh}
5073
+ * @brief 播放 URL 改变。
4707
5074
  */
4708
5075
  PlAY_URL_CHANGE: string;
4709
- /**
4710
- * 展示报错
5076
+ /** {zh}
5077
+ * @brief 展示报错。
4711
5078
  */
4712
5079
  SHOW_PLAY_ERROR: string;
4713
- /**
5080
+ /** {zh}
4714
5081
  * @hidden
4715
5082
  */
4716
5083
  PLAYER_EXTEND_BUTTON: string;
4717
- /**
4718
- * 长时间waiting
5084
+ /** {zh}
5085
+ * @brief 长时间等待。
4719
5086
  */
4720
5087
  LONG_WAITING: string;
4721
- /**
4722
- * 频繁waiting
5088
+ /** {zh}
5089
+ * @brief 频繁等待。
4723
5090
  */
4724
5091
  OFTEN_WAITING: string;
4725
- /**
4726
- * 清晰度降级
5092
+ /** {zh}
5093
+ * @brief 清晰度降级。
4727
5094
  */
4728
5095
  DEFINITION_DEMOTE: string;
4729
- /**
4730
- *@hidden
5096
+ /** {zh}
5097
+ * @hidden
4731
5098
  */
4732
5099
  LARKWINDOW_CHANGE: string;
4733
- /**
5100
+ /** {zh}
4734
5101
  * @hidden
4735
5102
  */
4736
5103
  PANEL_MODE_CHANGE: string;
4737
- /**
4738
- * 清晰度切换
5104
+ /** {zh}
5105
+ * @brief 清晰度切换。
4739
5106
  */
4740
5107
  INNER_DEFINITION_CHANGE: string;
4741
- /**
4742
- * 线路切换
5108
+ /** {zh}
5109
+ * @brief 线路切换。
4743
5110
  */
4744
5111
  LINE_CHANGE: string;
4745
- /**
4746
- * playAuthToken获取url失败
5112
+ /** {zh}
5113
+ * @brief `playAuthToken` 获取 URL 失败。
4747
5114
  */
4748
5115
  GET_PLAY_URL_ERR: string;
4749
- /**
4750
- * 资源过期
5116
+ /** {zh}
5117
+ * @brief 资源过期。
4751
5118
  */
4752
5119
  MEDIA_EXPIRED: string;
4753
- /**
4754
- * 开启镜像
5120
+ /** {zh}
5121
+ * @brief 镜像开启。
4755
5122
  */
4756
5123
  MIRROR_CHANGE: string;
4757
- /**
4758
- * 音乐播放器快进快退跨度
5124
+ /** {zh}
5125
+ * @brief 音乐播放器快进或快退。
4759
5126
  */
4760
5127
  TIME_SCALE_CHANGE: string;
4761
- /**
4762
- * 音乐播放器播放模式改变
5128
+ /** {zh}
5129
+ * @brief 音乐播放模式切换。
4763
5130
  */
4764
5131
  MUSIC_MODE_CHANGE: string;
4765
- /**
4766
- * 音乐播放器切换音乐
5132
+ /** {zh}
5133
+ * @brief 音乐播放模式下切换音乐。
4767
5134
  */
4768
5135
  MUSIC_CHANGE: string;
4769
- /**
4770
- * 音乐播放列表发生变化
5136
+ /** {zh}
5137
+ * @brief 音乐播放列表发生变化。
4771
5138
  */
4772
5139
  MUSIC_LIST_CHANGE: string;
4773
- /**
4774
- * 自动播放成功
5140
+ /** {zh}
5141
+ * @brief 自动播放成功。
4775
5142
  */
4776
5143
  AUTOPLAY_SUCCESS: string;
4777
- /**
4778
- * 自动播放失败
5144
+ /** {zh}
5145
+ * @brief 自动播放失败。
4779
5146
  */
4780
5147
  AUTOPLAY_FAILED: string;
4781
- /**
4782
- * 右键菜单事件,事件data中包含具体信息
5148
+ /** {zh}
5149
+ * @brief 右键菜单事件。事件 `data` 中包含具体信息。
4783
5150
  */
4784
5151
  MENU_LOG: string;
4785
- /**
4786
- * 点击了右键菜单的反馈按钮
5152
+ /** {zh}
5153
+ * @brief 点击了右键菜单的反馈按钮。
4787
5154
  */
4788
5155
  MENU_REPORT: string;
4789
- /**
4790
- * 播放列表更新
5156
+ /** {zh}
5157
+ * @brief 播放列表更新。
4791
5158
  */
4792
5159
  PLAY_LIST_CHANGE: string;
4793
- /**
4794
- * 播放列表播放项变更
5160
+ /** {zh}
5161
+ * @brief 播放列表播放项变更。
4795
5162
  */
4796
5163
  PLAY_LIST_ITEM_CHANGE: string;
4797
5164
  };