@byteplus/veplayer 1.9.0-rc.0 → 1.9.0-rc.1

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