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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts DELETED
@@ -1,3694 +0,0 @@
1
- import VodLogger from '@byted/xgplayer-app-logger/es/logger.js';
2
- import { Property } from 'dom-helpers/esm/types';
3
- import EventEmitter from 'eventemitter3';
4
- import Player from 'xgplayer';
5
- import { Events as XgEvents, I18N, IXGI18nText, Plugin } from 'xgplayer';
6
-
7
- declare enum POSITIONS {
8
- ROOT = "root",
9
- ROOT_LEFT = "rootLeft",
10
- ROOT_RIGHT = "rootRight",
11
- ROOT_TOP = "rootTop",
12
- CONTROLS_LEFT = "controlsLeft",
13
- CONTROLS_RIGHT = "controlsRight",
14
- CONTROLS_CENTER = "controlsCenter"
15
- }
16
- /**
17
- * @detail Options
18
- *
19
- *
20
- * @export
21
- * @interface ISdkErrorConfig
22
- */
23
- export interface ISdkErrorConfig {
24
- /**
25
- * 报错时是否显示提示图片
26
- * 默认:true
27
- *
28
- * @type {boolean}
29
- * @memberof ISdkErrorConfig
30
- */
31
- errorImg?: boolean;
32
- /**
33
- * 报错时是否展示
34
- * 默认:true
35
- *
36
- * @type {boolean}
37
- * @memberof ISdkErrorConfig
38
- */
39
- errorTips?: boolean;
40
- /**
41
- * 报错时是否展示“刷新”按钮
42
- * 默认:true
43
- *
44
- * @type {boolean}
45
- * @memberof ISdkErrorConfig
46
- */
47
- isNeedRefreshButton?: boolean;
48
- /**
49
- * 报错后是否进行降级,true则降级到playlist中相应 backUrlList字段(type为 rtm 不能设置true)
50
- * 默认:false
51
- *
52
- * @type {boolean}
53
- * @memberof ISdkErrorConfig
54
- */
55
- isNeedDemoteBack?: boolean;
56
- /**
57
- *
58
- * 报错后重试次数
59
- * 默认: 1
60
- *
61
- * @type {number}
62
- * @memberof ISdkErrorConfig
63
- */
64
- retryLoopNum?: number;
65
- /**
66
- *
67
- * 报错后提示文案
68
- * 默认:播放发生错误,点击刷新试试吧
69
- *
70
- * @type {(HTMLElement | string)}
71
- * @memberof ISdkErrorConfig
72
- */
73
- errorTipsText?: HTMLElement | string;
74
- /**
75
- * 播放器中所处的位置
76
- * @hidden
77
- * @type {string}
78
- * @memberof ISdkErrorConfig
79
- */
80
- position?: POSITIONS;
81
- }
82
- /**
83
- * @detail Options
84
- *
85
- *
86
- * @export
87
- * @interface IRtmConfig
88
- */
89
- export interface IRtmConfig {
90
- /**
91
- * sdp接口请求超时等待时间, 单位 ms
92
- * 默认值: 5000
93
- *
94
- * @type {number}
95
- * @memberof IRtmConfig
96
- */
97
- loadTimeout?: number;
98
- /**
99
- * sdp接口请求失败时重试间隔时间, 单位 ms
100
- * 默认值:1000
101
- *
102
- * @type {number}
103
- * @memberof IRtmConfig
104
- */
105
- retryDelay?: number;
106
- /**
107
- * sdp接口请求失败时的重试次数
108
- * 默认值:0
109
- *
110
- * @type {number}
111
- * @memberof IRtmConfig
112
- */
113
- retryCount?: number;
114
- /**
115
- * rtc播放video不会触发waiting,通过timeupdate事件模拟,两次timeupdate事件触发间隔时间大于此值时模拟waiting事件触发 , 单位 ms
116
- * 默认值:300
117
- *
118
- * @type {number}
119
- * @memberof IRtmConfig
120
- */
121
- stallInterval?: number;
122
- /**
123
- * rtc起播建联失败时降级到flv或hls播放, 指定时开启降级,不指定建联失败对外抛error
124
- * 默认值:''
125
- *
126
- * @type {string}
127
- * @memberof IRtmConfig
128
- */
129
- backupURL?: string;
130
- /**
131
- * 降级到flv或者hls时需要的播放插件, 配合 backupURL使用
132
- * 默认值:null
133
- *
134
- * @type {('hls' | 'flv')}
135
- * @memberof IRtmConfig
136
- */
137
- backupStreamType: "hls" | "flv";
138
- }
139
- /**
140
- * @detail Options
141
- * @brief 弹幕相关设置
142
- *
143
- * @export
144
- * @interface InitConfig
145
- */
146
- export interface InitConfig {
147
- /**
148
- * 透明度, 枚举值[0, 33, 66, 99], 实际对应0, 0.33, 0.66, 1
149
- * 默认:99
150
- *
151
- * @type {number}
152
- * @memberof InitConfig
153
- */
154
- opacity?: number;
155
- /**
156
- * 枚举值[0, 33, 66, 99] 实际对应1/4, 1/2, 3/4, 1
157
- * 默认:99
158
- *
159
- * @type {number}
160
- * @memberof InitConfig
161
- */
162
- area?: number;
163
- /**
164
- * 速度, 枚举值[0, 20, 40, 60, 80, 100], 实际对应1/4, 1/2,1,5/4,3/2,2
165
- * 默认:40
166
- *
167
- * @type {number}
168
- * @memberof InitConfig
169
- */
170
- speed?: number;
171
- /**
172
- * 字体大小, 枚举值[0, 50, 100],实际对应14px 16px 20px
173
- * 默认:50
174
- *
175
- * @type {number}
176
- * @memberof InitConfig
177
- */
178
- fontSize?: number;
179
- /**
180
- * 是否打开面板
181
- * 默认:false
182
- *
183
- * @type {boolean}
184
- * @memberof InitConfig
185
- */
186
- active?: boolean;
187
- /**
188
- * 是否展示弹幕设置面板
189
- * 默认: true
190
- *
191
- * @type {boolean}
192
- * @memberof InitConfig
193
- */
194
- usePanel?: boolean;
195
- /**
196
- * 弹幕列表
197
- *
198
- * @type {DanmuItem[]}
199
- * @memberof InitConfig
200
- */
201
- danmuItems?: DanmuItem[];
202
- /**
203
- * @hidden
204
- *
205
- * @type {ExternalItem[]}
206
- * @memberof InitConfig
207
- */
208
- external?: ExternalItem[];
209
- /**
210
- * @hidden
211
- *
212
- * @type {IMaskConfig}
213
- * @memberof InitConfig
214
- */
215
- maskConfig?: IMaskConfig;
216
- /**
217
- * @hidden
218
- *
219
- * @type {boolean}
220
- * @memberof InitConfig
221
- */
222
- maskActive?: boolean;
223
- }
224
- export interface IMaskConfig {
225
- maskUrl: string;
226
- maskOffset?: number;
227
- interval?: number;
228
- }
229
- export interface Lang {
230
- zh: string;
231
- en: string;
232
- [props: string]: string;
233
- }
234
- /**
235
- * @detail Options
236
- *
237
- *
238
- * @export
239
- * @interface DanmuItem
240
- */
241
- export interface DanmuItem {
242
- /**
243
- * 弹幕唯一id
244
- *
245
- * @type {string}
246
- * @memberof DanmuItem
247
- */
248
- id: string;
249
- /**
250
- * 弹幕文案
251
- *
252
- * @type {string}
253
- * @memberof DanmuItem
254
- */
255
- txt: string;
256
- /**
257
- * 弹幕出现时间, 单位为ms
258
- *
259
- * @type {number}
260
- * @memberof DanmuItem
261
- */
262
- start?: number;
263
- /**
264
- * 是否优先显示
265
- * @hidden
266
- * @type {boolean}
267
- * @memberof DanmuItem
268
- */
269
- prior?: boolean;
270
- /**
271
- * 弹幕持续显示时间, 单位为ms
272
- *
273
- * @type {number}
274
- * @memberof DanmuItem
275
- */
276
- duration?: number;
277
- /**
278
- * 弹幕样式
279
- * style : {
280
- * color: '#ff9500',
281
- * fontSize: '20px',
282
- * padding: '2px 11px'
283
- * }
284
- *
285
- * @type {Partial<Record<Property, string>>}
286
- * @memberof DanmuItem
287
- */
288
- style?: Partial<Record<Property, string>>;
289
- }
290
- export interface ExternalItem {
291
- key: string;
292
- name: string;
293
- value: boolean;
294
- lang?: Lang;
295
- }
296
- /**
297
- * @detail Options
298
- *
299
- * @export
300
- * @interface ISubtitleConfig
301
- */
302
- export interface ISubtitleConfig {
303
- /**
304
- *
305
- * @hidden
306
- */
307
- [propName: string]: any;
308
- /**
309
- * 图标位置
310
- * 默认值:controlsRight
311
- * @type {string}
312
- * @memberof ISubtitleConfig
313
- */
314
- position?: string;
315
- /**
316
- * 图标排列权重
317
- * 默认值:6
318
- * @type {number}
319
- * @memberof ISubtitleConfig
320
- */
321
- index?: number;
322
- /**
323
- * 字幕列表
324
- * 默认值:无
325
- * @type {Array<SubTitleItem>}
326
- * @memberof ISubtitleConfig
327
- */
328
- list?: Array<ISubTitleItem>;
329
- /**
330
- * 是否默认打开
331
- * 默认值:true
332
- * @type {boolean}
333
- * @memberof ISubtitleConfig
334
- */
335
- isDefaultOpen?: boolean;
336
- /**
337
- * 是否显示图标
338
- * 默认值:true
339
- * @type {boolean}
340
- * @memberof ISubtitleConfig
341
- */
342
- isShowIcon?: boolean;
343
- /**
344
- * 字幕渲染模式,外挂字幕或原生字幕
345
- * 默认值:external
346
- * @type {string}
347
- * @memberof ISubtitleConfig
348
- */
349
- mode?: "external" | "native";
350
- /**
351
- * 字幕更新模式,默认vod
352
- * 默认值:vod
353
- * @type {string}
354
- * @memberof ISubtitleConfig
355
- */
356
- updateMode?: "vod" | "live";
357
- /**
358
- * 字幕样式
359
- * 默认值:无
360
- * @type {ISubtitleStyle}
361
- * @memberof ISubtitleConfig
362
- */
363
- style?: ISubtitleStyle;
364
- }
365
- /**
366
- * @detail Options
367
- *
368
- * @export
369
- * @interface ISubtitleStyle
370
- */
371
- export interface ISubtitleStyle {
372
- /**
373
- * 是否跟随控制栏调整位置
374
- * 默认值:true
375
- * @type {boolean | null}
376
- * @memberof ISubtitleStyle
377
- */
378
- follow: boolean | null;
379
- /**
380
- * 字体显示模式,默认是描边
381
- * 默认值:'stroke'
382
- * @type {'stroke' | 'bg'}
383
- * @memberof ISubtitleStyle
384
- */
385
- mode?: "stroke" | "bg";
386
- /**
387
- * 跟随底部控制栏的高度
388
- * 默认值:50
389
- * @type {number}
390
- * @memberof ISubtitleStyle
391
- */
392
- followBottom?: number;
393
- /**
394
- * 是否跟随视频自动调整字号
395
- * 默认值:true
396
- * @type {boolean}
397
- * @memberof ISubtitleStyle
398
- */
399
- fitVideo?: boolean;
400
- /**
401
- * 字幕距离画面底部百分比
402
- * 默认值:4
403
- * @type {number}
404
- * @memberof ISubtitleStyle
405
- */
406
- offsetBottom?: number;
407
- /**
408
- * 横屏视频适配基准字号
409
- * 默认值:49
410
- * @type {number}
411
- * @memberof ISubtitleStyle
412
- */
413
- baseSizeX?: number;
414
- /**
415
- * 竖屏视频适配基准字号
416
- * 默认值:28
417
- * @type {number}
418
- * @memberof ISubtitleStyle
419
- */
420
- baseSizeY?: number;
421
- /**
422
- * pc端最小字号
423
- * 默认值:16
424
- * @type {number}
425
- * @memberof ISubtitleStyle
426
- */
427
- minSize?: number;
428
- /**
429
- * 移动端最小字号
430
- * 默认值:13
431
- * @type {number}
432
- * @memberof ISubtitleStyle
433
- */
434
- minMobileSize?: number;
435
- /**
436
- * 最大显示行数
437
- * 默认值:'double'
438
- * @type {'double' | 'single' | 'three'}
439
- * @memberof ISubtitleStyle
440
- */
441
- line?: "double" | "single" | "three";
442
- /**
443
- * 字体颜色, 16位颜色值或rgb值
444
- * 默认值:'#fff'
445
- * @type {string}
446
- * @memberof ISubtitleStyle
447
- */
448
- fontColor?: string;
449
- }
450
- /**
451
- * @detail Options
452
- *
453
- * @export
454
- * @interface ISubTitleItem
455
- */
456
- export interface ISubTitleItem {
457
- /**
458
- * 字幕语言
459
- * 默认值:无
460
- * @type {string | number}
461
- * @memberof ISubTitleItem
462
- */
463
- language?: string | number;
464
- /**
465
- * 字幕id
466
- * 默认值:无
467
- * @type {string | number}
468
- * @memberof ISubTitleItem
469
- */
470
- id?: number | string;
471
- /**
472
- * 是否是默认选择的字幕
473
- * 默认值:false
474
- * @type {boolean}
475
- * @memberof ISubTitleItem
476
- */
477
- isDefault?: boolean;
478
- /**
479
- * 字幕名称
480
- * 默认值:无
481
- * @type {any}
482
- * @memberof ISubTitleItem
483
- */
484
- text?: any;
485
- /**
486
- * 外挂字幕地址
487
- * 默认值:false
488
- * @type {string}
489
- * @memberof ISubTitleItem
490
- */
491
- url?: string;
492
- /**
493
- * stringContent
494
- * 默认值:无
495
- * @hidden
496
- * @type {string}
497
- * @memberof ISubTitleItem
498
- */
499
- stringContent?: string;
500
- /**
501
- * 字幕内容列表,非url形式时使用
502
- * 默认值:无
503
- * @type {Array<Object>}
504
- * @memberof ISubTitleItem
505
- */
506
- list?: IListItem[];
507
- }
508
- /**
509
- * @detail Options
510
- *
511
- * @export
512
- * @interface IListItem
513
- */
514
- export interface IListItem {
515
- /**
516
- * 开始时间
517
- * @type {number}
518
- */
519
- start: number;
520
- /**
521
- * 结束时间
522
- * @type {number}
523
- */
524
- end: number;
525
- /**
526
- * 字幕数据列表
527
- * @type {Array<ITextItem>}
528
- */
529
- list: Array<ITextItem>;
530
- /**
531
- * 默认值:无
532
- * @hidden
533
- * @type {any}
534
- */
535
- [propName: string]: any;
536
- }
537
- /**
538
- * @detail Options
539
- *
540
- * @export
541
- * @interface ITextItem
542
- */
543
- export interface ITextItem {
544
- /**
545
- * 默认值:无
546
- * @hidden
547
- * @type {any}
548
- */
549
- [propName: string]: any;
550
- /**
551
- * 开始时间
552
- * @type {number}
553
- */
554
- start: number;
555
- /**
556
- * 结束时间
557
- * @type {number}
558
- */
559
- end: number;
560
- /**
561
- * 字幕文案数组
562
- * @type {string[]}
563
- */
564
- text: string[];
565
- /**
566
- * 字幕顺序
567
- * @type {number}
568
- */
569
- index?: number;
570
- }
571
- /**
572
- * @detail Options
573
- *
574
- *
575
- * @export
576
- * @interface IDefinitionDemotePlugin
577
- */
578
- export interface IDefinitionDemotePlugin {
579
- /**
580
- * 超时重试次数
581
- * 默认:3
582
- *
583
- * @type {number}
584
- * @memberof IDefinitionDemotePlugin
585
- */
586
- oftenWaitingCount?: number;
587
- /**
588
- * 设置经常超时时间
589
- * 默认:5000
590
- *
591
- * @type {number}
592
- * @memberof IDefinitionDemotePlugin
593
- */
594
- oftenWaitingTime?: number;
595
- /**
596
- * 设置超时时间
597
- * 默认5000
598
- *
599
- * @type {number}
600
- * @memberof IDefinitionDemotePlugin
601
- */
602
- longWaitingTime?: number;
603
- /**
604
- * 是否自动触发降级
605
- * 默认:false
606
- *
607
- * @type {boolean}
608
- * @memberof IDefinitionDemotePlugin
609
- */
610
- isNeedAutoDemote?: boolean;
611
- /**
612
- *
613
- * 降级顺序,按照数组顺序依次降级,数字元素对应playList中的definition
614
- * 默认: ['uhd', 'hd', 'sd', 'ld', 'ao']
615
- *
616
- * @type {string[]}
617
- * @memberof IDefinitionDemotePlugin
618
- */
619
- demotePriority?: string[];
620
- }
621
- /**
622
- * @detail Options
623
- * @brief 更多options
624
- * @id 2
625
- *
626
-
627
- /**
628
- * dash播放配置想
629
- *
630
- * @detail Options
631
- * @export
632
- * @interface IDashPluginConfig
633
- */
634
- export interface IDashPluginConfig {
635
- /**
636
- * 视频vid
637
- * 默认:无
638
- * 播放加密视频时必选
639
- */
640
- vid?: string;
641
- /**
642
- * 播放类型
643
- * 默认:`TOP`
644
- * 非必选
645
- */
646
- playInfoType: "TOP";
647
- /**
648
- * 清晰度映射文案
649
- * 默认:无
650
- * 非必选
651
- * @example
652
- * ``` javascript
653
- * { 360p: "流畅 360p",
654
- * 480p: "清晰 480p",
655
- * 720p: "高清 720p",
656
- * 1080p: "超高清 1080p"
657
- * }
658
- * ```
659
- */
660
- definitionText: Record<string, string>;
661
- /**
662
- * 默认清晰度
663
- * 默认:列表第一个
664
- * 非必选
665
- * @example
666
- * ``` javascript
667
- * { 360p: "流畅 360p",
668
- * 480p: "清晰 480p",
669
- * 720p: "高清 720p",
670
- * 1080p: "超高清 1080p"
671
- * }
672
- * ```
673
- */
674
- defaultDefinition?: string;
675
- /**
676
- * 获取证书地址
677
- * 默认:`//i.snssdk.com/video/drm/v1/play_licenses`
678
- * 播放加密视频时必选
679
- */
680
- getLicenseUrl?: string;
681
- /**
682
- * dash播放信息,由`Service.url`服务接口获取
683
- * 默认:无
684
- * 必选
685
- */
686
- dashOpts?: {
687
- Data: any;
688
- };
689
- /**
690
- * 兜底的mp4播放列表,由`Service.url`服务接口获取
691
- * 默认:无
692
- * 非必选
693
- */
694
- mp4Opts: {
695
- mp4List: mp4OptsItem[];
696
- };
697
- /**
698
- * 预加载时间,单位ms
699
- * 默认:undefined
700
- * 非必选
701
- */
702
- preloadTime?: number;
703
- /**
704
- * @hidden
705
- * 自适应配置项
706
- * 默认:undefined
707
- * 非必选
708
- */
709
- autoBitrateOpts?: any;
710
- /**
711
- * @hidden
712
- * 备用地址降级,默认情况下,当dash播放出问题后,会降级为mp4播放;
713
- * 设置改参数后,会优先使用备用地址进行dash的降级播放,再次出错时,会降级为mp4播放
714
- * 默认:false
715
- * 非必选
716
- */
717
- useBackUrl?: boolean;
718
- /**
719
- * @hidden
720
- * 优化首帧
721
- * 是针对域名,将range参数放在url后面,避免OPTIONS请求,从而优化首帧
722
- * 默认:无
723
- * 非必选
724
- */
725
- url_range_domains?: string[];
726
- }
727
- /**
728
- * dash播放的mp4兜底播放列表配置
729
- *
730
- * @detail Options
731
- * @export
732
- * @interface mp4OptsItem
733
- */
734
- export interface mp4OptsItem {
735
- /**
736
- * 清晰度
737
- * 默认: 无
738
- * 必传
739
- */
740
- definition: string;
741
- /**
742
- * mp4地址
743
- * 默认: 无
744
- * 必传
745
- */
746
- url: string;
747
- }
748
- /**
749
- * DASH播放配置
750
- *
751
- * @detail Options
752
- * @export
753
- * @interface IDashPluginConfig
754
- */
755
- export interface IEncryptHlsPluginConfig {
756
- /**
757
- * 播放地址请求域名
758
- * 默认:无
759
- * 必选
760
- */
761
- playDomain: string;
762
- /**
763
- * 请求类型,固定值 'TOP'
764
- * 默认: 无
765
- */
766
- getKeyType: string;
767
- /**
768
- * 密钥请求域名
769
- * 默认:无
770
- * 必选
771
- */
772
- keyDomain: string;
773
- /**
774
- * 播放地址获取token,由服务端生成下发,详见{@link https://www.volcengine.com/docs/4/67350#%E4%B8%B4%E6%97%B6%E5%AE%89%E5%85%A8%E5%87%AD%E8%AF%81%E6%9C%BA%E5%88%B6%E8%AF%B4%E6%98%8E 播放临时安全凭证(PlayAuthToken)}
775
- * 默认:无
776
- * 必选
777
- */
778
- playAuthToken: string;
779
- /**
780
- * 密钥获取token,由服务端生成下发,详见{@link https://www.volcengine.com/docs/4/65659#%E7%AD%BE%E5%8F%91-hls-%E6%A0%87%E5%87%86%E5%8A%A0%E5%AF%86-authtoken%EF%BC%88sha1hlsdrmauthtoken%EF%BC%89 签发 Hls 标准加密AuthToken}
781
- * 默认:无
782
- * 必选
783
- */
784
- keyToken: string;
785
- /**
786
- * hls加密播放地址
787
- * 默认:无
788
- */
789
- url?: string;
790
- }
791
- /**
792
- * 质量日志配置
793
- *
794
- * @detail Options
795
- * @export
796
- * @interface IVodLogOptsConfig
797
- */
798
- export interface IVodLogOptsConfig {
799
- /**
800
- * 表示业务来源,使用业务自己的appid即可
801
- * 默认:无
802
- * 必选
803
- */
804
- line_app_id: number;
805
- /**
806
- * 用于识别单一用户的id
807
- * 默认:无
808
- * 必选
809
- */
810
- line_user_id: string | number;
811
- /**
812
- * 视频类型
813
- * 默认:无
814
- * 必选
815
- */
816
- vtype?: "MP4" | "HLS" | "DASH" | "FLV";
817
- /**
818
- * 自定义标签,对应控制台"业务维类型"维度
819
- * 默认:`default`
820
- * 必选
821
- */
822
- tag?: string;
823
- /**
824
- * 自定义子标签,对应控制台"自定义标签"维度
825
- * 默认:`default`
826
- * 必选
827
- */
828
- subtag?: string;
829
- /**
830
- * 视频解码器类型名称
831
- * 默认:`h264`
832
- * 必选
833
- */
834
- codec_type?: "h264" | "h265";
835
- /**
836
- * 是否加密,0:非drm视频,1:drm视频
837
- * 默认:`0`
838
- * 可选
839
- */
840
- drm_type?: 0 | 1;
841
- /**
842
- * 播放内核版本号
843
- * 默认:无
844
- * 可选
845
- */
846
- playerCoreVersion?: string;
847
- /**
848
- * 播放器版本号
849
- * 默认:无
850
- * 可选
851
- */
852
- playerVersion?: string;
853
- /**
854
- * DASH播放的封装类型
855
- * 默认:无
856
- * 可选
857
- */
858
- dynamic_type?: "segment_base" | "segment_template";
859
- /**
860
- * 是否使用bash,0:不使用,1:使用
861
- * 默认:`0`
862
- * 可选
863
- */
864
- enable_bash?: 0 | 1;
865
- /**
866
- * 发送的埋点日志是本地缓存的时候回调
867
- * 默认:无
868
- * 可选
869
- */
870
- sendLocalCallback?: (event: any, data: any) => void;
871
- /**
872
- * 是否禁用localStorage暂时缓存onPlay逻辑
873
- * 默认:`false`
874
- * 可选
875
- */
876
- disableLocalCache?: boolean;
877
- /**
878
- * 数据上报渠道,可选值:cn(国内)、va(美东) 、sg(新加坡)
879
- * 默认:`cn`
880
- * 可选
881
- */
882
- channel?: "cn" | "va" | "sg";
883
- /**
884
- * 是否关闭清晰度切换埋点
885
- * 默认:`false`
886
- * 可选
887
- */
888
- closeResolutionLog?: boolean;
889
- /**
890
- * 关闭seek相关埋点
891
- * 默认:`false`
892
- * 可选
893
- */
894
- closeSeekLog?: boolean;
895
- /**
896
- * 队列超过多少条日志的时候发送
897
- * 默认:`5`
898
- * 可选
899
- */
900
- maxQueueCount?: number;
901
- }
902
- /**
903
- * mp4加密日志配置项
904
- *
905
- * @detail Options
906
- * @export
907
- * @interface IMp4EncryptPlayerConfig
908
- */
909
- export interface IMp4EncryptPlayerConfig {
910
- /**
911
- * 是否加密
912
- * 默认:`false`
913
- * 可选
914
- */
915
- isEncrypt?: boolean;
916
- /**
917
- * 视频vid
918
- * 默认:无
919
- * 可选
920
- */
921
- vid?: string;
922
- /**
923
- * 视频密钥 id
924
- * 默认:无
925
- * 可选
926
- */
927
- kid?: string;
928
- /**
929
- * 获取密钥凭证地址
930
- * 默认:无
931
- * 可选
932
- */
933
- getLicenseUrl?: string;
934
- /**
935
- * 是否使用EME
936
- * 默认:`false`
937
- * 可选
938
- */
939
- useEME?: boolean;
940
- /**
941
- * 视频密钥值
942
- * 默认:无
943
- * 可选
944
- */
945
- keyValue?: string;
946
- /**
947
- * 加密后的视频密钥值
948
- * 默认:无
949
- * 可选
950
- */
951
- secretKey?: string;
952
- /**
953
- * 是否携带cookie
954
- */
955
- withCredentials?: boolean;
956
- /**
957
- * drm内容
958
- * 默认:无
959
- * 可选
960
- */
961
- drm?: {
962
- clearKeys: {
963
- [propName: string]: string;
964
- };
965
- };
966
- }
967
- export declare type IDefinition = {
968
- [propName: string]: any;
969
- url: any;
970
- definition: any;
971
- bitrate?: number;
972
- bandwidth?: number;
973
- text?: string | {
974
- [propName: string]: any;
975
- };
976
- iconText?: string | {
977
- [propName: string]: any;
978
- };
979
- };
980
- export declare type IPlayerOptions = {
981
- [propName: string]: any;
982
- id?: string;
983
- el?: HTMLElement;
984
- url?: any;
985
- domEventType?: "default" | "touch" | "mouse";
986
- nullUrlStart?: boolean;
987
- width?: number | string;
988
- height?: number | string;
989
- fluid?: boolean;
990
- fitVideoSize?: "fixWidth" | "fixHeight" | "fixed";
991
- videoFillMode?: "auto" | "fillHeight" | "fillWidth" | "fill" | "cover";
992
- volume?: number | {
993
- [propName: string]: any;
994
- };
995
- autoplay?: boolean;
996
- autoplayMuted?: boolean;
997
- loop?: boolean;
998
- isLive?: boolean;
999
- zoom?: number;
1000
- videoInit?: boolean;
1001
- poster?: string | {
1002
- [propName: string]: any;
1003
- };
1004
- isMobileSimulateMode?: "mobile" | "pc";
1005
- defaultPlaybackRate?: number;
1006
- execBeforePluginsCall?: () => any;
1007
- allowSeekAfterEnded?: boolean;
1008
- enableContextmenu?: boolean;
1009
- closeVideoClick?: boolean;
1010
- closeVideoDblclick?: boolean;
1011
- closePlayerBlur?: boolean;
1012
- closeDelayBlur?: boolean;
1013
- leavePlayerTime?: number;
1014
- closePlayVideoFocus?: boolean;
1015
- closePauseVideoFocus?: boolean;
1016
- closeFocusVideoFocus?: boolean;
1017
- closeControlsBlur?: boolean;
1018
- topBarAutoHide?: boolean;
1019
- videoAttributes?: {
1020
- [propName: string]: any;
1021
- };
1022
- startTime?: number;
1023
- seekedStatus?: "play" | "pause" | "auto";
1024
- miniprogress?: boolean;
1025
- disableSwipeHandler?: () => any;
1026
- enableSwipeHandler?: () => any;
1027
- ignores?: Array<"cssfullscreen" | "screenshot" | "pip" | "miniscreen" | "keyboard" | "download" | "playbackrate" | "time" | "definition" | "error" | "fullscreen" | "loading" | "mobile" | "pc" | "play" | "poster" | "progress" | "replay" | "start" | "volume" | string>;
1028
- inactive?: number;
1029
- lang?: string;
1030
- controls?: boolean | {
1031
- [propName: string]: any;
1032
- };
1033
- marginControls?: boolean;
1034
- fullscreenTarget?: HTMLElement;
1035
- screenShot?: boolean | {
1036
- [propName: string]: any;
1037
- };
1038
- rotate?: boolean | {
1039
- [propName: string]: any;
1040
- };
1041
- pip?: boolean | {
1042
- [propName: string]: any;
1043
- };
1044
- download?: boolean | {
1045
- [propName: string]: any;
1046
- };
1047
- mini?: boolean | {
1048
- [propName: string]: any;
1049
- };
1050
- cssFullscreen?: boolean | {
1051
- [propName: string]: any;
1052
- };
1053
- keyShortcut?: boolean;
1054
- presets?: any[];
1055
- plugins?: any[];
1056
- playbackRate?: number | number[] | {
1057
- [propName: string]: any;
1058
- };
1059
- definition?: {
1060
- [propName: string]: any;
1061
- list: Array<IDefinition>;
1062
- defaultDefinition?: IDefinition["definition"];
1063
- };
1064
- playsinline?: boolean;
1065
- customDuration?: number;
1066
- timeOffset?: number;
1067
- icons?: {
1068
- [propName: string]: string | HTMLElement | (() => HTMLElement | string);
1069
- };
1070
- i18n?: Array<any>;
1071
- tabindex?: number;
1072
- thumbnail?: {
1073
- urls: Array<string>;
1074
- pic_num: number;
1075
- col: number;
1076
- row: number;
1077
- height?: number;
1078
- width?: number;
1079
- };
1080
- videoConfig?: {
1081
- [propName: string]: any;
1082
- };
1083
- commonStyle?: {
1084
- progressColor?: string;
1085
- playedColor?: string;
1086
- cachedColor?: string;
1087
- sliderBtnStyle?: {
1088
- [propName: string]: any;
1089
- };
1090
- volumeColor?: string;
1091
- };
1092
- };
1093
- export interface IAutoplayPluginConfig {
1094
- position?: string;
1095
- enableDegradeMuteAutoplay?: boolean;
1096
- enableWxJsBridgeAutoplay?: boolean;
1097
- userActionDom?: Node;
1098
- enableUserActionAutoplay?: boolean;
1099
- }
1100
- export interface IPlayInfoList {
1101
- BackupPlayUrl: string;
1102
- BackupUrlExpire: string;
1103
- BarrageMaskOffset: string;
1104
- Bitrate: number;
1105
- CheckInfo: string;
1106
- Codec: string;
1107
- Definition: string;
1108
- Duration: number;
1109
- FileId: string;
1110
- FileType: string;
1111
- Format: string;
1112
- Height: number;
1113
- IndexRange: string;
1114
- InitRange: string;
1115
- KeyFrameAlignment: string;
1116
- LogoType: string;
1117
- MainPlayUrl: string;
1118
- MainUrlExpire: string;
1119
- Md5: string;
1120
- PlayAuth: string;
1121
- PlayAuthId: string;
1122
- Quality: string;
1123
- Size: number;
1124
- Volume?: number;
1125
- Width: number;
1126
- }
1127
- declare enum CodecType {
1128
- H265 = "h265",
1129
- H264 = "h264",
1130
- UNKNOWN = "unknown"
1131
- }
1132
- declare enum RTMCodec {
1133
- H264 = "h264"
1134
- }
1135
- export declare type TRegionType = "cn" | "va" | "sg";
1136
- export declare type PlayModeType = "order" | "sloop" | "loop" | "random";
1137
- export interface IMusicListItem {
1138
- /**
1139
- * 音乐地址
1140
- *
1141
- * @type {string}
1142
- * @memberof IMusicListItem
1143
- */
1144
- src: string;
1145
- /**
1146
- * 音乐唯一vid
1147
- *
1148
- * @type {string | number}
1149
- * @memberof IMusicListItem
1150
- */
1151
- vid: string | number;
1152
- /**
1153
- * 音乐封面
1154
- *
1155
- * @type {string}
1156
- * @memberof IMusicListItem
1157
- */
1158
- poster?: string;
1159
- /**
1160
- * 音乐标题
1161
- *
1162
- * @type {string}
1163
- * @memberof IMusicListItem
1164
- */
1165
- title?: string;
1166
- [propName: string]: any;
1167
- }
1168
- export interface IABCycle {
1169
- /**
1170
- * AB循环段开始时间
1171
- *
1172
- * @type {boolean}
1173
- * @memberof IABCycle
1174
- */
1175
- start: number;
1176
- /**
1177
- * AB循环段结束时间
1178
- *
1179
- * @type {boolean}
1180
- * @memberof IABCycle
1181
- */
1182
- end: number;
1183
- /**
1184
- * AB段是否循环播放
1185
- *
1186
- * @type {boolean}
1187
- * @memberof IABCycle
1188
- */
1189
- loop?: boolean;
1190
- [propName: string]: any;
1191
- }
1192
- export interface IMusicConfig {
1193
- /**
1194
- * 是否启用离线下载播放
1195
- *
1196
- * @type {boolean}
1197
- * @memberof IMusicConfig
1198
- */
1199
- offline?: boolean;
1200
- /**
1201
- * AB循环设置
1202
- *
1203
- * @type {IABCycle}
1204
- * @memberof IMusicConfig
1205
- */
1206
- abCycle?: IABCycle | null;
1207
- /**
1208
- * 快进快退时间跨度
1209
- *
1210
- * @type {number}
1211
- * @memberof IMusicConfig
1212
- */
1213
- timeScale?: number;
1214
- /**
1215
- * 循环模式
1216
- *
1217
- * @type {('order' | 'sloop' | 'loop' | 'random')}
1218
- * @memberof IMusicConfig
1219
- */
1220
- mode?: PlayModeType;
1221
- /**
1222
- * 播放列表
1223
- *
1224
- * @type {Array<IMusicListItem>}
1225
- * @memberof IMusicConfig
1226
- */
1227
- list?: Array<IMusicListItem>;
1228
- [propName: string]: any;
1229
- }
1230
- /**
1231
- * @detail Options
1232
- * @brief 播放地址列表, 可配置多线路和多清晰度
1233
- *
1234
- * @export
1235
- * @interface Stream
1236
- */
1237
- export interface Stream extends IPlayInfoList {
1238
- /**
1239
- * url类型,可以选值为“rtm”/“flv”/“mp4”/“hls”
1240
- *
1241
- * @type {('rtm' | 'flv' | 'mp4' | 'hls')}
1242
- * @memberof IPlayerConfig
1243
- */
1244
- streamType?: string;
1245
- /**
1246
- * 播放地址
1247
- *
1248
- * @type {string}
1249
- * @memberof IPlayerConfig
1250
- */
1251
- url: string;
1252
- /**
1253
- * 清晰度key
1254
- *
1255
- * @type {string}
1256
- * @memberof Stream
1257
- */
1258
- definition?: string;
1259
- /**
1260
- * 多语言词典中对应的key, 比如 definitionTextKey: HD_TEXT_KEY
1261
- *
1262
- * languages: {
1263
- * zh: {
1264
- * HD_TEXT_KEY: '高清'
1265
- * }
1266
- * }
1267
- *
1268
- * 则清晰度切换选项显示“高清”, 不设置则显示definition的值
1269
- *
1270
- * @type {string}
1271
- * @memberof Stream
1272
- */
1273
- definitionTextKey?: string;
1274
- /**
1275
- * 编码格式
1276
- *
1277
- * @type {('h265' | 'h264')}
1278
- * @memberof Stream
1279
- */
1280
- codec?: CodecType;
1281
- /**
1282
- * 线路唯一id
1283
- *
1284
- * @type {(number | string)}
1285
- * @memberof Stream
1286
- */
1287
- lineId?: number | string;
1288
- /**
1289
- * 多语言词典中对应的key, 比如 lineTextKey: LINE_ONE
1290
- *
1291
- * languages: {
1292
- * zh: {
1293
- * LINE_ONE: '线路一'
1294
- * }
1295
- * }
1296
- *
1297
- * 则线路切换选项中显示“线路一”
1298
- *
1299
- * @type {string}
1300
- * @memberof Stream
1301
- */
1302
- lineTextKey?: string;
1303
- [propName: string]: any;
1304
- }
1305
- export interface Condition {
1306
- definition?: string;
1307
- lineId?: number | string;
1308
- [propName: string]: any;
1309
- }
1310
- /**
1311
- * @description 播放器当前状态
1312
- */
1313
- export interface Current {
1314
- definition: string;
1315
- streamType: string;
1316
- language: string;
1317
- lineId?: number | string;
1318
- codec?: CodecType;
1319
- [propName: string]: any;
1320
- }
1321
- /**
1322
- * @detail Options
1323
- * @id 1
1324
- * @brief options参数列表:
1325
- * 本文档是介绍火山引擎直播和点播播放器VePlayer的相关参数和Api。
1326
- */
1327
- export interface IPlayerConfig extends IPlayerOptions {
1328
- /**
1329
- * 是否是直播,默认为false
1330
- * @type {boolean}
1331
- * @memberof IPlayerConfig
1332
- */
1333
- isLive?: boolean;
1334
- /**
1335
- * 播放器容器id,VePlayer将被插入在该容器中
1336
- *
1337
- * @notes id和root必填一个
1338
- * @type {string}
1339
- * @memberof IPlayerConfig
1340
- */
1341
- id?: string;
1342
- /**
1343
- * 播放器容器,VePlayer将被插入在该容器中
1344
- *
1345
- * @type {HTMLElement}
1346
- * @memberof IPlayerConfig
1347
- */
1348
- root?: HTMLElement;
1349
- /**
1350
- * 播放地址
1351
- * 直播可通过 {@link https://console.volcengine.com/live/main/locationGenerate 视频直播控制台} 生成
1352
- *
1353
- * @type {string}
1354
- * @memberof IPlayerConfig
1355
- */
1356
- url?: string;
1357
- /**
1358
- * 播放地址类型,可以选值为“rtm”/“flv”/“mp4”/“hls”
1359
- * @notes 播放地址带后缀的则streamType非必填,否则为必填
1360
- *
1361
- * @type {(''mp4' | 'hls' | 'dash' | 'rtm' | 'flv')}
1362
- * @memberof IPlayerConfig
1363
- */
1364
- streamType?: "mp4" | "hls" | "dash" | "rtm" | "flv";
1365
- /**
1366
- * 区域,影响服务接口和日志上报
1367
- * @volcengine/veplayer默认区域为cn, @byteplus/veplayer默认区域为sg
1368
- * 火山引擎海外区域播放时请填写'sg'
1369
- *
1370
- * @type {TRegionType}
1371
- * @memberof IPlayerConfig
1372
- */
1373
- region?: TRegionType;
1374
- /**
1375
- * 插件加载公共路径,用于指定插件的加载路径,或者本地文件服务加载插件
1376
- *
1377
- * @type {(string)}
1378
- * @memberof IPlayerConfig
1379
- */
1380
- pluginPublicPath?: string;
1381
- /**
1382
- * 是否音乐播放器模式
1383
- *
1384
- * @type {boolean}
1385
- * @memberof IPlayerConfig
1386
- */
1387
- isMusic?: boolean;
1388
- /**
1389
- * 是否开启播放器原生控件菜单(右键触发)
1390
- *
1391
- * @type {boolean}
1392
- * @memberof IPlayerConfig
1393
- */
1394
- enableContextmenu?: boolean;
1395
- /**
1396
- * 关闭video上的阻止事件传播
1397
- *
1398
- * @type {boolean}
1399
- * @memberof IPlayerConfig
1400
- */
1401
- closeVideoStopPropagation?: boolean;
1402
- /**
1403
- * 右键菜单是否可用,启用后enableContextmenu强制为false
1404
- *
1405
- * @type {boolean}
1406
- * @memberof IPlayerConfig
1407
- */
1408
- enableMenu?: boolean;
1409
- /**
1410
- * 是否开启hls的MSE模式,仅移动端生效,开启后采用MSE方式播放HLS,默认在移动端使用原生video播放hls
1411
- *
1412
- * @type {boolean}
1413
- * @memberof IPlayerConfig
1414
- */
1415
- enableHlsMSE?: boolean;
1416
- /**
1417
- * 在PC Safari上是否不使用hls插件播放,默认true。true: 启用;false: 不启用
1418
- *
1419
- * @type {boolean}
1420
- * @memberof IPlayerConfig
1421
- */
1422
- useHlsPluginForSafari?: boolean;
1423
- /**
1424
- * 是否开启mp4的MSE模式,开启后采用MSE方式播放MP4,
1425
- * 同时带来精确的seek加载、视频的无缝切换、流量节省等功能
1426
- *
1427
- * @type {boolean}
1428
- * @memberof IPlayerConfig
1429
- */
1430
- enableMp4MSE?: boolean;
1431
- /**
1432
- * 播放列表
1433
- * @notes url和playList必填一个,二者都传入时, url必须在playList中。
1434
- *
1435
- * @type {Stream[]}
1436
- * @memberof IPlayerConfig
1437
- */
1438
- playList?: Stream[];
1439
- /**
1440
- * 插件,可自行选择高级插件。
1441
- * 目前支持的高级插件为: DefinitionDemotePlugin
1442
- *
1443
- * @type {any[]}
1444
- * @memberof IPlayerConfig
1445
- */
1446
- plugins?: any[];
1447
- /**
1448
- * 默认配置
1449
- * @hidden
1450
- *
1451
- * @type {IDefaultConfig}
1452
- * @memberof IPlayerConfig
1453
- */
1454
- defaultConfig?: IDefaultConfig;
1455
- /**
1456
- * 设置多语言词典,可设置每个语言的多语言词典,
1457
- * 例如:
1458
- * {
1459
- * zh: {
1460
- * PIP: '画中画'
1461
- * },
1462
- * en: {
1463
- * PIP: 'pip'
1464
- * }
1465
- * }
1466
- *
1467
- * @type {{ [key: string]: Record<string, any> }}
1468
- * @memberof IPlayerConfig
1469
- */
1470
- languages?: {
1471
- [key: string]: Record<string, any>;
1472
- };
1473
- /**
1474
- * @hidden
1475
- *
1476
- * @type {boolean}
1477
- * @memberof IPlayerConfig
1478
- */
1479
- isMobile?: boolean;
1480
- /**
1481
- * umd依赖备用地址
1482
- * 用于依赖的CDN发生网络错误时的降级备用地址
1483
- * 支持的依赖有hls(非加密hls播放)、flv(flv播放)、XGVideo(软解播放)、hlsEncrypt(加密hls播放)、dash(dash播放)、mp4Encrypt(加密np4播放)、danmujs(弹幕)、danmuMask(蒙版弹幕)、subtitle(外挂字幕)
1484
- */
1485
- umdUrlMap?: Record<string, string>;
1486
- /**
1487
- * 是否启用软解
1488
- * 默认: false
1489
- *
1490
- * @type {boolean}
1491
- * @memberof IPlayerConfig
1492
- */
1493
- useSoftDecoding?: boolean;
1494
- /**
1495
- * 视频编码方式
1496
- * 软解useSoftDecoding设置为true时,提供codec可提升软解初始效率
1497
- *
1498
- * @type {('h264' | 'h265')}
1499
- * @memberof IPlayerConfig
1500
- */
1501
- codec?: CodecType;
1502
- /**
1503
- * 是否开H265播放降级,即H.265硬解不支持时自动降级为软解
1504
- *
1505
- * @type {boolean}
1506
- * @memberof IPlayerConfig
1507
- */
1508
- enableH265Degrade?: boolean;
1509
- /**
1510
- * 资源过期时的回调函数,用来更新视频资源
1511
- *
1512
- * @type {(any) => Promise<IPlayerConfig>}
1513
- * @memberof IPlayerConfig
1514
- */
1515
- onMediaExpired?: () => Promise<IPlayerConfig>;
1516
- /**
1517
- * playAuthToken过期时的回调函数,用来更新playAuthToken
1518
- *
1519
- * @type {(any) => Promise<IPlayAuthTokenConfig>}
1520
- * @memberof IPlayerConfig
1521
- */
1522
- onTokenExpired?: () => Promise<IPlayAuthTokenConfig>;
1523
- /**
1524
- * 定期检查资源过期的周期,单位秒,默认400
1525
- *
1526
- * @type {boolean}
1527
- * @memberof IPlayerConfig
1528
- */
1529
- checkExpireInterval?: number;
1530
- /**
1531
- * 定期检查资源过期的方式,支持三种类型
1532
- * urlExpire 根据url的过期时间判断
1533
- * xhrStatus 发送资源请求,根据资源xhr状态判断
1534
- * getUrlTime 根据估算的地址获取时间判断
1535
- * @type {boolean}
1536
- * @memberof IPlayerConfig
1537
- */
1538
- expireDetectType?: Array<"xhrStatus" | "getUrlTime">;
1539
- /**
1540
- * 有声音自动播放失败时是否降级成静音自动播放,默认不降级
1541
- *
1542
- * @type {boolean}
1543
- * @memberof IPlayerConfig
1544
- */
1545
- enableDegradeMuteAutoplay?: boolean;
1546
- /**
1547
- * 启用微信jsBridge方式的自动播放,默认不开启
1548
- *
1549
- * @type {boolean}
1550
- * @memberof IPlayerConfig
1551
- */
1552
- enableWxJsBridgeAutoplay?: boolean;
1553
- /**
1554
- * 开启任意点击的用户行为触发自动播放,默认不开启
1555
- *
1556
- * @type {boolean}
1557
- * @memberof IPlayerConfig
1558
- */
1559
- enableUserActionAutoplay?: boolean;
1560
- /**
1561
- * 禁用点播日志配置检测,默认开启,如果未配置line_app_id则会播放报错
1562
- *
1563
- * @type {boolean}
1564
- * @memberof IPlayerConfig
1565
- */
1566
- disableVodLogOptsCheck?: boolean;
1567
- /**
1568
- * 播放器报错展示配置, 可以配置播放异常时的播放器显示的异常文案、图片,以及是否提供刷新按钮等
1569
- *
1570
- */
1571
- sdkErrorPlugin?: ISdkErrorConfig;
1572
- /**
1573
- * rtm配置,配置rtm拉流参数
1574
- * @notes 传入rtm流url时才生效
1575
- *
1576
- * @type {IRtmConfig}
1577
- * @memberof IPlayerConfig
1578
- */
1579
- rtm?: IRtmConfig;
1580
- /**
1581
- * 弹幕及面板配置,可配置弹幕的一些参数,如弹幕文字大小、透明度、展示区域等,
1582
- *
1583
- * @type {InitConfig | boolean}
1584
- * @memberof IPlayerConfig
1585
- */
1586
- DanmuPlugin?: InitConfig | boolean;
1587
- /**
1588
- * 清晰度自动降级配置
1589
- * @notes 需要先引入DefinitionDemotePlugin插件,plugins: [window.VePlayer.DefinitionDemotePlugin]
1590
- *
1591
- * @type {IDefinitionDemotePlugin}
1592
- * @memberof IPlayerConfig
1593
- */
1594
- DefinitionDemotePlugin?: IDefinitionDemotePlugin;
1595
- /**
1596
- * 唯一id,用于私有DRM加密
1597
- *
1598
- * @type {string}
1599
- * @memberof IPlayerConfig
1600
- */
1601
- unionId?: string;
1602
- /**
1603
- * vid播放配置项
1604
- * @notes 需要业务方服务端通过vid生成临时playAuthToken
1605
- *
1606
- * @type {IPlayAuthTokenConfig}
1607
- * @memberof IPlayerConfig
1608
- */
1609
- getVideoByToken?: IPlayAuthTokenConfig;
1610
- /**
1611
- * dash 播放配置项
1612
- * @type {Partial<IDashPluginConfig>}
1613
- * @memberof IPlayerConfig
1614
- */
1615
- DASHPlugin?: Partial<IDashPluginConfig>;
1616
- /**
1617
- * hls 加密播放配置项
1618
- * @type {Partial<IEncryptHlsPluginConfig> | boolean}
1619
- * @memberof IPlayerConfig
1620
- */
1621
- EncryptHlsPlugin?: Partial<IEncryptHlsPluginConfig> | boolean;
1622
- /**
1623
- * 质量日志配置项
1624
- * @type {Partial<IVodLogOptsConfig>}
1625
- * @memberof IPlayerConfig
1626
- */
1627
- vodLogOpts?: Partial<IVodLogOptsConfig>;
1628
- /**
1629
- * mp4加密播放配置项
1630
- * @type {Partial<IMp4EncryptPlayerConfig> | boolean}
1631
- * @memberof IPlayerConfig
1632
- */
1633
- Mp4EncryptPlayer?: Partial<IMp4EncryptPlayerConfig> | boolean;
1634
- /**
1635
- * 自适应码率配置项
1636
- * @type {IAutoBitrateOptsConfig}
1637
- * @memberof IPlayerConfig
1638
- */
1639
- autoBitrateOpts?: IAutoBitrateOptsConfig;
1640
- /**
1641
- * 外挂字幕配置项
1642
- * @type {ISubtitleConfig}
1643
- * @memberof IPlayerConfig
1644
- */
1645
- Subtitle?: ISubtitleConfig;
1646
- /**
1647
- * 记忆播放配置项
1648
- * @type {IMemoryPlayConfig}
1649
- * @memberof IPlayerConfig
1650
- */
1651
- MemoryPlay?: IMemoryPlayConfig | boolean;
1652
- /**
1653
- * 音乐播放器配置项
1654
- * @type {IMusicConfig}
1655
- * @memberof IPlayerConfig
1656
- */
1657
- music?: IMusicConfig;
1658
- /**
1659
- * 自动播放配置
1660
- * @type {IMusicConfig}
1661
- * @memberof IPlayerConfig
1662
- */
1663
- AutoplayPlugin?: IAutoplayPluginConfig;
1664
- }
1665
- /**
1666
- * 初始配置
1667
- *
1668
- * @export
1669
- * @interface IDefaultConfig
1670
- */
1671
- export interface IDefaultConfig {
1672
- /**
1673
- * “点播”还是“直播”
1674
- *
1675
- * @type {('live' | 'vod')}
1676
- * @memberof IPlayerConfig
1677
- */
1678
- type?: "live" | "vod";
1679
- /**
1680
- * 是否是直播
1681
- *
1682
- * @type {boolean}
1683
- * @memberof IPlayerConfig
1684
- */
1685
- isLive?: boolean;
1686
- /**
1687
- * 线路唯一key
1688
- *
1689
- * @type {(number | string)}
1690
- * @memberof Stream
1691
- */
1692
- lineId?: number | string;
1693
- /**
1694
- * 清晰度选择
1695
- *
1696
- * @type {string}
1697
- * @memberof Stream
1698
- */
1699
- definition?: string;
1700
- /**
1701
- * 开始播放时间
1702
- *
1703
- * @type {number}
1704
- * @memberof IDefaultConfig
1705
- */
1706
- startTime?: number;
1707
- /**
1708
- * 音量
1709
- *
1710
- * @type {number}
1711
- * @memberof IDefaultConfig
1712
- */
1713
- volume?: number;
1714
- /**
1715
- * 弹幕插件配置
1716
- *
1717
- * @type {*}
1718
- * @memberof IDefaultConfig
1719
- */
1720
- DanmuPlugin?: any;
1721
- /**
1722
- * 字幕插件配置
1723
- *
1724
- * @type {*}
1725
- * @memberof IDefaultConfig
1726
- */
1727
- LiveSubtitlesIconPlugin?: any;
1728
- }
1729
- /**
1730
- * vid播放配置信息
1731
- *
1732
- * @detail Options
1733
- * @description PlayAuthToken获取视频信息配置
1734
- * @export
1735
- * @interface IPlayAuthTokenConfig
1736
- */
1737
- export interface IPlayAuthTokenConfig {
1738
- /**
1739
- * 服务端生成的临时playAuthToken
1740
- *
1741
- * @type {string}
1742
- * @memberof IPlayAuthTokenConfig
1743
- */
1744
- playAuthToken: string;
1745
- /**
1746
- * 默认清晰度
1747
- *
1748
- * @notes 为空时默认为最大码率的清晰度
1749
- * @type {string}
1750
- * @memberof IPlayAuthTokenConfig
1751
- */
1752
- defaultDefinition?: string;
1753
- /**
1754
- * 求地址接口域名
1755
- *
1756
- * @notes 默认为`//vod.volcengineapi.com`
1757
- * @type {string}
1758
- * @memberof IPlayAuthTokenConfig
1759
- */
1760
- playDomain?: string;
1761
- /**
1762
- * 是否启用控制台设置的封面图,默认false
1763
- * @type {boolean}
1764
- * @memberof IPlayAuthTokenConfig
1765
- */
1766
- needPoster?: boolean;
1767
- /**
1768
- * 是否启用控制台设置的雪碧图,默认false
1769
- * @type {boolean}
1770
- * @memberof IPlayAuthTokenConfig
1771
- */
1772
- needThumbs?: boolean;
1773
- /**
1774
- * 是否启用控制台设置的蒙版弹幕,默认false
1775
- * @type {boolean}
1776
- * @memberof IPlayAuthTokenConfig
1777
- */
1778
- needBarrageMask?: boolean;
1779
- /**
1780
- * 是否需要多清晰度,默认为true
1781
- * @type {boolean}
1782
- * @memberof IPlayAuthTokenConfig
1783
- */
1784
- needDefinitionList?: boolean;
1785
- /**
1786
- * hls标准加密播放所用的keyToken
1787
- * @type {boolean}
1788
- * @memberof IPlayAuthTokenConfig
1789
- */
1790
- keyToken?: string;
1791
- /**
1792
- * 密钥请求域名
1793
- * @type {string}
1794
- * @memberof IPlayAuthTokenConfig
1795
- */
1796
- keyDomain?: string;
1797
- /**
1798
- * 获取key方式,默认'TOP'
1799
- * @type {string}
1800
- * @memberof IPlayAuthTokenConfig
1801
- */
1802
- getKeyType?: string;
1803
- /**
1804
- * 获取privateDrmAuthToken的异步回调,
1805
- * @type {(
1806
- * playAuthIds: string,
1807
- * vid: string,
1808
- * unionInfo: string,
1809
- * ) => Promise<string>}
1810
- * 回调入参:
1811
- * 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时以英文逗号相连
1812
- * vid 视频vid
1813
- * unionInfo 由unionId生成的unionInfo,以用来加密PrivateDrmAuthToken
1814
- * @memberof IPlayAuthTokenConfig
1815
- *
1816
- */
1817
- getDrmAuthToken?: (playAuthIds: string, vid: string, unionInfo: string) => Promise<string>;
1818
- /**
1819
- * 可携带aid等透传参数,如
1820
- * {aid: 1234},以playAuthToken下发的参数的优先级最高。
1821
- * 具体可传参数见{@link https://www.volcengine.com/docs/4/65659 签发 PlayAuthToken}
1822
- *
1823
- * @type {Record<string, number | string | boolean>}
1824
- * @memberof IPlayAuthTokenConfig
1825
- */
1826
- reqParams?: Record<string, number | string | boolean>;
1827
- /**
1828
- * 定义清晰度的映射
1829
- *
1830
- * @example 如:
1831
- * ``` javascript
1832
- * {
1833
- * '480p': '标清',
1834
- * '720p': '高清'
1835
- * }
1836
- * ```
1837
- * 或
1838
- * ``` javascript
1839
- * {
1840
- * '480p': {
1841
- * definition: 'hd', // 清晰度兜底文案
1842
- * definitionTextKey: 'HD' // 多语言文案key
1843
- * },
1844
- * '720p': {
1845
- * definition: 'uhd',
1846
- * definitionTextKey: 'UHD'
1847
- * }
1848
- * }
1849
- * ```
1850
- * `definitionTextKey`用来指定多语言的key
1851
- * @type {Record<string, string | definitionItem>}
1852
- * @memberof IPlayAuthTokenConfig
1853
- */
1854
- definitionMap?: Record<string, string | definitionItem>;
1855
- /**
1856
- * 服务502错误时重试次数,默认为1
1857
- * @type {number}
1858
- * @memberof IPlayAuthTokenConfig
1859
- */
1860
- retryCount?: number;
1861
- }
1862
- /**
1863
- * 清晰度定义
1864
- *
1865
- * @detail Options
1866
- * @export
1867
- * @interface definitionItem
1868
- */
1869
- export interface definitionItem {
1870
- /**
1871
- * 清晰度
1872
- *
1873
- * @type {string}
1874
- * @memberof definitionItem
1875
- */
1876
- definition?: string;
1877
- /**
1878
- * 清晰度多语言key
1879
- *
1880
- * @type {string}
1881
- * @memberof definitionItem
1882
- */
1883
- definitionTextKey?: string;
1884
- }
1885
- export interface IAutoBitrateOptsConfig {
1886
- /**
1887
- * 是否开启功能,默认为false
1888
- *
1889
- * @type {boolean}
1890
- * @memberof IAutoBitrateOptsConfig
1891
- */
1892
- isOpenAutoDefi?: boolean;
1893
- /**
1894
- * 自动切换清晰度对应显示文案
1895
- *
1896
- * @type {string}
1897
- * @memberof IAutoBitrateOptsConfig
1898
- */
1899
- autoDefiText?: string;
1900
- /**
1901
- * 起播是否调整到自动切换, 默认为false
1902
- *
1903
- * @type {boolean}
1904
- * @memberof IAutoBitrateOptsConfig
1905
- */
1906
- isPlayAutoDefi?: boolean;
1907
- /**
1908
- * 调用算法频率
1909
- *
1910
- * @type {boolean}
1911
- * @memberof IAutoBitrateOptsConfig
1912
- */
1913
- interval?: number;
1914
- /**
1915
- * 多久后算消费视频,单位秒
1916
- *
1917
- * @type {number}
1918
- * @memberof IAutoBitrateOptsConfig
1919
- */
1920
- noStallCheckTime?: number;
1921
- /**
1922
- * 算法 方法选择见文档,默认使用31即可,目前31策略卡顿收益很高
1923
- *
1924
- * @type {number}
1925
- * @memberof IAutoBitrateOptsConfig
1926
- */
1927
- method?: number;
1928
- /**
1929
- * 算法模块, CDN方式为window.DashAbralgo
1930
- *
1931
- * @type {any}
1932
- * @memberof IAutoBitrateOptsConfig
1933
- */
1934
- module?: any;
1935
- }
1936
- /**
1937
- * 初始配置
1938
- *
1939
- * @export
1940
- * @interface IMemoryPlayConfig
1941
- */
1942
- export interface IMemoryPlayConfig {
1943
- /**
1944
- * 存储标识id
1945
- *
1946
- * @type {number | string}
1947
- * @memberof IMemoryPlayConfig
1948
- */
1949
- memoryId: number | string;
1950
- /**
1951
- * 设置时间函数
1952
- *
1953
- * @type {(id: number | string, time: number) => unknown}
1954
- * @memberof IMemoryPlayConfig
1955
- */
1956
- saveTime: (id: number | string, time: number) => unknown;
1957
- /**
1958
- * 获取最后一次播放时间函数
1959
- *
1960
- * @type {(id: number | string) => number | Promise<number>}
1961
- * @memberof IMemoryPlayConfig
1962
- */
1963
- getTime: (id: number | string) => number | Promise<number>;
1964
- }
1965
- export interface ApiMapConfig {
1966
- playDomain: string;
1967
- backupPlayDomain?: string;
1968
- }
1969
- declare class PlayerData {
1970
- id?: string;
1971
- root?: HTMLElement;
1972
- configs: any;
1973
- type: string;
1974
- isLive: boolean;
1975
- options: any;
1976
- isMobile: boolean;
1977
- playList: Stream[];
1978
- plugins: any[];
1979
- openSoftDecoding: boolean;
1980
- defaultConfig: IDefaultConfig | undefined;
1981
- isHitDefault: boolean;
1982
- codec?: CodecType;
1983
- enableH265Degrade: boolean;
1984
- languageData: {
1985
- extraLangList: IXGI18nText[];
1986
- extendLangList: IXGI18nText[];
1987
- };
1988
- current: Current;
1989
- checkExpireInterval: number;
1990
- expireDetectType: Array<"xhrStatus" | "urlExpire" | "getUrlTime">;
1991
- onMediaExpired: () => Promise<IPlayerConfig>;
1992
- onTokenExpired: () => Promise<IPlayAuthTokenConfig>;
1993
- unionId?: string;
1994
- unionInfo?: string;
1995
- isMusic?: boolean;
1996
- sdkPlugins: any[];
1997
- useHlsPluginForSafari: boolean;
1998
- enableMenu: boolean;
1999
- region: TRegionType;
2000
- playDomainDegrade: boolean;
2001
- constructor(configs: IPlayerConfig);
2002
- initPlayData(configs: any): void;
2003
- initPlaylistAndGetCurrent(configs: IPlayerConfig): any;
2004
- isCurrentH265(): boolean;
2005
- getCurrentByDefaultConfig(): Stream;
2006
- initCurrent(currentStreams: any): void;
2007
- initI18nData(languages: any): {
2008
- extraLangList: any[];
2009
- extendLangList: any[];
2010
- };
2011
- /**
2012
- * @description: 获取当前直播url
2013
- */
2014
- getCurrentUrl(): string;
2015
- /**
2016
- * @description: 获取当前的streamType
2017
- */
2018
- getCurrentStreamType(): any;
2019
- /**
2020
- * @description: 获取满足当前直播条件的流
2021
- */
2022
- getCurrentStreams(): Stream[];
2023
- /**
2024
- * @description: 获取根据线路ID去重的流,用于获取有几个线路
2025
- */
2026
- getLineList(): Stream[];
2027
- /**
2028
- * @description: 根据线路ID获取符合条件的流
2029
- * @param {number} lineId
2030
- */
2031
- getLineListByLineId(lineId: number | string): Stream[];
2032
- /**
2033
- * @description: 根据线路ID获取清晰度list,用于获取某个线路下有几个清晰度
2034
- * @param {number} lineId
2035
- */
2036
- getDefinitionListByLineId(lineId: number | string): Stream[];
2037
- /**
2038
- * @description: 根据条件筛选符合条件的流list
2039
- * @param {Condition} condition
2040
- */
2041
- getUrlList(condition: Condition): Stream[];
2042
- /**
2043
- * @description: 获取当期清晰的上一级清晰度或下一级清晰度
2044
- * @param {boolean} isDown
2045
- */
2046
- getNextDefinition(isDown: boolean, demotePriority: any): Stream[];
2047
- /**
2048
- * 获取api map
2049
- * @return { ApiMapConfig }
2050
- */
2051
- get apiMap(): ApiMapConfig;
2052
- /**
2053
- * 获取播放域名
2054
- */
2055
- get playDomain(): string;
2056
- setVodTeaId(): void;
2057
- }
2058
- declare function isMSESupport(mime?: string): boolean;
2059
- export interface IConfig {
2060
- mode?: number;
2061
- isAutoChange?: boolean;
2062
- }
2063
- declare class MobilePlayerPanel {
2064
- config: IConfig;
2065
- parent: HTMLElement;
2066
- root: any;
2067
- mode: number;
2068
- isAutoChange: number;
2069
- player: any;
2070
- children: HTMLElement | undefined;
2071
- container: HTMLElement | undefined;
2072
- title: HTMLElement | undefined;
2073
- isShow: boolean;
2074
- showCancelBtn: boolean;
2075
- constructor(args: any);
2076
- initEvents(): void;
2077
- handleOrientationChange(): void;
2078
- changeConfig(config: IConfig): void;
2079
- changeMode(mode: number): void;
2080
- renderPanel(): void;
2081
- showPanel(children: HTMLElement, title?: string, isItemList?: boolean): Promise<void>;
2082
- updatePanel(children: HTMLElement): void;
2083
- setTitle(title: any): void;
2084
- renderTitle(title: any): HTMLElement;
2085
- show(): void;
2086
- hide(): void;
2087
- handleHide(e: any): void;
2088
- bind(event: string, eventHandle: any, isBubble?: boolean): void;
2089
- destroy(): void;
2090
- }
2091
- declare class VePlayer {
2092
- /**
2093
- * 播放相关配置数据
2094
- * @hidden
2095
- *
2096
- * @type {PlayerData}
2097
- * @memberof VePlayer
2098
- */
2099
- playerData: PlayerData;
2100
- /**
2101
- * 播放器内核实例
2102
- * @type {*}
2103
- * @memberof VePlayer
2104
- */
2105
- player: Player & {
2106
- changePluginsIcon?: (name: any, isShow: any) => void;
2107
- playerData?: PlayerData;
2108
- playerType?: string;
2109
- playerVersion?: string;
2110
- panel?: MobilePlayerPanel;
2111
- emitExpireTimestamp?: number;
2112
- vodLogger?: VodLogger;
2113
- };
2114
- /**
2115
- * @hidden
2116
- *
2117
- * @type {*}
2118
- * @memberof VePlayer
2119
- */
2120
- mountingDom: any;
2121
- /**
2122
- * @hidden
2123
- *
2124
- * @type {*}
2125
- * @memberof VePlayer
2126
- */
2127
- playerContainer: any;
2128
- /**
2129
- * @hidden
2130
- *
2131
- * @type {*}
2132
- * @memberof VePlayer
2133
- */
2134
- mobilePanel: any;
2135
- /**
2136
- *
2137
- * @private
2138
- * @type {*}
2139
- * @memberof VePlayer
2140
- */
2141
- private _emitter;
2142
- /**
2143
- *
2144
- *
2145
- * @private
2146
- * @memberof VePlayer
2147
- */
2148
- private _isFirstCreated;
2149
- /**
2150
- * @hidden
2151
- * 要注册的sdk插件
2152
- *
2153
- * @type {*}
2154
- * @memberof VePlayer
2155
- */
2156
- sdkPlugins: any[];
2157
- /**
2158
- * @hidden
2159
- * 缓存运行的sdk插件实例
2160
- *
2161
- * @type {*}
2162
- * @memberof VePlayer
2163
- */
2164
- _sdkPlugins: any;
2165
- /**
2166
- * @hidden
2167
- *
2168
- * @type {*}
2169
- * @memberof VePlayer
2170
- */
2171
- private checkExpireTimer;
2172
- /**
2173
- * @hidden
2174
- *
2175
- * @type {*}
2176
- * @memberof VePlayer
2177
- */
2178
- private _playOriginalUrl;
2179
- /**
2180
- * @hidden
2181
- * 过期次数
2182
- * @type {*}
2183
- * @memberof VePlayer
2184
- */
2185
- private expireCount;
2186
- /**
2187
- * @hidden
2188
- * 获取url的时间
2189
- * @type {*}
2190
- * @memberof VePlayer
2191
- */
2192
- private getUrlTime;
2193
- /**
2194
- * @hidden
2195
- * 延迟触发但错误
2196
- * @type {*}
2197
- * @memberof VePlayer
2198
- */
2199
- delayError: any[];
2200
- private isFirstEmitted;
2201
- /**
2202
- * @hidden
2203
- * umd加载器
2204
- * @type {*}
2205
- * @memberof VePlayer
2206
- */
2207
- private sdkUmdLoader;
2208
- static isMSESupported: typeof isMSESupport;
2209
- static isRTMSupported: typeof import("@byted/xgplayer-rts").RtsPlugin.isSupported;
2210
- static sdkVersion: string;
2211
- static isRTMSupportCodec: (codec: RTMCodec, options: {
2212
- targetProfileLevel?: string;
2213
- }) => Promise<boolean>;
2214
- constructor(configs: IPlayerConfig);
2215
- /**
2216
- *
2217
- *
2218
- * @private
2219
- * @param {IPlayerConfig} configs
2220
- * @memberof VePlayer
2221
- */
2222
- private _init;
2223
- /**
2224
- * @hidden
2225
- * @description 初始化并注册sdk插件(非西瓜插件)
2226
- * @memberof VePlayer
2227
- */
2228
- _initSdkPlugins(): void;
2229
- /**
2230
- * @hidden
2231
- * @description 初始化过期检测
2232
- * @memberof VePlayer
2233
- */
2234
- initCheckExpire(): void;
2235
- /**
2236
- * @hidden
2237
- * @description 更新umdLoader 的配置
2238
- * @memberof VePlayer
2239
- */
2240
- private initUmdLoader;
2241
- private checkVodLogOptions;
2242
- /**
2243
- * @hidden
2244
- * @description umd 加载失败的回调
2245
- * @memberof VePlayer
2246
- */
2247
- umdLoadErr(umdName: any, err: any): void;
2248
- /**
2249
- * @hidden
2250
- * @description 循环执行过期检测
2251
- * @memberof VePlayer
2252
- */
2253
- onRepeat(): void;
2254
- /**
2255
- * @hidden
2256
- * @description 触发过期事件
2257
- * @memberof VePlayer
2258
- */
2259
- emitExpireEvent(): void;
2260
- /**
2261
- * @hidden
2262
- * @description 地址获取时间
2263
- * @memberof VePlayer
2264
- */
2265
- getUrlTimestamp(url: string): void;
2266
- /**
2267
- * @description 监听sdk事件
2268
- *
2269
- * @param {string} action
2270
- * @param {(...args: any[]) => void} func
2271
- * @memberof VePlayer
2272
- */
2273
- on(action: string, func: (...args: any[]) => void): void;
2274
- /**
2275
- * @description 触发sdk事件
2276
- *
2277
- * @param {string} action
2278
- * @param {*} [payload]
2279
- * @memberof VePlayer
2280
- */
2281
- emit(action: string, payload?: any): void;
2282
- /**
2283
- * 监听sdk事件,事件处理函数只执行一次
2284
- *
2285
- * @param {string} action
2286
- * @param {(...args: any[]) => void} func
2287
- * @memberof VePlayer
2288
- */
2289
- once(action: string, func: (...args: any[]) => void): void;
2290
- /**
2291
- * 解绑事件监听
2292
- *
2293
- * @param {string} action
2294
- * @param {(...args: any[]) => void} func
2295
- * @memberof VePlayer
2296
- */
2297
- off(action: string, func: (...args: any[]) => void): void;
2298
- /**
2299
- * @hidden
2300
- *
2301
- * @memberof VePlayer
2302
- */
2303
- renderDom(): void;
2304
- /**
2305
- * @hidden
2306
- *
2307
- * @return {*}
2308
- * @memberof VePlayer
2309
- */
2310
- renderPoster(): void;
2311
- /**
2312
- * @hidden
2313
- *
2314
- * @return {*}
2315
- * @memberof VePlayer
2316
- */
2317
- createPlayer(): Promise<Player & {
2318
- changePluginsIcon?: (name: any, isShow: any) => void;
2319
- playerData?: PlayerData;
2320
- playerType?: string;
2321
- playerVersion?: string;
2322
- panel?: MobilePlayerPanel;
2323
- emitExpireTimestamp?: number;
2324
- vodLogger?: VodLogger;
2325
- }>;
2326
- /**
2327
- * @hidden
2328
- *
2329
- * @param {IPlayerConfig} finalOptions
2330
- * @return {void}
2331
- * @memberof VePlayer
2332
- */
2333
- setPluginConfig(finalOptions: IPlayerConfig): void;
2334
- /**
2335
- * @hidden
2336
- *
2337
- * @param {string} url 地址
2338
- * @memberof VePlayer
2339
- */
2340
- detectCodec(url: string): Promise<void>;
2341
- /**
2342
- * @hidden
2343
- *
2344
- * @param {*} options
2345
- * @return {*}
2346
- * @memberof VePlayer
2347
- */
2348
- setDefaultConfigOptions(options: any): void;
2349
- /**
2350
- * 获取当前播放视频数据
2351
- *
2352
- * @return {any}
2353
- * @memberof VePlayer
2354
- */
2355
- getCurrentPlayerConfig(): {
2356
- type?: "vod" | "live";
2357
- isLive?: boolean;
2358
- lineId?: string | number;
2359
- definition?: string;
2360
- startTime?: number;
2361
- volume?: number;
2362
- DanmuPlugin?: any;
2363
- LiveSubtitlesIconPlugin?: any;
2364
- };
2365
- /**
2366
- *
2367
- * @private
2368
- * @return {*}
2369
- * @memberof VePlayer
2370
- */
2371
- private _analyzeExtendPlugins;
2372
- /**
2373
- * @hidden
2374
- *
2375
- * @memberof VePlayer
2376
- */
2377
- beforePlayerCreate(): Promise<void>;
2378
- /**
2379
- * @hidden
2380
- *
2381
- * @memberof VePlayer
2382
- */
2383
- afterPlayerCreate(): void;
2384
- /**
2385
- * @hidden
2386
- *
2387
- * @memberof VePlayer
2388
- */
2389
- emitDelayError(): void;
2390
- /**
2391
- * @hidden
2392
- *
2393
- * @memberof VePlayer
2394
- */
2395
- private _setPlayerInfo;
2396
- /**
2397
- *
2398
- *
2399
- * @private
2400
- * @param {boolean} isMobile
2401
- * @memberof VePlayer
2402
- */
2403
- private _mountingPlayerPanel;
2404
- /**
2405
- *
2406
- *
2407
- * @private
2408
- * @return {*}
2409
- * @memberof VePlayer
2410
- */
2411
- private _bindPlayerEvents;
2412
- /**
2413
- * @private
2414
- * @return {*}
2415
- * @memberof VePlayer
2416
- */
2417
- private onMediaExpiredAction;
2418
- /**
2419
- * @hidden
2420
- *
2421
- * @memberof VePlayer
2422
- */
2423
- private onTokenExpiredAction;
2424
- /**
2425
- *
2426
- *
2427
- * @private
2428
- * @memberof VePlayer
2429
- */
2430
- private _bindSdkEvents;
2431
- /**
2432
- * @hidden
2433
- *
2434
- * @memberof VePlayer
2435
- */
2436
- private _mountingExtendMethods;
2437
- /**
2438
- *
2439
- *
2440
- * @private
2441
- * @return {*}
2442
- * @memberof VePlayer
2443
- */
2444
- private _offPlayerEvents;
2445
- /**
2446
- * @hidden
2447
- * 切换插件展示
2448
- *
2449
- * @param {*} pluginName
2450
- * @param {*} IsShow
2451
- * @return {*}
2452
- * @memberof VePlayer
2453
- */
2454
- changePluginsIcon(pluginName: any, IsShow: any): void;
2455
- /**
2456
- * @hidden
2457
- *
2458
- * @description 对外提供获取SDK插件实例的方法
2459
- * @param { string } name
2460
- * @return {*}
2461
- * @memberof VePlayer
2462
- */
2463
- getSdkPlugin(name: any): any;
2464
- /**
2465
- * @description 更换playAuthToken的方法
2466
- * @notes 这里指同一个视频切换视频源,不能用来切换不同类型的视频
2467
- * @param { IPlayAuthTokenConfig } config authToken配置
2468
- * @param { boolean } isNewVideo 是否是新视频,默认true。若未false即表示同一个视频切换token播放,会在切换前时间点继续播放
2469
- * @memberof VePlayer
2470
- */
2471
- switchAuthToken(config: IPlayAuthTokenConfig, isNewVideo?: boolean): Promise<void>;
2472
- /**
2473
- * @description 更新playAuthToken的方法,用来更新视频地址
2474
- * @param { IPlayAuthTokenConfig } config
2475
- * @memberof VePlayer
2476
- */
2477
- updateAuthToken(config: IPlayAuthTokenConfig): Promise<void>;
2478
- /**
2479
- * @description 返回当前视频的地址
2480
- * @memberof VePlayer
2481
- */
2482
- get src(): any;
2483
- /**
2484
- * @description 设置当前视频的地址
2485
- * @notes 会重新拉取新的视频,从0开始起播
2486
- * @memberof VePlayer
2487
- */
2488
- set src(url: any);
2489
- /**
2490
- * 切换视频url
2491
- * @param {string} url 同一个视频,更新视频地址
2492
- * @notes 切换后从切换前的时间点继续播放
2493
- * @return {Promise<void>}
2494
- * @memberof VePlayer
2495
- */
2496
- switchURL(url: string): Promise<void>;
2497
- /**
2498
- * 重建播放下一个
2499
- *
2500
- * @param {playerConfig} config
2501
- * @param { boolean } isNewVideo 是否是新视频,默认true。若为false即表示同一个视频切换token播放,会在切换前时间点继续播放
2502
- * @memberof VePlayer
2503
- */
2504
- next(config: IPlayerConfig, isNewVideo?: boolean): Promise<void>;
2505
- /**
2506
- * 切换视频源
2507
- *
2508
- * @param {IPlayerConfig} config
2509
- * @param { boolean } isNewVideo 是否是新视频,默认true。若为false即表示同一个视频切换地址播放,会在切换前的时间点继续播放
2510
- * @return{Promise<any>}
2511
- * @memberof VePlayer
2512
- */
2513
- playNext(config: IPlayerConfig, isNewVideo?: boolean): Promise<any>;
2514
- /**
2515
- * @hidden
2516
- *
2517
- * @return {*}
2518
- * @memberof VePlayer
2519
- */
2520
- resetUrlState(url: any): void;
2521
- /**
2522
- * 销毁xgplayer实例
2523
- *
2524
- * @private
2525
- * @memberof VePlayer
2526
- */
2527
- private _destroyPlayer;
2528
- /**
2529
- * @hidden
2530
- *
2531
- * @return {*}
2532
- * @memberof VePlayer
2533
- */
2534
- getPlayerInstance(): Player & {
2535
- changePluginsIcon?: (name: any, isShow: any) => void;
2536
- playerData?: PlayerData;
2537
- playerType?: string;
2538
- playerVersion?: string;
2539
- panel?: MobilePlayerPanel;
2540
- emitExpireTimestamp?: number;
2541
- vodLogger?: VodLogger;
2542
- };
2543
- /**
2544
- * @hidden
2545
- *
2546
- * @return {*}
2547
- * @memberof VePlayer
2548
- */
2549
- getSoftDecodingOption(isOpenSoftDecoding: boolean, url: string, type: string): Promise<{
2550
- mediaType: string;
2551
- innerDegrade: number;
2552
- codecType: string;
2553
- } | {
2554
- mediaType?: undefined;
2555
- innerDegrade?: undefined;
2556
- codecType?: undefined;
2557
- }>;
2558
- /**
2559
- * @hidden
2560
- *
2561
- * @description 获取h265软解播放时的播放列表
2562
- * @memberof VePlayer
2563
- */
2564
- setH265SoftPlayList(): void;
2565
- /**
2566
- * 初始化多语言词典
2567
- *
2568
- * @param {*} languages
2569
- * @memberof VePlayer
2570
- */
2571
- private _initI18N;
2572
- /**
2573
- * 获取音乐播放模式
2574
- * @notes 仅音乐播放模式有效
2575
- * @return {PlayModeType}
2576
- * @memberof VePlayer
2577
- */
2578
- get musicMode(): PlayModeType;
2579
- /**
2580
- * 设置音乐播放模式
2581
- * @notes 仅音乐播放模式有效
2582
- * @memberof VePlayer
2583
- * @param {PlayModeType} val 模式值
2584
- */
2585
- set musicMode(val: PlayModeType);
2586
- /**
2587
- * 获取音乐播放快进快退时间跨度
2588
- * @notes 仅音乐播放模式有效
2589
- * @return {number}
2590
- * @memberof VePlayer
2591
- */
2592
- get musicTimeScale(): number;
2593
- /**
2594
- * 设置音乐播放快进快退时间跨度
2595
- * @notes 仅音乐播放模式有效
2596
- * @param {number} scale 时间跨度
2597
- * @memberof VePlayer
2598
- */
2599
- set musicTimeScale(scale: number);
2600
- /**
2601
- * 获取音乐播放列表
2602
- * @notes 仅音乐播放模式有效
2603
- * @return {IMusicListItem[]}
2604
- * @memberof VePlayer
2605
- */
2606
- get musicList(): IMusicListItem[];
2607
- /**
2608
- * 设置音乐播放列表
2609
- * @notes 仅音乐播放模式有效
2610
- * @param {IMusicListItem[]} list 播放列表
2611
- * @memberof VePlayer
2612
- */
2613
- set musicList(list: IMusicListItem[]);
2614
- /**
2615
- * 向播放列表中加入歌曲
2616
- * @notes 仅音乐播放模式有效
2617
- * @param {IMusicListItem} meta 歌曲信息
2618
- * @memberof VePlayer
2619
- */
2620
- musicAdd(meta: IMusicListItem): void;
2621
- /**
2622
- * 随机获取播放列表中某一首歌曲
2623
- * @notes 仅音乐播放模式有效
2624
- * @return {IMusicListItem} 歌曲信息
2625
- * @memberof VePlayer
2626
- */
2627
- musicRandom(): IMusicListItem;
2628
- /**
2629
- * 播放播放列表的下一首歌曲
2630
- * @notes 仅音乐播放模式有效
2631
- * @memberof VePlayer
2632
- */
2633
- musicNext(): void;
2634
- /**
2635
- * 播放播放列表的上一首歌曲
2636
- * @notes 仅音乐播放模式有效
2637
- * @memberof VePlayer
2638
- */
2639
- musicPrev(): void;
2640
- /**
2641
- * 播放播放列表的第n首歌曲
2642
- * @notes 仅音乐播放模式有效
2643
- * @param {number} index 播放列表中的序号
2644
- * @memberof VePlayer
2645
- */
2646
- musicSetIndex(index: number): void;
2647
- /**
2648
- * 歌曲快进
2649
- * @notes 仅音乐播放模式有效
2650
- * @memberof VePlayer
2651
- */
2652
- musicForward(): void;
2653
- /**
2654
- * 歌曲后退
2655
- * @notes 仅音乐播放模式有效
2656
- * @memberof VePlayer
2657
- */
2658
- musicBackward(): void;
2659
- /**
2660
- * 从播放列表移除指定歌曲
2661
- * @notes 仅音乐播放模式有效
2662
- * @param {string | number} vid 歌曲vid
2663
- * @memberof VePlayer
2664
- */
2665
- musicRemove(vid: string | number): void;
2666
- /**
2667
- * 设置ab循环
2668
- * @param { number | IABCycle } start
2669
- * @param { number } [end]
2670
- * @param { boolean } [loop]
2671
- * @param {{ [propName: string]: any }} [ext]
2672
- * @memberof VePlayer
2673
- */
2674
- musicSetAbCycle(start: number | IABCycle, end?: number, loop?: boolean, ext?: {
2675
- [propName: string]: any;
2676
- }): void;
2677
- /**
2678
- * 移除ab循环
2679
- * @memberof VePlayer
2680
- */
2681
- musicRemoveAbCycle(): void;
2682
- /**
2683
- * 获取质量日志上报的用户id
2684
- * @return {string | undefined}
2685
- * @memberof VePlayer
2686
- */
2687
- getLogUserId(): string;
2688
- /**
2689
- * 获取当前配置的region
2690
- * @return {TRegionType}
2691
- * @memberof VePlayer
2692
- */
2693
- get region(): TRegionType;
2694
- /**
2695
- * 销毁当前播放器SDK实例
2696
- *
2697
- * @memberof VePlayer
2698
- */
2699
- destroy(): Promise<void>;
2700
- }
2701
- export declare function getI18N(): typeof I18N;
2702
- declare class MusicPreset {
2703
- ignores: string[];
2704
- plugins: any[];
2705
- constructor(options: any, playerConfig: any);
2706
- }
2707
- export interface ISubTitles {
2708
- timestamp: number;
2709
- text: string;
2710
- duration: number;
2711
- url: string;
2712
- lang: string;
2713
- delimiter?: string;
2714
- textArr?: string[];
2715
- wordpiece?: any[];
2716
- }
2717
- export interface ISubTitlesState {
2718
- showLang: string;
2719
- subTitleList: ISubTitles[];
2720
- rtmpDtsGap: number;
2721
- showingSubtitle: string;
2722
- currentSub: any;
2723
- dtsBase: number;
2724
- }
2725
- declare class LiveSubTitlesPlugin extends Plugin {
2726
- static get pluginName(): string;
2727
- static get defaultConfig(): {
2728
- position: string;
2729
- showLang: string;
2730
- };
2731
- constructor(configs: any);
2732
- state: ISubTitlesState;
2733
- clearLineTimer: any;
2734
- showTimer: any;
2735
- beforePlayerInit(): void;
2736
- onPause(): void;
2737
- onPlay(): void;
2738
- destroy(): void;
2739
- clearRtmpDtsGap(): void;
2740
- clearSubTitle(isClearScreen: boolean): void;
2741
- getIsSoft(): boolean;
2742
- handleVideoTimeupdate(data: any): void;
2743
- renderSubtitle(subTitle: ISubTitles): void;
2744
- handleSEIParsed(sei: any, originPts?: any): void;
2745
- insertSubTitle(...subTitles: ISubTitles[]): void;
2746
- setCurrentLang(lang: string): void;
2747
- adjustSubTitleTime(time: number): number;
2748
- findSubTitleByTime(currentTime: number): {
2749
- delimiter: string;
2750
- textArr: string[];
2751
- timestamp: number;
2752
- text: string;
2753
- duration: number;
2754
- url: string;
2755
- lang: string;
2756
- wordpiece?: any[];
2757
- };
2758
- splitSubTitle(subTitle: ISubTitles): {
2759
- delimiter: string;
2760
- textArr: string[];
2761
- timestamp: number;
2762
- text: string;
2763
- duration: number;
2764
- url: string;
2765
- lang: string;
2766
- wordpiece?: any[];
2767
- };
2768
- showSurplus(): void;
2769
- createNewDom(parent: HTMLElement): HTMLSpanElement;
2770
- test(): void;
2771
- getPlayTime(): void;
2772
- resetDom(el: HTMLElement): void;
2773
- render(): string;
2774
- }
2775
- export declare class LiveSubtitlesIconPlugin extends Plugin {
2776
- static get pluginName(): string;
2777
- static get defaultConfig(): {
2778
- position: string;
2779
- index: number;
2780
- defaultOpen: boolean;
2781
- default: string;
2782
- list: {
2783
- key: string;
2784
- showText: string;
2785
- }[];
2786
- };
2787
- isMobile: boolean;
2788
- isOpenState: boolean;
2789
- optionList: any;
2790
- currentLang: string;
2791
- constructor(configs: any);
2792
- afterCreate(): void;
2793
- afterPlayerInit(): void;
2794
- registerIcons(): {
2795
- aiSubOpen: {
2796
- icon: any;
2797
- class: string;
2798
- };
2799
- aiSubClose: {
2800
- icon: any;
2801
- class: string;
2802
- };
2803
- };
2804
- registerLanguageTexts(): {
2805
- sub: {
2806
- jp: string;
2807
- en: string;
2808
- zh: string;
2809
- "zh-hk": string;
2810
- };
2811
- subOpen: {
2812
- jp: string;
2813
- en: string;
2814
- zh: string;
2815
- "zh-hk": string;
2816
- };
2817
- subClose: {
2818
- jp: string;
2819
- en: string;
2820
- zh: string;
2821
- "zh-hk": string;
2822
- };
2823
- };
2824
- children(): {
2825
- LiveSubTitlesPlugin: {
2826
- plugin: typeof LiveSubTitlesPlugin;
2827
- options: {
2828
- root: HTMLElement;
2829
- showLang: string;
2830
- };
2831
- };
2832
- };
2833
- initEvents(): void;
2834
- handleButtonChange(): void;
2835
- showMobilePanel(): void;
2836
- renderItemList(): HTMLElement;
2837
- renderItem(item: any): HTMLElement;
2838
- updatePanel(): void;
2839
- showPanel(): void;
2840
- hidePanel(): void;
2841
- open(isInit?: boolean): void;
2842
- close(): void;
2843
- renderOptionList(): void;
2844
- changeSubTitleLang(key: string, isInit?: boolean): void;
2845
- toggleSubTitle(): void;
2846
- destroy(): void;
2847
- render(): string;
2848
- }
2849
- declare class NativeSubTitle extends EventEmitter {
2850
- _media: any;
2851
- _list: any[];
2852
- _languages: string;
2853
- curIndex: number;
2854
- constructor(media: any);
2855
- _init(): void;
2856
- _onChange: (e: any) => void;
2857
- /**
2858
- * @description 切换字幕
2859
- * @param { null | {
2860
- * id: any,
2861
- * language: any
2862
- * }} data
2863
- * @return {Promise<{code: number}>}
2864
- */
2865
- switch(data: any): Promise<unknown>;
2866
- switchOff(): void;
2867
- destroy(): void;
2868
- }
2869
- export interface IPanelItem {
2870
- showText: string;
2871
- selected: boolean;
2872
- language?: string | number;
2873
- "data-id"?: number | string;
2874
- "data-type"?: string;
2875
- }
2876
- export declare class Subtitle extends Plugin {
2877
- constructor(args: any);
2878
- static get pluginName(): string;
2879
- static get defaultConfig(): {
2880
- position: string;
2881
- index: number;
2882
- list: any[];
2883
- isDefaultOpen: boolean;
2884
- style: {
2885
- follow: boolean;
2886
- mode: string;
2887
- followBottom: number;
2888
- fitVideo: boolean;
2889
- offsetBottom: number;
2890
- baseSizeX: number;
2891
- baseSizeY: number;
2892
- minSize: number;
2893
- minMobileSize: number;
2894
- line: string;
2895
- fontColor: string;
2896
- };
2897
- isShowIcon: boolean;
2898
- mode: string;
2899
- updateMode: string;
2900
- };
2901
- private _delegates;
2902
- isOpenState: boolean;
2903
- optionList: any;
2904
- currentLang: string;
2905
- subTitles: any;
2906
- curIndex: number;
2907
- curItem: ISubTitleItem;
2908
- player: Player & {
2909
- _subTitles?: NativeSubTitle;
2910
- };
2911
- afterCreate(): void;
2912
- /**
2913
- * @description 初始化原生字幕
2914
- *
2915
- */
2916
- _initNativeSubtitle(defaultIndex: any): void;
2917
- /**
2918
- * 初始化外挂字幕
2919
- * @param {number} defaultIndex
2920
- */
2921
- _initExtSubTitle(defaultIndex: any): void;
2922
- _renderList(defaultIndex: any): void;
2923
- _onOff(): void;
2924
- _onChange(data: any): void;
2925
- _onListReset(data: any): void;
2926
- updateCurItem(cIndex: any, subtitle: any): void;
2927
- initEvents(): void;
2928
- handleButtonChange(e: any): void;
2929
- showList(): void;
2930
- hideList(): void;
2931
- openSubtitle(): void;
2932
- getSubTitleIndex(list: any, subtitle?: {
2933
- id: string;
2934
- language: string;
2935
- }): number;
2936
- registerIcons(): {
2937
- vttSubOpen: {
2938
- icon: any;
2939
- class: string;
2940
- };
2941
- vttSubClose: {
2942
- icon: any;
2943
- class: string;
2944
- };
2945
- };
2946
- registerLanguageTexts(): {
2947
- sub: {
2948
- jp: string;
2949
- en: string;
2950
- zh: string;
2951
- "zh-hk": string;
2952
- };
2953
- subOpen: {
2954
- jp: string;
2955
- en: string;
2956
- zh: string;
2957
- "zh-hk": string;
2958
- };
2959
- subClose: {
2960
- jp: string;
2961
- en: string;
2962
- zh: string;
2963
- "zh-hk": string;
2964
- };
2965
- };
2966
- creatOptionList(): void;
2967
- getList(): any;
2968
- renderOptionList(): void;
2969
- handlerClickSwitch: (e: any, data: any) => void;
2970
- /**
2971
- *
2972
- * @param {ISubTitleItem} subtitle
2973
- * @returns
2974
- */
2975
- switchSubTitle(subtitle?: ISubTitleItem): any;
2976
- switchOffSubtitle(): void;
2977
- noShowSubtitle(): void;
2978
- renderItemList(): void;
2979
- /**
2980
- *
2981
- * @param { Array<SubTitleItem> } list
2982
- * @param { boolean } needRemove 是否移除原来的字幕
2983
- */
2984
- updateSubtitles(list?: any[], needRemove?: boolean): void;
2985
- updateList(data?: {
2986
- list?: any[];
2987
- isOpen?: boolean;
2988
- }): void;
2989
- changeTipText(): void;
2990
- showMobilePanel(): void;
2991
- updatePanel(): void;
2992
- renderPanel(): HTMLElement;
2993
- renderPanelItem(item: IPanelItem): HTMLElement;
2994
- getTextByLang(item: any, key?: any, lang?: any): any;
2995
- onPlayerFocus: (e: any) => void;
2996
- onPlayerBlur: (e: any) => void;
2997
- rePosition(): void;
2998
- destroy(): void;
2999
- render(): string;
3000
- }
3001
- export declare class DefinitionDemotePlugin extends Plugin {
3002
- static get pluginName(): string;
3003
- waitings: number[];
3004
- timer: any;
3005
- longWaitingEmitTime: number;
3006
- waitingStartTime: number;
3007
- playerData: any;
3008
- isNeedShowTips: boolean;
3009
- static get defaultConfig(): {
3010
- oftenWaitingCount: number;
3011
- oftenWaitingTime: number;
3012
- longWaitingTime: number;
3013
- isNeedAutoDemote: boolean;
3014
- demotePriority: any[];
3015
- };
3016
- constructor(args: any);
3017
- registerLanguageTexts(): {
3018
- definition_demote_txt: {
3019
- jp: string;
3020
- en: string;
3021
- zh: string;
3022
- "zh-hk": string;
3023
- };
3024
- };
3025
- afterCreate(): void;
3026
- bindCtx(): void;
3027
- bindEvents(): void;
3028
- _waiting(): void;
3029
- _count(): void;
3030
- _time(): void;
3031
- _clearTime(): void;
3032
- clearState(): void;
3033
- demote(): void;
3034
- changeUrl(url: any): void;
3035
- showToast(definition: any): void;
3036
- destroy(): void;
3037
- }
3038
- export declare class TimeShiftPlugin extends Plugin {
3039
- static get pluginName(): string;
3040
- static get defaultConfig(): {
3041
- position: string;
3042
- livingStartTime: number;
3043
- maxMoveTime: number;
3044
- currentTime: number;
3045
- timeShiftUrl: string;
3046
- cardList: any[];
3047
- };
3048
- isMobile: boolean;
3049
- playedBar: any;
3050
- cachedBar: any;
3051
- innerBar: any;
3052
- progressBtn: any;
3053
- progressPoint: any;
3054
- backLiveBt: any;
3055
- cardDomList: any[];
3056
- initTime: number;
3057
- liveGap: number;
3058
- shiftTimeGap: number;
3059
- isProgressMoving: boolean;
3060
- isPlayTimeShift: boolean;
3061
- private liveUrl;
3062
- get duration(): any;
3063
- registerLanguageTexts(): {
3064
- BACKLIVE: {
3065
- jp: string;
3066
- en: string;
3067
- zh: string;
3068
- "zh-hk": string;
3069
- };
3070
- };
3071
- updateLang(): void;
3072
- afterCreate(): void;
3073
- clacTime(): void;
3074
- initEvents(): void;
3075
- bindDomEvents(): void;
3076
- handleTimeUpdate(): void;
3077
- onBodyClick: (e: any) => void;
3078
- handleMouseDown(e: any): void;
3079
- handleMouseMove(e: any): void;
3080
- handleMouseUp(e: any): void;
3081
- handleMouseEnter(e: any): void;
3082
- handleMouseLeave(): void;
3083
- focus(): void;
3084
- blur(): void;
3085
- computeTime(e: any): {
3086
- percent: number;
3087
- offset: number;
3088
- width: any;
3089
- left: any;
3090
- e: any;
3091
- };
3092
- tipsUpdate(e: any): void;
3093
- updateShiftTime(percent: number): void;
3094
- getCurrentProgress(): number;
3095
- progressUpdate(): void;
3096
- changeTimeShift(time: any): void;
3097
- changeTimeUrl(): void;
3098
- createBackLiveBtDom(): any;
3099
- backLive(): void;
3100
- toggleBackButton(): void;
3101
- updateCardList(cardList: any): void;
3102
- clearCardDom(): void;
3103
- createTimeShiftCard(): void;
3104
- renderCard(card: any): void;
3105
- cardProcessUpdate(): void;
3106
- calcCardProcess(time: any): number;
3107
- destroy(): void;
3108
- render(): string;
3109
- }
3110
- export declare class MirrorPlugin extends Plugin {
3111
- static get pluginName(): string;
3112
- static get defaultConfig(): {
3113
- position: string;
3114
- index: number;
3115
- disable: boolean;
3116
- defaultEnable: boolean;
3117
- };
3118
- isEnableMirror: boolean;
3119
- constructor(args: any);
3120
- afterCreate(): void;
3121
- registerIcons(): {
3122
- [x: string]: {
3123
- icon: any;
3124
- class: string;
3125
- };
3126
- };
3127
- initIcons(): void;
3128
- registerLanguageTexts(): {
3129
- getMirror: {
3130
- jp: string;
3131
- en: string;
3132
- zh: string;
3133
- "zh-hk": string;
3134
- };
3135
- exitMirror: {
3136
- jp: string;
3137
- en: string;
3138
- zh: string;
3139
- "zh-hk": string;
3140
- };
3141
- };
3142
- btnClick(e: any): void;
3143
- action(flag: any): void;
3144
- updateMirrorState(isEnableMirror: any): void;
3145
- animate(isEnableMirror: any): void;
3146
- switchTips(isEnableMirror: any): void;
3147
- destroy(): void;
3148
- render(): string;
3149
- }
3150
- declare class ToastPlugin extends Plugin {
3151
- static get pluginName(): string;
3152
- static get defaultConfig(): {
3153
- index: number;
3154
- };
3155
- constructor(args: any);
3156
- private toastNumber;
3157
- private toastMaps;
3158
- beforePlayerInit(): void;
3159
- afterPlayerInit(): void;
3160
- afterCreate(): void;
3161
- destroy(): void;
3162
- add(content: string | HTMLElement, duration?: number, isNeedCloseBt?: boolean): number;
3163
- remove(id: number): void;
3164
- renderToast(content: string | HTMLElement, isNeedCloseBt: any, id: any): HTMLElement;
3165
- render(): string;
3166
- }
3167
- export declare class MemoryPlay extends Plugin {
3168
- static get pluginName(): string;
3169
- static get defaultConfig(): {
3170
- getTime: any;
3171
- saveTime: any;
3172
- memoryId: string;
3173
- };
3174
- startTime: number;
3175
- saveTimeFun: (id: number | string, time: number) => unknown;
3176
- getTimeFun: (id: number | string) => number | Promise<number>;
3177
- memoryId: number | string;
3178
- canJump: boolean;
3179
- constructor(args: any);
3180
- registerLanguageTexts(): {
3181
- preText: {
3182
- jp: string;
3183
- en: string;
3184
- zh: string;
3185
- "zh-hk": string;
3186
- };
3187
- };
3188
- children(): {
3189
- toast: typeof ToastPlugin;
3190
- };
3191
- afterCreate(): void;
3192
- beforePlayerInit(): Promise<void>;
3193
- destroy(): void;
3194
- getTime(): Promise<void>;
3195
- setSave(): void;
3196
- showToast(): void;
3197
- saveTimeByStorage(memoryId: any, time: any): void;
3198
- getTimeByStorage(memoryId: any): string;
3199
- }
3200
- export declare type InfoItem = {
3201
- key: string;
3202
- label: string;
3203
- labelTextKey?: string;
3204
- value?: any;
3205
- render?: (key: any) => string;
3206
- type?: string;
3207
- dom?: Element;
3208
- };
3209
- /**
3210
- * 直播信息面板
3211
- */
3212
- export declare class LiveInfoPanel extends Plugin {
3213
- private _pollTimer;
3214
- private _infoItems;
3215
- static get pluginName(): string;
3216
- static get defaultConfig(): {
3217
- visible: boolean;
3218
- showH265Info: boolean;
3219
- };
3220
- get streamType(): any;
3221
- afterCreate(): void;
3222
- registerLanguageTexts(): {
3223
- DECODEFPS: {
3224
- en: string;
3225
- zh: string;
3226
- };
3227
- DECODECOST: {
3228
- en: string;
3229
- zh: string;
3230
- };
3231
- FORMAT: {
3232
- en: string;
3233
- zh: string;
3234
- };
3235
- FPS: {
3236
- en: string;
3237
- zh: string;
3238
- };
3239
- BITRATE: {
3240
- en: string;
3241
- zh: string;
3242
- };
3243
- GOP: {
3244
- en: string;
3245
- zh: string;
3246
- };
3247
- RESOLUTION: {
3248
- en: string;
3249
- zh: string;
3250
- };
3251
- ENCODETYPE: {
3252
- en: string;
3253
- zh: string;
3254
- };
3255
- BUFFEREND: {
3256
- en: string;
3257
- zh: string;
3258
- };
3259
- CURRENTTIME: {
3260
- en: string;
3261
- zh: string;
3262
- };
3263
- };
3264
- _getDefaultInfo(data: any): Record<string, InfoItem>;
3265
- _init(): void;
3266
- _getStats(): any;
3267
- _getInfoListData(): Record<string, InfoItem>;
3268
- _initDom(infoItems: any): any;
3269
- _updateTitle(rowDom: Element, item: InfoItem): void;
3270
- _updateDom(rowdom: Element, newItem: InfoItem): void;
3271
- _renderLabel(item: InfoItem): any;
3272
- _renderValue(item: InfoItem): any;
3273
- _handleDataChange(): void;
3274
- _tick(): void;
3275
- _poll(): void;
3276
- destroy(): void;
3277
- _handleError(): void;
3278
- _handleLoadedData(): void;
3279
- _open(): void;
3280
- _close(): void;
3281
- open(): void;
3282
- close(): void;
3283
- render(): string;
3284
- }
3285
- export declare class SdkPlugin {
3286
- pluginName: string;
3287
- __args: any;
3288
- sdk: VePlayer;
3289
- playerData: PlayerData;
3290
- player: Player;
3291
- _emitter: EventEmitter;
3292
- static defineGetterOrSetter(Obj: any, map: any): void;
3293
- /**
3294
- * @type { string }
3295
- */
3296
- static get pluginName(): string;
3297
- /**
3298
- * @constructor
3299
- * @param { { sdk: object, pluginName: string, [propName: string]: any;} } args
3300
- */
3301
- constructor(args: any);
3302
- /**
3303
- * @description sdk实例创建,挂载插件实例时首先执行
3304
- */
3305
- beforeCreate(): void;
3306
- /**
3307
- * @description sdk实例创建,挂载插件实例完后执行
3308
- */
3309
- afterCreate(): void;
3310
- /**
3311
- * @description sdk创建播放器前执行,只有这里能保证异步操作在creatPlayer之前同步完成
3312
- */
3313
- beforePlayerCreate(): void;
3314
- /**
3315
- * @description sdk创建播放器完执行
3316
- */
3317
- afterPlayerCreate(): void;
3318
- /**
3319
- * @description sdk销毁时执行
3320
- */
3321
- destroy(): void;
3322
- /**
3323
- * @private
3324
- * @param { any } args
3325
- */
3326
- __init(args: any): void;
3327
- /**
3328
- * @description 插件销毁
3329
- * @private
3330
- */
3331
- __destroy(): void;
3332
- }
3333
- export declare const Events: {
3334
- /**
3335
- * 弹幕配置发生变化
3336
- */
3337
- DANMU_CHANGE: string;
3338
- /**
3339
- * @hidden
3340
- */
3341
- TIME_SHIFT_CHANGE: string;
3342
- /**
3343
- * @hidden
3344
- */
3345
- AI_SUBTITLE_LANG_CHANGE: string;
3346
- /**
3347
- * @hidden
3348
- */
3349
- AI_SUBTITLE_MATCH: string;
3350
- /**
3351
- * 取消静音
3352
- */
3353
- CANCEL_UNMUTE: string;
3354
- /**
3355
- * 处罚刷新
3356
- */
3357
- REFRESH_CLICK: string;
3358
- /**
3359
- * 报错时触发降级
3360
- */
3361
- PLAY_BACKUP_CHANGE: string;
3362
- /**
3363
- * 报错时触发所有降级结束
3364
- */
3365
- PLAY_BACKUP_CHANGE_FINISH: string;
3366
- /**
3367
- * 报错时触发重试
3368
- */
3369
- PLAY_ERROR_BUTTON_CLICK: string;
3370
- /**
3371
- * 播放url改变
3372
- */
3373
- PlAY_URL_CHANGE: string;
3374
- /**
3375
- * 展示报错
3376
- */
3377
- SHOW_PLAY_ERROR: string;
3378
- /**
3379
- * @hidden
3380
- */
3381
- PLAYER_EXTEND_BUTTON: string;
3382
- /**
3383
- * 长时间waiting
3384
- */
3385
- LONG_WAITING: string;
3386
- /**
3387
- * 频繁waiting
3388
- */
3389
- OFTEN_WAITING: string;
3390
- /**
3391
- * 清晰度降级
3392
- */
3393
- DEFINITION_DEMOTE: string;
3394
- /**
3395
- *@hidden
3396
- */
3397
- LARKWINDOW_CHANGE: string;
3398
- /**
3399
- * @hidden
3400
- */
3401
- PANEL_MODE_CHANGE: string;
3402
- /**
3403
- * 清晰度切换
3404
- */
3405
- INNER_DEFINITION_CHANGE: string;
3406
- /**
3407
- * 线路切换
3408
- */
3409
- LINE_CHANGE: string;
3410
- /**
3411
- * playAuthToken获取url失败
3412
- */
3413
- GET_PLAY_URL_ERR: string;
3414
- /**
3415
- * 资源过期
3416
- */
3417
- MEDIA_EXPIRED: string;
3418
- /**
3419
- * 开启镜像
3420
- */
3421
- MIRROR_CHANGE: string;
3422
- /**
3423
- * 音乐播放器快进快退跨度
3424
- */
3425
- TIME_SCALE_CHANGE: string;
3426
- /**
3427
- * 音乐播放器播放模式改变
3428
- */
3429
- MUSIC_MODE_CHANGE: string;
3430
- /**
3431
- * 音乐播放器切换音乐
3432
- */
3433
- MUSIC_CHANGE: string;
3434
- /**
3435
- * 音乐播放列表发生变化
3436
- */
3437
- MUSIC_LIST_CHANGE: string;
3438
- /**
3439
- * 自动播放成功
3440
- */
3441
- AUTOPLAY_SUCCESS: string;
3442
- /**
3443
- * 自动播放失败
3444
- */
3445
- AUTOPLAY_FAILED: string;
3446
- /**
3447
- * 右键菜单事件,事件data中包含具体信息
3448
- */
3449
- MENU_LOG: string;
3450
- /**
3451
- * 点击了右键菜单的反馈按钮
3452
- */
3453
- MENU_REPORT: string;
3454
- /**
3455
- * 播放器完成创建
3456
- */
3457
- PLAYER_CREATED_FINISH: string;
3458
- /**
3459
- * 播放器重建
3460
- */
3461
- PLAYER_REBUILD: string;
3462
- /**
3463
- * 硬解不支持
3464
- */
3465
- NOT_SUPPORT_HARDWARE_DECODER: string;
3466
- /**
3467
- * 软解不支持
3468
- */
3469
- NOT_SUPPORT_SOFT_DECODER: string;
3470
- /**
3471
- * playAuthToken 过期
3472
- */
3473
- TOKEN_EXPIRED: string;
3474
- /**
3475
- * umd 加载失败
3476
- */
3477
- UMD_LOAD_FAIL: string;
3478
- PLAY: "play";
3479
- PLAYING: "playing";
3480
- ENDED: "ended";
3481
- PAUSE: "pause";
3482
- ERROR: "error";
3483
- SEEKING: "seeking";
3484
- SEEKED: "seeked";
3485
- TIME_UPDATE: "timeupdate";
3486
- WAITING: "waiting";
3487
- CANPLAY: "canplay";
3488
- CANPLAY_THROUGH: "canplaythrough";
3489
- DURATION_CHANGE: "durationchange";
3490
- VOLUME_CHANGE: "volumechange";
3491
- LOADED_DATA: "loadeddata";
3492
- LOADED_METADATA: "loadedmetadata";
3493
- RATE_CHANGE: "ratechange";
3494
- PROGRESS: "progress";
3495
- LOAD_START: "loadstart";
3496
- EMPTIED: "emptied";
3497
- STALLED: "stalled";
3498
- SUSPEND: "suspend";
3499
- ABORT: "abort";
3500
- BUFFER_CHANGE: "bufferedChange";
3501
- PLAYER_FOCUS: "focus";
3502
- PLAYER_BLUR: "blur";
3503
- READY: "ready";
3504
- URL_NULL: "urlNull";
3505
- AUTOPLAY_STARTED: "autoplay_started";
3506
- AUTOPLAY_PREVENTED: "autoplay_was_prevented";
3507
- COMPLETE: "complete";
3508
- REPLAY: "replay";
3509
- DESTROY: "destroy";
3510
- URL_CHANGE: "urlchange";
3511
- DOWNLOAD_SPEED_CHANGE: "download_speed_change";
3512
- FULLSCREEN_CHANGE: "fullscreen_change";
3513
- CSS_FULLSCREEN_CHANGE: "cssFullscreen_change";
3514
- MINI_STATE_CHANGE: "mini_state_change";
3515
- DEFINITION_CHANGE: "definition_change";
3516
- BEFORE_DEFINITION_CHANGE: "before_definition_change";
3517
- AFTER_DEFINITION_CHANGE: "after_definition_change";
3518
- SEI_PARSED: "SEI_PARSED";
3519
- RETRY: "retry";
3520
- VIDEO_RESIZE: "video_resize";
3521
- PIP_CHANGE: "pip_change";
3522
- ROTATE: "rotate";
3523
- SCREEN_SHOT: "screenShot";
3524
- PLAYNEXT: "playnext";
3525
- SHORTCUT: "shortcut";
3526
- XGLOG: "xglog";
3527
- USER_ACTION: "user_action";
3528
- RESET: "reset";
3529
- SOURCE_ERROR: "source_error";
3530
- SOURCE_SUCCESS: "source_success";
3531
- SWITCH_SUBTITLE: "switch_subtitle";
3532
- VIDEO_EVENTS: string[];
3533
- STATS_EVENTS: typeof XgEvents.STATS_EVENTS;
3534
- FPS_STUCK: "fps_stuck";
3535
- };
3536
- export declare const Event: {
3537
- SDKEvents: {
3538
- /**
3539
- * 播放器完成创建
3540
- */
3541
- PLAYER_CREATED_FINISH: string;
3542
- /**
3543
- * 播放器重建
3544
- */
3545
- PLAYER_REBUILD: string;
3546
- /**
3547
- * 硬解不支持
3548
- */
3549
- NOT_SUPPORT_HARDWARE_DECODER: string;
3550
- /**
3551
- * 软解不支持
3552
- */
3553
- NOT_SUPPORT_SOFT_DECODER: string;
3554
- /**
3555
- * playAuthToken 过期
3556
- */
3557
- TOKEN_EXPIRED: string;
3558
- /**
3559
- * umd 加载失败
3560
- */
3561
- UMD_LOAD_FAIL: string;
3562
- };
3563
- PluginEvents: {
3564
- /**
3565
- * 弹幕配置发生变化
3566
- */
3567
- DANMU_CHANGE: string;
3568
- /**
3569
- * @hidden
3570
- */
3571
- TIME_SHIFT_CHANGE: string;
3572
- /**
3573
- * @hidden
3574
- */
3575
- AI_SUBTITLE_LANG_CHANGE: string;
3576
- /**
3577
- * @hidden
3578
- */
3579
- AI_SUBTITLE_MATCH: string;
3580
- /**
3581
- * 取消静音
3582
- */
3583
- CANCEL_UNMUTE: string;
3584
- /**
3585
- * 处罚刷新
3586
- */
3587
- REFRESH_CLICK: string;
3588
- /**
3589
- * 报错时触发降级
3590
- */
3591
- PLAY_BACKUP_CHANGE: string;
3592
- /**
3593
- * 报错时触发所有降级结束
3594
- */
3595
- PLAY_BACKUP_CHANGE_FINISH: string;
3596
- /**
3597
- * 报错时触发重试
3598
- */
3599
- PLAY_ERROR_BUTTON_CLICK: string;
3600
- /**
3601
- * 播放url改变
3602
- */
3603
- PlAY_URL_CHANGE: string;
3604
- /**
3605
- * 展示报错
3606
- */
3607
- SHOW_PLAY_ERROR: string;
3608
- /**
3609
- * @hidden
3610
- */
3611
- PLAYER_EXTEND_BUTTON: string;
3612
- /**
3613
- * 长时间waiting
3614
- */
3615
- LONG_WAITING: string;
3616
- /**
3617
- * 频繁waiting
3618
- */
3619
- OFTEN_WAITING: string;
3620
- /**
3621
- * 清晰度降级
3622
- */
3623
- DEFINITION_DEMOTE: string;
3624
- /**
3625
- *@hidden
3626
- */
3627
- LARKWINDOW_CHANGE: string;
3628
- /**
3629
- * @hidden
3630
- */
3631
- PANEL_MODE_CHANGE: string;
3632
- /**
3633
- * 清晰度切换
3634
- */
3635
- INNER_DEFINITION_CHANGE: string;
3636
- /**
3637
- * 线路切换
3638
- */
3639
- LINE_CHANGE: string;
3640
- /**
3641
- * playAuthToken获取url失败
3642
- */
3643
- GET_PLAY_URL_ERR: string;
3644
- /**
3645
- * 资源过期
3646
- */
3647
- MEDIA_EXPIRED: string;
3648
- /**
3649
- * 开启镜像
3650
- */
3651
- MIRROR_CHANGE: string;
3652
- /**
3653
- * 音乐播放器快进快退跨度
3654
- */
3655
- TIME_SCALE_CHANGE: string;
3656
- /**
3657
- * 音乐播放器播放模式改变
3658
- */
3659
- MUSIC_MODE_CHANGE: string;
3660
- /**
3661
- * 音乐播放器切换音乐
3662
- */
3663
- MUSIC_CHANGE: string;
3664
- /**
3665
- * 音乐播放列表发生变化
3666
- */
3667
- MUSIC_LIST_CHANGE: string;
3668
- /**
3669
- * 自动播放成功
3670
- */
3671
- AUTOPLAY_SUCCESS: string;
3672
- /**
3673
- * 自动播放失败
3674
- */
3675
- AUTOPLAY_FAILED: string;
3676
- /**
3677
- * 右键菜单事件,事件data中包含具体信息
3678
- */
3679
- MENU_LOG: string;
3680
- /**
3681
- * 点击了右键菜单的反馈按钮
3682
- */
3683
- MENU_REPORT: string;
3684
- };
3685
- };
3686
- export * from "xgplayer";
3687
-
3688
- export {
3689
- LiveSubTitlesPlugin as LiveSubtitlesPlugin,
3690
- MusicPreset as Music,
3691
- VePlayer as default,
3692
- };
3693
-
3694
- export {};