@theoplayer/extended 6.10.1 → 6.12.0
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/THEOplayer.chromeless.d.ts +1 -1
- package/THEOplayer.chromeless.esm.js +2 -2
- package/THEOplayer.chromeless.js +3 -3
- package/THEOplayer.common.d.ts +645 -7
- package/THEOplayer.common.esm.js +3 -3
- package/THEOplayer.d.ts +11 -1
- package/THEOplayer.esm.js +3 -3
- package/THEOplayer.js +3 -3
- package/THEOplayer.transmux.asmjs.js +3 -3
- package/THEOplayer.transmux.js +3 -3
- package/package.json +1 -1
- package/theoplayer.d.js +3 -3
- package/ui.css +1 -1
package/THEOplayer.common.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Fired when an event occurs.
|
|
3
3
|
*
|
|
4
|
+
* @category Events
|
|
4
5
|
* @public
|
|
5
6
|
*/
|
|
6
7
|
interface Event<TType extends string = string> {
|
|
@@ -17,6 +18,7 @@ interface Event<TType extends string = string> {
|
|
|
17
18
|
/**
|
|
18
19
|
* The function to be executed when an event occurred.
|
|
19
20
|
*
|
|
21
|
+
* @category Events
|
|
20
22
|
* @public
|
|
21
23
|
*/
|
|
22
24
|
type EventListener<TEvent extends Event> = (event: TEvent) => void;
|
|
@@ -33,6 +35,7 @@ type EventListener<TEvent extends Event> = (event: TEvent) => void;
|
|
|
33
35
|
* }
|
|
34
36
|
* ```
|
|
35
37
|
*
|
|
38
|
+
* @category Events
|
|
36
39
|
* @public
|
|
37
40
|
*/
|
|
38
41
|
type EventMap<TType extends string> = {
|
|
@@ -47,6 +50,7 @@ type StringKeyOf<T> = Extract<keyof T, string>;
|
|
|
47
50
|
/**
|
|
48
51
|
* Dispatches events that are fired.
|
|
49
52
|
*
|
|
53
|
+
* @category Events
|
|
50
54
|
* @public
|
|
51
55
|
*/
|
|
52
56
|
interface EventDispatcher<TEventMap extends EventMap<StringKeyOf<TEventMap>>> {
|
|
@@ -69,6 +73,8 @@ interface EventDispatcher<TEventMap extends EventMap<StringKeyOf<TEventMap>>> {
|
|
|
69
73
|
/**
|
|
70
74
|
* Fired when the ad has stalled playback to buffer.
|
|
71
75
|
*
|
|
76
|
+
* @category Ads
|
|
77
|
+
* @category Events
|
|
72
78
|
* @public
|
|
73
79
|
*/
|
|
74
80
|
interface AdBufferingEvent extends AdEvent<'adbuffering'> {
|
|
@@ -81,6 +87,8 @@ interface AdBufferingEvent extends AdEvent<'adbuffering'> {
|
|
|
81
87
|
/**
|
|
82
88
|
* Fired when an ads list is loaded.
|
|
83
89
|
*
|
|
90
|
+
* @category Ads
|
|
91
|
+
* @category Events
|
|
84
92
|
* @public
|
|
85
93
|
*/
|
|
86
94
|
interface AdMetadataEvent extends Event<'admetadata'> {
|
|
@@ -92,6 +100,7 @@ interface AdMetadataEvent extends Event<'admetadata'> {
|
|
|
92
100
|
* @remarks
|
|
93
101
|
* <br/> - Available since v3.7.0.
|
|
94
102
|
*
|
|
103
|
+
* @category Ads
|
|
95
104
|
* @public
|
|
96
105
|
*/
|
|
97
106
|
interface GoogleDAI {
|
|
@@ -127,6 +136,7 @@ interface GoogleDAI {
|
|
|
127
136
|
/**
|
|
128
137
|
* Represents a VAST creative. It is either a linear or non-linear ad.
|
|
129
138
|
*
|
|
139
|
+
* @category Ads
|
|
130
140
|
* @public
|
|
131
141
|
*/
|
|
132
142
|
interface Ad {
|
|
@@ -250,6 +260,7 @@ interface Ad {
|
|
|
250
260
|
* @remarks
|
|
251
261
|
* <br/> - For Google IMA, preloading starts 4 seconds before ad playback.
|
|
252
262
|
*
|
|
263
|
+
* @category Ads
|
|
253
264
|
* @public
|
|
254
265
|
*/
|
|
255
266
|
type AdPreloadType = 'none' | 'midroll-and-postroll';
|
|
@@ -262,12 +273,14 @@ type AdPreloadType = 'none' | 'midroll-and-postroll';
|
|
|
262
273
|
* <br/> - An ad is loaded when the ad resource (e.g. VAST file) is downloaded.
|
|
263
274
|
* <br/> - another remark
|
|
264
275
|
*
|
|
276
|
+
* @category Ads
|
|
265
277
|
* @public
|
|
266
278
|
*/
|
|
267
279
|
type AdReadyState = 'none' | 'ready';
|
|
268
280
|
/**
|
|
269
281
|
* Describes the configuration of advertisement.
|
|
270
282
|
*
|
|
283
|
+
* @category Ads
|
|
271
284
|
* @public
|
|
272
285
|
*/
|
|
273
286
|
interface AdsConfiguration {
|
|
@@ -318,6 +331,7 @@ interface AdsConfiguration {
|
|
|
318
331
|
/**
|
|
319
332
|
* Describes the configuration of Google IMA.
|
|
320
333
|
*
|
|
334
|
+
* @category Ads
|
|
321
335
|
* @public
|
|
322
336
|
*/
|
|
323
337
|
interface GoogleImaConfiguration {
|
|
@@ -337,10 +351,19 @@ interface GoogleImaConfiguration {
|
|
|
337
351
|
* @defaultValue -1
|
|
338
352
|
*/
|
|
339
353
|
bitrate?: number;
|
|
354
|
+
/**
|
|
355
|
+
* The language code of the UI elements. See {@link https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/localization | localization docs} for more information.
|
|
356
|
+
*
|
|
357
|
+
* @remarks
|
|
358
|
+
* <br/> - This will default to {@link UIConfiguration.language} when not specified.
|
|
359
|
+
*
|
|
360
|
+
*/
|
|
361
|
+
language?: string;
|
|
340
362
|
}
|
|
341
363
|
/**
|
|
342
364
|
* Represents a non-linear ad in the VAST specification.
|
|
343
365
|
*
|
|
366
|
+
* @category Ads
|
|
344
367
|
* @public
|
|
345
368
|
*/
|
|
346
369
|
interface NonLinearAd extends Ad {
|
|
@@ -374,6 +397,7 @@ interface NonLinearAd extends Ad {
|
|
|
374
397
|
* @remarks
|
|
375
398
|
* <br/> - `'streaming'` is currently not supported.
|
|
376
399
|
*
|
|
400
|
+
* @category Ads
|
|
377
401
|
* @public
|
|
378
402
|
*/
|
|
379
403
|
type DeliveryType = 'progressive' | 'streaming';
|
|
@@ -383,6 +407,7 @@ type DeliveryType = 'progressive' | 'streaming';
|
|
|
383
407
|
* @remarks
|
|
384
408
|
* <br/> - This metadata is retrieved from the VAST file.
|
|
385
409
|
*
|
|
410
|
+
* @category Ads
|
|
386
411
|
* @public
|
|
387
412
|
*/
|
|
388
413
|
interface MediaFile {
|
|
@@ -410,6 +435,7 @@ interface MediaFile {
|
|
|
410
435
|
/**
|
|
411
436
|
* Represents a linear ad in the VAST specification.
|
|
412
437
|
*
|
|
438
|
+
* @category Ads
|
|
413
439
|
* @public
|
|
414
440
|
*/
|
|
415
441
|
interface LinearAd extends Ad {
|
|
@@ -431,6 +457,7 @@ interface LinearAd extends Ad {
|
|
|
431
457
|
* @remarks
|
|
432
458
|
* <br/> - Available since v2.60.0.
|
|
433
459
|
*
|
|
460
|
+
* @category Ads
|
|
434
461
|
* @public
|
|
435
462
|
*/
|
|
436
463
|
interface GoogleImaAd extends Ad {
|
|
@@ -505,6 +532,7 @@ interface GoogleImaAd extends Ad {
|
|
|
505
532
|
/**
|
|
506
533
|
* Represents the information regarding the universal identifier of an ad.
|
|
507
534
|
*
|
|
535
|
+
* @category Ads
|
|
508
536
|
* @public
|
|
509
537
|
*/
|
|
510
538
|
interface UniversalAdId {
|
|
@@ -526,6 +554,7 @@ interface UniversalAdId {
|
|
|
526
554
|
/**
|
|
527
555
|
* Represents an ad break in the VMAP specification or an ad pod in the VAST specification.
|
|
528
556
|
*
|
|
557
|
+
* @category Ads
|
|
529
558
|
* @public
|
|
530
559
|
*/
|
|
531
560
|
interface AdBreak {
|
|
@@ -565,6 +594,7 @@ interface AdBreak {
|
|
|
565
594
|
/**
|
|
566
595
|
* Represents a companion ad which is displayed near the video player.
|
|
567
596
|
*
|
|
597
|
+
* @category Ads
|
|
568
598
|
* @public
|
|
569
599
|
*/
|
|
570
600
|
interface CompanionAd {
|
|
@@ -624,6 +654,7 @@ interface CompanionAd {
|
|
|
624
654
|
/**
|
|
625
655
|
* The events fired by the {@link Ads | ads API}.
|
|
626
656
|
*
|
|
657
|
+
* @category Ads
|
|
627
658
|
* @public
|
|
628
659
|
*/
|
|
629
660
|
interface AdsEventMap {
|
|
@@ -732,6 +763,8 @@ interface AdsEventMap {
|
|
|
732
763
|
/**
|
|
733
764
|
* Base type for events related to a single ad.
|
|
734
765
|
*
|
|
766
|
+
* @category Ads
|
|
767
|
+
* @category Events
|
|
735
768
|
* @public
|
|
736
769
|
*/
|
|
737
770
|
interface AdEvent<TType extends string> extends Event<TType> {
|
|
@@ -743,6 +776,8 @@ interface AdEvent<TType extends string> extends Event<TType> {
|
|
|
743
776
|
/**
|
|
744
777
|
* Fired when an ad is skipped.
|
|
745
778
|
*
|
|
779
|
+
* @category Ads
|
|
780
|
+
* @category Events
|
|
746
781
|
* @public
|
|
747
782
|
*/
|
|
748
783
|
interface AdSkipEvent extends AdEvent<'adskip'> {
|
|
@@ -754,6 +789,8 @@ interface AdSkipEvent extends AdEvent<'adskip'> {
|
|
|
754
789
|
/**
|
|
755
790
|
* Base type for events related to an ad break.
|
|
756
791
|
*
|
|
792
|
+
* @category Ads
|
|
793
|
+
* @category Events
|
|
757
794
|
* @public
|
|
758
795
|
*/
|
|
759
796
|
interface AdBreakEvent<TType extends string> extends Event<TType> {
|
|
@@ -774,6 +811,7 @@ interface AdBreakEvent<TType extends string> extends Event<TType> {
|
|
|
774
811
|
* @remarks
|
|
775
812
|
* <br/> - Integrates with `'theo'`, `'google-ima'`, `'google-dai'` or `'freewheel'`.
|
|
776
813
|
*
|
|
814
|
+
* @category Ads
|
|
777
815
|
* @public
|
|
778
816
|
*/
|
|
779
817
|
interface Ads extends EventDispatcher<AdsEventMap> {
|
|
@@ -831,12 +869,14 @@ interface Ads extends EventDispatcher<AdsEventMap> {
|
|
|
831
869
|
* @remarks
|
|
832
870
|
* <br/> - An ad rule is a simplified VMAP alternative only available in the Google IMA integration.
|
|
833
871
|
*
|
|
872
|
+
* @category Ads
|
|
834
873
|
* @public
|
|
835
874
|
*/
|
|
836
875
|
type AdSourceType = 'vast' | 'vmap' | 'adrule';
|
|
837
876
|
/**
|
|
838
877
|
* Describes the source of the ad.
|
|
839
878
|
*
|
|
879
|
+
* @category Ads
|
|
840
880
|
* @public
|
|
841
881
|
*/
|
|
842
882
|
interface AdSource {
|
|
@@ -854,6 +894,7 @@ interface AdSource {
|
|
|
854
894
|
/**
|
|
855
895
|
* Describes an ad break request.
|
|
856
896
|
*
|
|
897
|
+
* @category Ads
|
|
857
898
|
* @public
|
|
858
899
|
*/
|
|
859
900
|
interface AdDescription {
|
|
@@ -940,6 +981,7 @@ interface AdDescription {
|
|
|
940
981
|
* }
|
|
941
982
|
* ```
|
|
942
983
|
*
|
|
984
|
+
* @category Ads
|
|
943
985
|
* @public
|
|
944
986
|
*/
|
|
945
987
|
interface SpotXAdDescription extends AdDescription {
|
|
@@ -1015,6 +1057,7 @@ interface SpotXAdDescription extends AdDescription {
|
|
|
1015
1057
|
/**
|
|
1016
1058
|
* Describes a Google IMA ad break request.
|
|
1017
1059
|
*
|
|
1060
|
+
* @category Ads
|
|
1018
1061
|
* @public
|
|
1019
1062
|
*/
|
|
1020
1063
|
interface IMAAdDescription extends AdDescription {
|
|
@@ -1041,12 +1084,14 @@ interface IMAAdDescription extends AdDescription {
|
|
|
1041
1084
|
* <br/> - `'postroll'`: The linear ad will play after the content ended.
|
|
1042
1085
|
* <br/> - `'overlay'`: The non-linear ad.
|
|
1043
1086
|
*
|
|
1087
|
+
* @category Ads
|
|
1044
1088
|
* @public
|
|
1045
1089
|
*/
|
|
1046
1090
|
type FreeWheelAdUnitType = 'preroll' | 'midroll' | 'postroll' | 'overlay';
|
|
1047
1091
|
/**
|
|
1048
1092
|
* Represents a FreeWheel cue.
|
|
1049
1093
|
*
|
|
1094
|
+
* @category Ads
|
|
1050
1095
|
* @public
|
|
1051
1096
|
*/
|
|
1052
1097
|
interface FreeWheelCue {
|
|
@@ -1065,6 +1110,7 @@ interface FreeWheelCue {
|
|
|
1065
1110
|
* @remarks
|
|
1066
1111
|
* <br/> - Available since v2.42.0.
|
|
1067
1112
|
*
|
|
1113
|
+
* @category Ads
|
|
1068
1114
|
* @public
|
|
1069
1115
|
*/
|
|
1070
1116
|
interface FreeWheelAdDescription extends AdDescription {
|
|
@@ -1121,6 +1167,7 @@ interface FreeWheelAdDescription extends AdDescription {
|
|
|
1121
1167
|
/**
|
|
1122
1168
|
* Represents a geographical location.
|
|
1123
1169
|
*
|
|
1170
|
+
* @category Ads
|
|
1124
1171
|
* @public
|
|
1125
1172
|
*/
|
|
1126
1173
|
interface Geo {
|
|
@@ -1137,6 +1184,7 @@ interface Geo {
|
|
|
1137
1184
|
* A record of SpotX query string parameters.
|
|
1138
1185
|
* Each entry contains the parameter name with associated value.
|
|
1139
1186
|
*
|
|
1187
|
+
* @category Ads
|
|
1140
1188
|
* @public
|
|
1141
1189
|
*/
|
|
1142
1190
|
interface SpotxData {
|
|
@@ -1146,6 +1194,7 @@ interface SpotxData {
|
|
|
1146
1194
|
* A record of SpotX query string parameters which can be a nested structure.
|
|
1147
1195
|
* Each entry contains the parameter name with associated value.
|
|
1148
1196
|
*
|
|
1197
|
+
* @category Ads
|
|
1149
1198
|
* @public
|
|
1150
1199
|
*/
|
|
1151
1200
|
interface SpotxQueryParameter {
|
|
@@ -1161,6 +1210,7 @@ interface SpotxQueryParameter {
|
|
|
1161
1210
|
* @remarks
|
|
1162
1211
|
* <br/> - An empty string defaults to `'theo'`.
|
|
1163
1212
|
*
|
|
1213
|
+
* @category Ads
|
|
1164
1214
|
* @public
|
|
1165
1215
|
*/
|
|
1166
1216
|
type AdIntegrationKind = '' | 'theo' | 'google-ima' | 'spotx' | 'freewheel';
|
|
@@ -1170,12 +1220,14 @@ type AdIntegrationKind = '' | 'theo' | 'google-ima' | 'spotx' | 'freewheel';
|
|
|
1170
1220
|
* <br/> - `'insecure'`: Ads will load in a friendly iframe. This allows access to the site via JavaScript.
|
|
1171
1221
|
* <br/> - `'disabled'`: Ads will error when requested.
|
|
1172
1222
|
*
|
|
1223
|
+
* @category Ads
|
|
1173
1224
|
* @public
|
|
1174
1225
|
*/
|
|
1175
1226
|
type VPAIDMode = 'enabled' | 'insecure' | 'disabled';
|
|
1176
1227
|
/**
|
|
1177
1228
|
* Describes an ad break request.
|
|
1178
1229
|
*
|
|
1230
|
+
* @category Ads
|
|
1179
1231
|
* @public
|
|
1180
1232
|
*/
|
|
1181
1233
|
interface THEOplayerAdDescription extends AdDescription {
|
|
@@ -1222,6 +1274,8 @@ type BufferSource = ArrayBufferView | ArrayBuffer;
|
|
|
1222
1274
|
/**
|
|
1223
1275
|
* Describes the key system configuration.
|
|
1224
1276
|
*
|
|
1277
|
+
* @category Source
|
|
1278
|
+
* @category Content Protection
|
|
1225
1279
|
* @public
|
|
1226
1280
|
*/
|
|
1227
1281
|
interface KeySystemConfiguration {
|
|
@@ -1314,12 +1368,16 @@ interface KeySystemConfiguration {
|
|
|
1314
1368
|
* <br/> - `'temporary'`
|
|
1315
1369
|
* <br/> - `'persistent'`
|
|
1316
1370
|
*
|
|
1371
|
+
* @category Source
|
|
1372
|
+
* @category Content Protection
|
|
1317
1373
|
* @public
|
|
1318
1374
|
*/
|
|
1319
1375
|
type LicenseType = 'temporary' | 'persistent';
|
|
1320
1376
|
/**
|
|
1321
1377
|
* Describes the FairPlay key system configuration.
|
|
1322
1378
|
*
|
|
1379
|
+
* @category Source
|
|
1380
|
+
* @category Content Protection
|
|
1323
1381
|
* @public
|
|
1324
1382
|
*/
|
|
1325
1383
|
interface FairPlayKeySystemConfiguration extends KeySystemConfiguration {
|
|
@@ -1331,6 +1389,8 @@ interface FairPlayKeySystemConfiguration extends KeySystemConfiguration {
|
|
|
1331
1389
|
/**
|
|
1332
1390
|
* Describes the PlayReady key system configuration.
|
|
1333
1391
|
*
|
|
1392
|
+
* @category Source
|
|
1393
|
+
* @category Content Protection
|
|
1334
1394
|
* @public
|
|
1335
1395
|
*/
|
|
1336
1396
|
interface PlayReadyKeySystemConfiguration extends KeySystemConfiguration {
|
|
@@ -1342,12 +1402,16 @@ interface PlayReadyKeySystemConfiguration extends KeySystemConfiguration {
|
|
|
1342
1402
|
/**
|
|
1343
1403
|
* Describes the Widevine key system configuration.
|
|
1344
1404
|
*
|
|
1405
|
+
* @category Source
|
|
1406
|
+
* @category Content Protection
|
|
1345
1407
|
* @public
|
|
1346
1408
|
*/
|
|
1347
1409
|
type WidevineKeySystemConfiguration = KeySystemConfiguration;
|
|
1348
1410
|
/**
|
|
1349
1411
|
* Describes the ClearKey key system configuration.
|
|
1350
1412
|
*
|
|
1413
|
+
* @category Source
|
|
1414
|
+
* @category Content Protection
|
|
1351
1415
|
* @public
|
|
1352
1416
|
*/
|
|
1353
1417
|
interface ClearkeyKeySystemConfiguration extends KeySystemConfiguration {
|
|
@@ -1359,6 +1423,8 @@ interface ClearkeyKeySystemConfiguration extends KeySystemConfiguration {
|
|
|
1359
1423
|
/**
|
|
1360
1424
|
* Describes the ClearKey decryption key.
|
|
1361
1425
|
*
|
|
1426
|
+
* @category Source
|
|
1427
|
+
* @category Content Protection
|
|
1362
1428
|
* @public
|
|
1363
1429
|
*/
|
|
1364
1430
|
interface ClearkeyDecryptionKey {
|
|
@@ -1382,6 +1448,8 @@ interface ClearkeyDecryptionKey {
|
|
|
1382
1448
|
/**
|
|
1383
1449
|
* Describes the AES128 key system configuration.
|
|
1384
1450
|
*
|
|
1451
|
+
* @category Source
|
|
1452
|
+
* @category Content Protection
|
|
1385
1453
|
* @public
|
|
1386
1454
|
*/
|
|
1387
1455
|
interface AES128KeySystemConfiguration {
|
|
@@ -1398,6 +1466,8 @@ interface AES128KeySystemConfiguration {
|
|
|
1398
1466
|
/**
|
|
1399
1467
|
* Describes the configuration of the DRM.
|
|
1400
1468
|
*
|
|
1469
|
+
* @category Source
|
|
1470
|
+
* @category Content Protection
|
|
1401
1471
|
* @public
|
|
1402
1472
|
*/
|
|
1403
1473
|
interface DRMConfiguration {
|
|
@@ -1448,6 +1518,8 @@ interface DRMConfiguration {
|
|
|
1448
1518
|
/**
|
|
1449
1519
|
* The id of a key system. Possible values are 'widevine', 'fairplay' and 'playready'.
|
|
1450
1520
|
*
|
|
1521
|
+
* @category Source
|
|
1522
|
+
* @category Content Protection
|
|
1451
1523
|
* @public
|
|
1452
1524
|
*/
|
|
1453
1525
|
type KeySystemId = 'widevine' | 'fairplay' | 'playready';
|
|
@@ -1455,6 +1527,8 @@ type KeySystemId = 'widevine' | 'fairplay' | 'playready';
|
|
|
1455
1527
|
/**
|
|
1456
1528
|
* The identifier of the Yospace integration.
|
|
1457
1529
|
*
|
|
1530
|
+
* @category Source
|
|
1531
|
+
* @category SSAI
|
|
1458
1532
|
* @public
|
|
1459
1533
|
*/
|
|
1460
1534
|
type YospaceSSAIIntegrationID = 'yospace';
|
|
@@ -1465,6 +1539,8 @@ type YospaceSSAIIntegrationID = 'yospace';
|
|
|
1465
1539
|
* <br/> - `'nonlinear'`: The stream is a Non-Linear Start-Over stream.
|
|
1466
1540
|
* <br/> - `'vod'`: The stream is a video-on-demand stream.
|
|
1467
1541
|
*
|
|
1542
|
+
* @category Source
|
|
1543
|
+
* @category SSAI
|
|
1468
1544
|
* @public
|
|
1469
1545
|
*/
|
|
1470
1546
|
type YospaceStreamType = 'vod' | 'live' | 'livepause' | 'nonlinear';
|
|
@@ -1474,6 +1550,8 @@ type YospaceStreamType = 'vod' | 'live' | 'livepause' | 'nonlinear';
|
|
|
1474
1550
|
* @remarks
|
|
1475
1551
|
* <br/> - Available since v2.14.7.
|
|
1476
1552
|
*
|
|
1553
|
+
* @category Source
|
|
1554
|
+
* @category SSAI
|
|
1477
1555
|
* @public
|
|
1478
1556
|
*/
|
|
1479
1557
|
interface YospaceServerSideAdInsertionConfiguration extends ServerSideAdInsertionConfiguration {
|
|
@@ -1491,6 +1569,8 @@ interface YospaceServerSideAdInsertionConfiguration extends ServerSideAdInsertio
|
|
|
1491
1569
|
/**
|
|
1492
1570
|
* Represents a media resource with a Yospace server-side ad insertion request.
|
|
1493
1571
|
*
|
|
1572
|
+
* @category Source
|
|
1573
|
+
* @category SSAI
|
|
1494
1574
|
* @public
|
|
1495
1575
|
*/
|
|
1496
1576
|
interface YospaceTypedSource extends TypedSource {
|
|
@@ -1500,6 +1580,8 @@ interface YospaceTypedSource extends TypedSource {
|
|
|
1500
1580
|
/**
|
|
1501
1581
|
* The identifier of the Google DAI integration.
|
|
1502
1582
|
*
|
|
1583
|
+
* @category Source
|
|
1584
|
+
* @category SSAI
|
|
1503
1585
|
* @public
|
|
1504
1586
|
*/
|
|
1505
1587
|
type GoogleDAISSAIIntegrationID = 'google-dai';
|
|
@@ -1508,6 +1590,8 @@ type GoogleDAISSAIIntegrationID = 'google-dai';
|
|
|
1508
1590
|
* <br/> - `'live'`: The requested stream is a live stream.
|
|
1509
1591
|
* <br/> - `'vod'`: The requested stream is a video-on-demand stream.
|
|
1510
1592
|
*
|
|
1593
|
+
* @category Source
|
|
1594
|
+
* @category SSAI
|
|
1511
1595
|
* @public
|
|
1512
1596
|
*/
|
|
1513
1597
|
type DAIAvailabilityType = 'vod' | 'live';
|
|
@@ -1517,6 +1601,8 @@ type DAIAvailabilityType = 'vod' | 'live';
|
|
|
1517
1601
|
* @remarks
|
|
1518
1602
|
* <br/> - Available since v2.30.0.
|
|
1519
1603
|
*
|
|
1604
|
+
* @category Source
|
|
1605
|
+
* @category SSAI
|
|
1520
1606
|
* @public
|
|
1521
1607
|
*/
|
|
1522
1608
|
interface GoogleDAIConfiguration extends ServerSideAdInsertionConfiguration {
|
|
@@ -1570,6 +1656,8 @@ interface GoogleDAIConfiguration extends ServerSideAdInsertionConfiguration {
|
|
|
1570
1656
|
* @remarks
|
|
1571
1657
|
* <br/> - Available since v2.30.0.
|
|
1572
1658
|
*
|
|
1659
|
+
* @category Source
|
|
1660
|
+
* @category SSAI
|
|
1573
1661
|
* @public
|
|
1574
1662
|
*/
|
|
1575
1663
|
interface GoogleDAILiveConfiguration extends GoogleDAIConfiguration {
|
|
@@ -1592,6 +1680,8 @@ interface GoogleDAILiveConfiguration extends GoogleDAIConfiguration {
|
|
|
1592
1680
|
* @remarks
|
|
1593
1681
|
* <br/> - Available since v2.30.0.
|
|
1594
1682
|
*
|
|
1683
|
+
* @category Source
|
|
1684
|
+
* @category SSAI
|
|
1595
1685
|
* @public
|
|
1596
1686
|
*/
|
|
1597
1687
|
interface GoogleDAIVodConfiguration extends GoogleDAIConfiguration {
|
|
@@ -1618,6 +1708,8 @@ interface GoogleDAIVodConfiguration extends GoogleDAIConfiguration {
|
|
|
1618
1708
|
/**
|
|
1619
1709
|
* Represents a media resource with a Google DAI server-side ad insertion request.
|
|
1620
1710
|
*
|
|
1711
|
+
* @category Source
|
|
1712
|
+
* @category SSAI
|
|
1621
1713
|
* @public
|
|
1622
1714
|
*/
|
|
1623
1715
|
interface GoogleDAITypedSource extends TypedSource {
|
|
@@ -1633,12 +1725,16 @@ interface GoogleDAITypedSource extends TypedSource {
|
|
|
1633
1725
|
/**
|
|
1634
1726
|
* The identifier of the Imagine integration.
|
|
1635
1727
|
*
|
|
1728
|
+
* @category Source
|
|
1729
|
+
* @category SSAI
|
|
1636
1730
|
* @public
|
|
1637
1731
|
*/
|
|
1638
1732
|
type ImagineSSAIIntegrationID = 'imagine';
|
|
1639
1733
|
/**
|
|
1640
1734
|
* Describes the SSAI configuration of the Imagine integration.
|
|
1641
1735
|
*
|
|
1736
|
+
* @category Source
|
|
1737
|
+
* @category SSAI
|
|
1642
1738
|
* @public
|
|
1643
1739
|
*/
|
|
1644
1740
|
interface ImagineServerSideAdInsertionConfiguration extends ServerSideAdInsertionConfiguration {
|
|
@@ -1650,6 +1746,8 @@ interface ImagineServerSideAdInsertionConfiguration extends ServerSideAdInsertio
|
|
|
1650
1746
|
/**
|
|
1651
1747
|
* Describes a source of the Imagine integration.
|
|
1652
1748
|
*
|
|
1749
|
+
* @category Source
|
|
1750
|
+
* @category SSAI
|
|
1653
1751
|
* @public
|
|
1654
1752
|
*/
|
|
1655
1753
|
interface ImagineTypedSource extends TypedSource {
|
|
@@ -1662,6 +1760,8 @@ interface ImagineTypedSource extends TypedSource {
|
|
|
1662
1760
|
* <br/> - `'google-dai'`: The configuration with this identifier is a {@link GoogleDAIConfiguration}
|
|
1663
1761
|
* <br/> - `'imagine'`: The configuration with this identifier is a {@link ImagineServerSideAdInsertionConfiguration}
|
|
1664
1762
|
*
|
|
1763
|
+
* @category Source
|
|
1764
|
+
* @category SSAI
|
|
1665
1765
|
* @public
|
|
1666
1766
|
*/
|
|
1667
1767
|
type SSAIIntegrationId = YospaceSSAIIntegrationID | GoogleDAISSAIIntegrationID | ImagineSSAIIntegrationID;
|
|
@@ -1671,6 +1771,8 @@ type SSAIIntegrationId = YospaceSSAIIntegrationID | GoogleDAISSAIIntegrationID |
|
|
|
1671
1771
|
* @remarks
|
|
1672
1772
|
* <br/> - Available since v2.12.0.
|
|
1673
1773
|
*
|
|
1774
|
+
* @category Source
|
|
1775
|
+
* @category SSAI
|
|
1674
1776
|
* @public
|
|
1675
1777
|
*/
|
|
1676
1778
|
interface ServerSideAdInsertionConfiguration {
|
|
@@ -1686,6 +1788,7 @@ interface ServerSideAdInsertionConfiguration {
|
|
|
1686
1788
|
* <br/> - `'horizontal'`: The two viewpoints are in a side-by-side layout. The view for the left eye is in the left half of the video frame, the view for the right eye is in the right half of the video frame.
|
|
1687
1789
|
* <br/> - `'vertical'`: The two viewpoints are in a top-bottom layout. The view for the left eye is in the upper half of the video frame, the view for the right eye is in the lower half of the video frame.
|
|
1688
1790
|
*
|
|
1791
|
+
* @category VR
|
|
1689
1792
|
* @public
|
|
1690
1793
|
*/
|
|
1691
1794
|
type VRStereoMode = '' | 'horizontal' | 'vertical';
|
|
@@ -1695,6 +1798,7 @@ type VRStereoMode = '' | 'horizontal' | 'vertical';
|
|
|
1695
1798
|
* <br/> - `'360'`: The video contains content with a full 360 degree field of view.
|
|
1696
1799
|
* <br/> - `'180'`: The video contains content with a 180 degree field of view. `'180'` is only available when using the WebXR API.
|
|
1697
1800
|
*
|
|
1801
|
+
* @category VR
|
|
1698
1802
|
* @public
|
|
1699
1803
|
*/
|
|
1700
1804
|
type VRPanoramaMode = '' | '360' | '180';
|
|
@@ -1705,6 +1809,7 @@ type VRPanoramaMode = '' | '360' | '180';
|
|
|
1705
1809
|
* <br/> - Available since v2.12.0.
|
|
1706
1810
|
* <br/> - See {@link VR | the VR API} to control display of VR videos.
|
|
1707
1811
|
*
|
|
1812
|
+
* @category VR
|
|
1708
1813
|
* @public
|
|
1709
1814
|
*/
|
|
1710
1815
|
interface VRConfiguration {
|
|
@@ -1743,6 +1848,7 @@ interface VRConfiguration {
|
|
|
1743
1848
|
/**
|
|
1744
1849
|
* Describes the configuration of the Cast integrations.
|
|
1745
1850
|
*
|
|
1851
|
+
* @category Casting
|
|
1746
1852
|
* @public
|
|
1747
1853
|
*/
|
|
1748
1854
|
interface CastConfiguration {
|
|
@@ -1765,12 +1871,14 @@ interface CastConfiguration {
|
|
|
1765
1871
|
* <br/> - `'manual'` : The player will take over an existing session if there is one and the cast button is clicked. Otherwise it will prompt the user with all available devices.
|
|
1766
1872
|
* <br/> - `'disabled'` : The player is not affected by cast sessions and is not castable.
|
|
1767
1873
|
*
|
|
1874
|
+
* @category Casting
|
|
1768
1875
|
* @public
|
|
1769
1876
|
*/
|
|
1770
1877
|
type JoinStrategy = 'auto' | 'manual' | 'disabled';
|
|
1771
1878
|
/**
|
|
1772
1879
|
* Describes the configuration of the Chromecast integration.
|
|
1773
1880
|
*
|
|
1881
|
+
* @category Casting
|
|
1774
1882
|
* @public
|
|
1775
1883
|
*/
|
|
1776
1884
|
interface ChromecastConfiguration {
|
|
@@ -1788,12 +1896,14 @@ interface ChromecastConfiguration {
|
|
|
1788
1896
|
* <br/> - `'play-none'`: Plays none of the ad breaks skipped due to a seek.
|
|
1789
1897
|
* <br/> - `'play-last'`: Plays the last ad break skipped due to a seek.
|
|
1790
1898
|
*
|
|
1899
|
+
* @category Verizon Media
|
|
1791
1900
|
* @public
|
|
1792
1901
|
*/
|
|
1793
1902
|
type SkippedAdStrategy = 'play-all' | 'play-none' | 'play-last';
|
|
1794
1903
|
/**
|
|
1795
1904
|
* Describes the configuration of the Verizon Media integration.
|
|
1796
1905
|
*
|
|
1906
|
+
* @category Verizon Media
|
|
1797
1907
|
* @public
|
|
1798
1908
|
*/
|
|
1799
1909
|
interface VerizonMediaConfiguration {
|
|
@@ -1825,6 +1935,7 @@ interface VerizonMediaConfiguration {
|
|
|
1825
1935
|
/**
|
|
1826
1936
|
* Describes the UI configuration of the Verizon Media integration.
|
|
1827
1937
|
*
|
|
1938
|
+
* @category Verizon Media
|
|
1828
1939
|
* @public
|
|
1829
1940
|
*/
|
|
1830
1941
|
interface VerizonMediaUiConfiguration {
|
|
@@ -1863,6 +1974,8 @@ interface VerizonMediaUiConfiguration {
|
|
|
1863
1974
|
/**
|
|
1864
1975
|
* Describes the ABR configuration for a specific source.
|
|
1865
1976
|
*
|
|
1977
|
+
* @category Source
|
|
1978
|
+
* @category ABR
|
|
1866
1979
|
* @public
|
|
1867
1980
|
*/
|
|
1868
1981
|
interface SourceAbrConfiguration {
|
|
@@ -1891,6 +2004,7 @@ interface SourceAbrConfiguration {
|
|
|
1891
2004
|
/**
|
|
1892
2005
|
* Describes the VR configuration
|
|
1893
2006
|
*
|
|
2007
|
+
* @category VR
|
|
1894
2008
|
* @public
|
|
1895
2009
|
*/
|
|
1896
2010
|
interface VRPlayerConfiguration {
|
|
@@ -1905,6 +2019,7 @@ interface VRPlayerConfiguration {
|
|
|
1905
2019
|
/**
|
|
1906
2020
|
* Object containing values used for the player's retry mechanisms.
|
|
1907
2021
|
*
|
|
2022
|
+
* @category Player
|
|
1908
2023
|
* @public
|
|
1909
2024
|
*/
|
|
1910
2025
|
interface RetryConfiguration {
|
|
@@ -1929,6 +2044,7 @@ interface RetryConfiguration {
|
|
|
1929
2044
|
/**
|
|
1930
2045
|
* Describes a player's configuration.
|
|
1931
2046
|
*
|
|
2047
|
+
* @category Player
|
|
1932
2048
|
* @public
|
|
1933
2049
|
*/
|
|
1934
2050
|
interface PlayerConfiguration {
|
|
@@ -2078,6 +2194,7 @@ interface PlayerConfiguration {
|
|
|
2078
2194
|
* <br/> - `'all'`: Allow muted autoplay. If the player is requested to autoplay while unmuted, and the platform supports muted autoplay, the player will start muted playback.
|
|
2079
2195
|
* <br/> - `'content'`: Allow muted autoplay only for the main content. Disallow muted autoplay for e.g. advertisements. (Not yet supported.)
|
|
2080
2196
|
*
|
|
2197
|
+
* @category Player
|
|
2081
2198
|
* @public
|
|
2082
2199
|
*/
|
|
2083
2200
|
type MutedAutoplayConfiguration = 'none' | 'all' | 'content';
|
|
@@ -2088,6 +2205,8 @@ type MutedAutoplayConfiguration = 'none' | 'all' | 'content';
|
|
|
2088
2205
|
* @remarks
|
|
2089
2206
|
* <br/> - Available since v2.21.0.
|
|
2090
2207
|
*
|
|
2208
|
+
* @category Source
|
|
2209
|
+
* @category Casting
|
|
2091
2210
|
* @public
|
|
2092
2211
|
*/
|
|
2093
2212
|
interface ChromecastMetadataImage {
|
|
@@ -2111,6 +2230,8 @@ interface ChromecastMetadataImage {
|
|
|
2111
2230
|
* <br/> - `'tv-show'`
|
|
2112
2231
|
* <br/> - `'generic'`
|
|
2113
2232
|
*
|
|
2233
|
+
* @category Source
|
|
2234
|
+
* @category Casting
|
|
2114
2235
|
* @public
|
|
2115
2236
|
*/
|
|
2116
2237
|
type ChromecastMetadataType = 'movie' | 'audio' | 'tv-show' | 'generic';
|
|
@@ -2120,6 +2241,7 @@ type ChromecastMetadataType = 'movie' | 'audio' | 'tv-show' | 'generic';
|
|
|
2120
2241
|
* @remarks
|
|
2121
2242
|
* <br/> - Available since v2.21.0.
|
|
2122
2243
|
*
|
|
2244
|
+
* @category Source
|
|
2123
2245
|
* @public
|
|
2124
2246
|
*/
|
|
2125
2247
|
interface MetadataDescription {
|
|
@@ -2137,6 +2259,8 @@ interface MetadataDescription {
|
|
|
2137
2259
|
* <br/> - Do not use metadata key `images` if its value doesn't adhere to {@link ChromecastMetadataImage} or `string[]` (where the strings are image URLs).
|
|
2138
2260
|
* <br/> - All values will be provided with the Media Info's {@link https://developers.google.com/cast/docs/reference/web_sender/chrome.cast.media.MediaInfo#metadata | metadata}.
|
|
2139
2261
|
*
|
|
2262
|
+
* @category Source
|
|
2263
|
+
* @category Casting
|
|
2140
2264
|
* @public
|
|
2141
2265
|
*/
|
|
2142
2266
|
interface ChromecastMetadataDescription extends MetadataDescription {
|
|
@@ -2301,6 +2425,8 @@ interface ChromecastMetadataDescription extends MetadataDescription {
|
|
|
2301
2425
|
/**
|
|
2302
2426
|
* Represents a media resource which is found on the Verizon Media Platform.
|
|
2303
2427
|
*
|
|
2428
|
+
* @category Source
|
|
2429
|
+
* @category Verizon Media
|
|
2304
2430
|
* @public
|
|
2305
2431
|
*/
|
|
2306
2432
|
interface VerizonMediaSource extends BaseSource {
|
|
@@ -2384,6 +2510,8 @@ interface VerizonMediaSource extends BaseSource {
|
|
|
2384
2510
|
* @remarks
|
|
2385
2511
|
* <br/> - This asset identifier determines a unique asset on the Verizon Media Platform.
|
|
2386
2512
|
*
|
|
2513
|
+
* @category Source
|
|
2514
|
+
* @category Verizon Media
|
|
2387
2515
|
* @public
|
|
2388
2516
|
*/
|
|
2389
2517
|
type VerizonMediaAssetId = string;
|
|
@@ -2393,6 +2521,8 @@ type VerizonMediaAssetId = string;
|
|
|
2393
2521
|
* @remarks
|
|
2394
2522
|
* <br/> - Each combination of the user identifier and external identifier determines a unique asset on the Verizon Media Platform.
|
|
2395
2523
|
*
|
|
2524
|
+
* @category Source
|
|
2525
|
+
* @category Verizon Media
|
|
2396
2526
|
* @public
|
|
2397
2527
|
*/
|
|
2398
2528
|
interface VerizonMediaExternalId {
|
|
@@ -2408,6 +2538,8 @@ interface VerizonMediaExternalId {
|
|
|
2408
2538
|
/**
|
|
2409
2539
|
* Describes the configuration of Verizon Media Ping features.
|
|
2410
2540
|
*
|
|
2541
|
+
* @category Source
|
|
2542
|
+
* @category Verizon Media
|
|
2411
2543
|
* @public
|
|
2412
2544
|
*/
|
|
2413
2545
|
interface VerizonMediaPingConfiguration {
|
|
@@ -2447,6 +2579,8 @@ interface VerizonMediaPingConfiguration {
|
|
|
2447
2579
|
* <br/> - `'channel'`: A Live content channel.
|
|
2448
2580
|
* <br/> - `'event'`: A Live event.
|
|
2449
2581
|
*
|
|
2582
|
+
* @category Source
|
|
2583
|
+
* @category Verizon Media
|
|
2450
2584
|
* @public
|
|
2451
2585
|
*/
|
|
2452
2586
|
type VerizonMediaAssetType = 'asset' | 'channel' | 'event';
|
|
@@ -2469,6 +2603,7 @@ type VerizonMediaAssetType = 'asset' | 'channel' | 'event';
|
|
|
2469
2603
|
* Use this if you notice that the player is attempting but failing to preload the next period on the current platform only when
|
|
2470
2604
|
* content protection is different between periods.
|
|
2471
2605
|
*
|
|
2606
|
+
* @category Source
|
|
2472
2607
|
* @public
|
|
2473
2608
|
*/
|
|
2474
2609
|
type SeamlessPeriodSwitchStrategy = 'auto' | 'always' | 'never' | 'clear-only' | 'same-drm-only';
|
|
@@ -2478,6 +2613,7 @@ type SeamlessPeriodSwitchStrategy = 'auto' | 'always' | 'never' | 'clear-only' |
|
|
|
2478
2613
|
* @remarks
|
|
2479
2614
|
* <br/> - Available since v2.79.0.
|
|
2480
2615
|
*
|
|
2616
|
+
* @category Source
|
|
2481
2617
|
* @public
|
|
2482
2618
|
*/
|
|
2483
2619
|
interface DashPlaybackConfiguration {
|
|
@@ -2574,6 +2710,7 @@ interface DashPlaybackConfiguration {
|
|
|
2574
2710
|
* @remarks
|
|
2575
2711
|
* <br/> - See {@link HlsPlaybackConfiguration.discontinuityAlignment}.
|
|
2576
2712
|
*
|
|
2713
|
+
* @category Source
|
|
2577
2714
|
* @public
|
|
2578
2715
|
*/
|
|
2579
2716
|
type HlsDiscontinuityAlignment = 'auto' | 'playlist' | 'media';
|
|
@@ -2583,6 +2720,7 @@ type HlsDiscontinuityAlignment = 'auto' | 'playlist' | 'media';
|
|
|
2583
2720
|
* @remarks
|
|
2584
2721
|
* <br/> - Available since v2.82.0.
|
|
2585
2722
|
*
|
|
2723
|
+
* @category Source
|
|
2586
2724
|
* @public
|
|
2587
2725
|
*/
|
|
2588
2726
|
interface HlsPlaybackConfiguration {
|
|
@@ -2597,6 +2735,8 @@ interface HlsPlaybackConfiguration {
|
|
|
2597
2735
|
/**
|
|
2598
2736
|
* Fired when a text track cue is entered.
|
|
2599
2737
|
*
|
|
2738
|
+
* @category Media and Text Tracks
|
|
2739
|
+
* @category Events
|
|
2600
2740
|
* @public
|
|
2601
2741
|
*/
|
|
2602
2742
|
interface TextTrackCueEnterEvent extends Event<'enter'> {
|
|
@@ -2608,6 +2748,8 @@ interface TextTrackCueEnterEvent extends Event<'enter'> {
|
|
|
2608
2748
|
/**
|
|
2609
2749
|
* Fired when a text track cue is exited.
|
|
2610
2750
|
*
|
|
2751
|
+
* @category Media and Text Tracks
|
|
2752
|
+
* @category Events
|
|
2611
2753
|
* @public
|
|
2612
2754
|
*/
|
|
2613
2755
|
interface TextTrackCueExitEvent extends Event<'exit'> {
|
|
@@ -2619,6 +2761,8 @@ interface TextTrackCueExitEvent extends Event<'exit'> {
|
|
|
2619
2761
|
/**
|
|
2620
2762
|
* Fired when a text track cue is updated.
|
|
2621
2763
|
*
|
|
2764
|
+
* @category Media and Text Tracks
|
|
2765
|
+
* @category Events
|
|
2622
2766
|
* @public
|
|
2623
2767
|
*/
|
|
2624
2768
|
interface TextTrackCueUpdateEvent extends Event<'update'> {
|
|
@@ -2630,6 +2774,7 @@ interface TextTrackCueUpdateEvent extends Event<'update'> {
|
|
|
2630
2774
|
/**
|
|
2631
2775
|
* The events fired by the {@link TextTrackCue}.
|
|
2632
2776
|
*
|
|
2777
|
+
* @category Media and Text Tracks
|
|
2633
2778
|
* @public
|
|
2634
2779
|
*/
|
|
2635
2780
|
interface TextTrackCueEventMap {
|
|
@@ -2649,6 +2794,7 @@ interface TextTrackCueEventMap {
|
|
|
2649
2794
|
/**
|
|
2650
2795
|
* Represents a cue of a text track.
|
|
2651
2796
|
*
|
|
2797
|
+
* @category Media and Text Tracks
|
|
2652
2798
|
* @public
|
|
2653
2799
|
*/
|
|
2654
2800
|
interface TextTrackCue extends EventDispatcher<TextTrackCueEventMap> {
|
|
@@ -2692,6 +2838,7 @@ interface TextTrackCue extends EventDispatcher<TextTrackCueEventMap> {
|
|
|
2692
2838
|
/**
|
|
2693
2839
|
* List of text track cues.
|
|
2694
2840
|
*
|
|
2841
|
+
* @category Media and Text Tracks
|
|
2695
2842
|
* @public
|
|
2696
2843
|
*/
|
|
2697
2844
|
interface TextTrackCueList extends ReadonlyArray<TextTrackCue> {
|
|
@@ -2715,6 +2862,8 @@ interface TextTrackCueList extends ReadonlyArray<TextTrackCue> {
|
|
|
2715
2862
|
/**
|
|
2716
2863
|
* Fired when a new track has been added to this list.
|
|
2717
2864
|
*
|
|
2865
|
+
* @category Media and Text Tracks
|
|
2866
|
+
* @category Events
|
|
2718
2867
|
* @public
|
|
2719
2868
|
*/
|
|
2720
2869
|
interface AddTrackEvent extends Event<'addtrack'> {
|
|
@@ -2726,6 +2875,8 @@ interface AddTrackEvent extends Event<'addtrack'> {
|
|
|
2726
2875
|
/**
|
|
2727
2876
|
* Fired when a track has been removed to this list.
|
|
2728
2877
|
*
|
|
2878
|
+
* @category Media and Text Tracks
|
|
2879
|
+
* @category Events
|
|
2729
2880
|
* @public
|
|
2730
2881
|
*/
|
|
2731
2882
|
interface RemoveTrackEvent extends Event<'removetrack'> {
|
|
@@ -2737,6 +2888,8 @@ interface RemoveTrackEvent extends Event<'removetrack'> {
|
|
|
2737
2888
|
/**
|
|
2738
2889
|
* Fired when a track has been changed.
|
|
2739
2890
|
*
|
|
2891
|
+
* @category Media and Text Tracks
|
|
2892
|
+
* @category Events
|
|
2740
2893
|
* @public
|
|
2741
2894
|
*/
|
|
2742
2895
|
interface TrackChangeEvent extends Event<'change'> {
|
|
@@ -2748,6 +2901,7 @@ interface TrackChangeEvent extends Event<'change'> {
|
|
|
2748
2901
|
/**
|
|
2749
2902
|
* The events fired by a {@link TrackList}.
|
|
2750
2903
|
*
|
|
2904
|
+
* @category Media and Text Tracks
|
|
2751
2905
|
* @public
|
|
2752
2906
|
*/
|
|
2753
2907
|
interface TrackListEventMap {
|
|
@@ -2768,6 +2922,8 @@ interface TrackListEventMap {
|
|
|
2768
2922
|
/**
|
|
2769
2923
|
* Fired when one or more properties of a track have been updated.
|
|
2770
2924
|
*
|
|
2925
|
+
* @category Media and Text Tracks
|
|
2926
|
+
* @category Events
|
|
2771
2927
|
* @public
|
|
2772
2928
|
*/
|
|
2773
2929
|
interface TrackUpdateEvent extends Event<'update'> {
|
|
@@ -2779,6 +2935,7 @@ interface TrackUpdateEvent extends Event<'update'> {
|
|
|
2779
2935
|
/**
|
|
2780
2936
|
* The events fired by a {@link Track}.
|
|
2781
2937
|
*
|
|
2938
|
+
* @category Media and Text Tracks
|
|
2782
2939
|
* @public
|
|
2783
2940
|
*/
|
|
2784
2941
|
interface TrackEventMap {
|
|
@@ -2800,6 +2957,7 @@ interface TrackEventMap {
|
|
|
2800
2957
|
* @remarks
|
|
2801
2958
|
* <br/> - A specific track type (e.g. {@link TextTrack}) will always be used.
|
|
2802
2959
|
*
|
|
2960
|
+
* @category Media and Text Tracks
|
|
2803
2961
|
* @public
|
|
2804
2962
|
*/
|
|
2805
2963
|
interface Track extends EventDispatcher<TrackEventMap> {
|
|
@@ -2845,6 +3003,7 @@ interface Track extends EventDispatcher<TrackEventMap> {
|
|
|
2845
3003
|
/**
|
|
2846
3004
|
* Possible accessibility roles.
|
|
2847
3005
|
*
|
|
3006
|
+
* @category Media and Text Tracks
|
|
2848
3007
|
* @public
|
|
2849
3008
|
*/
|
|
2850
3009
|
type AccessibilityRole = 'caption' | 'sign' | 'description' | 'enhanced audio intelligibility' | 'easy reader' | 'transcribes spoken dialog' | 'describes music and sound' | 'describes video';
|
|
@@ -2852,6 +3011,7 @@ type AccessibilityRole = 'caption' | 'sign' | 'description' | 'enhanced audio in
|
|
|
2852
3011
|
/**
|
|
2853
3012
|
* A code that indicates the type of error that has occurred.
|
|
2854
3013
|
*
|
|
3014
|
+
* @category Errors
|
|
2855
3015
|
* @public
|
|
2856
3016
|
*/
|
|
2857
3017
|
declare enum ErrorCode {
|
|
@@ -3029,6 +3189,7 @@ declare enum ErrorCode {
|
|
|
3029
3189
|
/**
|
|
3030
3190
|
* The category of an error.
|
|
3031
3191
|
*
|
|
3192
|
+
* @category Errors
|
|
3032
3193
|
* @public
|
|
3033
3194
|
*/
|
|
3034
3195
|
declare enum ErrorCategory {
|
|
@@ -3082,6 +3243,9 @@ declare enum ErrorCategory {
|
|
|
3082
3243
|
CACHE = 12
|
|
3083
3244
|
}
|
|
3084
3245
|
/**
|
|
3246
|
+
* The category of an error.
|
|
3247
|
+
*
|
|
3248
|
+
* @category Errors
|
|
3085
3249
|
* @public
|
|
3086
3250
|
*/
|
|
3087
3251
|
declare namespace ErrorCategory {
|
|
@@ -3096,6 +3260,7 @@ declare namespace ErrorCategory {
|
|
|
3096
3260
|
/**
|
|
3097
3261
|
* An error that is thrown by THEOplayer.
|
|
3098
3262
|
*
|
|
3263
|
+
* @category Errors
|
|
3099
3264
|
* @public
|
|
3100
3265
|
*/
|
|
3101
3266
|
interface THEOplayerError extends Error {
|
|
@@ -3119,6 +3284,8 @@ interface THEOplayerError extends Error {
|
|
|
3119
3284
|
/**
|
|
3120
3285
|
* Fired when an error occurs.
|
|
3121
3286
|
*
|
|
3287
|
+
* @category Errors
|
|
3288
|
+
* @category Events
|
|
3122
3289
|
* @public
|
|
3123
3290
|
*/
|
|
3124
3291
|
interface ErrorEvent extends Event<'error'> {
|
|
@@ -3137,12 +3304,16 @@ interface ErrorEvent extends Event<'error'> {
|
|
|
3137
3304
|
/**
|
|
3138
3305
|
* An error code whose category is `ErrorCategory.SUBTITLE`.
|
|
3139
3306
|
*
|
|
3307
|
+
* @category Media and Text Tracks
|
|
3308
|
+
* @category Errors
|
|
3140
3309
|
* @public
|
|
3141
3310
|
*/
|
|
3142
3311
|
type TextTrackErrorCode = ErrorCode.SUBTITLE_LOAD_ERROR | ErrorCode.SUBTITLE_CORS_ERROR | ErrorCode.SUBTITLE_PARSE_ERROR;
|
|
3143
3312
|
/**
|
|
3144
3313
|
* An error thrown by a text track.
|
|
3145
3314
|
*
|
|
3315
|
+
* @category Media and Text Tracks
|
|
3316
|
+
* @category Errors
|
|
3146
3317
|
* @public
|
|
3147
3318
|
*/
|
|
3148
3319
|
interface TextTrackError extends THEOplayerError {
|
|
@@ -3172,6 +3343,7 @@ interface TextTrackError extends THEOplayerError {
|
|
|
3172
3343
|
* <br/> - `'daterange'`: The track contains HLS EXT-X-DATERANGE content.
|
|
3173
3344
|
* <br/> - `''`: The type of the track contents is unknown.
|
|
3174
3345
|
*
|
|
3346
|
+
* @category Media and Text Tracks
|
|
3175
3347
|
* @public
|
|
3176
3348
|
*/
|
|
3177
3349
|
type TextTrackType = 'srt' | 'ttml' | 'webvtt' | 'emsg' | 'eventstream' | 'id3' | 'cea608' | 'daterange' | '';
|
|
@@ -3182,12 +3354,16 @@ type TextTrackType = 'srt' | 'ttml' | 'webvtt' | 'emsg' | 'eventstream' | 'id3'
|
|
|
3182
3354
|
* <br/> - `2`: The text track has been loaded with no fatal errors.
|
|
3183
3355
|
* <br/> - `3`: An error occurred obtaining the cues for the track. Some or all of the cues are likely missing and will not be obtained.
|
|
3184
3356
|
*
|
|
3357
|
+
* @category Media and Text Tracks
|
|
3185
3358
|
* @public
|
|
3186
3359
|
*/
|
|
3187
3360
|
type TextTrackReadyState = 0 | 1 | 2 | 3;
|
|
3188
3361
|
/**
|
|
3189
3362
|
* An error event fired by a {@link TextTrack}.
|
|
3190
3363
|
*
|
|
3364
|
+
* @category Media and Text Tracks
|
|
3365
|
+
* @category Errors
|
|
3366
|
+
* @category Events
|
|
3191
3367
|
* @public
|
|
3192
3368
|
*/
|
|
3193
3369
|
interface TextTrackErrorEvent extends ErrorEvent {
|
|
@@ -3199,6 +3375,8 @@ interface TextTrackErrorEvent extends ErrorEvent {
|
|
|
3199
3375
|
/**
|
|
3200
3376
|
* Fired when a cue is added to the text track.
|
|
3201
3377
|
*
|
|
3378
|
+
* @category Media and Text Tracks
|
|
3379
|
+
* @category Events
|
|
3202
3380
|
* @public
|
|
3203
3381
|
*/
|
|
3204
3382
|
interface TextTrackAddCueEvent extends Event<'addcue'> {
|
|
@@ -3210,6 +3388,8 @@ interface TextTrackAddCueEvent extends Event<'addcue'> {
|
|
|
3210
3388
|
/**
|
|
3211
3389
|
* Fired when a cue is removed from the text track.
|
|
3212
3390
|
*
|
|
3391
|
+
* @category Media and Text Tracks
|
|
3392
|
+
* @category Events
|
|
3213
3393
|
* @public
|
|
3214
3394
|
*/
|
|
3215
3395
|
interface TextTrackRemoveCueEvent extends Event<'removecue'> {
|
|
@@ -3221,6 +3401,8 @@ interface TextTrackRemoveCueEvent extends Event<'removecue'> {
|
|
|
3221
3401
|
/**
|
|
3222
3402
|
* Fired when a cue from the text track is updated.
|
|
3223
3403
|
*
|
|
3404
|
+
* @category Media and Text Tracks
|
|
3405
|
+
* @category Events
|
|
3224
3406
|
* @public
|
|
3225
3407
|
*/
|
|
3226
3408
|
interface TextTrackUpdateCueEvent extends Event<'updatecue'> {
|
|
@@ -3232,6 +3414,8 @@ interface TextTrackUpdateCueEvent extends Event<'updatecue'> {
|
|
|
3232
3414
|
/**
|
|
3233
3415
|
* Fired when a cue of the text track has entered.
|
|
3234
3416
|
*
|
|
3417
|
+
* @category Media and Text Tracks
|
|
3418
|
+
* @category Events
|
|
3235
3419
|
* @public
|
|
3236
3420
|
*/
|
|
3237
3421
|
interface TextTrackEnterCueEvent extends Event<'entercue'> {
|
|
@@ -3243,6 +3427,8 @@ interface TextTrackEnterCueEvent extends Event<'entercue'> {
|
|
|
3243
3427
|
/**
|
|
3244
3428
|
* Fired when a cue of the text track has exited.
|
|
3245
3429
|
*
|
|
3430
|
+
* @category Media and Text Tracks
|
|
3431
|
+
* @category Events
|
|
3246
3432
|
* @public
|
|
3247
3433
|
*/
|
|
3248
3434
|
interface TextTrackExitCueEvent extends Event<'exitcue'> {
|
|
@@ -3254,6 +3440,8 @@ interface TextTrackExitCueEvent extends Event<'exitcue'> {
|
|
|
3254
3440
|
/**
|
|
3255
3441
|
* Fired when the displaying cues of the text track has changed.
|
|
3256
3442
|
*
|
|
3443
|
+
* @category Media and Text Tracks
|
|
3444
|
+
* @category Events
|
|
3257
3445
|
* @public
|
|
3258
3446
|
*/
|
|
3259
3447
|
interface TextTrackCueChangeEvent extends Event<'cuechange'> {
|
|
@@ -3265,6 +3453,8 @@ interface TextTrackCueChangeEvent extends Event<'cuechange'> {
|
|
|
3265
3453
|
/**
|
|
3266
3454
|
* Fired when the {@link TextTrack.readyState | ready state} of the text track has changed.
|
|
3267
3455
|
*
|
|
3456
|
+
* @category Media and Text Tracks
|
|
3457
|
+
* @category Events
|
|
3268
3458
|
* @public
|
|
3269
3459
|
*/
|
|
3270
3460
|
interface TextTrackReadyStateChangeEvent extends Event<'readystatechange'> {
|
|
@@ -3280,6 +3470,8 @@ interface TextTrackReadyStateChangeEvent extends Event<'readystatechange'> {
|
|
|
3280
3470
|
/**
|
|
3281
3471
|
* Fired when the {@link TextTrack."type" | type} of the text track has changed.
|
|
3282
3472
|
*
|
|
3473
|
+
* @category Media and Text Tracks
|
|
3474
|
+
* @category Events
|
|
3283
3475
|
* @public
|
|
3284
3476
|
*/
|
|
3285
3477
|
interface TextTrackTypeChangeEvent extends Event<'typechange'> {
|
|
@@ -3291,6 +3483,7 @@ interface TextTrackTypeChangeEvent extends Event<'typechange'> {
|
|
|
3291
3483
|
/**
|
|
3292
3484
|
* The events fired by a {@link TextTrack}.
|
|
3293
3485
|
*
|
|
3486
|
+
* @category Media and Text Tracks
|
|
3294
3487
|
* @public
|
|
3295
3488
|
*/
|
|
3296
3489
|
interface TextTrackEventMap extends TrackEventMap {
|
|
@@ -3334,6 +3527,7 @@ interface TextTrackEventMap extends TrackEventMap {
|
|
|
3334
3527
|
/**
|
|
3335
3528
|
* Represents a text track of a media resource.
|
|
3336
3529
|
*
|
|
3530
|
+
* @category Media and Text Tracks
|
|
3337
3531
|
* @public
|
|
3338
3532
|
*/
|
|
3339
3533
|
interface TextTrack extends Track, EventDispatcher<TextTrackEventMap> {
|
|
@@ -3438,6 +3632,7 @@ interface TextTrack extends Track, EventDispatcher<TextTrackEventMap> {
|
|
|
3438
3632
|
* @remarks
|
|
3439
3633
|
* <br/> - Can be a string value representing the URL of a media resource, a {@link TypedSource} or a {@link VerizonMediaSource}.
|
|
3440
3634
|
*
|
|
3635
|
+
* @category Source
|
|
3441
3636
|
* @public
|
|
3442
3637
|
*/
|
|
3443
3638
|
type Source = string | TypedSource | VerizonMediaSource;
|
|
@@ -3447,6 +3642,7 @@ type Source = string | TypedSource | VerizonMediaSource;
|
|
|
3447
3642
|
* @remarks
|
|
3448
3643
|
* <br/> - The order of sources when using a list determines their priority when attempting playback.
|
|
3449
3644
|
*
|
|
3645
|
+
* @category Source
|
|
3450
3646
|
* @public
|
|
3451
3647
|
*/
|
|
3452
3648
|
type Sources = Source | Source[];
|
|
@@ -3459,12 +3655,14 @@ type Sources = Source | Source[];
|
|
|
3459
3655
|
* @remarks
|
|
3460
3656
|
* <br/> - See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes | The crossorigin attribute: Requesting CORS access to content}
|
|
3461
3657
|
*
|
|
3658
|
+
* @category Source
|
|
3462
3659
|
* @public
|
|
3463
3660
|
*/
|
|
3464
3661
|
type CrossOriginSetting = '' | 'anonymous' | 'use-credentials';
|
|
3465
3662
|
/**
|
|
3466
3663
|
* Describes the configuration of a player's source.
|
|
3467
3664
|
*
|
|
3665
|
+
* @category Source
|
|
3468
3666
|
* @public
|
|
3469
3667
|
*/
|
|
3470
3668
|
interface SourceConfiguration {
|
|
@@ -3486,6 +3684,7 @@ interface SourceConfiguration {
|
|
|
3486
3684
|
*
|
|
3487
3685
|
* @remarks
|
|
3488
3686
|
* <br/> - This setting is strictly after - e.g. setting `playAdsAfterTime` to 15 will cause the player to ignore an ad break scheduled to play at 15s.
|
|
3687
|
+
* <br/> - When scheduling a VMAP, it is required to set the {@link AdSource} type to `vmap`.
|
|
3489
3688
|
*
|
|
3490
3689
|
*/
|
|
3491
3690
|
playAdsAfterTime?: number;
|
|
@@ -3567,6 +3766,7 @@ interface SourceConfiguration {
|
|
|
3567
3766
|
/**
|
|
3568
3767
|
* Describes the configuration of a player's source.
|
|
3569
3768
|
*
|
|
3769
|
+
* @category Source
|
|
3570
3770
|
* @public
|
|
3571
3771
|
*/
|
|
3572
3772
|
interface SourceDescription extends SourceConfiguration {
|
|
@@ -3621,6 +3821,7 @@ interface SourceDescription extends SourceConfiguration {
|
|
|
3621
3821
|
/**
|
|
3622
3822
|
* Describes the configuration of a side-loaded text track.
|
|
3623
3823
|
*
|
|
3824
|
+
* @category Source
|
|
3624
3825
|
* @public
|
|
3625
3826
|
*/
|
|
3626
3827
|
interface TextTrackDescription {
|
|
@@ -3686,6 +3887,7 @@ interface TextTrackDescription {
|
|
|
3686
3887
|
/**
|
|
3687
3888
|
* Represents the common properties of a media resource.
|
|
3688
3889
|
*
|
|
3890
|
+
* @category Source
|
|
3689
3891
|
* @public
|
|
3690
3892
|
*/
|
|
3691
3893
|
interface BaseSource {
|
|
@@ -3879,12 +4081,14 @@ interface BaseSource {
|
|
|
3879
4081
|
* Use this if you notice that the player is attempting but failing to preload the next period on the current platform only when
|
|
3880
4082
|
* content protection is different between discontinuities.
|
|
3881
4083
|
* This is only supported for MPEG-DASH.
|
|
4084
|
+
* @category Source
|
|
3882
4085
|
* @public
|
|
3883
4086
|
*/
|
|
3884
4087
|
type SeamlessSwitchStrategy = 'auto' | 'always' | 'never' | 'clear-only' | 'same-drm-only';
|
|
3885
4088
|
/**
|
|
3886
4089
|
* Represents a media resource characterized by a URL to the resource and optionally information about the resource.
|
|
3887
4090
|
*
|
|
4091
|
+
* @category Source
|
|
3888
4092
|
* @public
|
|
3889
4093
|
*/
|
|
3890
4094
|
interface TypedSource extends BaseSource {
|
|
@@ -3940,6 +4144,7 @@ interface TypedSource extends BaseSource {
|
|
|
3940
4144
|
* <br/> - `'dvr'`: Live content with DVR.
|
|
3941
4145
|
* <br/> - `'vod'`: On demand content.
|
|
3942
4146
|
*
|
|
4147
|
+
* @category Source
|
|
3943
4148
|
* @public
|
|
3944
4149
|
*/
|
|
3945
4150
|
type StreamType = 'live' | 'dvr' | 'vod';
|
|
@@ -3948,6 +4153,7 @@ type StreamType = 'live' | 'dvr' | 'vod';
|
|
|
3948
4153
|
* <br/> - `'verizon-media'`: The source is a {@link VerizonMediaSource}
|
|
3949
4154
|
* <br/> - `'mediatailor'`: The source contains the MediaTailor initialization url
|
|
3950
4155
|
*
|
|
4156
|
+
* @category Source
|
|
3951
4157
|
* @public
|
|
3952
4158
|
*/
|
|
3953
4159
|
type SourceIntegrationId = 'verizon-media' | 'mediatailor';
|
|
@@ -3960,12 +4166,14 @@ type SourceIntegrationId = 'verizon-media' | 'mediatailor';
|
|
|
3960
4166
|
* <br/> - `'streamone'`: The description is a {@link StreamOneConfiguration}
|
|
3961
4167
|
* <br/> - `'smartsight'`: The description is a {@link SmartSightConfiguration}
|
|
3962
4168
|
*
|
|
4169
|
+
* @category Source
|
|
3963
4170
|
* @public
|
|
3964
4171
|
*/
|
|
3965
4172
|
type AnalyticsIntegrationID = 'agama' | 'conviva' | 'youbora' | 'moat' | 'streamone' | 'smartsight';
|
|
3966
4173
|
/**
|
|
3967
4174
|
* Describes the configuration of an analytics integration.
|
|
3968
4175
|
*
|
|
4176
|
+
* @category Source
|
|
3969
4177
|
* @public
|
|
3970
4178
|
*/
|
|
3971
4179
|
interface AnalyticsDescription {
|
|
@@ -3978,24 +4186,31 @@ interface AnalyticsDescription {
|
|
|
3978
4186
|
/**
|
|
3979
4187
|
* Fired when {@link RelatedContent.sources} changes.
|
|
3980
4188
|
*
|
|
4189
|
+
* @category UI
|
|
4190
|
+
* @category Events
|
|
3981
4191
|
* @public
|
|
3982
4192
|
*/
|
|
3983
4193
|
type RelatedChangeEvent = Event<'relatedchange'>;
|
|
3984
4194
|
/**
|
|
3985
4195
|
* Fired when the related content panel is shown.
|
|
3986
4196
|
*
|
|
4197
|
+
* @category UI
|
|
4198
|
+
* @category Events
|
|
3987
4199
|
* @public
|
|
3988
4200
|
*/
|
|
3989
4201
|
type RelatedShowEvent = Event<'show'>;
|
|
3990
4202
|
/**
|
|
3991
4203
|
* Fired when the related content panel is hidden.
|
|
3992
4204
|
*
|
|
4205
|
+
* @category UI
|
|
4206
|
+
* @category Events
|
|
3993
4207
|
* @public
|
|
3994
4208
|
*/
|
|
3995
4209
|
type RelatedHideEvent = Event<'hide'>;
|
|
3996
4210
|
/**
|
|
3997
4211
|
* The events fired by the {@link RelatedContent | related content API}.
|
|
3998
4212
|
*
|
|
4213
|
+
* @category UI
|
|
3999
4214
|
* @public
|
|
4000
4215
|
*/
|
|
4001
4216
|
interface RelatedContentEventMap {
|
|
@@ -4010,6 +4225,7 @@ interface RelatedContentEventMap {
|
|
|
4010
4225
|
* @remarks
|
|
4011
4226
|
* <br/> - Available since v2.14.2.
|
|
4012
4227
|
*
|
|
4228
|
+
* @category UI
|
|
4013
4229
|
* @public
|
|
4014
4230
|
*/
|
|
4015
4231
|
interface RelatedContent extends EventDispatcher<RelatedContentEventMap> {
|
|
@@ -4021,6 +4237,7 @@ interface RelatedContent extends EventDispatcher<RelatedContentEventMap> {
|
|
|
4021
4237
|
/**
|
|
4022
4238
|
* The events fired by the {@link UIRelatedContent | related content API (with ui)}.
|
|
4023
4239
|
*
|
|
4240
|
+
* @category UI
|
|
4024
4241
|
* @public
|
|
4025
4242
|
*/
|
|
4026
4243
|
interface UIRelatedContentEventMap extends RelatedContentEventMap {
|
|
@@ -4039,6 +4256,7 @@ interface UIRelatedContentEventMap extends RelatedContentEventMap {
|
|
|
4039
4256
|
* @remarks
|
|
4040
4257
|
* <br/> - Available since v2.14.2.
|
|
4041
4258
|
*
|
|
4259
|
+
* @category UI
|
|
4042
4260
|
* @public
|
|
4043
4261
|
*/
|
|
4044
4262
|
interface UIRelatedContent extends RelatedContent, EventDispatcher<UIRelatedContentEventMap> {
|
|
@@ -4069,6 +4287,7 @@ interface UIRelatedContent extends RelatedContent, EventDispatcher<UIRelatedCont
|
|
|
4069
4287
|
* @remarks
|
|
4070
4288
|
* <br/> - Available since v2.14.2.
|
|
4071
4289
|
*
|
|
4290
|
+
* @category UI
|
|
4072
4291
|
* @public
|
|
4073
4292
|
*/
|
|
4074
4293
|
interface RelatedContentSource {
|
|
@@ -4105,6 +4324,7 @@ interface RelatedContentSource {
|
|
|
4105
4324
|
/**
|
|
4106
4325
|
* List of tracks.
|
|
4107
4326
|
*
|
|
4327
|
+
* @category Media and Text Tracks
|
|
4108
4328
|
* @public
|
|
4109
4329
|
*/
|
|
4110
4330
|
interface TrackList<TTrack extends Track> extends ReadonlyArray<TTrack>, EventDispatcher<TrackListEventMap> {
|
|
@@ -4128,6 +4348,7 @@ interface TrackList<TTrack extends Track> extends ReadonlyArray<TTrack>, EventDi
|
|
|
4128
4348
|
/**
|
|
4129
4349
|
* List of text tracks.
|
|
4130
4350
|
*
|
|
4351
|
+
* @category Media and Text Tracks
|
|
4131
4352
|
* @public
|
|
4132
4353
|
*/
|
|
4133
4354
|
interface TextTracksList extends TrackList<TextTrack> {
|
|
@@ -4158,12 +4379,14 @@ interface TextTracksList extends TrackList<TextTrack> {
|
|
|
4158
4379
|
* <br/> - `6` - LICENSE_INVALID: The player's license was determined to be invalid.
|
|
4159
4380
|
* <br/> - `7` - ADVERTISEMENT_ERROR: Some kind of advertisement related error occurred.
|
|
4160
4381
|
*
|
|
4382
|
+
* @category Errors
|
|
4161
4383
|
* @public
|
|
4162
4384
|
*/
|
|
4163
4385
|
type MediaErrorCode = 1 | 2 | 3 | 4 | 5 | 6 | 7;
|
|
4164
4386
|
/**
|
|
4165
4387
|
* Thrown when a media error occurs.
|
|
4166
4388
|
*
|
|
4389
|
+
* @category Errors
|
|
4167
4390
|
* @public
|
|
4168
4391
|
*/
|
|
4169
4392
|
interface MediaError extends Error {
|
|
@@ -4184,6 +4407,7 @@ interface MediaError extends Error {
|
|
|
4184
4407
|
/**
|
|
4185
4408
|
* The events fired by a {@link Quality}.
|
|
4186
4409
|
*
|
|
4410
|
+
* @category Media and Text Tracks
|
|
4187
4411
|
* @public
|
|
4188
4412
|
*/
|
|
4189
4413
|
interface QualityEventMap {
|
|
@@ -4195,6 +4419,8 @@ interface QualityEventMap {
|
|
|
4195
4419
|
/**
|
|
4196
4420
|
* Fired when the quality updates.
|
|
4197
4421
|
*
|
|
4422
|
+
* @category Media and Text Tracks
|
|
4423
|
+
* @category Events
|
|
4198
4424
|
* @public
|
|
4199
4425
|
*/
|
|
4200
4426
|
interface UpdateQualityEvent extends Event<'update'> {
|
|
@@ -4206,6 +4432,7 @@ interface UpdateQualityEvent extends Event<'update'> {
|
|
|
4206
4432
|
/**
|
|
4207
4433
|
* Represents a quality of a media track.
|
|
4208
4434
|
*
|
|
4435
|
+
* @category Media and Text Tracks
|
|
4209
4436
|
* @public
|
|
4210
4437
|
*/
|
|
4211
4438
|
interface Quality extends EventDispatcher<QualityEventMap> {
|
|
@@ -4259,6 +4486,7 @@ interface Quality extends EventDispatcher<QualityEventMap> {
|
|
|
4259
4486
|
/**
|
|
4260
4487
|
* Represents a quality of a video track.
|
|
4261
4488
|
*
|
|
4489
|
+
* @category Media and Text Tracks
|
|
4262
4490
|
* @public
|
|
4263
4491
|
*/
|
|
4264
4492
|
interface VideoQuality extends Quality {
|
|
@@ -4282,6 +4510,7 @@ interface VideoQuality extends Quality {
|
|
|
4282
4510
|
/**
|
|
4283
4511
|
* Represents a quality of an audio track.
|
|
4284
4512
|
*
|
|
4513
|
+
* @category Media and Text Tracks
|
|
4285
4514
|
* @public
|
|
4286
4515
|
*/
|
|
4287
4516
|
interface AudioQuality extends Quality {
|
|
@@ -4294,6 +4523,7 @@ interface AudioQuality extends Quality {
|
|
|
4294
4523
|
/**
|
|
4295
4524
|
* List of qualities.
|
|
4296
4525
|
*
|
|
4526
|
+
* @category Media and Text Tracks
|
|
4297
4527
|
* @public
|
|
4298
4528
|
*/
|
|
4299
4529
|
interface QualityList extends Array<Quality> {
|
|
@@ -4311,8 +4541,10 @@ interface QualityList extends Array<Quality> {
|
|
|
4311
4541
|
}
|
|
4312
4542
|
|
|
4313
4543
|
/**
|
|
4314
|
-
*
|
|
4544
|
+
* A quality-related event fired by a {@link MediaTrack}.
|
|
4315
4545
|
*
|
|
4546
|
+
* @category Media and Text Tracks
|
|
4547
|
+
* @category Events
|
|
4316
4548
|
* @public
|
|
4317
4549
|
*/
|
|
4318
4550
|
interface QualityEvent<TType extends string> extends Event<TType> {
|
|
@@ -4324,6 +4556,8 @@ interface QualityEvent<TType extends string> extends Event<TType> {
|
|
|
4324
4556
|
/**
|
|
4325
4557
|
* Fired when the media track's {@link MediaTrack.targetQuality | target quality} changes.
|
|
4326
4558
|
*
|
|
4559
|
+
* @category Media and Text Tracks
|
|
4560
|
+
* @category Events
|
|
4327
4561
|
* @public
|
|
4328
4562
|
*/
|
|
4329
4563
|
interface TargetQualityChangedEvent extends Event<'targetqualitychanged'> {
|
|
@@ -4339,6 +4573,7 @@ interface TargetQualityChangedEvent extends Event<'targetqualitychanged'> {
|
|
|
4339
4573
|
/**
|
|
4340
4574
|
* The events fired by a {@link MediaTrack}.
|
|
4341
4575
|
*
|
|
4576
|
+
* @category Media and Text Tracks
|
|
4342
4577
|
* @public
|
|
4343
4578
|
*/
|
|
4344
4579
|
interface MediaTrackEventMap extends TrackEventMap {
|
|
@@ -4361,6 +4596,7 @@ interface MediaTrackEventMap extends TrackEventMap {
|
|
|
4361
4596
|
/**
|
|
4362
4597
|
* Represents a media track (audio or video) of a media resource.
|
|
4363
4598
|
*
|
|
4599
|
+
* @category Media and Text Tracks
|
|
4364
4600
|
* @public
|
|
4365
4601
|
*/
|
|
4366
4602
|
interface MediaTrack extends Track, EventDispatcher<MediaTrackEventMap> {
|
|
@@ -4431,6 +4667,7 @@ interface MediaTrack extends Track, EventDispatcher<MediaTrackEventMap> {
|
|
|
4431
4667
|
/**
|
|
4432
4668
|
* List of media tracks.
|
|
4433
4669
|
*
|
|
4670
|
+
* @category Media and Text Tracks
|
|
4434
4671
|
* @public
|
|
4435
4672
|
*/
|
|
4436
4673
|
interface MediaTrackList extends TrackList<MediaTrack> {
|
|
@@ -4454,6 +4691,8 @@ interface MediaTrackList extends TrackList<MediaTrack> {
|
|
|
4454
4691
|
/**
|
|
4455
4692
|
* Fires when the cast state changes.
|
|
4456
4693
|
*
|
|
4694
|
+
* @category Casting
|
|
4695
|
+
* @category Events
|
|
4457
4696
|
* @public
|
|
4458
4697
|
*/
|
|
4459
4698
|
interface CastStateChangeEvent extends Event<'statechange'> {
|
|
@@ -4470,12 +4709,14 @@ interface CastStateChangeEvent extends Event<'statechange'> {
|
|
|
4470
4709
|
* <br/> - `'connecting'`: Cast device available and the player is connecting.
|
|
4471
4710
|
* <br/> - `'connected'`: Cast device available and the player is connected.
|
|
4472
4711
|
*
|
|
4712
|
+
* @category Casting
|
|
4473
4713
|
* @public
|
|
4474
4714
|
*/
|
|
4475
4715
|
type CastState = 'unavailable' | 'available' | 'connecting' | 'connected';
|
|
4476
4716
|
/**
|
|
4477
4717
|
* The events fired by the common vendor APIs.
|
|
4478
4718
|
*
|
|
4719
|
+
* @category Casting
|
|
4479
4720
|
* @public
|
|
4480
4721
|
*/
|
|
4481
4722
|
interface VendorCastEventMap {
|
|
@@ -4487,6 +4728,7 @@ interface VendorCastEventMap {
|
|
|
4487
4728
|
/**
|
|
4488
4729
|
* Common API for all cast integrations.
|
|
4489
4730
|
*
|
|
4731
|
+
* @category Casting
|
|
4490
4732
|
* @public
|
|
4491
4733
|
*/
|
|
4492
4734
|
interface VendorCast extends EventDispatcher<VendorCastEventMap> {
|
|
@@ -4514,6 +4756,7 @@ interface VendorCast extends EventDispatcher<VendorCastEventMap> {
|
|
|
4514
4756
|
/**
|
|
4515
4757
|
* The events fired by the Chromecast API.
|
|
4516
4758
|
*
|
|
4759
|
+
* @category Casting
|
|
4517
4760
|
* @public
|
|
4518
4761
|
*/
|
|
4519
4762
|
interface ChromecastEventMap extends VendorCastEventMap {
|
|
@@ -4525,6 +4768,7 @@ interface ChromecastEventMap extends VendorCastEventMap {
|
|
|
4525
4768
|
/**
|
|
4526
4769
|
* The Chromecast API.
|
|
4527
4770
|
*
|
|
4771
|
+
* @category Casting
|
|
4528
4772
|
* @public
|
|
4529
4773
|
*/
|
|
4530
4774
|
interface Chromecast extends VendorCast, EventDispatcher<ChromecastEventMap> {
|
|
@@ -4570,6 +4814,7 @@ interface Chromecast extends VendorCast, EventDispatcher<ChromecastEventMap> {
|
|
|
4570
4814
|
/**
|
|
4571
4815
|
* The ChromecastConnectionCallback.
|
|
4572
4816
|
*
|
|
4817
|
+
* @category Casting
|
|
4573
4818
|
* @public
|
|
4574
4819
|
*/
|
|
4575
4820
|
interface ChromecastConnectionCallback {
|
|
@@ -4621,6 +4866,7 @@ interface ChromecastConnectionCallback {
|
|
|
4621
4866
|
/**
|
|
4622
4867
|
* The global Chromecast API.
|
|
4623
4868
|
*
|
|
4869
|
+
* @category Casting
|
|
4624
4870
|
* @public
|
|
4625
4871
|
*/
|
|
4626
4872
|
interface GlobalChromecast {
|
|
@@ -4648,6 +4894,8 @@ interface GlobalChromecast {
|
|
|
4648
4894
|
/**
|
|
4649
4895
|
* An error that occurred while casting or attempting to cast to Chromecast.
|
|
4650
4896
|
*
|
|
4897
|
+
* @category Casting
|
|
4898
|
+
* @category Errors
|
|
4651
4899
|
* @public
|
|
4652
4900
|
*/
|
|
4653
4901
|
interface ChromecastError {
|
|
@@ -4676,12 +4924,14 @@ interface ChromecastError {
|
|
|
4676
4924
|
* @remarks
|
|
4677
4925
|
* <br/> - The error codes correspond to the error codes documented in the {@link https://developers.google.com/cast/docs/reference/chrome/chrome.cast.html#.ErrorCode | Chromecast API reference}.
|
|
4678
4926
|
*
|
|
4927
|
+
* @category Casting
|
|
4679
4928
|
* @public
|
|
4680
4929
|
*/
|
|
4681
4930
|
type ChromecastErrorCode = 'CANCEL' | 'TIMEOUT' | 'API_NOT_INITIALIZED' | 'INVALID_PARAMETER' | 'EXTENSION_NOT_COMPATIBLE' | 'EXTENSION_MISSING' | 'RECEIVER_UNAVAILABLE' | 'SESSION_ERROR' | 'CHANNEL_ERROR' | 'LOAD_MEDIA_FAILED';
|
|
4682
4931
|
/**
|
|
4683
4932
|
* Fired when an error occurs while casting or trying to cast.
|
|
4684
4933
|
*
|
|
4934
|
+
* @category Casting
|
|
4685
4935
|
* @public
|
|
4686
4936
|
*/
|
|
4687
4937
|
interface ChromecastErrorEvent extends Event<'error'> {
|
|
@@ -4694,6 +4944,7 @@ interface ChromecastErrorEvent extends Event<'error'> {
|
|
|
4694
4944
|
/**
|
|
4695
4945
|
* The AirPlay API.
|
|
4696
4946
|
*
|
|
4947
|
+
* @category Casting
|
|
4697
4948
|
* @public
|
|
4698
4949
|
*/
|
|
4699
4950
|
interface AirPlay extends VendorCast {
|
|
@@ -4702,6 +4953,7 @@ interface AirPlay extends VendorCast {
|
|
|
4702
4953
|
/**
|
|
4703
4954
|
* The events fired by the {@link Cast | cast API}.
|
|
4704
4955
|
*
|
|
4956
|
+
* @category Casting
|
|
4705
4957
|
* @public
|
|
4706
4958
|
*/
|
|
4707
4959
|
interface CastEventMap {
|
|
@@ -4713,6 +4965,7 @@ interface CastEventMap {
|
|
|
4713
4965
|
/**
|
|
4714
4966
|
* The cast API.
|
|
4715
4967
|
*
|
|
4968
|
+
* @category Casting
|
|
4716
4969
|
* @public
|
|
4717
4970
|
*/
|
|
4718
4971
|
interface Cast extends EventDispatcher<CastEventMap> {
|
|
@@ -4738,6 +4991,7 @@ interface Cast extends EventDispatcher<CastEventMap> {
|
|
|
4738
4991
|
/**
|
|
4739
4992
|
* The global cast API.
|
|
4740
4993
|
*
|
|
4994
|
+
* @category Casting
|
|
4741
4995
|
* @public
|
|
4742
4996
|
*/
|
|
4743
4997
|
interface GlobalCast {
|
|
@@ -4753,6 +5007,7 @@ interface GlobalCast {
|
|
|
4753
5007
|
/**
|
|
4754
5008
|
* Represents a direction in the VR feature.
|
|
4755
5009
|
*
|
|
5010
|
+
* @category VR
|
|
4756
5011
|
* @public
|
|
4757
5012
|
*/
|
|
4758
5013
|
interface VRDirection {
|
|
@@ -4784,30 +5039,38 @@ interface VRDirection {
|
|
|
4784
5039
|
* <br/> - `'available'`
|
|
4785
5040
|
* <br/> - `'presenting'`
|
|
4786
5041
|
*
|
|
5042
|
+
* @category VR
|
|
4787
5043
|
* @public
|
|
4788
5044
|
*/
|
|
4789
5045
|
type VRState = 'unavailable' | 'available' | 'presenting';
|
|
4790
5046
|
/**
|
|
4791
5047
|
* Fired when the {@link VR.direction} changes.
|
|
4792
5048
|
*
|
|
5049
|
+
* @category VR
|
|
5050
|
+
* @category Events
|
|
4793
5051
|
* @public
|
|
4794
5052
|
*/
|
|
4795
5053
|
type DirectionChangeEvent = Event<'directionchange'>;
|
|
4796
5054
|
/**
|
|
4797
5055
|
* Fired when the {@link VR.state} changes.
|
|
4798
5056
|
*
|
|
5057
|
+
* @category VR
|
|
5058
|
+
* @category Events
|
|
4799
5059
|
* @public
|
|
4800
5060
|
*/
|
|
4801
5061
|
type StateChangeEvent = Event<'statechange'>;
|
|
4802
5062
|
/**
|
|
4803
5063
|
* Fired when the {@link VR.stereo} changes.
|
|
4804
5064
|
*
|
|
5065
|
+
* @category VR
|
|
5066
|
+
* @category Events
|
|
4805
5067
|
* @public
|
|
4806
5068
|
*/
|
|
4807
5069
|
type StereoChangeEvent = Event<'stereochange'>;
|
|
4808
5070
|
/**
|
|
4809
5071
|
* The events fired by the {@link VR | VR API}.
|
|
4810
5072
|
*
|
|
5073
|
+
* @category VR
|
|
4811
5074
|
* @public
|
|
4812
5075
|
*/
|
|
4813
5076
|
interface VREventMap {
|
|
@@ -4856,6 +5119,7 @@ interface VREventMap {
|
|
|
4856
5119
|
* });
|
|
4857
5120
|
* ```
|
|
4858
5121
|
*
|
|
5122
|
+
* @category VR
|
|
4859
5123
|
* @public
|
|
4860
5124
|
*/
|
|
4861
5125
|
interface VR extends EventDispatcher<VREventMap> {
|
|
@@ -4933,6 +5197,7 @@ interface VR extends EventDispatcher<VREventMap> {
|
|
|
4933
5197
|
*
|
|
4934
5198
|
* Available since v2.12.0.
|
|
4935
5199
|
*
|
|
5200
|
+
* @category Canvas
|
|
4936
5201
|
* @public
|
|
4937
5202
|
*/
|
|
4938
5203
|
interface Canvas {
|
|
@@ -5024,6 +5289,7 @@ interface Canvas {
|
|
|
5024
5289
|
* @param now - The current time in milliseconds, see {@link https://developer.mozilla.org/en-US/docs/Web/API/Performance/now | performance.now()}.
|
|
5025
5290
|
* @param metadata - The video frame metadata. If `requestVideoFrameCallback()` is not natively supported, this is `undefined`.
|
|
5026
5291
|
*
|
|
5292
|
+
* @category Canvas
|
|
5027
5293
|
* @public
|
|
5028
5294
|
*/
|
|
5029
5295
|
type VideoFrameRequestCallback = (now: DOMHighResTimeStamp, metadata?: VideoFrameCallbackMetadata) => void;
|
|
@@ -5033,6 +5299,7 @@ type VideoFrameRequestCallback = (now: DOMHighResTimeStamp, metadata?: VideoFram
|
|
|
5033
5299
|
* @remarks
|
|
5034
5300
|
* <br/> - See {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement/requestVideoFrameCallback#parameters | requestVideoFrameCallback} for more information.
|
|
5035
5301
|
*
|
|
5302
|
+
* @category Canvas
|
|
5036
5303
|
* @public
|
|
5037
5304
|
*/
|
|
5038
5305
|
interface VideoFrameCallbackMetadata {
|
|
@@ -5053,12 +5320,14 @@ interface VideoFrameCallbackMetadata {
|
|
|
5053
5320
|
*
|
|
5054
5321
|
* @param ratio - Describes the ratio of visible pixels of the player.
|
|
5055
5322
|
*
|
|
5323
|
+
* @category Player
|
|
5056
5324
|
* @public
|
|
5057
5325
|
*/
|
|
5058
5326
|
type VisibilityObserverCallback = (ratio: number) => void;
|
|
5059
5327
|
/**
|
|
5060
5328
|
* The visibility API.
|
|
5061
5329
|
*
|
|
5330
|
+
* @category Player
|
|
5062
5331
|
* @public
|
|
5063
5332
|
*/
|
|
5064
5333
|
interface Visibility {
|
|
@@ -5102,6 +5371,7 @@ interface Visibility {
|
|
|
5102
5371
|
/**
|
|
5103
5372
|
* Represents a visibility observer.
|
|
5104
5373
|
*
|
|
5374
|
+
* @category Player
|
|
5105
5375
|
* @public
|
|
5106
5376
|
*/
|
|
5107
5377
|
interface VisibilityObserver {
|
|
@@ -5147,6 +5417,7 @@ interface VisibilityObserver {
|
|
|
5147
5417
|
*
|
|
5148
5418
|
* Available since v2.19.4.
|
|
5149
5419
|
*
|
|
5420
|
+
* @category Player
|
|
5150
5421
|
* @public
|
|
5151
5422
|
*/
|
|
5152
5423
|
interface WebAudio {
|
|
@@ -5165,12 +5436,15 @@ interface WebAudio {
|
|
|
5165
5436
|
* <br/> - `'fullscreen'`: The player fills the entire screen.
|
|
5166
5437
|
* <br/> - `'picture-in-picture'`: The player is shown on top of the page (see {@link PiPConfiguration} for more options).
|
|
5167
5438
|
*
|
|
5439
|
+
* @category Player
|
|
5168
5440
|
* @public
|
|
5169
5441
|
*/
|
|
5170
5442
|
type PresentationMode = 'inline' | 'fullscreen' | 'picture-in-picture';
|
|
5171
5443
|
/**
|
|
5172
5444
|
* Fired when the presentation mode changes.
|
|
5173
5445
|
*
|
|
5446
|
+
* @category Player
|
|
5447
|
+
* @category Events
|
|
5174
5448
|
* @public
|
|
5175
5449
|
*/
|
|
5176
5450
|
interface PresentationModeChangeEvent extends Event<'presentationmodechange'> {
|
|
@@ -5182,6 +5456,7 @@ interface PresentationModeChangeEvent extends Event<'presentationmodechange'> {
|
|
|
5182
5456
|
/**
|
|
5183
5457
|
* The events fired by the {@link Presentation | presentation API}.
|
|
5184
5458
|
*
|
|
5459
|
+
* @category Player
|
|
5185
5460
|
* @public
|
|
5186
5461
|
*/
|
|
5187
5462
|
interface PresentationEventMap {
|
|
@@ -5197,6 +5472,7 @@ interface PresentationEventMap {
|
|
|
5197
5472
|
/**
|
|
5198
5473
|
* The presentation API.
|
|
5199
5474
|
*
|
|
5475
|
+
* @category Player
|
|
5200
5476
|
* @public
|
|
5201
5477
|
*/
|
|
5202
5478
|
interface Presentation extends EventDispatcher<PresentationEventMap> {
|
|
@@ -5224,6 +5500,7 @@ interface Presentation extends EventDispatcher<PresentationEventMap> {
|
|
|
5224
5500
|
/**
|
|
5225
5501
|
* Provides estimates on the current network state.
|
|
5226
5502
|
*
|
|
5503
|
+
* @category Network
|
|
5227
5504
|
* @public
|
|
5228
5505
|
*/
|
|
5229
5506
|
interface NetworkEstimator {
|
|
@@ -5240,6 +5517,7 @@ interface NetworkEstimator {
|
|
|
5240
5517
|
/**
|
|
5241
5518
|
* Measures network metrics of an HTTP request and the associated HTTP response.
|
|
5242
5519
|
*
|
|
5520
|
+
* @category Network
|
|
5243
5521
|
* @public
|
|
5244
5522
|
*/
|
|
5245
5523
|
interface RequestMeasurer {
|
|
@@ -5278,6 +5556,7 @@ interface RequestMeasurer {
|
|
|
5278
5556
|
/**
|
|
5279
5557
|
* A {@link NetworkEstimator} that allows measuring the current network state.
|
|
5280
5558
|
*
|
|
5559
|
+
* @category Network
|
|
5281
5560
|
* @public
|
|
5282
5561
|
*/
|
|
5283
5562
|
interface MeasurableNetworkEstimator extends NetworkEstimator {
|
|
@@ -5291,12 +5570,14 @@ interface MeasurableNetworkEstimator extends NetworkEstimator {
|
|
|
5291
5570
|
/**
|
|
5292
5571
|
* The RequestInterceptor is a function that accepts a Request object as its argument and can return a promise. If it returns a promise then the request waits until the promise is resolved.
|
|
5293
5572
|
*
|
|
5573
|
+
* @category Network
|
|
5294
5574
|
* @public
|
|
5295
5575
|
*/
|
|
5296
5576
|
type RequestInterceptor = (request: InterceptableRequest) => void | PromiseLike<void>;
|
|
5297
5577
|
/**
|
|
5298
5578
|
* The ResponseInterceptor is a function that accepts a Response object as its argument and can return a promise. If it returns a promise then the response waits until the promise is resolved.
|
|
5299
5579
|
*
|
|
5580
|
+
* @category Network
|
|
5300
5581
|
* @public
|
|
5301
5582
|
*/
|
|
5302
5583
|
type ResponseInterceptor = (response: InterceptableResponse) => void | PromiseLike<void>;
|
|
@@ -5304,6 +5585,7 @@ type ResponseInterceptor = (response: InterceptableResponse) => void | PromiseLi
|
|
|
5304
5585
|
* Record of HTTP headers.
|
|
5305
5586
|
* Each entry contains the header name and its associated value.
|
|
5306
5587
|
*
|
|
5588
|
+
* @category Network
|
|
5307
5589
|
* @public
|
|
5308
5590
|
*/
|
|
5309
5591
|
interface HTTPHeaders {
|
|
@@ -5312,12 +5594,14 @@ interface HTTPHeaders {
|
|
|
5312
5594
|
/**
|
|
5313
5595
|
* The possible types of an HTTP request body.
|
|
5314
5596
|
*
|
|
5597
|
+
* @category Network
|
|
5315
5598
|
* @public
|
|
5316
5599
|
*/
|
|
5317
5600
|
type RequestBody = ArrayBuffer | ArrayBufferView | string | null;
|
|
5318
5601
|
/**
|
|
5319
5602
|
* The possible types of an HTTP response body.
|
|
5320
5603
|
*
|
|
5604
|
+
* @category Network
|
|
5321
5605
|
* @public
|
|
5322
5606
|
*/
|
|
5323
5607
|
type ResponseBody = ArrayBuffer | object | string | null;
|
|
@@ -5328,6 +5612,7 @@ type ResponseBody = ArrayBuffer | object | string | null;
|
|
|
5328
5612
|
* <br/> - `'preload-hint'`
|
|
5329
5613
|
* <br/> - `'content-protection'`
|
|
5330
5614
|
*
|
|
5615
|
+
* @category Network
|
|
5331
5616
|
* @public
|
|
5332
5617
|
*/
|
|
5333
5618
|
type RequestType = '' | 'manifest' | 'segment' | 'preload-hint' | 'content-protection';
|
|
@@ -5341,6 +5626,7 @@ type RequestType = '' | 'manifest' | 'segment' | 'preload-hint' | 'content-prote
|
|
|
5341
5626
|
* <br/> - `'clearkey-license'`
|
|
5342
5627
|
* <br/> - `'aes128-key'`
|
|
5343
5628
|
*
|
|
5629
|
+
* @category Network
|
|
5344
5630
|
* @public
|
|
5345
5631
|
*/
|
|
5346
5632
|
type ContentProtectionRequestSubType = 'fairplay-license' | 'fairplay-certificate' | 'widevine-license' | 'widevine-certificate' | 'playready-license' | 'clearkey-license' | 'aes128-key';
|
|
@@ -5350,6 +5636,7 @@ type ContentProtectionRequestSubType = 'fairplay-license' | 'fairplay-certificat
|
|
|
5350
5636
|
* <br/> - Any value of {@link ContentProtectionRequestSubType}
|
|
5351
5637
|
* <br/> - Empty string (`''`) when the subtype is unknown
|
|
5352
5638
|
*
|
|
5639
|
+
* @category Network
|
|
5353
5640
|
* @public
|
|
5354
5641
|
*/
|
|
5355
5642
|
type RequestSubType = '' | 'initialization-segment' | ContentProtectionRequestSubType;
|
|
@@ -5361,6 +5648,7 @@ type RequestSubType = '' | 'initialization-segment' | ContentProtectionRequestSu
|
|
|
5361
5648
|
* <br/> - `'image'`
|
|
5362
5649
|
* <br/> - Empty string (`''`) when the media type is unknown
|
|
5363
5650
|
*
|
|
5651
|
+
* @category Network
|
|
5364
5652
|
* @public
|
|
5365
5653
|
*/
|
|
5366
5654
|
type MediaType = '' | 'audio' | 'video' | 'text' | 'image';
|
|
@@ -5371,6 +5659,7 @@ type MediaType = '' | 'audio' | 'video' | 'text' | 'image';
|
|
|
5371
5659
|
* <br/> - `'stream'`
|
|
5372
5660
|
* <br/> - `'text'`
|
|
5373
5661
|
*
|
|
5662
|
+
* @category Network
|
|
5374
5663
|
* @public
|
|
5375
5664
|
*/
|
|
5376
5665
|
type ResponseType = 'arraybuffer' | 'json' | 'stream' | 'text';
|
|
@@ -5383,18 +5672,21 @@ type ResponseType = 'arraybuffer' | 'json' | 'stream' | 'text';
|
|
|
5383
5672
|
* <br/> - `'DELETE'`
|
|
5384
5673
|
* <br/> - `'OPTIONS'`
|
|
5385
5674
|
*
|
|
5675
|
+
* @category Network
|
|
5386
5676
|
* @public
|
|
5387
5677
|
*/
|
|
5388
5678
|
type RequestMethod = 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'POST' | 'PUT';
|
|
5389
5679
|
/**
|
|
5390
5680
|
* The possible types representing an HTTP request.
|
|
5391
5681
|
*
|
|
5682
|
+
* @category Network
|
|
5392
5683
|
* @public
|
|
5393
5684
|
*/
|
|
5394
5685
|
type RequestLike = string | RequestInit;
|
|
5395
5686
|
/**
|
|
5396
5687
|
* The possible types representing an HTTP response.
|
|
5397
5688
|
*
|
|
5689
|
+
* @category Network
|
|
5398
5690
|
* @public
|
|
5399
5691
|
*/
|
|
5400
5692
|
type ResponseLike = ResponseInit;
|
|
@@ -5403,6 +5695,7 @@ type ResponseLike = ResponseInit;
|
|
|
5403
5695
|
*
|
|
5404
5696
|
* After all asynchronous work is done, the callback *must* call `done`, optionally passing an error argument.
|
|
5405
5697
|
*
|
|
5698
|
+
* @category Network
|
|
5406
5699
|
* @public
|
|
5407
5700
|
*/
|
|
5408
5701
|
type NodeStyleVoidCallback = (done: (error?: any) => void) => void;
|
|
@@ -5411,12 +5704,14 @@ type NodeStyleVoidCallback = (done: (error?: any) => void) => void;
|
|
|
5411
5704
|
*
|
|
5412
5705
|
* The callback *must* return a promise that resolves (or rejects) after all asynchronous work is done.
|
|
5413
5706
|
*
|
|
5707
|
+
* @category Network
|
|
5414
5708
|
* @public
|
|
5415
5709
|
*/
|
|
5416
5710
|
type VoidPromiseCallback = () => PromiseLike<void>;
|
|
5417
5711
|
/**
|
|
5418
5712
|
* An asynchronous callback to delay a request or response.
|
|
5419
5713
|
*
|
|
5714
|
+
* @category Network
|
|
5420
5715
|
* @public
|
|
5421
5716
|
*/
|
|
5422
5717
|
type WaitUntilCallback = NodeStyleVoidCallback | VoidPromiseCallback;
|
|
@@ -5427,6 +5722,7 @@ type WaitUntilCallback = NodeStyleVoidCallback | VoidPromiseCallback;
|
|
|
5427
5722
|
* <br/> - Request interceptors will be executed in the order they were added.
|
|
5428
5723
|
* <br/> - {@link InterceptableRequest.respondWith} can be called at most once, otherwise an error will be thrown.
|
|
5429
5724
|
*
|
|
5725
|
+
* @category Network
|
|
5430
5726
|
* @public
|
|
5431
5727
|
*/
|
|
5432
5728
|
interface NetworkInterceptorController {
|
|
@@ -5462,6 +5758,7 @@ interface NetworkInterceptorController {
|
|
|
5462
5758
|
* @remarks
|
|
5463
5759
|
* <br/> - EXPERIMENTAL: Setting an external `MeasurableNetworkEstimator` implementation will only affect playback of HLS streams.
|
|
5464
5760
|
*
|
|
5761
|
+
* @category Network
|
|
5465
5762
|
* @public
|
|
5466
5763
|
*/
|
|
5467
5764
|
interface NetworkEstimatorController {
|
|
@@ -5477,6 +5774,7 @@ interface NetworkEstimatorController {
|
|
|
5477
5774
|
/**
|
|
5478
5775
|
* The events fired by the {@link Network | network API}.
|
|
5479
5776
|
*
|
|
5777
|
+
* @category Network
|
|
5480
5778
|
* @public
|
|
5481
5779
|
*/
|
|
5482
5780
|
interface NetworkEventMap {
|
|
@@ -5495,6 +5793,7 @@ interface NetworkEventMap {
|
|
|
5495
5793
|
* @remarks
|
|
5496
5794
|
* <br/> - Available since v2.21.0.
|
|
5497
5795
|
*
|
|
5796
|
+
* @category Network
|
|
5498
5797
|
* @public
|
|
5499
5798
|
*/
|
|
5500
5799
|
interface Network extends EventDispatcher<NetworkEventMap>, NetworkInterceptorController, NetworkEstimatorController {
|
|
@@ -5506,6 +5805,7 @@ interface Network extends EventDispatcher<NetworkEventMap>, NetworkInterceptorCo
|
|
|
5506
5805
|
/**
|
|
5507
5806
|
* Contains network request properties used to modify an HTTP request.
|
|
5508
5807
|
*
|
|
5808
|
+
* @category Network
|
|
5509
5809
|
* @public
|
|
5510
5810
|
*/
|
|
5511
5811
|
interface RequestInit {
|
|
@@ -5570,6 +5870,7 @@ interface RequestInit {
|
|
|
5570
5870
|
/**
|
|
5571
5871
|
* Contains network response properties used to modify an HTTP response.
|
|
5572
5872
|
*
|
|
5873
|
+
* @category Network
|
|
5573
5874
|
* @public
|
|
5574
5875
|
*/
|
|
5575
5876
|
interface ResponseInit {
|
|
@@ -5607,6 +5908,7 @@ interface ResponseInit {
|
|
|
5607
5908
|
/**
|
|
5608
5909
|
* Represents an HTTP request.
|
|
5609
5910
|
*
|
|
5911
|
+
* @category Network
|
|
5610
5912
|
* @public
|
|
5611
5913
|
*/
|
|
5612
5914
|
interface Request {
|
|
@@ -5650,6 +5952,7 @@ interface Request {
|
|
|
5650
5952
|
/**
|
|
5651
5953
|
* Represents an intercepted HTTP request which can be modified.
|
|
5652
5954
|
*
|
|
5955
|
+
* @category Network
|
|
5653
5956
|
* @public
|
|
5654
5957
|
*/
|
|
5655
5958
|
interface InterceptableRequest extends Request {
|
|
@@ -5717,6 +6020,7 @@ interface InterceptableRequest extends Request {
|
|
|
5717
6020
|
/**
|
|
5718
6021
|
* Represents an intercepted HTTP response which can be modified.
|
|
5719
6022
|
*
|
|
6023
|
+
* @category Network
|
|
5720
6024
|
* @public
|
|
5721
6025
|
*/
|
|
5722
6026
|
interface InterceptableResponse {
|
|
@@ -5800,6 +6104,7 @@ interface InterceptableResponse {
|
|
|
5800
6104
|
/**
|
|
5801
6105
|
* Events fired by the {@link TextTrackStyle | TextTrackStyle API}.
|
|
5802
6106
|
*
|
|
6107
|
+
* @category Media and Text Tracks
|
|
5803
6108
|
* @public
|
|
5804
6109
|
*/
|
|
5805
6110
|
interface TextTrackStyleEventMap {
|
|
@@ -5814,6 +6119,7 @@ interface TextTrackStyleEventMap {
|
|
|
5814
6119
|
* @remarks
|
|
5815
6120
|
* <br/> - Available since v2.27.4.
|
|
5816
6121
|
*
|
|
6122
|
+
* @category Media and Text Tracks
|
|
5817
6123
|
* @public
|
|
5818
6124
|
*/
|
|
5819
6125
|
interface TextTrackStyle extends EventDispatcher<TextTrackStyleEventMap> {
|
|
@@ -5915,6 +6221,7 @@ interface TextTrackStyle extends EventDispatcher<TextTrackStyleEventMap> {
|
|
|
5915
6221
|
* <br/> - `'depressed'`
|
|
5916
6222
|
* <br/> - `'uniform'`
|
|
5917
6223
|
*
|
|
6224
|
+
* @category Media and Text Tracks
|
|
5918
6225
|
* @public
|
|
5919
6226
|
*/
|
|
5920
6227
|
type EdgeStyle = 'none' | 'dropshadow' | 'raised' | 'depressed' | 'uniform';
|
|
@@ -5925,12 +6232,14 @@ type EdgeStyle = 'none' | 'dropshadow' | 'raised' | 'depressed' | 'uniform';
|
|
|
5925
6232
|
* <br/> - `'quality'`: The player will optimize ABR behavior to focus displaying the best visual quality to the end-user. This strategy initiates playback with the highest bit rate suitable for the device.
|
|
5926
6233
|
* <br/> - `'bandwidth'`: The player will optimize the ABR behavior to focus on displaying the most optimal quality based on historic data of available bandwidth and knowledge of the network conditions.
|
|
5927
6234
|
*
|
|
6235
|
+
* @category ABR
|
|
5928
6236
|
* @public
|
|
5929
6237
|
*/
|
|
5930
6238
|
type ABRStrategyType = 'performance' | 'quality' | 'bandwidth';
|
|
5931
6239
|
/**
|
|
5932
6240
|
* Describes the metadata of the adaptive bitrate strategy.
|
|
5933
6241
|
*
|
|
6242
|
+
* @category ABR
|
|
5934
6243
|
* @public
|
|
5935
6244
|
*/
|
|
5936
6245
|
interface ABRMetadata {
|
|
@@ -5944,6 +6253,7 @@ interface ABRMetadata {
|
|
|
5944
6253
|
/**
|
|
5945
6254
|
* Describes the configuration of the adaptive bitrate strategy.
|
|
5946
6255
|
*
|
|
6256
|
+
* @category ABR
|
|
5947
6257
|
* @public
|
|
5948
6258
|
*/
|
|
5949
6259
|
interface ABRStrategyConfiguration {
|
|
@@ -5961,6 +6271,7 @@ interface ABRStrategyConfiguration {
|
|
|
5961
6271
|
/**
|
|
5962
6272
|
* The adaptive bitrate stratey.
|
|
5963
6273
|
*
|
|
6274
|
+
* @category ABR
|
|
5964
6275
|
* @public
|
|
5965
6276
|
*/
|
|
5966
6277
|
type ABRStrategy = ABRStrategyConfiguration | ABRStrategyType;
|
|
@@ -5970,6 +6281,7 @@ type ABRStrategy = ABRStrategyConfiguration | ABRStrategyType;
|
|
|
5970
6281
|
* @remarks
|
|
5971
6282
|
* <br/> - Available since v2.30.0.
|
|
5972
6283
|
*
|
|
6284
|
+
* @category ABR
|
|
5973
6285
|
* @public
|
|
5974
6286
|
*/
|
|
5975
6287
|
interface ABRConfiguration {
|
|
@@ -6024,6 +6336,7 @@ interface ABRConfiguration {
|
|
|
6024
6336
|
/**
|
|
6025
6337
|
* The identifier of the Conviva integration.
|
|
6026
6338
|
*
|
|
6339
|
+
* @category Analytics
|
|
6027
6340
|
* @public
|
|
6028
6341
|
*/
|
|
6029
6342
|
type ConvivaAnalyticsIntegrationID = 'conviva';
|
|
@@ -6033,6 +6346,7 @@ type ConvivaAnalyticsIntegrationID = 'conviva';
|
|
|
6033
6346
|
* @remarks
|
|
6034
6347
|
* <br/> - Available since v2.14.4.
|
|
6035
6348
|
*
|
|
6349
|
+
* @category Analytics
|
|
6036
6350
|
* @public
|
|
6037
6351
|
*/
|
|
6038
6352
|
interface ConvivaConfiguration extends AnalyticsDescription {
|
|
@@ -6072,6 +6386,7 @@ interface ConvivaConfiguration extends AnalyticsDescription {
|
|
|
6072
6386
|
/**
|
|
6073
6387
|
* The Conviva API.
|
|
6074
6388
|
*
|
|
6389
|
+
* @category Analytics
|
|
6075
6390
|
* @public
|
|
6076
6391
|
*/
|
|
6077
6392
|
interface Conviva {
|
|
@@ -6114,6 +6429,7 @@ interface Conviva {
|
|
|
6114
6429
|
* @remarks
|
|
6115
6430
|
* <br/> - Available since v2.14.4.
|
|
6116
6431
|
*
|
|
6432
|
+
* @category Analytics
|
|
6117
6433
|
* @public
|
|
6118
6434
|
*/
|
|
6119
6435
|
interface ConvivaContentMetadata {
|
|
@@ -6178,6 +6494,7 @@ interface ConvivaContentMetadata {
|
|
|
6178
6494
|
/**
|
|
6179
6495
|
* The analytics API.
|
|
6180
6496
|
*
|
|
6497
|
+
* @category Analytics
|
|
6181
6498
|
* @public
|
|
6182
6499
|
*/
|
|
6183
6500
|
interface Analytics {
|
|
@@ -6193,6 +6510,7 @@ interface Analytics {
|
|
|
6193
6510
|
/**
|
|
6194
6511
|
* The events fired by the {@link Clip | clip API}.
|
|
6195
6512
|
*
|
|
6513
|
+
* @category Clipping
|
|
6196
6514
|
* @public
|
|
6197
6515
|
*/
|
|
6198
6516
|
interface ClipEventMap {
|
|
@@ -6204,6 +6522,7 @@ interface ClipEventMap {
|
|
|
6204
6522
|
/**
|
|
6205
6523
|
* The clip API which can be used to clip the playback window of a source.
|
|
6206
6524
|
*
|
|
6525
|
+
* @category Clipping
|
|
6207
6526
|
* @public
|
|
6208
6527
|
*/
|
|
6209
6528
|
interface Clip extends EventDispatcher<ClipEventMap> {
|
|
@@ -6220,6 +6539,7 @@ interface Clip extends EventDispatcher<ClipEventMap> {
|
|
|
6220
6539
|
/**
|
|
6221
6540
|
* The number of audio and video segments in the buffer.
|
|
6222
6541
|
*
|
|
6542
|
+
* @category Analytics
|
|
6223
6543
|
* @public
|
|
6224
6544
|
*/
|
|
6225
6545
|
interface BufferedSegments {
|
|
@@ -6232,6 +6552,7 @@ interface BufferedSegments {
|
|
|
6232
6552
|
* @remarks
|
|
6233
6553
|
* <br/> - Available since v2.46.0.
|
|
6234
6554
|
*
|
|
6555
|
+
* @category Analytics
|
|
6235
6556
|
* @public
|
|
6236
6557
|
*/
|
|
6237
6558
|
interface Metrics {
|
|
@@ -6276,6 +6597,7 @@ interface Metrics {
|
|
|
6276
6597
|
* <br/> - `'metadata'` loads enough resources to be able to determine the {@link ChromelessPlayer.duration}.
|
|
6277
6598
|
* <br/> - `'auto'` loads media up to {@link ABRConfiguration.targetBuffer}.
|
|
6278
6599
|
*
|
|
6600
|
+
* @category Player
|
|
6279
6601
|
* @public
|
|
6280
6602
|
*/
|
|
6281
6603
|
type PreloadType = 'none' | 'metadata' | 'auto' | '';
|
|
@@ -6283,6 +6605,8 @@ type PreloadType = 'none' | 'metadata' | 'auto' | '';
|
|
|
6283
6605
|
/**
|
|
6284
6606
|
* Fired when an event related to the Imagine integration occurs.
|
|
6285
6607
|
*
|
|
6608
|
+
* @category SSAI
|
|
6609
|
+
* @category Events
|
|
6286
6610
|
* @public
|
|
6287
6611
|
*/
|
|
6288
6612
|
interface ImagineTrackingEvent extends Event<'start' | 'firstquartile' | 'midpoint' | 'thirdquartile' | 'complete' | 'pause' | 'resume'> {
|
|
@@ -6291,6 +6615,7 @@ interface ImagineTrackingEvent extends Event<'start' | 'firstquartile' | 'midpoi
|
|
|
6291
6615
|
/**
|
|
6292
6616
|
* The events fired by the {@link Imagine | Imagine API}.
|
|
6293
6617
|
*
|
|
6618
|
+
* @category SSAI
|
|
6294
6619
|
* @public
|
|
6295
6620
|
*/
|
|
6296
6621
|
interface ImagineEventMap {
|
|
@@ -6326,6 +6651,7 @@ interface ImagineEventMap {
|
|
|
6326
6651
|
/**
|
|
6327
6652
|
* The Imagine API.
|
|
6328
6653
|
*
|
|
6654
|
+
* @category SSAI
|
|
6329
6655
|
* @public
|
|
6330
6656
|
*/
|
|
6331
6657
|
interface Imagine extends EventDispatcher<ImagineEventMap> {
|
|
@@ -6338,6 +6664,8 @@ interface Imagine extends EventDispatcher<ImagineEventMap> {
|
|
|
6338
6664
|
/**
|
|
6339
6665
|
* Fired when the ad break begins.
|
|
6340
6666
|
*
|
|
6667
|
+
* @category Verizon Media
|
|
6668
|
+
* @category Events
|
|
6341
6669
|
* @public
|
|
6342
6670
|
*/
|
|
6343
6671
|
interface VerizonMediaAdBreakBeginEvent extends Event<'adbreakbegin'> {
|
|
@@ -6350,6 +6678,8 @@ interface VerizonMediaAdBreakBeginEvent extends Event<'adbreakbegin'> {
|
|
|
6350
6678
|
/**
|
|
6351
6679
|
* Fired when the ad break ends.
|
|
6352
6680
|
*
|
|
6681
|
+
* @category Verizon Media
|
|
6682
|
+
* @category Events
|
|
6353
6683
|
* @public
|
|
6354
6684
|
*/
|
|
6355
6685
|
interface VerizonMediaAdBreakEndEvent extends Event<'adbreakend'> {
|
|
@@ -6362,6 +6692,8 @@ interface VerizonMediaAdBreakEndEvent extends Event<'adbreakend'> {
|
|
|
6362
6692
|
/**
|
|
6363
6693
|
* Fired when the ad break is skipped.
|
|
6364
6694
|
*
|
|
6695
|
+
* @category Verizon Media
|
|
6696
|
+
* @category Events
|
|
6365
6697
|
* @public
|
|
6366
6698
|
*/
|
|
6367
6699
|
interface VerizonMediaAdBreakSkipEvent extends Event<'adbreakskip'> {
|
|
@@ -6374,6 +6706,8 @@ interface VerizonMediaAdBreakSkipEvent extends Event<'adbreakskip'> {
|
|
|
6374
6706
|
/**
|
|
6375
6707
|
* Fired when the ad break is updated.
|
|
6376
6708
|
*
|
|
6709
|
+
* @category Verizon Media
|
|
6710
|
+
* @category Events
|
|
6377
6711
|
* @public
|
|
6378
6712
|
*/
|
|
6379
6713
|
interface VerizonMediaUpdateAdBreakEvent extends Event<'updateadbreak'> {
|
|
@@ -6414,6 +6748,8 @@ interface EventedList<T, M extends EventMap<StringKeyOf<M>>> extends List<T>, Ev
|
|
|
6414
6748
|
/**
|
|
6415
6749
|
* Fired when an ad begins.
|
|
6416
6750
|
*
|
|
6751
|
+
* @category Verizon Media
|
|
6752
|
+
* @category Events
|
|
6417
6753
|
* @public
|
|
6418
6754
|
*/
|
|
6419
6755
|
interface VerizonMediaAdBeginEvent extends Event<'adbegin'> {
|
|
@@ -6426,6 +6762,8 @@ interface VerizonMediaAdBeginEvent extends Event<'adbegin'> {
|
|
|
6426
6762
|
/**
|
|
6427
6763
|
* Fired when the ad ends.
|
|
6428
6764
|
*
|
|
6765
|
+
* @category Verizon Media
|
|
6766
|
+
* @category Events
|
|
6429
6767
|
* @public
|
|
6430
6768
|
*/
|
|
6431
6769
|
interface VerizonMediaAdEndEvent extends Event<'adend'> {
|
|
@@ -6438,6 +6776,8 @@ interface VerizonMediaAdEndEvent extends Event<'adend'> {
|
|
|
6438
6776
|
/**
|
|
6439
6777
|
* Fired when the ad reaches the first quartile.
|
|
6440
6778
|
*
|
|
6779
|
+
* @category Verizon Media
|
|
6780
|
+
* @category Events
|
|
6441
6781
|
* @public
|
|
6442
6782
|
*/
|
|
6443
6783
|
interface VerizonMediaAdFirstQuartileEvent extends Event<'adfirstquartile'> {
|
|
@@ -6449,6 +6789,8 @@ interface VerizonMediaAdFirstQuartileEvent extends Event<'adfirstquartile'> {
|
|
|
6449
6789
|
/**
|
|
6450
6790
|
* Fired when the ad reaches the mid point.
|
|
6451
6791
|
*
|
|
6792
|
+
* @category Verizon Media
|
|
6793
|
+
* @category Events
|
|
6452
6794
|
* @public
|
|
6453
6795
|
*/
|
|
6454
6796
|
interface VerizonMediaAdMidpointEvent extends Event<'admidpoint'> {
|
|
@@ -6460,6 +6802,8 @@ interface VerizonMediaAdMidpointEvent extends Event<'admidpoint'> {
|
|
|
6460
6802
|
/**
|
|
6461
6803
|
* Fired when the ad reaches the third quartile.
|
|
6462
6804
|
*
|
|
6805
|
+
* @category Verizon Media
|
|
6806
|
+
* @category Events
|
|
6463
6807
|
* @public
|
|
6464
6808
|
*/
|
|
6465
6809
|
interface VerizonMediaAdThirdQuartileEvent extends Event<'adthirdquartile'> {
|
|
@@ -6471,6 +6815,8 @@ interface VerizonMediaAdThirdQuartileEvent extends Event<'adthirdquartile'> {
|
|
|
6471
6815
|
/**
|
|
6472
6816
|
* Fired when the ad is completed.
|
|
6473
6817
|
*
|
|
6818
|
+
* @category Verizon Media
|
|
6819
|
+
* @category Events
|
|
6474
6820
|
* @public
|
|
6475
6821
|
*/
|
|
6476
6822
|
interface VerizonMediaAdCompleteEvent extends Event<'adcomplete'> {
|
|
@@ -6483,6 +6829,7 @@ interface VerizonMediaAdCompleteEvent extends Event<'adcomplete'> {
|
|
|
6483
6829
|
/**
|
|
6484
6830
|
* The events fired by the {@link VerizonMediaAd}.
|
|
6485
6831
|
*
|
|
6832
|
+
* @category Verizon Media
|
|
6486
6833
|
* @public
|
|
6487
6834
|
*/
|
|
6488
6835
|
interface VerizonMediaAdEventMap {
|
|
@@ -6514,6 +6861,7 @@ interface VerizonMediaAdEventMap {
|
|
|
6514
6861
|
/**
|
|
6515
6862
|
* Represents a Verizon Media ad.
|
|
6516
6863
|
*
|
|
6864
|
+
* @category Verizon Media
|
|
6517
6865
|
* @public
|
|
6518
6866
|
*/
|
|
6519
6867
|
interface VerizonMediaAd extends EventDispatcher<VerizonMediaAdEventMap> {
|
|
@@ -6590,6 +6938,7 @@ interface VerizonMediaAd extends EventDispatcher<VerizonMediaAdEventMap> {
|
|
|
6590
6938
|
/**
|
|
6591
6939
|
* Fired when the ad is removed.
|
|
6592
6940
|
*
|
|
6941
|
+
* @category Verizon Media
|
|
6593
6942
|
* @public
|
|
6594
6943
|
*/
|
|
6595
6944
|
interface VerizonMediaRemoveAdEvent extends Event<'removead'> {
|
|
@@ -6599,6 +6948,7 @@ interface VerizonMediaRemoveAdEvent extends Event<'removead'> {
|
|
|
6599
6948
|
/**
|
|
6600
6949
|
* Events fired by the {@link VerizonMediaAdList}.
|
|
6601
6950
|
*
|
|
6951
|
+
* @category Verizon Media
|
|
6602
6952
|
* @public
|
|
6603
6953
|
*/
|
|
6604
6954
|
interface VerizonMediaAdListEventMap {
|
|
@@ -6610,6 +6960,7 @@ interface VerizonMediaAdListEventMap {
|
|
|
6610
6960
|
/**
|
|
6611
6961
|
* List of Verizon Media ads.
|
|
6612
6962
|
*
|
|
6963
|
+
* @category Verizon Media
|
|
6613
6964
|
* @public
|
|
6614
6965
|
*/
|
|
6615
6966
|
interface VerizonMediaAdList extends EventedList<VerizonMediaAd, VerizonMediaAdListEventMap> {
|
|
@@ -6618,6 +6969,7 @@ interface VerizonMediaAdList extends EventedList<VerizonMediaAd, VerizonMediaAdL
|
|
|
6618
6969
|
/**
|
|
6619
6970
|
* The events fired by the {@link VerizonMediaAdBreak}.
|
|
6620
6971
|
*
|
|
6972
|
+
* @category Verizon Media
|
|
6621
6973
|
* @public
|
|
6622
6974
|
*/
|
|
6623
6975
|
interface VerizonMediaAdBreakEventMap {
|
|
@@ -6641,6 +6993,7 @@ interface VerizonMediaAdBreakEventMap {
|
|
|
6641
6993
|
/**
|
|
6642
6994
|
* Represents a Verizon Media ad.
|
|
6643
6995
|
*
|
|
6996
|
+
* @category Verizon Media
|
|
6644
6997
|
* @public
|
|
6645
6998
|
*/
|
|
6646
6999
|
interface VerizonMediaAdBreak extends EventDispatcher<VerizonMediaAdBreakEventMap> {
|
|
@@ -6686,6 +7039,8 @@ interface VerizonMediaAdBreak extends EventDispatcher<VerizonMediaAdBreakEventMa
|
|
|
6686
7039
|
/**
|
|
6687
7040
|
* Fired when the ad break is added.
|
|
6688
7041
|
*
|
|
7042
|
+
* @category Verizon Media
|
|
7043
|
+
* @category Events
|
|
6689
7044
|
* @public
|
|
6690
7045
|
*/
|
|
6691
7046
|
interface VerizonMediaAddAdBreakEvent extends Event<'addadbreak'> {
|
|
@@ -6698,6 +7053,8 @@ interface VerizonMediaAddAdBreakEvent extends Event<'addadbreak'> {
|
|
|
6698
7053
|
/**
|
|
6699
7054
|
* Fired when the ad break is removed.
|
|
6700
7055
|
*
|
|
7056
|
+
* @category Verizon Media
|
|
7057
|
+
* @category Events
|
|
6701
7058
|
* @public
|
|
6702
7059
|
*/
|
|
6703
7060
|
interface VerizonMediaRemoveAdBreakEvent extends Event<'removeadbreak'> {
|
|
@@ -6710,6 +7067,7 @@ interface VerizonMediaRemoveAdBreakEvent extends Event<'removeadbreak'> {
|
|
|
6710
7067
|
/**
|
|
6711
7068
|
* The events fired by the {@link VerizonMediaAdBreakList}.
|
|
6712
7069
|
*
|
|
7070
|
+
* @category Verizon Media
|
|
6713
7071
|
* @public
|
|
6714
7072
|
*/
|
|
6715
7073
|
interface VerizonMediaAdBreakListEventMap {
|
|
@@ -6725,6 +7083,7 @@ interface VerizonMediaAdBreakListEventMap {
|
|
|
6725
7083
|
/**
|
|
6726
7084
|
* List with Verizon Media ad breaks.
|
|
6727
7085
|
*
|
|
7086
|
+
* @category Verizon Media
|
|
6728
7087
|
* @public
|
|
6729
7088
|
*/
|
|
6730
7089
|
interface VerizonMediaAdBreakList extends EventedList<VerizonMediaAdBreak, VerizonMediaAdBreakListEventMap> {
|
|
@@ -6733,6 +7092,7 @@ interface VerizonMediaAdBreakList extends EventedList<VerizonMediaAdBreak, Veriz
|
|
|
6733
7092
|
/**
|
|
6734
7093
|
* The Verizon Media ads API.
|
|
6735
7094
|
*
|
|
7095
|
+
* @category Verizon Media
|
|
6736
7096
|
* @public
|
|
6737
7097
|
*/
|
|
6738
7098
|
interface VerizonMediaAds {
|
|
@@ -6763,6 +7123,7 @@ interface VerizonMediaAds {
|
|
|
6763
7123
|
/**
|
|
6764
7124
|
* Represents a Verizon Media response with advertisement information for VOD assets.
|
|
6765
7125
|
*
|
|
7126
|
+
* @category Verizon Media
|
|
6766
7127
|
* @public
|
|
6767
7128
|
*/
|
|
6768
7129
|
interface VerizonMediaResponseVodAds {
|
|
@@ -6785,6 +7146,7 @@ interface VerizonMediaResponseVodAds {
|
|
|
6785
7146
|
/**
|
|
6786
7147
|
* Represents a Verizon Media response with ad break information for VOD assets.
|
|
6787
7148
|
*
|
|
7149
|
+
* @category Verizon Media
|
|
6788
7150
|
* @public
|
|
6789
7151
|
*/
|
|
6790
7152
|
interface VerizonMediaResponseVodAdBreak {
|
|
@@ -6823,6 +7185,7 @@ interface VerizonMediaResponseVodAdBreak {
|
|
|
6823
7185
|
/**
|
|
6824
7186
|
* The Verizon Media response with ad information for VOD assets.
|
|
6825
7187
|
*
|
|
7188
|
+
* @category Verizon Media
|
|
6826
7189
|
* @public
|
|
6827
7190
|
*/
|
|
6828
7191
|
interface VerizonMediaResponseVodAd {
|
|
@@ -6890,6 +7253,7 @@ interface VerizonMediaResponseVodAd {
|
|
|
6890
7253
|
/**
|
|
6891
7254
|
* Represents the offset of a Verizon Media ad break.
|
|
6892
7255
|
*
|
|
7256
|
+
* @category Verizon Media
|
|
6893
7257
|
* @public
|
|
6894
7258
|
*/
|
|
6895
7259
|
interface VerizonMediaResponseVodAdBreakOffset {
|
|
@@ -6910,6 +7274,7 @@ interface VerizonMediaResponseVodAdBreakOffset {
|
|
|
6910
7274
|
* <br/> - is a short blank video for non-video ads (e.g. VPAID ads).
|
|
6911
7275
|
* <br/> - is a system asset which is potentially subject to change.
|
|
6912
7276
|
*
|
|
7277
|
+
* @category Verizon Media
|
|
6913
7278
|
* @public
|
|
6914
7279
|
*/
|
|
6915
7280
|
interface VerizonMediaResponseVodAdPlaceholder {
|
|
@@ -6936,18 +7301,21 @@ interface VerizonMediaResponseVodAdPlaceholder {
|
|
|
6936
7301
|
* <br/> - `'vod'`
|
|
6937
7302
|
* <br/> - `'live'`
|
|
6938
7303
|
*
|
|
7304
|
+
* @category Verizon Media
|
|
6939
7305
|
* @public
|
|
6940
7306
|
*/
|
|
6941
7307
|
type VerizonMediaPreplayResponseType = 'vod' | 'live';
|
|
6942
7308
|
/**
|
|
6943
7309
|
* Type of a Verizon Media Preplay response.
|
|
6944
7310
|
*
|
|
7311
|
+
* @category Verizon Media
|
|
6945
7312
|
* @public
|
|
6946
7313
|
*/
|
|
6947
7314
|
type VerizonMediaPreplayResponse = VerizonMediaPreplayVodResponse | VerizonMediaPreplayLiveResponse;
|
|
6948
7315
|
/**
|
|
6949
7316
|
* Represents a Verizon Media Preplay base response.
|
|
6950
7317
|
*
|
|
7318
|
+
* @category Verizon Media
|
|
6951
7319
|
* @public
|
|
6952
7320
|
*/
|
|
6953
7321
|
interface VerizonMediaPreplayBaseResponse {
|
|
@@ -6986,6 +7354,7 @@ interface VerizonMediaPreplayBaseResponse {
|
|
|
6986
7354
|
/**
|
|
6987
7355
|
* Represents a Verizon Media DRM response.
|
|
6988
7356
|
*
|
|
7357
|
+
* @category Verizon Media
|
|
6989
7358
|
* @public
|
|
6990
7359
|
*/
|
|
6991
7360
|
interface VerizonMediaResponseDrm {
|
|
@@ -7005,6 +7374,7 @@ interface VerizonMediaResponseDrm {
|
|
|
7005
7374
|
/**
|
|
7006
7375
|
* Represents a Verizon Media Preplay response for VOD assets.
|
|
7007
7376
|
*
|
|
7377
|
+
* @category Verizon Media
|
|
7008
7378
|
* @public
|
|
7009
7379
|
*/
|
|
7010
7380
|
interface VerizonMediaPreplayVodResponse extends VerizonMediaPreplayBaseResponse {
|
|
@@ -7029,6 +7399,7 @@ interface VerizonMediaPreplayVodResponse extends VerizonMediaPreplayBaseResponse
|
|
|
7029
7399
|
/**
|
|
7030
7400
|
* Represents a Verizon Media Preplay response for live assets.
|
|
7031
7401
|
*
|
|
7402
|
+
* @category Verizon Media
|
|
7032
7403
|
* @public
|
|
7033
7404
|
*/
|
|
7034
7405
|
interface VerizonMediaPreplayLiveResponse extends VerizonMediaPreplayBaseResponse {
|
|
@@ -7041,6 +7412,7 @@ interface VerizonMediaPreplayLiveResponse extends VerizonMediaPreplayBaseRespons
|
|
|
7041
7412
|
/**
|
|
7042
7413
|
* Fired when a Preplay response is received.
|
|
7043
7414
|
*
|
|
7415
|
+
* @category Verizon Media
|
|
7044
7416
|
* @public
|
|
7045
7417
|
*/
|
|
7046
7418
|
interface VerizonMediaPreplayResponseEvent extends Event<'preplayresponse'> {
|
|
@@ -7056,6 +7428,7 @@ interface VerizonMediaPreplayResponseEvent extends Event<'preplayresponse'> {
|
|
|
7056
7428
|
* @remarks
|
|
7057
7429
|
* <br/> - See {@link https://docs.vdms.com/video/#Develop/AssetInfo.htm%3FTocPath%3DDevelop%7CClient%2520(Media%2520Player)%7C_____1 | Asset Info}.
|
|
7058
7430
|
*
|
|
7431
|
+
* @category Verizon Media
|
|
7059
7432
|
* @public
|
|
7060
7433
|
*/
|
|
7061
7434
|
interface VerizonMediaAssetInfoResponse {
|
|
@@ -7191,12 +7564,14 @@ interface VerizonMediaAssetInfoResponse {
|
|
|
7191
7564
|
* @remarks
|
|
7192
7565
|
* <br/> - See {@link https://docs.vdms.com/video/#Setup/Boundaries-Setup-Playback.htm | Boundaries }
|
|
7193
7566
|
*
|
|
7567
|
+
* @category Verizon Media
|
|
7194
7568
|
* @public
|
|
7195
7569
|
*/
|
|
7196
7570
|
type Boundary = BoundaryC3 | BoundaryC7 | BoundaryHalftime;
|
|
7197
7571
|
/**
|
|
7198
7572
|
* Represents the information of an ad boundary.
|
|
7199
7573
|
*
|
|
7574
|
+
* @category Verizon Media
|
|
7200
7575
|
* @public
|
|
7201
7576
|
*/
|
|
7202
7577
|
interface BoundaryInfo {
|
|
@@ -7212,6 +7587,7 @@ interface BoundaryInfo {
|
|
|
7212
7587
|
/**
|
|
7213
7588
|
* Represents the boundary of an ad that is relevant for up to three days after the original airing.
|
|
7214
7589
|
*
|
|
7590
|
+
* @category Verizon Media
|
|
7215
7591
|
* @public
|
|
7216
7592
|
*/
|
|
7217
7593
|
interface BoundaryC3 {
|
|
@@ -7220,6 +7596,7 @@ interface BoundaryC3 {
|
|
|
7220
7596
|
/**
|
|
7221
7597
|
* Represents the boundary of an ad that is relevant for up to seven days after the original airing.
|
|
7222
7598
|
*
|
|
7599
|
+
* @category Verizon Media
|
|
7223
7600
|
* @public
|
|
7224
7601
|
*/
|
|
7225
7602
|
interface BoundaryC7 {
|
|
@@ -7228,6 +7605,7 @@ interface BoundaryC7 {
|
|
|
7228
7605
|
/**
|
|
7229
7606
|
* Represents the boundary that identifies special content.
|
|
7230
7607
|
*
|
|
7608
|
+
* @category Verizon Media
|
|
7231
7609
|
* @public
|
|
7232
7610
|
*/
|
|
7233
7611
|
interface BoundaryHalftime {
|
|
@@ -7236,6 +7614,7 @@ interface BoundaryHalftime {
|
|
|
7236
7614
|
/**
|
|
7237
7615
|
* Represents the resolution of a Verizon Media thumbnail.
|
|
7238
7616
|
*
|
|
7617
|
+
* @category Verizon Media
|
|
7239
7618
|
* @public
|
|
7240
7619
|
*/
|
|
7241
7620
|
interface ThumbnailResolution {
|
|
@@ -7282,6 +7661,7 @@ interface ThumbnailResolution {
|
|
|
7282
7661
|
* In the online documentation the value for 0 is also "NOT RATED". Since this is counter-intuitive, we have assumed
|
|
7283
7662
|
* this to be erronous and have modeled this according to the Movie Ratings, with 0 being "NOT APPLICABLE".
|
|
7284
7663
|
*
|
|
7664
|
+
* @category Verizon Media
|
|
7285
7665
|
* @public
|
|
7286
7666
|
*/
|
|
7287
7667
|
type VerizonMediaAssetTvRating = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
|
|
@@ -7297,6 +7677,7 @@ type VerizonMediaAssetTvRating = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
|
|
|
7297
7677
|
* <br/> - `6` (X)
|
|
7298
7678
|
* <br/> - `7` (NOT_RATED)
|
|
7299
7679
|
*
|
|
7680
|
+
* @category Verizon Media
|
|
7300
7681
|
* @public
|
|
7301
7682
|
*/
|
|
7302
7683
|
type VerizonMediaAssetMovieRating = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
|
|
@@ -7304,6 +7685,8 @@ type VerizonMediaAssetMovieRating = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
|
|
|
7304
7685
|
/**
|
|
7305
7686
|
* Fired when an asset info response is received.
|
|
7306
7687
|
*
|
|
7688
|
+
* @category Verizon Media
|
|
7689
|
+
* @category Events
|
|
7307
7690
|
* @public
|
|
7308
7691
|
*/
|
|
7309
7692
|
interface VerizonMediaAssetInfoResponseEvent extends Event<'assetinforesponse'> {
|
|
@@ -7316,6 +7699,7 @@ interface VerizonMediaAssetInfoResponseEvent extends Event<'assetinforesponse'>
|
|
|
7316
7699
|
/**
|
|
7317
7700
|
* Represents a Verizon Media response with advertisement information for live assets.
|
|
7318
7701
|
*
|
|
7702
|
+
* @category Verizon Media
|
|
7319
7703
|
* @public
|
|
7320
7704
|
*/
|
|
7321
7705
|
interface VerizonMediaResponseLiveAds {
|
|
@@ -7330,6 +7714,7 @@ interface VerizonMediaResponseLiveAds {
|
|
|
7330
7714
|
/**
|
|
7331
7715
|
* Represents a Verizon Media response for live ad breaks.
|
|
7332
7716
|
*
|
|
7717
|
+
* @category Verizon Media
|
|
7333
7718
|
* @public
|
|
7334
7719
|
*/
|
|
7335
7720
|
interface VerizonMediaResponseLiveAdBreak {
|
|
@@ -7386,6 +7771,7 @@ interface VerizonMediaResponseLiveAdBreak {
|
|
|
7386
7771
|
/**
|
|
7387
7772
|
* Represents a Verizon Media response with live ads.
|
|
7388
7773
|
*
|
|
7774
|
+
* @category Verizon Media
|
|
7389
7775
|
* @public
|
|
7390
7776
|
*/
|
|
7391
7777
|
interface VerizonMediaResponseLiveAd {
|
|
@@ -7456,6 +7842,7 @@ interface VerizonMediaResponseLiveAd {
|
|
|
7456
7842
|
* @remarks
|
|
7457
7843
|
* <br/> - See {@link https://docs.vdms.com/video/#Develop/Pingv2.htm%3FTocPath%3DDevelop%7CClient%2520(Media%2520Player)%7C_____3 | Ping API (Version 2)}.
|
|
7458
7844
|
*
|
|
7845
|
+
* @category Verizon Media
|
|
7459
7846
|
* @public
|
|
7460
7847
|
*/
|
|
7461
7848
|
interface VerizonMediaPingResponse {
|
|
@@ -7490,6 +7877,8 @@ interface VerizonMediaPingResponse {
|
|
|
7490
7877
|
/**
|
|
7491
7878
|
* Fired when a Ping response is received.
|
|
7492
7879
|
*
|
|
7880
|
+
* @category Verizon Media
|
|
7881
|
+
* @category Events
|
|
7493
7882
|
* @public
|
|
7494
7883
|
*/
|
|
7495
7884
|
interface VerizonMediaPingResponseEvent extends Event<'pingresponse'> {
|
|
@@ -7502,6 +7891,8 @@ interface VerizonMediaPingResponseEvent extends Event<'pingresponse'> {
|
|
|
7502
7891
|
/**
|
|
7503
7892
|
* Fired when an error or invalid response is received from the Ping API.
|
|
7504
7893
|
*
|
|
7894
|
+
* @category Verizon Media
|
|
7895
|
+
* @category Events
|
|
7505
7896
|
* @public
|
|
7506
7897
|
*/
|
|
7507
7898
|
interface VerizonMediaPingErrorEvent extends Event<'pingerror'> {
|
|
@@ -7514,6 +7905,7 @@ interface VerizonMediaPingErrorEvent extends Event<'pingerror'> {
|
|
|
7514
7905
|
/**
|
|
7515
7906
|
* Represents a Verizon Media asset.
|
|
7516
7907
|
*
|
|
7908
|
+
* @category Verizon Media
|
|
7517
7909
|
* @public
|
|
7518
7910
|
*/
|
|
7519
7911
|
interface VerizonMediaAsset {
|
|
@@ -7649,6 +8041,8 @@ interface VerizonMediaAsset {
|
|
|
7649
8041
|
/**
|
|
7650
8042
|
* Fired when an asset is added.
|
|
7651
8043
|
*
|
|
8044
|
+
* @category Verizon Media
|
|
8045
|
+
* @category Events
|
|
7652
8046
|
* @public
|
|
7653
8047
|
*/
|
|
7654
8048
|
interface VerizonMediaAddAssetEvent extends Event<'addasset'> {
|
|
@@ -7661,6 +8055,8 @@ interface VerizonMediaAddAssetEvent extends Event<'addasset'> {
|
|
|
7661
8055
|
/**
|
|
7662
8056
|
* Fired when an asset is removed.
|
|
7663
8057
|
*
|
|
8058
|
+
* @category Verizon Media
|
|
8059
|
+
* @category Events
|
|
7664
8060
|
* @public
|
|
7665
8061
|
*/
|
|
7666
8062
|
interface VerizonMediaRemoveAssetEvent extends Event<'removeasset'> {
|
|
@@ -7673,6 +8069,7 @@ interface VerizonMediaRemoveAssetEvent extends Event<'removeasset'> {
|
|
|
7673
8069
|
/**
|
|
7674
8070
|
* The events fired by the {@link VerizonMediaAssetList}.
|
|
7675
8071
|
*
|
|
8072
|
+
* @category Verizon Media
|
|
7676
8073
|
* @public
|
|
7677
8074
|
*/
|
|
7678
8075
|
interface VerizonMediaAssetEventMap {
|
|
@@ -7688,6 +8085,7 @@ interface VerizonMediaAssetEventMap {
|
|
|
7688
8085
|
/**
|
|
7689
8086
|
* List of Verizon Media assets.
|
|
7690
8087
|
*
|
|
8088
|
+
* @category Verizon Media
|
|
7691
8089
|
* @public
|
|
7692
8090
|
*/
|
|
7693
8091
|
interface VerizonMediaAssetList extends EventedList<VerizonMediaAsset, VerizonMediaAssetEventMap> {
|
|
@@ -7696,6 +8094,7 @@ interface VerizonMediaAssetList extends EventedList<VerizonMediaAsset, VerizonMe
|
|
|
7696
8094
|
/**
|
|
7697
8095
|
* The events fired by the {@link VerizonMedia | Verizon Media API}.
|
|
7698
8096
|
*
|
|
8097
|
+
* @category Verizon Media
|
|
7699
8098
|
* @public
|
|
7700
8099
|
*/
|
|
7701
8100
|
interface VerizonMediaEventMap {
|
|
@@ -7722,6 +8121,7 @@ interface VerizonMediaEventMap {
|
|
|
7722
8121
|
* @remarks
|
|
7723
8122
|
* <br/> - Only available with the feature 'verizonmedia'.
|
|
7724
8123
|
*
|
|
8124
|
+
* @category Verizon Media
|
|
7725
8125
|
* @public
|
|
7726
8126
|
*/
|
|
7727
8127
|
interface VerizonMedia extends EventDispatcher<VerizonMediaEventMap> {
|
|
@@ -7738,6 +8138,7 @@ interface VerizonMedia extends EventDispatcher<VerizonMediaEventMap> {
|
|
|
7738
8138
|
/**
|
|
7739
8139
|
* The events fired by the {@link Yospace | Yospace API}.
|
|
7740
8140
|
*
|
|
8141
|
+
* @category SSAI
|
|
7741
8142
|
* @public
|
|
7742
8143
|
*/
|
|
7743
8144
|
interface YospaceEventMap {
|
|
@@ -7752,6 +8153,7 @@ interface YospaceEventMap {
|
|
|
7752
8153
|
* @remarks
|
|
7753
8154
|
* <br/> - These callbacks will be used by the Yospace SDK to provide feedback to the player.
|
|
7754
8155
|
*
|
|
8156
|
+
* @category SSAI
|
|
7755
8157
|
* @public
|
|
7756
8158
|
*/
|
|
7757
8159
|
interface YospaceCallbackObject {
|
|
@@ -7768,6 +8170,7 @@ interface YospaceCallbackObject {
|
|
|
7768
8170
|
* @remarks
|
|
7769
8171
|
* <br/> - Available since v2.14.7.
|
|
7770
8172
|
*
|
|
8173
|
+
* @category SSAI
|
|
7771
8174
|
* @public
|
|
7772
8175
|
*/
|
|
7773
8176
|
interface Yospace extends EventDispatcher<YospaceEventMap> {
|
|
@@ -7790,12 +8193,16 @@ interface Yospace extends EventDispatcher<YospaceEventMap> {
|
|
|
7790
8193
|
/**
|
|
7791
8194
|
* An error code whose category is `ErrorCategory.CONTENT_PROTECTION`.
|
|
7792
8195
|
*
|
|
8196
|
+
* @category Content Protection
|
|
8197
|
+
* @category Errors
|
|
7793
8198
|
* @public
|
|
7794
8199
|
*/
|
|
7795
8200
|
type ContentProtectionErrorCode = ErrorCode.CONTENT_PROTECTION_ERROR | ErrorCode.CONTENT_PROTECTION_NOT_SUPPORTED | ErrorCode.CONTENT_PROTECTION_CONFIGURATION_MISSING | ErrorCode.CONTENT_PROTECTION_CONFIGURATION_INVALID | ErrorCode.CONTENT_PROTECTION_INITIALIZATION_INVALID | ErrorCode.CONTENT_PROTECTION_CERTIFICATE_ERROR | ErrorCode.CONTENT_PROTECTION_CERTIFICATE_INVALID | ErrorCode.CONTENT_PROTECTION_LICENSE_ERROR | ErrorCode.CONTENT_PROTECTION_LICENSE_INVALID | ErrorCode.CONTENT_PROTECTION_KEY_EXPIRED | ErrorCode.CONTENT_PROTECTION_KEY_MISSING | ErrorCode.CONTENT_PROTECTION_OUTPUT_RESTRICTED | ErrorCode.CONTENT_PROTECTION_INTERNAL_ERROR;
|
|
7796
8201
|
/**
|
|
7797
8202
|
* An error related to content protection.
|
|
7798
8203
|
*
|
|
8204
|
+
* @category Content Protection
|
|
8205
|
+
* @category Errors
|
|
7799
8206
|
* @public
|
|
7800
8207
|
*/
|
|
7801
8208
|
interface ContentProtectionError extends THEOplayerError {
|
|
@@ -7843,6 +8250,9 @@ interface ContentProtectionError extends THEOplayerError {
|
|
|
7843
8250
|
/**
|
|
7844
8251
|
* Fired when an error related to content protection occurs.
|
|
7845
8252
|
*
|
|
8253
|
+
* @category Content Protection
|
|
8254
|
+
* @category Errors
|
|
8255
|
+
* @category Events
|
|
7846
8256
|
* @public
|
|
7847
8257
|
*/
|
|
7848
8258
|
interface ContentProtectionErrorEvent extends Event<'contentprotectionerror'> {
|
|
@@ -7886,6 +8296,7 @@ interface ContentProtectionErrorEvent extends Event<'contentprotectionerror'> {
|
|
|
7886
8296
|
* <br/> - Only available with the feature `'hesp'`.
|
|
7887
8297
|
* <br/> - Only applies to HESP streams.
|
|
7888
8298
|
*
|
|
8299
|
+
* @category HESP
|
|
7889
8300
|
* @public
|
|
7890
8301
|
*/
|
|
7891
8302
|
interface HespLatencyConfiguration {
|
|
@@ -7916,6 +8327,7 @@ interface HespLatencyConfiguration {
|
|
|
7916
8327
|
* <br/> - Only available with the feature `'hesp'`.
|
|
7917
8328
|
* <br/> - Only available when an HESP source is playing.
|
|
7918
8329
|
*
|
|
8330
|
+
* @category HESP
|
|
7919
8331
|
* @public
|
|
7920
8332
|
*/
|
|
7921
8333
|
interface HespApiEventMap {
|
|
@@ -7934,6 +8346,7 @@ interface HespApiEventMap {
|
|
|
7934
8346
|
* <br/> - Note: This API is in an experimental stage and may be subject to breaking changes.
|
|
7935
8347
|
* <br/> - Only available with the feature `'hesp'`.
|
|
7936
8348
|
*
|
|
8349
|
+
* @category HESP
|
|
7937
8350
|
* @public
|
|
7938
8351
|
*/
|
|
7939
8352
|
interface HespApi extends EventDispatcher<HespApiEventMap> {
|
|
@@ -7986,6 +8399,8 @@ interface HespApi extends EventDispatcher<HespApiEventMap> {
|
|
|
7986
8399
|
* <br/> - Only available with the feature `'hesp'`.
|
|
7987
8400
|
* <br/> - Only applicable when configuring an HESP source.
|
|
7988
8401
|
*
|
|
8402
|
+
* @category HESP
|
|
8403
|
+
* @category Source
|
|
7989
8404
|
* @public
|
|
7990
8405
|
*/
|
|
7991
8406
|
interface HespSourceConfiguration {
|
|
@@ -7997,6 +8412,8 @@ interface HespSourceConfiguration {
|
|
|
7997
8412
|
* <br/> - Only available with the feature `'hesp'`.
|
|
7998
8413
|
* <br/> - Only applicable when configuring an HESP source.
|
|
7999
8414
|
*
|
|
8415
|
+
* @category HESP
|
|
8416
|
+
* @category Source
|
|
8000
8417
|
* @public
|
|
8001
8418
|
*/
|
|
8002
8419
|
interface HespTypedSource extends TypedSource {
|
|
@@ -8037,6 +8454,7 @@ interface Latencies {
|
|
|
8037
8454
|
/**
|
|
8038
8455
|
* Represents a DASH representation.
|
|
8039
8456
|
*
|
|
8457
|
+
* @category Media and Text Tracks
|
|
8040
8458
|
* @public
|
|
8041
8459
|
*/
|
|
8042
8460
|
interface Representation {
|
|
@@ -8081,6 +8499,7 @@ interface Representation {
|
|
|
8081
8499
|
/**
|
|
8082
8500
|
* Fired when `ChromelessPlayer.source` changes.
|
|
8083
8501
|
*
|
|
8502
|
+
* @category Events
|
|
8084
8503
|
* @public
|
|
8085
8504
|
*/
|
|
8086
8505
|
interface SourceChangeEvent extends Event<'sourcechange'> {
|
|
@@ -8092,6 +8511,7 @@ interface SourceChangeEvent extends Event<'sourcechange'> {
|
|
|
8092
8511
|
/**
|
|
8093
8512
|
* Fired when the current source, which is chosen from {@link SourceDescription.sources | ChromelessPlayer.source.sources}, changes.
|
|
8094
8513
|
*
|
|
8514
|
+
* @category Events
|
|
8095
8515
|
* @public
|
|
8096
8516
|
*/
|
|
8097
8517
|
interface CurrentSourceChangeEvent extends Event<'currentsourcechange'> {
|
|
@@ -8103,6 +8523,7 @@ interface CurrentSourceChangeEvent extends Event<'currentsourcechange'> {
|
|
|
8103
8523
|
/**
|
|
8104
8524
|
* Fired when `ChromelessPlayer.paused` changes to `false`.
|
|
8105
8525
|
*
|
|
8526
|
+
* @category Events
|
|
8106
8527
|
* @public
|
|
8107
8528
|
*/
|
|
8108
8529
|
interface PlayEvent extends Event<'play'> {
|
|
@@ -8114,6 +8535,7 @@ interface PlayEvent extends Event<'play'> {
|
|
|
8114
8535
|
/**
|
|
8115
8536
|
* Fired when `ChromelessPlayer.paused` changes to `true`.
|
|
8116
8537
|
*
|
|
8538
|
+
* @category Events
|
|
8117
8539
|
* @public
|
|
8118
8540
|
*/
|
|
8119
8541
|
interface PauseEvent extends Event<'pause'> {
|
|
@@ -8125,6 +8547,7 @@ interface PauseEvent extends Event<'pause'> {
|
|
|
8125
8547
|
/**
|
|
8126
8548
|
* Fired when `ChromelessPlayer.seeking` changes to `true`, and the player has started seeking to a new position.
|
|
8127
8549
|
*
|
|
8550
|
+
* @category Events
|
|
8128
8551
|
* @public
|
|
8129
8552
|
*/
|
|
8130
8553
|
interface SeekingEvent extends Event<'seeking'> {
|
|
@@ -8136,6 +8559,7 @@ interface SeekingEvent extends Event<'seeking'> {
|
|
|
8136
8559
|
/**
|
|
8137
8560
|
* Fired when `ChromelessPlayer.seeking` changes to `false` after the current playback position was changed.
|
|
8138
8561
|
*
|
|
8562
|
+
* @category Events
|
|
8139
8563
|
* @public
|
|
8140
8564
|
*/
|
|
8141
8565
|
interface SeekedEvent extends Event<'seeked'> {
|
|
@@ -8147,6 +8571,7 @@ interface SeekedEvent extends Event<'seeked'> {
|
|
|
8147
8571
|
/**
|
|
8148
8572
|
* Fired when the current playback position changed as part of normal playback or in an especially interesting way, for example discontinuously.
|
|
8149
8573
|
*
|
|
8574
|
+
* @category Events
|
|
8150
8575
|
* @public
|
|
8151
8576
|
*/
|
|
8152
8577
|
interface TimeUpdateEvent extends Event<'timeupdate'> {
|
|
@@ -8162,6 +8587,7 @@ interface TimeUpdateEvent extends Event<'timeupdate'> {
|
|
|
8162
8587
|
/**
|
|
8163
8588
|
* Fired when playback has stopped because the end of the media resource was reached.
|
|
8164
8589
|
*
|
|
8590
|
+
* @category Events
|
|
8165
8591
|
* @public
|
|
8166
8592
|
*/
|
|
8167
8593
|
interface EndedEvent extends Event<'ended'> {
|
|
@@ -8173,6 +8599,7 @@ interface EndedEvent extends Event<'ended'> {
|
|
|
8173
8599
|
/**
|
|
8174
8600
|
* Fired when playback is ready to start after having been paused or delayed due to lack of media data.
|
|
8175
8601
|
*
|
|
8602
|
+
* @category Events
|
|
8176
8603
|
* @public
|
|
8177
8604
|
*/
|
|
8178
8605
|
interface PlayingEvent extends Event<'playing'> {
|
|
@@ -8184,6 +8611,7 @@ interface PlayingEvent extends Event<'playing'> {
|
|
|
8184
8611
|
/**
|
|
8185
8612
|
* Fired when playback has stopped because the next frame is not available, but the player expects that frame to become available in due course.
|
|
8186
8613
|
*
|
|
8614
|
+
* @category Events
|
|
8187
8615
|
* @public
|
|
8188
8616
|
*/
|
|
8189
8617
|
interface WaitingEvent extends Event<'waiting'> {
|
|
@@ -8195,6 +8623,7 @@ interface WaitingEvent extends Event<'waiting'> {
|
|
|
8195
8623
|
/**
|
|
8196
8624
|
* Fired when `ChromelessPlayer.readyState` changes.
|
|
8197
8625
|
*
|
|
8626
|
+
* @category Events
|
|
8198
8627
|
* @public
|
|
8199
8628
|
*/
|
|
8200
8629
|
interface ReadyStateChangeEvent extends Event<'readystatechange'> {
|
|
@@ -8210,6 +8639,7 @@ interface ReadyStateChangeEvent extends Event<'readystatechange'> {
|
|
|
8210
8639
|
/**
|
|
8211
8640
|
* Fired when the player determines the duration and dimensions of the media resource.
|
|
8212
8641
|
*
|
|
8642
|
+
* @category Events
|
|
8213
8643
|
* @public
|
|
8214
8644
|
*/
|
|
8215
8645
|
interface LoadedMetadataEvent extends Event<'loadedmetadata'> {
|
|
@@ -8225,6 +8655,7 @@ interface LoadedMetadataEvent extends Event<'loadedmetadata'> {
|
|
|
8225
8655
|
/**
|
|
8226
8656
|
* Fired when the player can render the media data at the current playback position for the first time.
|
|
8227
8657
|
*
|
|
8658
|
+
* @category Events
|
|
8228
8659
|
* @public
|
|
8229
8660
|
*/
|
|
8230
8661
|
interface LoadedDataEvent extends Event<'loadeddata'> {
|
|
@@ -8240,6 +8671,7 @@ interface LoadedDataEvent extends Event<'loadeddata'> {
|
|
|
8240
8671
|
/**
|
|
8241
8672
|
* Fired when the player can resume playback of the media data.
|
|
8242
8673
|
*
|
|
8674
|
+
* @category Events
|
|
8243
8675
|
* @public
|
|
8244
8676
|
*/
|
|
8245
8677
|
interface CanPlayEvent extends Event<'canplay'> {
|
|
@@ -8255,6 +8687,7 @@ interface CanPlayEvent extends Event<'canplay'> {
|
|
|
8255
8687
|
/**
|
|
8256
8688
|
* Fired when the player can resume playback of the media data and buffering is unlikely.
|
|
8257
8689
|
*
|
|
8690
|
+
* @category Events
|
|
8258
8691
|
* @public
|
|
8259
8692
|
*/
|
|
8260
8693
|
interface CanPlayThroughEvent extends Event<'canplaythrough'> {
|
|
@@ -8270,6 +8703,7 @@ interface CanPlayThroughEvent extends Event<'canplaythrough'> {
|
|
|
8270
8703
|
/**
|
|
8271
8704
|
* Fired when the player's source is cleared.
|
|
8272
8705
|
*
|
|
8706
|
+
* @category Events
|
|
8273
8707
|
* @public
|
|
8274
8708
|
*/
|
|
8275
8709
|
interface EmptiedEvent extends Event<'emptied'> {
|
|
@@ -8285,6 +8719,7 @@ interface EmptiedEvent extends Event<'emptied'> {
|
|
|
8285
8719
|
/**
|
|
8286
8720
|
* Fired when the player loaded media data.
|
|
8287
8721
|
*
|
|
8722
|
+
* @category Events
|
|
8288
8723
|
* @public
|
|
8289
8724
|
*/
|
|
8290
8725
|
interface ProgressEvent extends Event<'progress'> {
|
|
@@ -8296,6 +8731,7 @@ interface ProgressEvent extends Event<'progress'> {
|
|
|
8296
8731
|
/**
|
|
8297
8732
|
* Fired when `ChromelessPlayer.duration` changes.
|
|
8298
8733
|
*
|
|
8734
|
+
* @category Events
|
|
8299
8735
|
* @public
|
|
8300
8736
|
*/
|
|
8301
8737
|
interface DurationChangeEvent extends Event<'durationchange'> {
|
|
@@ -8307,6 +8743,7 @@ interface DurationChangeEvent extends Event<'durationchange'> {
|
|
|
8307
8743
|
/**
|
|
8308
8744
|
* Fired when `ChromelessPlayer.volume` changes.
|
|
8309
8745
|
*
|
|
8746
|
+
* @category Events
|
|
8310
8747
|
* @public
|
|
8311
8748
|
*/
|
|
8312
8749
|
interface VolumeChangeEvent extends Event<'volumechange'> {
|
|
@@ -8318,6 +8755,7 @@ interface VolumeChangeEvent extends Event<'volumechange'> {
|
|
|
8318
8755
|
/**
|
|
8319
8756
|
* Fired when the current representation changes.
|
|
8320
8757
|
*
|
|
8758
|
+
* @category Events
|
|
8321
8759
|
* @public
|
|
8322
8760
|
*/
|
|
8323
8761
|
interface RepresentationChangeEvent extends Event<'representationchange'> {
|
|
@@ -8333,6 +8771,7 @@ interface RepresentationChangeEvent extends Event<'representationchange'> {
|
|
|
8333
8771
|
/**
|
|
8334
8772
|
* Fired when `ChromelessPlayer.playbackRate` changes.
|
|
8335
8773
|
*
|
|
8774
|
+
* @category Events
|
|
8336
8775
|
* @public
|
|
8337
8776
|
*/
|
|
8338
8777
|
interface RateChangeEvent extends Event<'ratechange'> {
|
|
@@ -8344,6 +8783,7 @@ interface RateChangeEvent extends Event<'ratechange'> {
|
|
|
8344
8783
|
/**
|
|
8345
8784
|
* Fired when the dimensions of the HTML element changes.
|
|
8346
8785
|
*
|
|
8786
|
+
* @category Events
|
|
8347
8787
|
* @public
|
|
8348
8788
|
*/
|
|
8349
8789
|
interface DimensionChangeEvent extends Event<'dimensionchange'> {
|
|
@@ -8359,6 +8799,7 @@ interface DimensionChangeEvent extends Event<'dimensionchange'> {
|
|
|
8359
8799
|
/**
|
|
8360
8800
|
* Fired when the player encounters key system initialization data in the media data.
|
|
8361
8801
|
*
|
|
8802
|
+
* @category Events
|
|
8362
8803
|
* @public
|
|
8363
8804
|
*/
|
|
8364
8805
|
interface EncryptedEvent extends Event<'encrypted'> {
|
|
@@ -8379,6 +8820,7 @@ interface EncryptedEvent extends Event<'encrypted'> {
|
|
|
8379
8820
|
/**
|
|
8380
8821
|
* The latency manager, used to control low-latency live playback.
|
|
8381
8822
|
*
|
|
8823
|
+
* @category Player
|
|
8382
8824
|
* @public
|
|
8383
8825
|
*/
|
|
8384
8826
|
interface LatencyManager {
|
|
@@ -8416,6 +8858,7 @@ interface LatencyManager {
|
|
|
8416
8858
|
/**
|
|
8417
8859
|
* The latency configuration for managing the live offset of the player.
|
|
8418
8860
|
*
|
|
8861
|
+
* @category Player
|
|
8419
8862
|
* @public
|
|
8420
8863
|
*/
|
|
8421
8864
|
interface LatencyConfiguration {
|
|
@@ -8481,6 +8924,7 @@ interface TimeRanges {
|
|
|
8481
8924
|
/**
|
|
8482
8925
|
* The events fired by the {@link ChromelessPlayer}.
|
|
8483
8926
|
*
|
|
8927
|
+
* @category Player
|
|
8484
8928
|
* @public
|
|
8485
8929
|
*/
|
|
8486
8930
|
interface PlayerEventMap {
|
|
@@ -8682,6 +9126,8 @@ interface PlayerEventMap {
|
|
|
8682
9126
|
/**
|
|
8683
9127
|
* The player API.
|
|
8684
9128
|
*
|
|
9129
|
+
* @category API
|
|
9130
|
+
* @category Player
|
|
8685
9131
|
* @public
|
|
8686
9132
|
*/
|
|
8687
9133
|
declare class ChromelessPlayer implements EventDispatcher<PlayerEventMap> {
|
|
@@ -9024,12 +9470,14 @@ declare class ChromelessPlayer implements EventDispatcher<PlayerEventMap> {
|
|
|
9024
9470
|
* <br/> - `'bottom-left'`
|
|
9025
9471
|
* <br/> - `'bottom-right'`
|
|
9026
9472
|
*
|
|
9473
|
+
* @category UI
|
|
9027
9474
|
* @public
|
|
9028
9475
|
*/
|
|
9029
9476
|
type PiPPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
|
|
9030
9477
|
/**
|
|
9031
9478
|
* Describes the configuration of the picture-in-picture feature.
|
|
9032
9479
|
*
|
|
9480
|
+
* @category UI
|
|
9033
9481
|
* @public
|
|
9034
9482
|
*/
|
|
9035
9483
|
interface PiPConfiguration {
|
|
@@ -9059,6 +9507,7 @@ interface PiPConfiguration {
|
|
|
9059
9507
|
/**
|
|
9060
9508
|
* Describes the UI related configuration of the player.
|
|
9061
9509
|
*
|
|
9510
|
+
* @category UI
|
|
9062
9511
|
* @public
|
|
9063
9512
|
*/
|
|
9064
9513
|
interface UIPlayerConfiguration extends PlayerConfiguration {
|
|
@@ -9086,6 +9535,7 @@ interface UIPlayerConfiguration extends PlayerConfiguration {
|
|
|
9086
9535
|
/**
|
|
9087
9536
|
* Describes the UI configuration of the player.
|
|
9088
9537
|
*
|
|
9538
|
+
* @category UI
|
|
9089
9539
|
* @public
|
|
9090
9540
|
*/
|
|
9091
9541
|
interface UIConfiguration {
|
|
@@ -9166,7 +9616,7 @@ interface UIConfiguration {
|
|
|
9166
9616
|
*/
|
|
9167
9617
|
fullscreenOptions?: FullscreenOptions$1;
|
|
9168
9618
|
/**
|
|
9169
|
-
* Actions that define the behavior of the player
|
|
9619
|
+
* Actions that define the behavior of the player.
|
|
9170
9620
|
*
|
|
9171
9621
|
* @remarks
|
|
9172
9622
|
* <br/> - Available since v4.3.0
|
|
@@ -9174,18 +9624,25 @@ interface UIConfiguration {
|
|
|
9174
9624
|
userActions?: UserActions;
|
|
9175
9625
|
}
|
|
9176
9626
|
/**
|
|
9177
|
-
*
|
|
9178
|
-
*
|
|
9627
|
+
* A record used to map localization.
|
|
9628
|
+
* Each entry contains a translation of an English string.
|
|
9179
9629
|
*
|
|
9630
|
+
* @category UI
|
|
9180
9631
|
* @public
|
|
9181
9632
|
*/
|
|
9182
9633
|
type UILanguage = Record<string, string>;
|
|
9183
9634
|
/**
|
|
9635
|
+
* Options to control transitions to fullscreen mode.
|
|
9636
|
+
*
|
|
9637
|
+
* @remarks
|
|
9638
|
+
* <br/> - Available since v2.90.0.
|
|
9639
|
+
*
|
|
9640
|
+
* @category UI
|
|
9184
9641
|
* @public
|
|
9185
9642
|
*/
|
|
9186
9643
|
interface FullscreenOptions$1 {
|
|
9187
9644
|
/**
|
|
9188
|
-
* Whether
|
|
9645
|
+
* Whether to show navigation UI while in fullscreen.
|
|
9189
9646
|
*
|
|
9190
9647
|
* @remarks
|
|
9191
9648
|
* <p>On mobile devices, the platform may want to show a native on-screen navigation UI (such as a back button or home button)
|
|
@@ -9202,6 +9659,12 @@ interface FullscreenOptions$1 {
|
|
|
9202
9659
|
navigationUI?: 'auto' | 'show' | 'hide';
|
|
9203
9660
|
}
|
|
9204
9661
|
/**
|
|
9662
|
+
* Actions that define the behavior of the player.
|
|
9663
|
+
*
|
|
9664
|
+
* @remarks
|
|
9665
|
+
* <br/> - Available since v4.3.0
|
|
9666
|
+
*
|
|
9667
|
+
* @category UI
|
|
9205
9668
|
* @public
|
|
9206
9669
|
*/
|
|
9207
9670
|
interface UserActions {
|
|
@@ -9217,6 +9680,7 @@ interface UserActions {
|
|
|
9217
9680
|
/**
|
|
9218
9681
|
* List of players.
|
|
9219
9682
|
*
|
|
9683
|
+
* @category Player
|
|
9220
9684
|
* @public
|
|
9221
9685
|
*/
|
|
9222
9686
|
interface PlayerList extends Array<ChromelessPlayer> {
|
|
@@ -9237,6 +9701,7 @@ interface PlayerList extends Array<ChromelessPlayer> {
|
|
|
9237
9701
|
/**
|
|
9238
9702
|
* The {@link CachingTask}'s license API.
|
|
9239
9703
|
*
|
|
9704
|
+
* @category Caching
|
|
9240
9705
|
* @public
|
|
9241
9706
|
*/
|
|
9242
9707
|
interface CachingTaskLicense {
|
|
@@ -9251,6 +9716,7 @@ interface CachingTaskLicense {
|
|
|
9251
9716
|
/**
|
|
9252
9717
|
* Describes the configuration of a caching task.
|
|
9253
9718
|
*
|
|
9719
|
+
* @category Caching
|
|
9254
9720
|
* @public
|
|
9255
9721
|
*/
|
|
9256
9722
|
interface CachingTaskParameters {
|
|
@@ -9293,12 +9759,14 @@ interface CachingTaskParameters {
|
|
|
9293
9759
|
* <br/> - `'error'`: The task has encountered an error while downloading or evicting content.
|
|
9294
9760
|
* <br/> - `'evicted'`: All data associated with the task has been removed because the task expired or the user invoked the {@link CachingTask.remove|remove} method.
|
|
9295
9761
|
*
|
|
9762
|
+
* @category Caching
|
|
9296
9763
|
* @public
|
|
9297
9764
|
*/
|
|
9298
9765
|
type CacheTaskStatus = 'idle' | 'loading' | 'done' | 'error' | 'evicted';
|
|
9299
9766
|
/**
|
|
9300
9767
|
* The events fired by the {@link CachingTask}.
|
|
9301
9768
|
*
|
|
9769
|
+
* @category Caching
|
|
9302
9770
|
* @public
|
|
9303
9771
|
*/
|
|
9304
9772
|
interface CachingTaskEventMap {
|
|
@@ -9314,6 +9782,7 @@ interface CachingTaskEventMap {
|
|
|
9314
9782
|
/**
|
|
9315
9783
|
* Represents a caching task.
|
|
9316
9784
|
*
|
|
9785
|
+
* @category Caching
|
|
9317
9786
|
* @public
|
|
9318
9787
|
*/
|
|
9319
9788
|
interface CachingTask extends EventDispatcher<CachingTaskEventMap> {
|
|
@@ -9384,6 +9853,8 @@ interface CachingTask extends EventDispatcher<CachingTaskEventMap> {
|
|
|
9384
9853
|
/**
|
|
9385
9854
|
* Fired when a caching task is added.
|
|
9386
9855
|
*
|
|
9856
|
+
* @category Caching
|
|
9857
|
+
* @category Events
|
|
9387
9858
|
* @public
|
|
9388
9859
|
*/
|
|
9389
9860
|
interface AddCachingTaskEvent extends Event<'addtask'> {
|
|
@@ -9396,6 +9867,8 @@ interface AddCachingTaskEvent extends Event<'addtask'> {
|
|
|
9396
9867
|
/**
|
|
9397
9868
|
* Fired when a caching task is removed.
|
|
9398
9869
|
*
|
|
9870
|
+
* @category Caching
|
|
9871
|
+
* @category Events
|
|
9399
9872
|
* @public
|
|
9400
9873
|
*/
|
|
9401
9874
|
interface RemoveCachingTaskEvent extends Event<'removetask'> {
|
|
@@ -9408,6 +9881,7 @@ interface RemoveCachingTaskEvent extends Event<'removetask'> {
|
|
|
9408
9881
|
/**
|
|
9409
9882
|
* The events fired by the {@link CachingTaskList}.
|
|
9410
9883
|
*
|
|
9884
|
+
* @category Caching
|
|
9411
9885
|
* @public
|
|
9412
9886
|
*/
|
|
9413
9887
|
interface CachingTaskListEventMap {
|
|
@@ -9423,6 +9897,7 @@ interface CachingTaskListEventMap {
|
|
|
9423
9897
|
/**
|
|
9424
9898
|
* List of caching tasks.
|
|
9425
9899
|
*
|
|
9900
|
+
* @category Caching
|
|
9426
9901
|
* @public
|
|
9427
9902
|
*/
|
|
9428
9903
|
interface CachingTaskList extends EventedList<CachingTask, CachingTaskListEventMap> {
|
|
@@ -9433,12 +9908,14 @@ interface CachingTaskList extends EventedList<CachingTask, CachingTaskListEventM
|
|
|
9433
9908
|
* <br/> - `'uninitialised'`: Previously stored caching tasks are unavailable.
|
|
9434
9909
|
* <br/> - `'initialised'`: Previously stored caching tasks are now available.
|
|
9435
9910
|
*
|
|
9911
|
+
* @category Caching
|
|
9436
9912
|
* @public
|
|
9437
9913
|
*/
|
|
9438
9914
|
type CacheStatus = 'uninitialised' | 'initialised';
|
|
9439
9915
|
/**
|
|
9440
9916
|
* The events fired by the {@link Cache | cache API}.
|
|
9441
9917
|
*
|
|
9918
|
+
* @category Caching
|
|
9442
9919
|
* @public
|
|
9443
9920
|
*/
|
|
9444
9921
|
interface CacheEventMap {
|
|
@@ -9453,6 +9930,7 @@ interface CacheEventMap {
|
|
|
9453
9930
|
* @remarks
|
|
9454
9931
|
* <br/> - Available since v2.26.
|
|
9455
9932
|
*
|
|
9933
|
+
* @category Caching
|
|
9456
9934
|
* @public
|
|
9457
9935
|
*/
|
|
9458
9936
|
interface Cache extends EventDispatcher<CacheEventMap> {
|
|
@@ -9497,6 +9975,7 @@ interface CommonUtils {
|
|
|
9497
9975
|
|
|
9498
9976
|
/**
|
|
9499
9977
|
* A request, either for a certificate or a license.
|
|
9978
|
+
* @category Content Protection
|
|
9500
9979
|
* @public
|
|
9501
9980
|
*/
|
|
9502
9981
|
interface ContentProtectionRequest {
|
|
@@ -9535,11 +10014,13 @@ interface ContentProtectionRequest {
|
|
|
9535
10014
|
/**
|
|
9536
10015
|
* A request for a certificate.
|
|
9537
10016
|
*
|
|
10017
|
+
* @category Content Protection
|
|
9538
10018
|
* @public
|
|
9539
10019
|
*/
|
|
9540
10020
|
type CertificateRequest = ContentProtectionRequest;
|
|
9541
10021
|
/**
|
|
9542
10022
|
* A request for a license.
|
|
10023
|
+
* @category Content Protection
|
|
9543
10024
|
* @public
|
|
9544
10025
|
*/
|
|
9545
10026
|
interface LicenseRequest extends ContentProtectionRequest {
|
|
@@ -9554,6 +10035,7 @@ interface LicenseRequest extends ContentProtectionRequest {
|
|
|
9554
10035
|
|
|
9555
10036
|
/**
|
|
9556
10037
|
* The response, either of a license or for a certificate request.
|
|
10038
|
+
* @category Content Protection
|
|
9557
10039
|
* @public
|
|
9558
10040
|
*/
|
|
9559
10041
|
interface ContentProtectionResponse {
|
|
@@ -9589,6 +10071,7 @@ interface ContentProtectionResponse {
|
|
|
9589
10071
|
}
|
|
9590
10072
|
/**
|
|
9591
10073
|
* The response of a certificate request.
|
|
10074
|
+
* @category Content Protection
|
|
9592
10075
|
* @public
|
|
9593
10076
|
*/
|
|
9594
10077
|
interface CertificateResponse extends ContentProtectionResponse {
|
|
@@ -9599,6 +10082,7 @@ interface CertificateResponse extends ContentProtectionResponse {
|
|
|
9599
10082
|
}
|
|
9600
10083
|
/**
|
|
9601
10084
|
* The response of a license request.
|
|
10085
|
+
* @category Content Protection
|
|
9602
10086
|
* @public
|
|
9603
10087
|
*/
|
|
9604
10088
|
interface LicenseResponse extends ContentProtectionResponse {
|
|
@@ -9611,12 +10095,14 @@ interface LicenseResponse extends ContentProtectionResponse {
|
|
|
9611
10095
|
/**
|
|
9612
10096
|
* A synchronous or asynchronous return type
|
|
9613
10097
|
*
|
|
10098
|
+
* @category Content Protection
|
|
9614
10099
|
* @public
|
|
9615
10100
|
*/
|
|
9616
10101
|
type MaybeAsync<T> = T | PromiseLike<T>;
|
|
9617
10102
|
/**
|
|
9618
10103
|
* This ContentProtectionIntegration defines some methods to alter license and certificate requests and responses.
|
|
9619
10104
|
*
|
|
10105
|
+
* @category Content Protection
|
|
9620
10106
|
* @public
|
|
9621
10107
|
*/
|
|
9622
10108
|
interface ContentProtectionIntegration {
|
|
@@ -9695,6 +10181,7 @@ interface ContentProtectionIntegration {
|
|
|
9695
10181
|
/**
|
|
9696
10182
|
* Factory pattern to create {@link ContentProtectionIntegration}s.
|
|
9697
10183
|
*
|
|
10184
|
+
* @category Content Protection
|
|
9698
10185
|
* @public
|
|
9699
10186
|
*/
|
|
9700
10187
|
interface ContentProtectionIntegrationFactory {
|
|
@@ -9709,6 +10196,8 @@ interface ContentProtectionIntegrationFactory {
|
|
|
9709
10196
|
/**
|
|
9710
10197
|
* The identifier of the Axinom integration.
|
|
9711
10198
|
*
|
|
10199
|
+
* @category Source
|
|
10200
|
+
* @category Content Protection
|
|
9712
10201
|
* @public
|
|
9713
10202
|
*/
|
|
9714
10203
|
type AxinomIntegrationID = 'axinom';
|
|
@@ -9727,6 +10216,8 @@ type AxinomIntegrationID = 'axinom';
|
|
|
9727
10216
|
* }
|
|
9728
10217
|
* ```
|
|
9729
10218
|
*
|
|
10219
|
+
* @category Source
|
|
10220
|
+
* @category Content Protection
|
|
9730
10221
|
* @public
|
|
9731
10222
|
*/
|
|
9732
10223
|
interface AxinomDRMConfiguration extends DRMConfiguration {
|
|
@@ -9746,12 +10237,16 @@ interface AxinomDRMConfiguration extends DRMConfiguration {
|
|
|
9746
10237
|
/**
|
|
9747
10238
|
* The identifier of the Azure Media Services integration.
|
|
9748
10239
|
*
|
|
10240
|
+
* @category Source
|
|
10241
|
+
* @category Content Protection
|
|
9749
10242
|
* @public
|
|
9750
10243
|
*/
|
|
9751
10244
|
type AzureIntegrationID = 'azure';
|
|
9752
10245
|
/**
|
|
9753
10246
|
* Describes the configuration of the Azure Media Services DRM integration.
|
|
9754
10247
|
*
|
|
10248
|
+
* @category Source
|
|
10249
|
+
* @category Content Protection
|
|
9755
10250
|
* @public
|
|
9756
10251
|
*/
|
|
9757
10252
|
interface AzureDRMConfiguration extends DRMConfiguration {
|
|
@@ -9771,6 +10266,8 @@ interface AzureDRMConfiguration extends DRMConfiguration {
|
|
|
9771
10266
|
/**
|
|
9772
10267
|
* The identifier of the Comcast integration.
|
|
9773
10268
|
*
|
|
10269
|
+
* @category Source
|
|
10270
|
+
* @category Content Protection
|
|
9774
10271
|
* @public
|
|
9775
10272
|
*/
|
|
9776
10273
|
type ComcastIntegrationID = 'comcast';
|
|
@@ -9788,6 +10285,8 @@ type ComcastIntegrationID = 'comcast';
|
|
|
9788
10285
|
* }
|
|
9789
10286
|
* ```
|
|
9790
10287
|
*
|
|
10288
|
+
* @category Source
|
|
10289
|
+
* @category Content Protection
|
|
9791
10290
|
* @public
|
|
9792
10291
|
*/
|
|
9793
10292
|
interface ComcastDRMConfiguration extends DRMConfiguration {
|
|
@@ -9816,6 +10315,8 @@ interface ComcastDRMConfiguration extends DRMConfiguration {
|
|
|
9816
10315
|
/**
|
|
9817
10316
|
* The identifier of the Conax integration.
|
|
9818
10317
|
*
|
|
10318
|
+
* @category Source
|
|
10319
|
+
* @category Content Protection
|
|
9819
10320
|
* @public
|
|
9820
10321
|
*/
|
|
9821
10322
|
type ConaxIntegrationID = 'conax';
|
|
@@ -9845,6 +10346,8 @@ type ConaxIntegrationID = 'conax';
|
|
|
9845
10346
|
* }
|
|
9846
10347
|
* ```
|
|
9847
10348
|
*
|
|
10349
|
+
* @category Source
|
|
10350
|
+
* @category Content Protection
|
|
9848
10351
|
* @public
|
|
9849
10352
|
*/
|
|
9850
10353
|
interface ConaxDRMConfiguration extends DRMConfiguration {
|
|
@@ -9874,12 +10377,16 @@ interface ConaxDRMConfiguration extends DRMConfiguration {
|
|
|
9874
10377
|
/**
|
|
9875
10378
|
* The identifier of the DRM Today integration.
|
|
9876
10379
|
*
|
|
10380
|
+
* @category Source
|
|
10381
|
+
* @category Content Protection
|
|
9877
10382
|
* @public
|
|
9878
10383
|
*/
|
|
9879
10384
|
type DRMTodayIntegrationID = 'drmtoday';
|
|
9880
10385
|
/**
|
|
9881
10386
|
* Describes the configuration of the DRM Today DRM integration.
|
|
9882
10387
|
*
|
|
10388
|
+
* @category Source
|
|
10389
|
+
* @category Content Protection
|
|
9883
10390
|
* @public
|
|
9884
10391
|
*/
|
|
9885
10392
|
interface DRMTodayDRMConfiguration extends DRMConfiguration {
|
|
@@ -9920,12 +10427,16 @@ interface DRMTodayDRMConfiguration extends DRMConfiguration {
|
|
|
9920
10427
|
/**
|
|
9921
10428
|
* The identifier of the ExpressPlay integration.
|
|
9922
10429
|
*
|
|
10430
|
+
* @category Source
|
|
10431
|
+
* @category Content Protection
|
|
9923
10432
|
* @public
|
|
9924
10433
|
*/
|
|
9925
10434
|
type ExpressPlayIntegrationID = 'expressplay';
|
|
9926
10435
|
/**
|
|
9927
10436
|
* Describes the configuration of the ExpressPlay DRM integration.
|
|
9928
10437
|
*
|
|
10438
|
+
* @category Source
|
|
10439
|
+
* @category Content Protection
|
|
9929
10440
|
* @public
|
|
9930
10441
|
*/
|
|
9931
10442
|
interface ExpressPlayDRMConfiguration extends DRMConfiguration {
|
|
@@ -9938,6 +10449,8 @@ interface ExpressPlayDRMConfiguration extends DRMConfiguration {
|
|
|
9938
10449
|
/**
|
|
9939
10450
|
* The identifier of the Ezdrm integration.
|
|
9940
10451
|
*
|
|
10452
|
+
* @category Source
|
|
10453
|
+
* @category Content Protection
|
|
9941
10454
|
* @public
|
|
9942
10455
|
*/
|
|
9943
10456
|
type EzdrmIntegrationID = 'ezdrm';
|
|
@@ -9955,6 +10468,8 @@ type EzdrmIntegrationID = 'ezdrm';
|
|
|
9955
10468
|
* }
|
|
9956
10469
|
* ```
|
|
9957
10470
|
*
|
|
10471
|
+
* @category Source
|
|
10472
|
+
* @category Content Protection
|
|
9958
10473
|
* @public
|
|
9959
10474
|
*/
|
|
9960
10475
|
interface EzdrmDRMConfiguration extends DRMConfiguration {
|
|
@@ -9967,6 +10482,8 @@ interface EzdrmDRMConfiguration extends DRMConfiguration {
|
|
|
9967
10482
|
/**
|
|
9968
10483
|
* The identifier of the Irdeto integration.
|
|
9969
10484
|
*
|
|
10485
|
+
* @category Source
|
|
10486
|
+
* @category Content Protection
|
|
9970
10487
|
* @public
|
|
9971
10488
|
*/
|
|
9972
10489
|
type IrdetoIntegrationID = 'irdeto';
|
|
@@ -9989,6 +10506,8 @@ type IrdetoIntegrationID = 'irdeto';
|
|
|
9989
10506
|
* }
|
|
9990
10507
|
* ```
|
|
9991
10508
|
*
|
|
10509
|
+
* @category Source
|
|
10510
|
+
* @category Content Protection
|
|
9992
10511
|
* @public
|
|
9993
10512
|
*/
|
|
9994
10513
|
interface IrdetoDRMConfiguration extends DRMConfiguration {
|
|
@@ -10046,6 +10565,8 @@ interface IrdetoDRMConfiguration extends DRMConfiguration {
|
|
|
10046
10565
|
/**
|
|
10047
10566
|
* The identifier of the KeyOS integration.
|
|
10048
10567
|
*
|
|
10568
|
+
* @category Source
|
|
10569
|
+
* @category Content Protection
|
|
10049
10570
|
* @public
|
|
10050
10571
|
*/
|
|
10051
10572
|
type KeyOSIntegrationID = 'keyos';
|
|
@@ -10074,6 +10595,8 @@ type KeyOSIntegrationID = 'keyos';
|
|
|
10074
10595
|
* }
|
|
10075
10596
|
* ```
|
|
10076
10597
|
*
|
|
10598
|
+
* @category Source
|
|
10599
|
+
* @category Content Protection
|
|
10077
10600
|
* @public
|
|
10078
10601
|
*/
|
|
10079
10602
|
interface KeyOSDRMConfiguration extends DRMConfiguration {
|
|
@@ -10106,6 +10629,8 @@ interface KeyOSDRMConfiguration extends DRMConfiguration {
|
|
|
10106
10629
|
/**
|
|
10107
10630
|
* Describes the KeyOS key system configuration.
|
|
10108
10631
|
*
|
|
10632
|
+
* @category Source
|
|
10633
|
+
* @category Content Protection
|
|
10109
10634
|
* @public
|
|
10110
10635
|
*/
|
|
10111
10636
|
interface KeyOSKeySystemConfiguration extends KeySystemConfiguration {
|
|
@@ -10117,6 +10642,8 @@ interface KeyOSKeySystemConfiguration extends KeySystemConfiguration {
|
|
|
10117
10642
|
/**
|
|
10118
10643
|
* Describes the KeyOS FairPlay key system configuration.
|
|
10119
10644
|
*
|
|
10645
|
+
* @category Source
|
|
10646
|
+
* @category Content Protection
|
|
10120
10647
|
* @public
|
|
10121
10648
|
*/
|
|
10122
10649
|
interface KeyOSFairplayKeySystemConfiguration extends FairPlayKeySystemConfiguration {
|
|
@@ -10129,6 +10656,8 @@ interface KeyOSFairplayKeySystemConfiguration extends FairPlayKeySystemConfigura
|
|
|
10129
10656
|
/**
|
|
10130
10657
|
* The identifier of the Titanium integration.
|
|
10131
10658
|
*
|
|
10659
|
+
* @category Source
|
|
10660
|
+
* @category Content Protection
|
|
10132
10661
|
* @public
|
|
10133
10662
|
*/
|
|
10134
10663
|
type TitaniumIntegrationID = 'titanium';
|
|
@@ -10152,6 +10681,8 @@ type TitaniumIntegrationID = 'titanium';
|
|
|
10152
10681
|
* }
|
|
10153
10682
|
* ```
|
|
10154
10683
|
*
|
|
10684
|
+
* @category Source
|
|
10685
|
+
* @category Content Protection
|
|
10155
10686
|
* @public
|
|
10156
10687
|
*/
|
|
10157
10688
|
interface TitaniumDRMConfiguration extends DRMConfiguration {
|
|
@@ -10210,6 +10741,8 @@ interface TitaniumDRMConfiguration extends DRMConfiguration {
|
|
|
10210
10741
|
/**
|
|
10211
10742
|
* Describes the configuration of the Titanium DRM integration with device-based authentication.
|
|
10212
10743
|
*
|
|
10744
|
+
* @category Source
|
|
10745
|
+
* @category Content Protection
|
|
10213
10746
|
* @public
|
|
10214
10747
|
*/
|
|
10215
10748
|
interface DeviceBasedTitaniumDRMConfiguration extends TitaniumDRMConfiguration {
|
|
@@ -10240,6 +10773,8 @@ interface DeviceBasedTitaniumDRMConfiguration extends TitaniumDRMConfiguration {
|
|
|
10240
10773
|
/**
|
|
10241
10774
|
* Describes the configuration of the Titanium DRM integration with token-based authentication.
|
|
10242
10775
|
*
|
|
10776
|
+
* @category Source
|
|
10777
|
+
* @category Content Protection
|
|
10243
10778
|
* @public
|
|
10244
10779
|
*/
|
|
10245
10780
|
interface TokenBasedTitaniumDRMConfiguration extends TitaniumDRMConfiguration {
|
|
@@ -10271,6 +10806,8 @@ interface TokenBasedTitaniumDRMConfiguration extends TitaniumDRMConfiguration {
|
|
|
10271
10806
|
/**
|
|
10272
10807
|
* The identifier of the Uplynk integration.
|
|
10273
10808
|
*
|
|
10809
|
+
* @category Source
|
|
10810
|
+
* @category Content Protection
|
|
10274
10811
|
* @public
|
|
10275
10812
|
*/
|
|
10276
10813
|
type UplynkIntegrationID = 'uplynk';
|
|
@@ -10287,6 +10824,8 @@ type UplynkIntegrationID = 'uplynk';
|
|
|
10287
10824
|
* }
|
|
10288
10825
|
* ```
|
|
10289
10826
|
*
|
|
10827
|
+
* @category Source
|
|
10828
|
+
* @category Content Protection
|
|
10290
10829
|
* @public
|
|
10291
10830
|
*/
|
|
10292
10831
|
interface UplynkDRMConfiguration extends DRMConfiguration {
|
|
@@ -10299,6 +10838,8 @@ interface UplynkDRMConfiguration extends DRMConfiguration {
|
|
|
10299
10838
|
/**
|
|
10300
10839
|
* The identifier of the Verimatrix integration.
|
|
10301
10840
|
*
|
|
10841
|
+
* @category Source
|
|
10842
|
+
* @category Content Protection
|
|
10302
10843
|
* @public
|
|
10303
10844
|
*/
|
|
10304
10845
|
type VerimatrixIntegrationID = 'verimatrix';
|
|
@@ -10316,6 +10857,8 @@ type VerimatrixIntegrationID = 'verimatrix';
|
|
|
10316
10857
|
* }
|
|
10317
10858
|
* ```
|
|
10318
10859
|
*
|
|
10860
|
+
* @category Source
|
|
10861
|
+
* @category Content Protection
|
|
10319
10862
|
* @public
|
|
10320
10863
|
*/
|
|
10321
10864
|
interface VerimatrixDRMConfiguration extends DRMConfiguration {
|
|
@@ -10328,12 +10871,16 @@ interface VerimatrixDRMConfiguration extends DRMConfiguration {
|
|
|
10328
10871
|
/**
|
|
10329
10872
|
* The identifier of the Vimond integration.
|
|
10330
10873
|
*
|
|
10874
|
+
* @category Source
|
|
10875
|
+
* @category Content Protection
|
|
10331
10876
|
* @public
|
|
10332
10877
|
*/
|
|
10333
10878
|
type VimondIntegrationID = 'vimond';
|
|
10334
10879
|
/**
|
|
10335
10880
|
* Describes the configuration of the Vimond DRM integration.
|
|
10336
10881
|
*
|
|
10882
|
+
* @category Source
|
|
10883
|
+
* @category Content Protection
|
|
10337
10884
|
* @public
|
|
10338
10885
|
*/
|
|
10339
10886
|
interface VimondDRMConfiguration extends DRMConfiguration {
|
|
@@ -10346,6 +10893,8 @@ interface VimondDRMConfiguration extends DRMConfiguration {
|
|
|
10346
10893
|
/**
|
|
10347
10894
|
* The identifier of the Vudrm integration.
|
|
10348
10895
|
*
|
|
10896
|
+
* @category Source
|
|
10897
|
+
* @category Content Protection
|
|
10349
10898
|
* @public
|
|
10350
10899
|
*/
|
|
10351
10900
|
type VudrmIntegrationID = 'vudrm';
|
|
@@ -10366,6 +10915,8 @@ type VudrmIntegrationID = 'vudrm';
|
|
|
10366
10915
|
* }
|
|
10367
10916
|
* ```
|
|
10368
10917
|
*
|
|
10918
|
+
* @category Source
|
|
10919
|
+
* @category Content Protection
|
|
10369
10920
|
* @public
|
|
10370
10921
|
*/
|
|
10371
10922
|
interface VudrmDRMConfiguration extends DRMConfiguration {
|
|
@@ -10389,6 +10940,8 @@ interface VudrmDRMConfiguration extends DRMConfiguration {
|
|
|
10389
10940
|
/**
|
|
10390
10941
|
* The identifier of the Xstream integration.
|
|
10391
10942
|
*
|
|
10943
|
+
* @category Source
|
|
10944
|
+
* @category Content Protection
|
|
10392
10945
|
* @public
|
|
10393
10946
|
*/
|
|
10394
10947
|
type XstreamIntegrationID = 'xstream';
|
|
@@ -10408,6 +10961,8 @@ type XstreamIntegrationID = 'xstream';
|
|
|
10408
10961
|
* }
|
|
10409
10962
|
* ```
|
|
10410
10963
|
*
|
|
10964
|
+
* @category Source
|
|
10965
|
+
* @category Content Protection
|
|
10411
10966
|
* @public
|
|
10412
10967
|
*/
|
|
10413
10968
|
interface XstreamDRMConfiguration extends DRMConfiguration {
|
|
@@ -10432,6 +10987,8 @@ interface XstreamDRMConfiguration extends DRMConfiguration {
|
|
|
10432
10987
|
/**
|
|
10433
10988
|
* Represents a source for the MediaTailor integration.
|
|
10434
10989
|
*
|
|
10990
|
+
* @category Source
|
|
10991
|
+
* @category Analytics
|
|
10435
10992
|
* @public
|
|
10436
10993
|
*/
|
|
10437
10994
|
interface MediaTailorSource extends TypedSource {
|
|
@@ -10449,6 +11006,7 @@ interface MediaTailorSource extends TypedSource {
|
|
|
10449
11006
|
/**
|
|
10450
11007
|
* Represents a cue of a HLS date range metadata text track.
|
|
10451
11008
|
*
|
|
11009
|
+
* @category Media and Text Tracks
|
|
10452
11010
|
* @public
|
|
10453
11011
|
*/
|
|
10454
11012
|
interface DateRangeCue extends TextTrackCue {
|
|
@@ -10509,6 +11067,7 @@ interface DateRangeCue extends TextTrackCue {
|
|
|
10509
11067
|
/**
|
|
10510
11068
|
* Represents a cue of an emsg metadata text track.
|
|
10511
11069
|
*
|
|
11070
|
+
* @category Media and Text Tracks
|
|
10512
11071
|
* @public
|
|
10513
11072
|
*/
|
|
10514
11073
|
interface EmsgCue extends TextTrackCue {
|
|
@@ -10532,6 +11091,7 @@ interface EmsgCue extends TextTrackCue {
|
|
|
10532
11091
|
/**
|
|
10533
11092
|
* Represents a cue of an Event Stream metadata text track.
|
|
10534
11093
|
*
|
|
11094
|
+
* @category Media and Text Tracks
|
|
10535
11095
|
* @public
|
|
10536
11096
|
*/
|
|
10537
11097
|
interface EventStreamCue extends TextTrackCue {
|
|
@@ -10553,6 +11113,7 @@ interface EventStreamCue extends TextTrackCue {
|
|
|
10553
11113
|
/**
|
|
10554
11114
|
* Represents a generic ID3 frame.
|
|
10555
11115
|
*
|
|
11116
|
+
* @category Media and Text Tracks
|
|
10556
11117
|
* @public
|
|
10557
11118
|
*/
|
|
10558
11119
|
interface ID3BaseFrame {
|
|
@@ -10567,6 +11128,7 @@ interface ID3BaseFrame {
|
|
|
10567
11128
|
/**
|
|
10568
11129
|
* Represents an unknown ID3 frame.
|
|
10569
11130
|
*
|
|
11131
|
+
* @category Media and Text Tracks
|
|
10570
11132
|
* @public
|
|
10571
11133
|
*/
|
|
10572
11134
|
interface ID3Unknown extends ID3BaseFrame {
|
|
@@ -10578,6 +11140,7 @@ interface ID3Unknown extends ID3BaseFrame {
|
|
|
10578
11140
|
/**
|
|
10579
11141
|
* Represents an attached picture ID3 frame.
|
|
10580
11142
|
*
|
|
11143
|
+
* @category Media and Text Tracks
|
|
10581
11144
|
* @public
|
|
10582
11145
|
*/
|
|
10583
11146
|
interface ID3AttachedPicture extends ID3BaseFrame {
|
|
@@ -10611,6 +11174,7 @@ interface ID3AttachedPicture extends ID3BaseFrame {
|
|
|
10611
11174
|
/**
|
|
10612
11175
|
* Represents a comments ID3 frame.
|
|
10613
11176
|
*
|
|
11177
|
+
* @category Media and Text Tracks
|
|
10614
11178
|
* @public
|
|
10615
11179
|
*/
|
|
10616
11180
|
interface ID3Comments extends ID3BaseFrame {
|
|
@@ -10634,6 +11198,7 @@ interface ID3Comments extends ID3BaseFrame {
|
|
|
10634
11198
|
/**
|
|
10635
11199
|
* Represents a commercial ID3 frame.
|
|
10636
11200
|
*
|
|
11201
|
+
* @category Media and Text Tracks
|
|
10637
11202
|
* @public
|
|
10638
11203
|
*/
|
|
10639
11204
|
interface ID3CommercialFrame extends ID3BaseFrame {
|
|
@@ -10693,6 +11258,7 @@ interface ID3CommercialFrame extends ID3BaseFrame {
|
|
|
10693
11258
|
/**
|
|
10694
11259
|
* Represents a general encapsulated object ID3 frame.
|
|
10695
11260
|
*
|
|
11261
|
+
* @category Media and Text Tracks
|
|
10696
11262
|
* @public
|
|
10697
11263
|
*/
|
|
10698
11264
|
interface ID3GenericEncapsulatedObject extends ID3BaseFrame {
|
|
@@ -10720,6 +11286,7 @@ interface ID3GenericEncapsulatedObject extends ID3BaseFrame {
|
|
|
10720
11286
|
/**
|
|
10721
11287
|
* Represents an involved people list ID3 frame.
|
|
10722
11288
|
*
|
|
11289
|
+
* @category Media and Text Tracks
|
|
10723
11290
|
* @public
|
|
10724
11291
|
*/
|
|
10725
11292
|
interface ID3InvolvedPeopleList extends ID3BaseFrame {
|
|
@@ -10738,6 +11305,7 @@ interface ID3InvolvedPeopleList extends ID3BaseFrame {
|
|
|
10738
11305
|
/**
|
|
10739
11306
|
* Represents a private ID3 frame.
|
|
10740
11307
|
*
|
|
11308
|
+
* @category Media and Text Tracks
|
|
10741
11309
|
* @public
|
|
10742
11310
|
*/
|
|
10743
11311
|
interface ID3PrivateFrame extends ID3BaseFrame {
|
|
@@ -10757,6 +11325,7 @@ interface ID3PrivateFrame extends ID3BaseFrame {
|
|
|
10757
11325
|
/**
|
|
10758
11326
|
* Represents an position synchronisation ID3 frame.
|
|
10759
11327
|
*
|
|
11328
|
+
* @category Media and Text Tracks
|
|
10760
11329
|
* @public
|
|
10761
11330
|
*/
|
|
10762
11331
|
interface ID3PositionSynchronisationFrame extends ID3BaseFrame {
|
|
@@ -10778,6 +11347,7 @@ interface ID3PositionSynchronisationFrame extends ID3BaseFrame {
|
|
|
10778
11347
|
/**
|
|
10779
11348
|
* Represents a synchronised lyrics/text ID3 frame.
|
|
10780
11349
|
*
|
|
11350
|
+
* @category Media and Text Tracks
|
|
10781
11351
|
* @public
|
|
10782
11352
|
*/
|
|
10783
11353
|
interface ID3SynchronizedLyricsText extends ID3BaseFrame {
|
|
@@ -10823,6 +11393,7 @@ interface ID3SynchronizedLyricsText extends ID3BaseFrame {
|
|
|
10823
11393
|
/**
|
|
10824
11394
|
* Represents a text information ID3 frame.
|
|
10825
11395
|
*
|
|
11396
|
+
* @category Media and Text Tracks
|
|
10826
11397
|
* @public
|
|
10827
11398
|
*/
|
|
10828
11399
|
interface ID3Text extends ID3BaseFrame {
|
|
@@ -10841,6 +11412,7 @@ interface ID3Text extends ID3BaseFrame {
|
|
|
10841
11412
|
/**
|
|
10842
11413
|
* Represents a used defined text ID3 frame.
|
|
10843
11414
|
*
|
|
11415
|
+
* @category Media and Text Tracks
|
|
10844
11416
|
* @public
|
|
10845
11417
|
*/
|
|
10846
11418
|
interface ID3UserDefinedText extends ID3BaseFrame {
|
|
@@ -10860,6 +11432,7 @@ interface ID3UserDefinedText extends ID3BaseFrame {
|
|
|
10860
11432
|
/**
|
|
10861
11433
|
* Represents a unique file identifier ID3 frame.
|
|
10862
11434
|
*
|
|
11435
|
+
* @category Media and Text Tracks
|
|
10863
11436
|
* @public
|
|
10864
11437
|
*/
|
|
10865
11438
|
interface ID3UniqueFileIdentifier extends ID3BaseFrame {
|
|
@@ -10879,6 +11452,7 @@ interface ID3UniqueFileIdentifier extends ID3BaseFrame {
|
|
|
10879
11452
|
/**
|
|
10880
11453
|
* Represents a terms of use ID3 frame.
|
|
10881
11454
|
*
|
|
11455
|
+
* @category Media and Text Tracks
|
|
10882
11456
|
* @public
|
|
10883
11457
|
*/
|
|
10884
11458
|
interface ID3TermsOfUse extends ID3BaseFrame {
|
|
@@ -10898,6 +11472,7 @@ interface ID3TermsOfUse extends ID3BaseFrame {
|
|
|
10898
11472
|
/**
|
|
10899
11473
|
* Represents a unsynchronised lyrics/text transcription ID3 frame.
|
|
10900
11474
|
*
|
|
11475
|
+
* @category Media and Text Tracks
|
|
10901
11476
|
* @public
|
|
10902
11477
|
*/
|
|
10903
11478
|
interface ID3UnsynchronisedLyricsTextTranscription extends ID3BaseFrame {
|
|
@@ -10921,6 +11496,7 @@ interface ID3UnsynchronisedLyricsTextTranscription extends ID3BaseFrame {
|
|
|
10921
11496
|
/**
|
|
10922
11497
|
* Represents a URL link ID3 frame.
|
|
10923
11498
|
*
|
|
11499
|
+
* @category Media and Text Tracks
|
|
10924
11500
|
* @public
|
|
10925
11501
|
*/
|
|
10926
11502
|
interface ID3UrlLink extends ID3BaseFrame {
|
|
@@ -10939,6 +11515,7 @@ interface ID3UrlLink extends ID3BaseFrame {
|
|
|
10939
11515
|
/**
|
|
10940
11516
|
* Represents a user defined URL link ID3 frame.
|
|
10941
11517
|
*
|
|
11518
|
+
* @category Media and Text Tracks
|
|
10942
11519
|
* @public
|
|
10943
11520
|
*/
|
|
10944
11521
|
interface ID3UserDefinedUrlLink extends ID3BaseFrame {
|
|
@@ -10976,12 +11553,16 @@ interface ID3UserDefinedUrlLink extends ID3BaseFrame {
|
|
|
10976
11553
|
* };
|
|
10977
11554
|
* ```
|
|
10978
11555
|
*
|
|
11556
|
+
* @category Media and Text Tracks
|
|
11557
|
+
* @category SSAI
|
|
10979
11558
|
* @public
|
|
10980
11559
|
*/
|
|
10981
11560
|
type YospaceId = 'YMID' | 'YTYP' | 'YSEQ' | 'YDUR' | 'YCSP';
|
|
10982
11561
|
/**
|
|
10983
11562
|
* Represents a Yospace ID3 frame.
|
|
10984
11563
|
*
|
|
11564
|
+
* @category Media and Text Tracks
|
|
11565
|
+
* @category SSAI
|
|
10985
11566
|
* @public
|
|
10986
11567
|
*/
|
|
10987
11568
|
interface ID3Yospace extends ID3BaseFrame {
|
|
@@ -10997,6 +11578,7 @@ interface ID3Yospace extends ID3BaseFrame {
|
|
|
10997
11578
|
/**
|
|
10998
11579
|
* The possible types of an ID3 frame.
|
|
10999
11580
|
*
|
|
11581
|
+
* @category Media and Text Tracks
|
|
11000
11582
|
* @public
|
|
11001
11583
|
*/
|
|
11002
11584
|
type ID3Frame = ID3Unknown | ID3AttachedPicture | ID3GenericEncapsulatedObject | ID3Comments | ID3CommercialFrame | ID3InvolvedPeopleList | ID3PositionSynchronisationFrame | ID3PrivateFrame | ID3SynchronizedLyricsText | ID3Text | ID3UserDefinedText | ID3UniqueFileIdentifier | ID3TermsOfUse | ID3UnsynchronisedLyricsTextTranscription | ID3UrlLink | ID3UserDefinedUrlLink | ID3Yospace;
|
|
@@ -11004,6 +11586,7 @@ type ID3Frame = ID3Unknown | ID3AttachedPicture | ID3GenericEncapsulatedObject |
|
|
|
11004
11586
|
/**
|
|
11005
11587
|
* Represents a cue of an ID3 metadata text track.
|
|
11006
11588
|
*
|
|
11589
|
+
* @category Media and Text Tracks
|
|
11007
11590
|
* @public
|
|
11008
11591
|
*/
|
|
11009
11592
|
interface ID3Cue extends TextTrackCue {
|
|
@@ -11018,12 +11601,14 @@ interface ID3Cue extends TextTrackCue {
|
|
|
11018
11601
|
* <br/> - `''`: None. Cues in the region stay fixed at the location they were first painted in.
|
|
11019
11602
|
* <br/> - `'up'`: Up. Cues in the region will be added at the bottom of the region and push any already displayed cues in the region up until all lines of the new cue are visible in the region.
|
|
11020
11603
|
*
|
|
11604
|
+
* @category Media and Text Tracks
|
|
11021
11605
|
* @public
|
|
11022
11606
|
*/
|
|
11023
11607
|
type VTTScrollSetting = '' | /* none */ 'up';
|
|
11024
11608
|
/**
|
|
11025
11609
|
* Represents a WebVTT region.
|
|
11026
11610
|
*
|
|
11611
|
+
* @category Media and Text Tracks
|
|
11027
11612
|
* @public
|
|
11028
11613
|
*/
|
|
11029
11614
|
interface WebVTTRegion {
|
|
@@ -11073,6 +11658,7 @@ interface WebVTTRegion {
|
|
|
11073
11658
|
* <br/> - `'rl'`: Vertical right-to-left. A line extends vertically and is offset horizontally from the video viewport’s right edge, with consecutive lines displayed to the left of each other.
|
|
11074
11659
|
* <br/> - `'lr'`: vertical left-to-right. A line extends vertically and is offset horizontally from the video viewport’s left edge, with consecutive lines displayed to the right of each other.
|
|
11075
11660
|
*
|
|
11661
|
+
* @category Media and Text Tracks
|
|
11076
11662
|
* @public
|
|
11077
11663
|
*/
|
|
11078
11664
|
type VTTDirectionSetting = '' | 'rl' | 'lr';
|
|
@@ -11082,6 +11668,7 @@ type VTTDirectionSetting = '' | 'rl' | 'lr';
|
|
|
11082
11668
|
* <br/> - `'center'`: The cue box's center is aligned at a specified line.
|
|
11083
11669
|
* <br/> - `'end'`: The cue box's end is aligned at a specified line.
|
|
11084
11670
|
*
|
|
11671
|
+
* @category Media and Text Tracks
|
|
11085
11672
|
* @public
|
|
11086
11673
|
*/
|
|
11087
11674
|
type VTTLineAlignSetting = 'start' | 'center' | 'end';
|
|
@@ -11093,6 +11680,7 @@ type VTTLineAlignSetting = 'start' | 'center' | 'end';
|
|
|
11093
11680
|
* <br/> - `'left'`: The text of each line is aligned to the box’s left side for horizontal cues, or top side otherwise.
|
|
11094
11681
|
* <br/> - `'right'`: The text of each line is aligned to the box’s right side for horizontal cues, or bottom side otherwise.
|
|
11095
11682
|
*
|
|
11683
|
+
* @category Media and Text Tracks
|
|
11096
11684
|
* @public
|
|
11097
11685
|
*/
|
|
11098
11686
|
type VTTAlignSetting = 'start' | 'center' | 'end' | 'left' | 'right';
|
|
@@ -11103,6 +11691,7 @@ type VTTAlignSetting = 'start' | 'center' | 'end' | 'left' | 'right';
|
|
|
11103
11691
|
* <br/> - `'line-right'`: The cue box's end is aligned at a specified position.
|
|
11104
11692
|
* <br/> - `'auto'`: The cue box's alignment is dependent on its text alignment setting.
|
|
11105
11693
|
*
|
|
11694
|
+
* @category Media and Text Tracks
|
|
11106
11695
|
* @public
|
|
11107
11696
|
*/
|
|
11108
11697
|
type VTTPositionAlignSetting = 'line-left' | 'center' | 'line-right' | 'auto';
|
|
@@ -11114,6 +11703,7 @@ type VTTPositionAlignSetting = 'line-left' | 'center' | 'line-right' | 'auto';
|
|
|
11114
11703
|
* @remarks
|
|
11115
11704
|
* <br/> - The semantics of the `number` variant are dependent on {@link WebVTTCue.snapToLines}.
|
|
11116
11705
|
*
|
|
11706
|
+
* @category Media and Text Tracks
|
|
11117
11707
|
* @public
|
|
11118
11708
|
*/
|
|
11119
11709
|
type VTTLine = number | 'auto';
|
|
@@ -11122,12 +11712,14 @@ type VTTLine = number | 'auto';
|
|
|
11122
11712
|
* <br/> - a number: The position is expressed as a percentage value.
|
|
11123
11713
|
* <br/> - `'auto'`: The position depends on the text alignment of the cue.
|
|
11124
11714
|
*
|
|
11715
|
+
* @category Media and Text Tracks
|
|
11125
11716
|
* @public
|
|
11126
11717
|
*/
|
|
11127
11718
|
type VTTPosition = number | 'auto';
|
|
11128
11719
|
/**
|
|
11129
11720
|
* Represents a cue of a {@link https://www.w3.org/TR/webvtt1/ | WebVTT} text track.
|
|
11130
11721
|
*
|
|
11722
|
+
* @category Media and Text Tracks
|
|
11131
11723
|
* @public
|
|
11132
11724
|
*/
|
|
11133
11725
|
interface WebVTTCue extends TextTrackCue {
|
|
@@ -11187,12 +11779,14 @@ interface WebVTTCue extends TextTrackCue {
|
|
|
11187
11779
|
* Record of style properties.
|
|
11188
11780
|
* Each entry contains the style property name with associated value.
|
|
11189
11781
|
*
|
|
11782
|
+
* @category Media and Text Tracks
|
|
11190
11783
|
* @public
|
|
11191
11784
|
*/
|
|
11192
11785
|
type StylePropertyRecord = Record<string, string>;
|
|
11193
11786
|
/**
|
|
11194
11787
|
* Represents a cue of a TTML text track.
|
|
11195
11788
|
*
|
|
11789
|
+
* @category Media and Text Tracks
|
|
11196
11790
|
* @public
|
|
11197
11791
|
*/
|
|
11198
11792
|
interface TTMLCue extends TextTrackCue {
|
|
@@ -11220,6 +11814,7 @@ interface TTMLCue extends TextTrackCue {
|
|
|
11220
11814
|
}
|
|
11221
11815
|
|
|
11222
11816
|
/**
|
|
11817
|
+
* @category HESP
|
|
11223
11818
|
* @public
|
|
11224
11819
|
*/
|
|
11225
11820
|
type HespMediaType = 'audio' | 'video' | 'metadata';
|
|
@@ -11227,6 +11822,7 @@ type HespMediaType = 'audio' | 'video' | 'metadata';
|
|
|
11227
11822
|
/**
|
|
11228
11823
|
* The identifier of the Agama integration.
|
|
11229
11824
|
*
|
|
11825
|
+
* @category Analytics
|
|
11230
11826
|
* @public
|
|
11231
11827
|
*/
|
|
11232
11828
|
type AgamaAnalyticsIntegrationID = 'agama';
|
|
@@ -11238,12 +11834,14 @@ type AgamaAnalyticsIntegrationID = 'agama';
|
|
|
11238
11834
|
* <br/> - `'error'`
|
|
11239
11835
|
* <br/> - `'fatal'`
|
|
11240
11836
|
*
|
|
11837
|
+
* @category Analytics
|
|
11241
11838
|
* @public
|
|
11242
11839
|
*/
|
|
11243
11840
|
type AgamaLogLevelType = 'info' | 'debug' | 'warning' | 'error' | 'fatal';
|
|
11244
11841
|
/**
|
|
11245
11842
|
* Describes the configuration of Agama.
|
|
11246
11843
|
*
|
|
11844
|
+
* @category Analytics
|
|
11247
11845
|
* @public
|
|
11248
11846
|
*/
|
|
11249
11847
|
interface AgamaConfiguration extends AnalyticsDescription {
|
|
@@ -11258,6 +11856,7 @@ interface AgamaConfiguration extends AnalyticsDescription {
|
|
|
11258
11856
|
* @remarks
|
|
11259
11857
|
* <br/> - Available since v2.45.6.
|
|
11260
11858
|
*
|
|
11859
|
+
* @category Analytics
|
|
11261
11860
|
* @public
|
|
11262
11861
|
*/
|
|
11263
11862
|
interface AgamaPlayerConfiguration extends AgamaConfiguration {
|
|
@@ -11367,6 +11966,7 @@ interface AgamaPlayerConfiguration extends AgamaConfiguration {
|
|
|
11367
11966
|
* <br/> - `'live'`
|
|
11368
11967
|
* <br/> - `'vod'`
|
|
11369
11968
|
*
|
|
11969
|
+
* @category Analytics
|
|
11370
11970
|
* @public
|
|
11371
11971
|
*/
|
|
11372
11972
|
type AgamaStreamType = 'live' | 'vod';
|
|
@@ -11379,6 +11979,7 @@ type AgamaStreamType = 'live' | 'vod';
|
|
|
11379
11979
|
* <br/> - `'avod'`
|
|
11380
11980
|
* <br/> - `'catchuptv'`
|
|
11381
11981
|
*
|
|
11982
|
+
* @category Analytics
|
|
11382
11983
|
* @public
|
|
11383
11984
|
*/
|
|
11384
11985
|
type AgamaServiceName = 'live' | 'svod' | 'nvod' | 'tvod' | 'avod' | 'catchuptv';
|
|
@@ -11389,6 +11990,7 @@ type AgamaServiceName = 'live' | 'svod' | 'nvod' | 'tvod' | 'avod' | 'catchuptv'
|
|
|
11389
11990
|
* <br/> - Available since v2.45.6.
|
|
11390
11991
|
* <br/> - Overrides the {@link AgamaPlayerConfiguration}.
|
|
11391
11992
|
*
|
|
11993
|
+
* @category Analytics
|
|
11392
11994
|
* @public
|
|
11393
11995
|
*/
|
|
11394
11996
|
interface AgamaSourceConfiguration extends AgamaConfiguration {
|
|
@@ -11447,6 +12049,7 @@ interface AgamaSourceConfiguration extends AgamaConfiguration {
|
|
|
11447
12049
|
/**
|
|
11448
12050
|
* The identifier of the Moat integration.
|
|
11449
12051
|
*
|
|
12052
|
+
* @category Analytics
|
|
11450
12053
|
* @public
|
|
11451
12054
|
*/
|
|
11452
12055
|
type MoatAnalyticsIntegrationID = 'moat';
|
|
@@ -11456,6 +12059,7 @@ type MoatAnalyticsIntegrationID = 'moat';
|
|
|
11456
12059
|
* @remarks
|
|
11457
12060
|
* <br/> - Available since v2.27.0.
|
|
11458
12061
|
*
|
|
12062
|
+
* @category Analytics
|
|
11459
12063
|
* @public
|
|
11460
12064
|
*/
|
|
11461
12065
|
interface MoatConfiguration extends AnalyticsDescription {
|
|
@@ -11472,6 +12076,7 @@ interface MoatConfiguration extends AnalyticsDescription {
|
|
|
11472
12076
|
/**
|
|
11473
12077
|
* Describes the configuration of the Media Melon integration.
|
|
11474
12078
|
*
|
|
12079
|
+
* @category Analytics
|
|
11475
12080
|
* @public
|
|
11476
12081
|
*/
|
|
11477
12082
|
interface MediaMelonConfiguration {
|
|
@@ -11509,6 +12114,7 @@ interface MediaMelonConfiguration {
|
|
|
11509
12114
|
/**
|
|
11510
12115
|
* The identifier of the Media Melon SmartSight integration.
|
|
11511
12116
|
*
|
|
12117
|
+
* @category Analytics
|
|
11512
12118
|
* @public
|
|
11513
12119
|
*/
|
|
11514
12120
|
type SmartSightIntegrationID = 'smartsight';
|
|
@@ -11518,6 +12124,7 @@ type SmartSightIntegrationID = 'smartsight';
|
|
|
11518
12124
|
* @remarks
|
|
11519
12125
|
* <br/> - Available since v2.33.2.
|
|
11520
12126
|
*
|
|
12127
|
+
* @category Analytics
|
|
11521
12128
|
* @public
|
|
11522
12129
|
*/
|
|
11523
12130
|
interface SmartSightConfiguration extends AnalyticsDescription, MediaMelonConfiguration {
|
|
@@ -11530,6 +12137,7 @@ interface SmartSightConfiguration extends AnalyticsDescription, MediaMelonConfig
|
|
|
11530
12137
|
/**
|
|
11531
12138
|
* The identifier of the Stream One integration.
|
|
11532
12139
|
*
|
|
12140
|
+
* @category Analytics
|
|
11533
12141
|
* @public
|
|
11534
12142
|
*/
|
|
11535
12143
|
type StreamOneAnalyticsIntegrationID = 'streamone';
|
|
@@ -11539,6 +12147,7 @@ type StreamOneAnalyticsIntegrationID = 'streamone';
|
|
|
11539
12147
|
* @remarks
|
|
11540
12148
|
* <br/> - Available since v2.32.0.
|
|
11541
12149
|
*
|
|
12150
|
+
* @category Analytics
|
|
11542
12151
|
* @public
|
|
11543
12152
|
*/
|
|
11544
12153
|
interface StreamOneConfiguration extends AnalyticsDescription {
|
|
@@ -11563,6 +12172,7 @@ interface StreamOneConfiguration extends AnalyticsDescription {
|
|
|
11563
12172
|
/**
|
|
11564
12173
|
* The identifier of the Youbora integration.
|
|
11565
12174
|
*
|
|
12175
|
+
* @category Analytics
|
|
11566
12176
|
* @public
|
|
11567
12177
|
*/
|
|
11568
12178
|
type YouboraAnalyticsIntegrationID = 'youbora';
|
|
@@ -11585,6 +12195,7 @@ type YouboraAnalyticsIntegrationID = 'youbora';
|
|
|
11585
12195
|
*
|
|
11586
12196
|
* Available since v2.21.2.
|
|
11587
12197
|
*
|
|
12198
|
+
* @category Analytics
|
|
11588
12199
|
* @public
|
|
11589
12200
|
*/
|
|
11590
12201
|
interface YouboraOptions extends AnalyticsDescription {
|
|
@@ -11601,6 +12212,7 @@ interface YouboraOptions extends AnalyticsDescription {
|
|
|
11601
12212
|
}
|
|
11602
12213
|
|
|
11603
12214
|
/**
|
|
12215
|
+
* @category Multi-view
|
|
11604
12216
|
* @public
|
|
11605
12217
|
*/
|
|
11606
12218
|
declare enum MultiViewPlayerLayout {
|
|
@@ -11611,6 +12223,7 @@ declare enum MultiViewPlayerLayout {
|
|
|
11611
12223
|
/**
|
|
11612
12224
|
* The View API
|
|
11613
12225
|
*
|
|
12226
|
+
* @category Multi-view
|
|
11614
12227
|
* @public
|
|
11615
12228
|
*/
|
|
11616
12229
|
interface View {
|
|
@@ -11692,6 +12305,7 @@ interface View {
|
|
|
11692
12305
|
/**
|
|
11693
12306
|
* The MultiViewPlayer API
|
|
11694
12307
|
*
|
|
12308
|
+
* @category Multi-view
|
|
11695
12309
|
* @public
|
|
11696
12310
|
*/
|
|
11697
12311
|
interface MultiViewPlayerEventMap {
|
|
@@ -11836,9 +12450,11 @@ interface MultiViewPlayerEventMap {
|
|
|
11836
12450
|
*
|
|
11837
12451
|
* @remarks
|
|
11838
12452
|
* <br/> - Available since v4.3.0
|
|
11839
|
-
* <br/> - Only available with the feature `'
|
|
12453
|
+
* <br/> - Only available with the feature `'multiview'`.
|
|
11840
12454
|
* <br/> - Only supported on modern browsers such as evergreen Chrome, Firefox and Safari. Not supported on Internet Explorer.
|
|
11841
12455
|
*
|
|
12456
|
+
* @category API
|
|
12457
|
+
* @category Multi-view
|
|
11842
12458
|
* @public
|
|
11843
12459
|
*/
|
|
11844
12460
|
declare class MultiViewPlayer implements EventDispatcher<MultiViewPlayerEventMap> {
|
|
@@ -11979,6 +12595,8 @@ declare class MultiViewPlayer implements EventDispatcher<MultiViewPlayerEventMap
|
|
|
11979
12595
|
/**
|
|
11980
12596
|
* Fired when a new {@link View} has been added to the {@link MultiViewPlayer}.
|
|
11981
12597
|
*
|
|
12598
|
+
* @category Multi-view
|
|
12599
|
+
* @category Events
|
|
11982
12600
|
* @public
|
|
11983
12601
|
*/
|
|
11984
12602
|
interface AddViewEvent extends Event<'addview'> {
|
|
@@ -11990,6 +12608,8 @@ interface AddViewEvent extends Event<'addview'> {
|
|
|
11990
12608
|
/**
|
|
11991
12609
|
* Fired when a {@link View} has been removed from the {@link MultiViewPlayer}.
|
|
11992
12610
|
*
|
|
12611
|
+
* @category Multi-view
|
|
12612
|
+
* @category Events
|
|
11993
12613
|
* @public
|
|
11994
12614
|
*/
|
|
11995
12615
|
interface RemoveViewEvent extends Event<'removeview'> {
|
|
@@ -12001,6 +12621,8 @@ interface RemoveViewEvent extends Event<'removeview'> {
|
|
|
12001
12621
|
/**
|
|
12002
12622
|
* Fired when a view's {@link View.enabled | enabled} changes.
|
|
12003
12623
|
*
|
|
12624
|
+
* @category Multi-view
|
|
12625
|
+
* @category Events
|
|
12004
12626
|
* @public
|
|
12005
12627
|
*/
|
|
12006
12628
|
interface ViewChangeEvent extends Event<'viewchange'> {
|
|
@@ -12012,6 +12634,8 @@ interface ViewChangeEvent extends Event<'viewchange'> {
|
|
|
12012
12634
|
/**
|
|
12013
12635
|
* Fired when a {@link View} has swapped positions in the list.
|
|
12014
12636
|
*
|
|
12637
|
+
* @category Multi-view
|
|
12638
|
+
* @category Events
|
|
12015
12639
|
* @public
|
|
12016
12640
|
*/
|
|
12017
12641
|
interface ViewPositionChangeEvent extends Event<'viewpositionchange'> {
|
|
@@ -12027,6 +12651,8 @@ interface ViewPositionChangeEvent extends Event<'viewpositionchange'> {
|
|
|
12027
12651
|
/**
|
|
12028
12652
|
* Fired when {@link MultiViewPlayer.layout} changes.
|
|
12029
12653
|
*
|
|
12654
|
+
* @category Multi-view
|
|
12655
|
+
* @category Events
|
|
12030
12656
|
* @public
|
|
12031
12657
|
*/
|
|
12032
12658
|
interface LayoutChangeEvent extends Event<'layoutchange'> {
|
|
@@ -12039,12 +12665,14 @@ interface LayoutChangeEvent extends Event<'layoutchange'> {
|
|
|
12039
12665
|
/**
|
|
12040
12666
|
* The version of the THEOplayer SDK.
|
|
12041
12667
|
*
|
|
12668
|
+
* @category API
|
|
12042
12669
|
* @public
|
|
12043
12670
|
*/
|
|
12044
12671
|
declare const version: string;
|
|
12045
12672
|
/**
|
|
12046
12673
|
* The player suite version of the THEOplayer SDK.
|
|
12047
12674
|
*
|
|
12675
|
+
* @category API
|
|
12048
12676
|
* @public
|
|
12049
12677
|
* @deprecated Use {@link version | THEOplayer.version} instead.
|
|
12050
12678
|
*/
|
|
@@ -12052,24 +12680,30 @@ declare const playerSuiteVersion: string;
|
|
|
12052
12680
|
/**
|
|
12053
12681
|
* The features included in the THEOplayer SDK.
|
|
12054
12682
|
*
|
|
12683
|
+
* @category API
|
|
12055
12684
|
* @public
|
|
12056
12685
|
*/
|
|
12057
|
-
declare const features: string;
|
|
12686
|
+
declare const features: readonly string[];
|
|
12058
12687
|
/**
|
|
12059
12688
|
* List of players.
|
|
12060
12689
|
*
|
|
12690
|
+
* @category API
|
|
12061
12691
|
* @public
|
|
12062
12692
|
*/
|
|
12063
12693
|
declare const players: PlayerList;
|
|
12064
12694
|
/**
|
|
12065
12695
|
* The global cast API.
|
|
12066
12696
|
*
|
|
12697
|
+
* @category API
|
|
12698
|
+
* @category Casting
|
|
12067
12699
|
* @public
|
|
12068
12700
|
*/
|
|
12069
12701
|
declare const cast: GlobalCast;
|
|
12070
12702
|
/**
|
|
12071
12703
|
* The global cache API.
|
|
12072
12704
|
*
|
|
12705
|
+
* @category API
|
|
12706
|
+
* @category Caching
|
|
12073
12707
|
* @public
|
|
12074
12708
|
*/
|
|
12075
12709
|
declare const cache: Cache;
|
|
@@ -12088,11 +12722,15 @@ declare const cache: Cache;
|
|
|
12088
12722
|
* {@link ContentProtectionIntegration} based on the {@link DRMConfiguration}. This {@link ContentProtectionIntegration} allows for altering license
|
|
12089
12723
|
* and certificate requests and responses.
|
|
12090
12724
|
*
|
|
12725
|
+
* @category API
|
|
12726
|
+
* @category Content Protection
|
|
12091
12727
|
* @public
|
|
12092
12728
|
*/
|
|
12093
12729
|
declare function registerContentProtectionIntegration(integrationId: string, keySystem: KeySystemId, integrationFactory: ContentProtectionIntegrationFactory): void;
|
|
12094
12730
|
/**
|
|
12095
12731
|
* Utils that serve common use cases. For example encoding and decoding a base64 string to Uint8Array and vice versa.
|
|
12732
|
+
*
|
|
12733
|
+
* @category API
|
|
12096
12734
|
* @public
|
|
12097
12735
|
*/
|
|
12098
12736
|
declare const utils: CommonUtils;
|