@theoplayer/extended 6.10.0 → 6.11.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.
@@ -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 {
@@ -341,6 +355,7 @@ interface GoogleImaConfiguration {
341
355
  /**
342
356
  * Represents a non-linear ad in the VAST specification.
343
357
  *
358
+ * @category Ads
344
359
  * @public
345
360
  */
346
361
  interface NonLinearAd extends Ad {
@@ -374,6 +389,7 @@ interface NonLinearAd extends Ad {
374
389
  * @remarks
375
390
  * <br/> - `'streaming'` is currently not supported.
376
391
  *
392
+ * @category Ads
377
393
  * @public
378
394
  */
379
395
  type DeliveryType = 'progressive' | 'streaming';
@@ -383,6 +399,7 @@ type DeliveryType = 'progressive' | 'streaming';
383
399
  * @remarks
384
400
  * <br/> - This metadata is retrieved from the VAST file.
385
401
  *
402
+ * @category Ads
386
403
  * @public
387
404
  */
388
405
  interface MediaFile {
@@ -410,6 +427,7 @@ interface MediaFile {
410
427
  /**
411
428
  * Represents a linear ad in the VAST specification.
412
429
  *
430
+ * @category Ads
413
431
  * @public
414
432
  */
415
433
  interface LinearAd extends Ad {
@@ -431,6 +449,7 @@ interface LinearAd extends Ad {
431
449
  * @remarks
432
450
  * <br/> - Available since v2.60.0.
433
451
  *
452
+ * @category Ads
434
453
  * @public
435
454
  */
436
455
  interface GoogleImaAd extends Ad {
@@ -505,6 +524,7 @@ interface GoogleImaAd extends Ad {
505
524
  /**
506
525
  * Represents the information regarding the universal identifier of an ad.
507
526
  *
527
+ * @category Ads
508
528
  * @public
509
529
  */
510
530
  interface UniversalAdId {
@@ -526,6 +546,7 @@ interface UniversalAdId {
526
546
  /**
527
547
  * Represents an ad break in the VMAP specification or an ad pod in the VAST specification.
528
548
  *
549
+ * @category Ads
529
550
  * @public
530
551
  */
531
552
  interface AdBreak {
@@ -565,6 +586,7 @@ interface AdBreak {
565
586
  /**
566
587
  * Represents a companion ad which is displayed near the video player.
567
588
  *
589
+ * @category Ads
568
590
  * @public
569
591
  */
570
592
  interface CompanionAd {
@@ -624,6 +646,7 @@ interface CompanionAd {
624
646
  /**
625
647
  * The events fired by the {@link Ads | ads API}.
626
648
  *
649
+ * @category Ads
627
650
  * @public
628
651
  */
629
652
  interface AdsEventMap {
@@ -732,6 +755,8 @@ interface AdsEventMap {
732
755
  /**
733
756
  * Base type for events related to a single ad.
734
757
  *
758
+ * @category Ads
759
+ * @category Events
735
760
  * @public
736
761
  */
737
762
  interface AdEvent<TType extends string> extends Event<TType> {
@@ -743,6 +768,8 @@ interface AdEvent<TType extends string> extends Event<TType> {
743
768
  /**
744
769
  * Fired when an ad is skipped.
745
770
  *
771
+ * @category Ads
772
+ * @category Events
746
773
  * @public
747
774
  */
748
775
  interface AdSkipEvent extends AdEvent<'adskip'> {
@@ -754,6 +781,8 @@ interface AdSkipEvent extends AdEvent<'adskip'> {
754
781
  /**
755
782
  * Base type for events related to an ad break.
756
783
  *
784
+ * @category Ads
785
+ * @category Events
757
786
  * @public
758
787
  */
759
788
  interface AdBreakEvent<TType extends string> extends Event<TType> {
@@ -774,6 +803,7 @@ interface AdBreakEvent<TType extends string> extends Event<TType> {
774
803
  * @remarks
775
804
  * <br/> - Integrates with `'theo'`, `'google-ima'`, `'google-dai'` or `'freewheel'`.
776
805
  *
806
+ * @category Ads
777
807
  * @public
778
808
  */
779
809
  interface Ads extends EventDispatcher<AdsEventMap> {
@@ -831,12 +861,14 @@ interface Ads extends EventDispatcher<AdsEventMap> {
831
861
  * @remarks
832
862
  * <br/> - An ad rule is a simplified VMAP alternative only available in the Google IMA integration.
833
863
  *
864
+ * @category Ads
834
865
  * @public
835
866
  */
836
867
  type AdSourceType = 'vast' | 'vmap' | 'adrule';
837
868
  /**
838
869
  * Describes the source of the ad.
839
870
  *
871
+ * @category Ads
840
872
  * @public
841
873
  */
842
874
  interface AdSource {
@@ -854,6 +886,7 @@ interface AdSource {
854
886
  /**
855
887
  * Describes an ad break request.
856
888
  *
889
+ * @category Ads
857
890
  * @public
858
891
  */
859
892
  interface AdDescription {
@@ -940,6 +973,7 @@ interface AdDescription {
940
973
  * }
941
974
  * ```
942
975
  *
976
+ * @category Ads
943
977
  * @public
944
978
  */
945
979
  interface SpotXAdDescription extends AdDescription {
@@ -1015,6 +1049,7 @@ interface SpotXAdDescription extends AdDescription {
1015
1049
  /**
1016
1050
  * Describes a Google IMA ad break request.
1017
1051
  *
1052
+ * @category Ads
1018
1053
  * @public
1019
1054
  */
1020
1055
  interface IMAAdDescription extends AdDescription {
@@ -1041,12 +1076,14 @@ interface IMAAdDescription extends AdDescription {
1041
1076
  * <br/> - `'postroll'`: The linear ad will play after the content ended.
1042
1077
  * <br/> - `'overlay'`: The non-linear ad.
1043
1078
  *
1079
+ * @category Ads
1044
1080
  * @public
1045
1081
  */
1046
1082
  type FreeWheelAdUnitType = 'preroll' | 'midroll' | 'postroll' | 'overlay';
1047
1083
  /**
1048
1084
  * Represents a FreeWheel cue.
1049
1085
  *
1086
+ * @category Ads
1050
1087
  * @public
1051
1088
  */
1052
1089
  interface FreeWheelCue {
@@ -1065,6 +1102,7 @@ interface FreeWheelCue {
1065
1102
  * @remarks
1066
1103
  * <br/> - Available since v2.42.0.
1067
1104
  *
1105
+ * @category Ads
1068
1106
  * @public
1069
1107
  */
1070
1108
  interface FreeWheelAdDescription extends AdDescription {
@@ -1121,6 +1159,7 @@ interface FreeWheelAdDescription extends AdDescription {
1121
1159
  /**
1122
1160
  * Represents a geographical location.
1123
1161
  *
1162
+ * @category Ads
1124
1163
  * @public
1125
1164
  */
1126
1165
  interface Geo {
@@ -1137,6 +1176,7 @@ interface Geo {
1137
1176
  * A record of SpotX query string parameters.
1138
1177
  * Each entry contains the parameter name with associated value.
1139
1178
  *
1179
+ * @category Ads
1140
1180
  * @public
1141
1181
  */
1142
1182
  interface SpotxData {
@@ -1146,6 +1186,7 @@ interface SpotxData {
1146
1186
  * A record of SpotX query string parameters which can be a nested structure.
1147
1187
  * Each entry contains the parameter name with associated value.
1148
1188
  *
1189
+ * @category Ads
1149
1190
  * @public
1150
1191
  */
1151
1192
  interface SpotxQueryParameter {
@@ -1161,6 +1202,7 @@ interface SpotxQueryParameter {
1161
1202
  * @remarks
1162
1203
  * <br/> - An empty string defaults to `'theo'`.
1163
1204
  *
1205
+ * @category Ads
1164
1206
  * @public
1165
1207
  */
1166
1208
  type AdIntegrationKind = '' | 'theo' | 'google-ima' | 'spotx' | 'freewheel';
@@ -1170,12 +1212,14 @@ type AdIntegrationKind = '' | 'theo' | 'google-ima' | 'spotx' | 'freewheel';
1170
1212
  * <br/> - `'insecure'`: Ads will load in a friendly iframe. This allows access to the site via JavaScript.
1171
1213
  * <br/> - `'disabled'`: Ads will error when requested.
1172
1214
  *
1215
+ * @category Ads
1173
1216
  * @public
1174
1217
  */
1175
1218
  type VPAIDMode = 'enabled' | 'insecure' | 'disabled';
1176
1219
  /**
1177
1220
  * Describes an ad break request.
1178
1221
  *
1222
+ * @category Ads
1179
1223
  * @public
1180
1224
  */
1181
1225
  interface THEOplayerAdDescription extends AdDescription {
@@ -1222,6 +1266,8 @@ type BufferSource = ArrayBufferView | ArrayBuffer;
1222
1266
  /**
1223
1267
  * Describes the key system configuration.
1224
1268
  *
1269
+ * @category Source
1270
+ * @category Content Protection
1225
1271
  * @public
1226
1272
  */
1227
1273
  interface KeySystemConfiguration {
@@ -1314,12 +1360,16 @@ interface KeySystemConfiguration {
1314
1360
  * <br/> - `'temporary'`
1315
1361
  * <br/> - `'persistent'`
1316
1362
  *
1363
+ * @category Source
1364
+ * @category Content Protection
1317
1365
  * @public
1318
1366
  */
1319
1367
  type LicenseType = 'temporary' | 'persistent';
1320
1368
  /**
1321
1369
  * Describes the FairPlay key system configuration.
1322
1370
  *
1371
+ * @category Source
1372
+ * @category Content Protection
1323
1373
  * @public
1324
1374
  */
1325
1375
  interface FairPlayKeySystemConfiguration extends KeySystemConfiguration {
@@ -1331,6 +1381,8 @@ interface FairPlayKeySystemConfiguration extends KeySystemConfiguration {
1331
1381
  /**
1332
1382
  * Describes the PlayReady key system configuration.
1333
1383
  *
1384
+ * @category Source
1385
+ * @category Content Protection
1334
1386
  * @public
1335
1387
  */
1336
1388
  interface PlayReadyKeySystemConfiguration extends KeySystemConfiguration {
@@ -1342,12 +1394,16 @@ interface PlayReadyKeySystemConfiguration extends KeySystemConfiguration {
1342
1394
  /**
1343
1395
  * Describes the Widevine key system configuration.
1344
1396
  *
1397
+ * @category Source
1398
+ * @category Content Protection
1345
1399
  * @public
1346
1400
  */
1347
1401
  type WidevineKeySystemConfiguration = KeySystemConfiguration;
1348
1402
  /**
1349
1403
  * Describes the ClearKey key system configuration.
1350
1404
  *
1405
+ * @category Source
1406
+ * @category Content Protection
1351
1407
  * @public
1352
1408
  */
1353
1409
  interface ClearkeyKeySystemConfiguration extends KeySystemConfiguration {
@@ -1359,6 +1415,8 @@ interface ClearkeyKeySystemConfiguration extends KeySystemConfiguration {
1359
1415
  /**
1360
1416
  * Describes the ClearKey decryption key.
1361
1417
  *
1418
+ * @category Source
1419
+ * @category Content Protection
1362
1420
  * @public
1363
1421
  */
1364
1422
  interface ClearkeyDecryptionKey {
@@ -1382,6 +1440,8 @@ interface ClearkeyDecryptionKey {
1382
1440
  /**
1383
1441
  * Describes the AES128 key system configuration.
1384
1442
  *
1443
+ * @category Source
1444
+ * @category Content Protection
1385
1445
  * @public
1386
1446
  */
1387
1447
  interface AES128KeySystemConfiguration {
@@ -1398,6 +1458,8 @@ interface AES128KeySystemConfiguration {
1398
1458
  /**
1399
1459
  * Describes the configuration of the DRM.
1400
1460
  *
1461
+ * @category Source
1462
+ * @category Content Protection
1401
1463
  * @public
1402
1464
  */
1403
1465
  interface DRMConfiguration {
@@ -1448,6 +1510,8 @@ interface DRMConfiguration {
1448
1510
  /**
1449
1511
  * The id of a key system. Possible values are 'widevine', 'fairplay' and 'playready'.
1450
1512
  *
1513
+ * @category Source
1514
+ * @category Content Protection
1451
1515
  * @public
1452
1516
  */
1453
1517
  type KeySystemId = 'widevine' | 'fairplay' | 'playready';
@@ -1455,6 +1519,8 @@ type KeySystemId = 'widevine' | 'fairplay' | 'playready';
1455
1519
  /**
1456
1520
  * The identifier of the Yospace integration.
1457
1521
  *
1522
+ * @category Source
1523
+ * @category SSAI
1458
1524
  * @public
1459
1525
  */
1460
1526
  type YospaceSSAIIntegrationID = 'yospace';
@@ -1465,6 +1531,8 @@ type YospaceSSAIIntegrationID = 'yospace';
1465
1531
  * <br/> - `'nonlinear'`: The stream is a Non-Linear Start-Over stream.
1466
1532
  * <br/> - `'vod'`: The stream is a video-on-demand stream.
1467
1533
  *
1534
+ * @category Source
1535
+ * @category SSAI
1468
1536
  * @public
1469
1537
  */
1470
1538
  type YospaceStreamType = 'vod' | 'live' | 'livepause' | 'nonlinear';
@@ -1474,6 +1542,8 @@ type YospaceStreamType = 'vod' | 'live' | 'livepause' | 'nonlinear';
1474
1542
  * @remarks
1475
1543
  * <br/> - Available since v2.14.7.
1476
1544
  *
1545
+ * @category Source
1546
+ * @category SSAI
1477
1547
  * @public
1478
1548
  */
1479
1549
  interface YospaceServerSideAdInsertionConfiguration extends ServerSideAdInsertionConfiguration {
@@ -1491,6 +1561,8 @@ interface YospaceServerSideAdInsertionConfiguration extends ServerSideAdInsertio
1491
1561
  /**
1492
1562
  * Represents a media resource with a Yospace server-side ad insertion request.
1493
1563
  *
1564
+ * @category Source
1565
+ * @category SSAI
1494
1566
  * @public
1495
1567
  */
1496
1568
  interface YospaceTypedSource extends TypedSource {
@@ -1500,6 +1572,8 @@ interface YospaceTypedSource extends TypedSource {
1500
1572
  /**
1501
1573
  * The identifier of the Google DAI integration.
1502
1574
  *
1575
+ * @category Source
1576
+ * @category SSAI
1503
1577
  * @public
1504
1578
  */
1505
1579
  type GoogleDAISSAIIntegrationID = 'google-dai';
@@ -1508,6 +1582,8 @@ type GoogleDAISSAIIntegrationID = 'google-dai';
1508
1582
  * <br/> - `'live'`: The requested stream is a live stream.
1509
1583
  * <br/> - `'vod'`: The requested stream is a video-on-demand stream.
1510
1584
  *
1585
+ * @category Source
1586
+ * @category SSAI
1511
1587
  * @public
1512
1588
  */
1513
1589
  type DAIAvailabilityType = 'vod' | 'live';
@@ -1517,6 +1593,8 @@ type DAIAvailabilityType = 'vod' | 'live';
1517
1593
  * @remarks
1518
1594
  * <br/> - Available since v2.30.0.
1519
1595
  *
1596
+ * @category Source
1597
+ * @category SSAI
1520
1598
  * @public
1521
1599
  */
1522
1600
  interface GoogleDAIConfiguration extends ServerSideAdInsertionConfiguration {
@@ -1570,6 +1648,8 @@ interface GoogleDAIConfiguration extends ServerSideAdInsertionConfiguration {
1570
1648
  * @remarks
1571
1649
  * <br/> - Available since v2.30.0.
1572
1650
  *
1651
+ * @category Source
1652
+ * @category SSAI
1573
1653
  * @public
1574
1654
  */
1575
1655
  interface GoogleDAILiveConfiguration extends GoogleDAIConfiguration {
@@ -1592,6 +1672,8 @@ interface GoogleDAILiveConfiguration extends GoogleDAIConfiguration {
1592
1672
  * @remarks
1593
1673
  * <br/> - Available since v2.30.0.
1594
1674
  *
1675
+ * @category Source
1676
+ * @category SSAI
1595
1677
  * @public
1596
1678
  */
1597
1679
  interface GoogleDAIVodConfiguration extends GoogleDAIConfiguration {
@@ -1618,6 +1700,8 @@ interface GoogleDAIVodConfiguration extends GoogleDAIConfiguration {
1618
1700
  /**
1619
1701
  * Represents a media resource with a Google DAI server-side ad insertion request.
1620
1702
  *
1703
+ * @category Source
1704
+ * @category SSAI
1621
1705
  * @public
1622
1706
  */
1623
1707
  interface GoogleDAITypedSource extends TypedSource {
@@ -1633,12 +1717,16 @@ interface GoogleDAITypedSource extends TypedSource {
1633
1717
  /**
1634
1718
  * The identifier of the Imagine integration.
1635
1719
  *
1720
+ * @category Source
1721
+ * @category SSAI
1636
1722
  * @public
1637
1723
  */
1638
1724
  type ImagineSSAIIntegrationID = 'imagine';
1639
1725
  /**
1640
1726
  * Describes the SSAI configuration of the Imagine integration.
1641
1727
  *
1728
+ * @category Source
1729
+ * @category SSAI
1642
1730
  * @public
1643
1731
  */
1644
1732
  interface ImagineServerSideAdInsertionConfiguration extends ServerSideAdInsertionConfiguration {
@@ -1650,6 +1738,8 @@ interface ImagineServerSideAdInsertionConfiguration extends ServerSideAdInsertio
1650
1738
  /**
1651
1739
  * Describes a source of the Imagine integration.
1652
1740
  *
1741
+ * @category Source
1742
+ * @category SSAI
1653
1743
  * @public
1654
1744
  */
1655
1745
  interface ImagineTypedSource extends TypedSource {
@@ -1662,6 +1752,8 @@ interface ImagineTypedSource extends TypedSource {
1662
1752
  * <br/> - `'google-dai'`: The configuration with this identifier is a {@link GoogleDAIConfiguration}
1663
1753
  * <br/> - `'imagine'`: The configuration with this identifier is a {@link ImagineServerSideAdInsertionConfiguration}
1664
1754
  *
1755
+ * @category Source
1756
+ * @category SSAI
1665
1757
  * @public
1666
1758
  */
1667
1759
  type SSAIIntegrationId = YospaceSSAIIntegrationID | GoogleDAISSAIIntegrationID | ImagineSSAIIntegrationID;
@@ -1671,6 +1763,8 @@ type SSAIIntegrationId = YospaceSSAIIntegrationID | GoogleDAISSAIIntegrationID |
1671
1763
  * @remarks
1672
1764
  * <br/> - Available since v2.12.0.
1673
1765
  *
1766
+ * @category Source
1767
+ * @category SSAI
1674
1768
  * @public
1675
1769
  */
1676
1770
  interface ServerSideAdInsertionConfiguration {
@@ -1686,6 +1780,7 @@ interface ServerSideAdInsertionConfiguration {
1686
1780
  * <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
1781
  * <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
1782
  *
1783
+ * @category VR
1689
1784
  * @public
1690
1785
  */
1691
1786
  type VRStereoMode = '' | 'horizontal' | 'vertical';
@@ -1695,6 +1790,7 @@ type VRStereoMode = '' | 'horizontal' | 'vertical';
1695
1790
  * <br/> - `'360'`: The video contains content with a full 360 degree field of view.
1696
1791
  * <br/> - `'180'`: The video contains content with a 180 degree field of view. `'180'` is only available when using the WebXR API.
1697
1792
  *
1793
+ * @category VR
1698
1794
  * @public
1699
1795
  */
1700
1796
  type VRPanoramaMode = '' | '360' | '180';
@@ -1705,6 +1801,7 @@ type VRPanoramaMode = '' | '360' | '180';
1705
1801
  * <br/> - Available since v2.12.0.
1706
1802
  * <br/> - See {@link VR | the VR API} to control display of VR videos.
1707
1803
  *
1804
+ * @category VR
1708
1805
  * @public
1709
1806
  */
1710
1807
  interface VRConfiguration {
@@ -1743,6 +1840,7 @@ interface VRConfiguration {
1743
1840
  /**
1744
1841
  * Describes the configuration of the Cast integrations.
1745
1842
  *
1843
+ * @category Casting
1746
1844
  * @public
1747
1845
  */
1748
1846
  interface CastConfiguration {
@@ -1765,12 +1863,14 @@ interface CastConfiguration {
1765
1863
  * <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
1864
  * <br/> - `'disabled'` : The player is not affected by cast sessions and is not castable.
1767
1865
  *
1866
+ * @category Casting
1768
1867
  * @public
1769
1868
  */
1770
1869
  type JoinStrategy = 'auto' | 'manual' | 'disabled';
1771
1870
  /**
1772
1871
  * Describes the configuration of the Chromecast integration.
1773
1872
  *
1873
+ * @category Casting
1774
1874
  * @public
1775
1875
  */
1776
1876
  interface ChromecastConfiguration {
@@ -1788,12 +1888,14 @@ interface ChromecastConfiguration {
1788
1888
  * <br/> - `'play-none'`: Plays none of the ad breaks skipped due to a seek.
1789
1889
  * <br/> - `'play-last'`: Plays the last ad break skipped due to a seek.
1790
1890
  *
1891
+ * @category Verizon Media
1791
1892
  * @public
1792
1893
  */
1793
1894
  type SkippedAdStrategy = 'play-all' | 'play-none' | 'play-last';
1794
1895
  /**
1795
1896
  * Describes the configuration of the Verizon Media integration.
1796
1897
  *
1898
+ * @category Verizon Media
1797
1899
  * @public
1798
1900
  */
1799
1901
  interface VerizonMediaConfiguration {
@@ -1825,6 +1927,7 @@ interface VerizonMediaConfiguration {
1825
1927
  /**
1826
1928
  * Describes the UI configuration of the Verizon Media integration.
1827
1929
  *
1930
+ * @category Verizon Media
1828
1931
  * @public
1829
1932
  */
1830
1933
  interface VerizonMediaUiConfiguration {
@@ -1863,6 +1966,8 @@ interface VerizonMediaUiConfiguration {
1863
1966
  /**
1864
1967
  * Describes the ABR configuration for a specific source.
1865
1968
  *
1969
+ * @category Source
1970
+ * @category ABR
1866
1971
  * @public
1867
1972
  */
1868
1973
  interface SourceAbrConfiguration {
@@ -1891,6 +1996,7 @@ interface SourceAbrConfiguration {
1891
1996
  /**
1892
1997
  * Describes the VR configuration
1893
1998
  *
1999
+ * @category VR
1894
2000
  * @public
1895
2001
  */
1896
2002
  interface VRPlayerConfiguration {
@@ -1905,6 +2011,7 @@ interface VRPlayerConfiguration {
1905
2011
  /**
1906
2012
  * Object containing values used for the player's retry mechanisms.
1907
2013
  *
2014
+ * @category Player
1908
2015
  * @public
1909
2016
  */
1910
2017
  interface RetryConfiguration {
@@ -1929,6 +2036,7 @@ interface RetryConfiguration {
1929
2036
  /**
1930
2037
  * Describes a player's configuration.
1931
2038
  *
2039
+ * @category Player
1932
2040
  * @public
1933
2041
  */
1934
2042
  interface PlayerConfiguration {
@@ -2078,6 +2186,7 @@ interface PlayerConfiguration {
2078
2186
  * <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
2187
  * <br/> - `'content'`: Allow muted autoplay only for the main content. Disallow muted autoplay for e.g. advertisements. (Not yet supported.)
2080
2188
  *
2189
+ * @category Player
2081
2190
  * @public
2082
2191
  */
2083
2192
  type MutedAutoplayConfiguration = 'none' | 'all' | 'content';
@@ -2088,6 +2197,8 @@ type MutedAutoplayConfiguration = 'none' | 'all' | 'content';
2088
2197
  * @remarks
2089
2198
  * <br/> - Available since v2.21.0.
2090
2199
  *
2200
+ * @category Source
2201
+ * @category Casting
2091
2202
  * @public
2092
2203
  */
2093
2204
  interface ChromecastMetadataImage {
@@ -2111,6 +2222,8 @@ interface ChromecastMetadataImage {
2111
2222
  * <br/> - `'tv-show'`
2112
2223
  * <br/> - `'generic'`
2113
2224
  *
2225
+ * @category Source
2226
+ * @category Casting
2114
2227
  * @public
2115
2228
  */
2116
2229
  type ChromecastMetadataType = 'movie' | 'audio' | 'tv-show' | 'generic';
@@ -2120,6 +2233,7 @@ type ChromecastMetadataType = 'movie' | 'audio' | 'tv-show' | 'generic';
2120
2233
  * @remarks
2121
2234
  * <br/> - Available since v2.21.0.
2122
2235
  *
2236
+ * @category Source
2123
2237
  * @public
2124
2238
  */
2125
2239
  interface MetadataDescription {
@@ -2137,6 +2251,8 @@ interface MetadataDescription {
2137
2251
  * <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
2252
  * <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
2253
  *
2254
+ * @category Source
2255
+ * @category Casting
2140
2256
  * @public
2141
2257
  */
2142
2258
  interface ChromecastMetadataDescription extends MetadataDescription {
@@ -2301,6 +2417,8 @@ interface ChromecastMetadataDescription extends MetadataDescription {
2301
2417
  /**
2302
2418
  * Represents a media resource which is found on the Verizon Media Platform.
2303
2419
  *
2420
+ * @category Source
2421
+ * @category Verizon Media
2304
2422
  * @public
2305
2423
  */
2306
2424
  interface VerizonMediaSource extends BaseSource {
@@ -2384,6 +2502,8 @@ interface VerizonMediaSource extends BaseSource {
2384
2502
  * @remarks
2385
2503
  * <br/> - This asset identifier determines a unique asset on the Verizon Media Platform.
2386
2504
  *
2505
+ * @category Source
2506
+ * @category Verizon Media
2387
2507
  * @public
2388
2508
  */
2389
2509
  type VerizonMediaAssetId = string;
@@ -2393,6 +2513,8 @@ type VerizonMediaAssetId = string;
2393
2513
  * @remarks
2394
2514
  * <br/> - Each combination of the user identifier and external identifier determines a unique asset on the Verizon Media Platform.
2395
2515
  *
2516
+ * @category Source
2517
+ * @category Verizon Media
2396
2518
  * @public
2397
2519
  */
2398
2520
  interface VerizonMediaExternalId {
@@ -2408,6 +2530,8 @@ interface VerizonMediaExternalId {
2408
2530
  /**
2409
2531
  * Describes the configuration of Verizon Media Ping features.
2410
2532
  *
2533
+ * @category Source
2534
+ * @category Verizon Media
2411
2535
  * @public
2412
2536
  */
2413
2537
  interface VerizonMediaPingConfiguration {
@@ -2447,6 +2571,8 @@ interface VerizonMediaPingConfiguration {
2447
2571
  * <br/> - `'channel'`: A Live content channel.
2448
2572
  * <br/> - `'event'`: A Live event.
2449
2573
  *
2574
+ * @category Source
2575
+ * @category Verizon Media
2450
2576
  * @public
2451
2577
  */
2452
2578
  type VerizonMediaAssetType = 'asset' | 'channel' | 'event';
@@ -2469,6 +2595,7 @@ type VerizonMediaAssetType = 'asset' | 'channel' | 'event';
2469
2595
  * Use this if you notice that the player is attempting but failing to preload the next period on the current platform only when
2470
2596
  * content protection is different between periods.
2471
2597
  *
2598
+ * @category Source
2472
2599
  * @public
2473
2600
  */
2474
2601
  type SeamlessPeriodSwitchStrategy = 'auto' | 'always' | 'never' | 'clear-only' | 'same-drm-only';
@@ -2478,6 +2605,7 @@ type SeamlessPeriodSwitchStrategy = 'auto' | 'always' | 'never' | 'clear-only' |
2478
2605
  * @remarks
2479
2606
  * <br/> - Available since v2.79.0.
2480
2607
  *
2608
+ * @category Source
2481
2609
  * @public
2482
2610
  */
2483
2611
  interface DashPlaybackConfiguration {
@@ -2574,6 +2702,7 @@ interface DashPlaybackConfiguration {
2574
2702
  * @remarks
2575
2703
  * <br/> - See {@link HlsPlaybackConfiguration.discontinuityAlignment}.
2576
2704
  *
2705
+ * @category Source
2577
2706
  * @public
2578
2707
  */
2579
2708
  type HlsDiscontinuityAlignment = 'auto' | 'playlist' | 'media';
@@ -2583,6 +2712,7 @@ type HlsDiscontinuityAlignment = 'auto' | 'playlist' | 'media';
2583
2712
  * @remarks
2584
2713
  * <br/> - Available since v2.82.0.
2585
2714
  *
2715
+ * @category Source
2586
2716
  * @public
2587
2717
  */
2588
2718
  interface HlsPlaybackConfiguration {
@@ -2597,6 +2727,8 @@ interface HlsPlaybackConfiguration {
2597
2727
  /**
2598
2728
  * Fired when a text track cue is entered.
2599
2729
  *
2730
+ * @category Media and Text Tracks
2731
+ * @category Events
2600
2732
  * @public
2601
2733
  */
2602
2734
  interface TextTrackCueEnterEvent extends Event<'enter'> {
@@ -2608,6 +2740,8 @@ interface TextTrackCueEnterEvent extends Event<'enter'> {
2608
2740
  /**
2609
2741
  * Fired when a text track cue is exited.
2610
2742
  *
2743
+ * @category Media and Text Tracks
2744
+ * @category Events
2611
2745
  * @public
2612
2746
  */
2613
2747
  interface TextTrackCueExitEvent extends Event<'exit'> {
@@ -2619,6 +2753,8 @@ interface TextTrackCueExitEvent extends Event<'exit'> {
2619
2753
  /**
2620
2754
  * Fired when a text track cue is updated.
2621
2755
  *
2756
+ * @category Media and Text Tracks
2757
+ * @category Events
2622
2758
  * @public
2623
2759
  */
2624
2760
  interface TextTrackCueUpdateEvent extends Event<'update'> {
@@ -2630,6 +2766,7 @@ interface TextTrackCueUpdateEvent extends Event<'update'> {
2630
2766
  /**
2631
2767
  * The events fired by the {@link TextTrackCue}.
2632
2768
  *
2769
+ * @category Media and Text Tracks
2633
2770
  * @public
2634
2771
  */
2635
2772
  interface TextTrackCueEventMap {
@@ -2649,6 +2786,7 @@ interface TextTrackCueEventMap {
2649
2786
  /**
2650
2787
  * Represents a cue of a text track.
2651
2788
  *
2789
+ * @category Media and Text Tracks
2652
2790
  * @public
2653
2791
  */
2654
2792
  interface TextTrackCue extends EventDispatcher<TextTrackCueEventMap> {
@@ -2692,6 +2830,7 @@ interface TextTrackCue extends EventDispatcher<TextTrackCueEventMap> {
2692
2830
  /**
2693
2831
  * List of text track cues.
2694
2832
  *
2833
+ * @category Media and Text Tracks
2695
2834
  * @public
2696
2835
  */
2697
2836
  interface TextTrackCueList extends ReadonlyArray<TextTrackCue> {
@@ -2715,6 +2854,8 @@ interface TextTrackCueList extends ReadonlyArray<TextTrackCue> {
2715
2854
  /**
2716
2855
  * Fired when a new track has been added to this list.
2717
2856
  *
2857
+ * @category Media and Text Tracks
2858
+ * @category Events
2718
2859
  * @public
2719
2860
  */
2720
2861
  interface AddTrackEvent extends Event<'addtrack'> {
@@ -2726,6 +2867,8 @@ interface AddTrackEvent extends Event<'addtrack'> {
2726
2867
  /**
2727
2868
  * Fired when a track has been removed to this list.
2728
2869
  *
2870
+ * @category Media and Text Tracks
2871
+ * @category Events
2729
2872
  * @public
2730
2873
  */
2731
2874
  interface RemoveTrackEvent extends Event<'removetrack'> {
@@ -2737,6 +2880,8 @@ interface RemoveTrackEvent extends Event<'removetrack'> {
2737
2880
  /**
2738
2881
  * Fired when a track has been changed.
2739
2882
  *
2883
+ * @category Media and Text Tracks
2884
+ * @category Events
2740
2885
  * @public
2741
2886
  */
2742
2887
  interface TrackChangeEvent extends Event<'change'> {
@@ -2748,6 +2893,7 @@ interface TrackChangeEvent extends Event<'change'> {
2748
2893
  /**
2749
2894
  * The events fired by a {@link TrackList}.
2750
2895
  *
2896
+ * @category Media and Text Tracks
2751
2897
  * @public
2752
2898
  */
2753
2899
  interface TrackListEventMap {
@@ -2768,6 +2914,8 @@ interface TrackListEventMap {
2768
2914
  /**
2769
2915
  * Fired when one or more properties of a track have been updated.
2770
2916
  *
2917
+ * @category Media and Text Tracks
2918
+ * @category Events
2771
2919
  * @public
2772
2920
  */
2773
2921
  interface TrackUpdateEvent extends Event<'update'> {
@@ -2779,6 +2927,7 @@ interface TrackUpdateEvent extends Event<'update'> {
2779
2927
  /**
2780
2928
  * The events fired by a {@link Track}.
2781
2929
  *
2930
+ * @category Media and Text Tracks
2782
2931
  * @public
2783
2932
  */
2784
2933
  interface TrackEventMap {
@@ -2800,6 +2949,7 @@ interface TrackEventMap {
2800
2949
  * @remarks
2801
2950
  * <br/> - A specific track type (e.g. {@link TextTrack}) will always be used.
2802
2951
  *
2952
+ * @category Media and Text Tracks
2803
2953
  * @public
2804
2954
  */
2805
2955
  interface Track extends EventDispatcher<TrackEventMap> {
@@ -2845,6 +2995,7 @@ interface Track extends EventDispatcher<TrackEventMap> {
2845
2995
  /**
2846
2996
  * Possible accessibility roles.
2847
2997
  *
2998
+ * @category Media and Text Tracks
2848
2999
  * @public
2849
3000
  */
2850
3001
  type AccessibilityRole = 'caption' | 'sign' | 'description' | 'enhanced audio intelligibility' | 'easy reader' | 'transcribes spoken dialog' | 'describes music and sound' | 'describes video';
@@ -2852,6 +3003,7 @@ type AccessibilityRole = 'caption' | 'sign' | 'description' | 'enhanced audio in
2852
3003
  /**
2853
3004
  * A code that indicates the type of error that has occurred.
2854
3005
  *
3006
+ * @category Errors
2855
3007
  * @public
2856
3008
  */
2857
3009
  declare enum ErrorCode {
@@ -3029,6 +3181,7 @@ declare enum ErrorCode {
3029
3181
  /**
3030
3182
  * The category of an error.
3031
3183
  *
3184
+ * @category Errors
3032
3185
  * @public
3033
3186
  */
3034
3187
  declare enum ErrorCategory {
@@ -3082,6 +3235,9 @@ declare enum ErrorCategory {
3082
3235
  CACHE = 12
3083
3236
  }
3084
3237
  /**
3238
+ * The category of an error.
3239
+ *
3240
+ * @category Errors
3085
3241
  * @public
3086
3242
  */
3087
3243
  declare namespace ErrorCategory {
@@ -3096,6 +3252,7 @@ declare namespace ErrorCategory {
3096
3252
  /**
3097
3253
  * An error that is thrown by THEOplayer.
3098
3254
  *
3255
+ * @category Errors
3099
3256
  * @public
3100
3257
  */
3101
3258
  interface THEOplayerError extends Error {
@@ -3119,6 +3276,8 @@ interface THEOplayerError extends Error {
3119
3276
  /**
3120
3277
  * Fired when an error occurs.
3121
3278
  *
3279
+ * @category Errors
3280
+ * @category Events
3122
3281
  * @public
3123
3282
  */
3124
3283
  interface ErrorEvent extends Event<'error'> {
@@ -3137,12 +3296,16 @@ interface ErrorEvent extends Event<'error'> {
3137
3296
  /**
3138
3297
  * An error code whose category is `ErrorCategory.SUBTITLE`.
3139
3298
  *
3299
+ * @category Media and Text Tracks
3300
+ * @category Errors
3140
3301
  * @public
3141
3302
  */
3142
3303
  type TextTrackErrorCode = ErrorCode.SUBTITLE_LOAD_ERROR | ErrorCode.SUBTITLE_CORS_ERROR | ErrorCode.SUBTITLE_PARSE_ERROR;
3143
3304
  /**
3144
3305
  * An error thrown by a text track.
3145
3306
  *
3307
+ * @category Media and Text Tracks
3308
+ * @category Errors
3146
3309
  * @public
3147
3310
  */
3148
3311
  interface TextTrackError extends THEOplayerError {
@@ -3172,6 +3335,7 @@ interface TextTrackError extends THEOplayerError {
3172
3335
  * <br/> - `'daterange'`: The track contains HLS EXT-X-DATERANGE content.
3173
3336
  * <br/> - `''`: The type of the track contents is unknown.
3174
3337
  *
3338
+ * @category Media and Text Tracks
3175
3339
  * @public
3176
3340
  */
3177
3341
  type TextTrackType = 'srt' | 'ttml' | 'webvtt' | 'emsg' | 'eventstream' | 'id3' | 'cea608' | 'daterange' | '';
@@ -3182,12 +3346,16 @@ type TextTrackType = 'srt' | 'ttml' | 'webvtt' | 'emsg' | 'eventstream' | 'id3'
3182
3346
  * <br/> - `2`: The text track has been loaded with no fatal errors.
3183
3347
  * <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
3348
  *
3349
+ * @category Media and Text Tracks
3185
3350
  * @public
3186
3351
  */
3187
3352
  type TextTrackReadyState = 0 | 1 | 2 | 3;
3188
3353
  /**
3189
3354
  * An error event fired by a {@link TextTrack}.
3190
3355
  *
3356
+ * @category Media and Text Tracks
3357
+ * @category Errors
3358
+ * @category Events
3191
3359
  * @public
3192
3360
  */
3193
3361
  interface TextTrackErrorEvent extends ErrorEvent {
@@ -3199,6 +3367,8 @@ interface TextTrackErrorEvent extends ErrorEvent {
3199
3367
  /**
3200
3368
  * Fired when a cue is added to the text track.
3201
3369
  *
3370
+ * @category Media and Text Tracks
3371
+ * @category Events
3202
3372
  * @public
3203
3373
  */
3204
3374
  interface TextTrackAddCueEvent extends Event<'addcue'> {
@@ -3210,6 +3380,8 @@ interface TextTrackAddCueEvent extends Event<'addcue'> {
3210
3380
  /**
3211
3381
  * Fired when a cue is removed from the text track.
3212
3382
  *
3383
+ * @category Media and Text Tracks
3384
+ * @category Events
3213
3385
  * @public
3214
3386
  */
3215
3387
  interface TextTrackRemoveCueEvent extends Event<'removecue'> {
@@ -3221,6 +3393,8 @@ interface TextTrackRemoveCueEvent extends Event<'removecue'> {
3221
3393
  /**
3222
3394
  * Fired when a cue from the text track is updated.
3223
3395
  *
3396
+ * @category Media and Text Tracks
3397
+ * @category Events
3224
3398
  * @public
3225
3399
  */
3226
3400
  interface TextTrackUpdateCueEvent extends Event<'updatecue'> {
@@ -3232,6 +3406,8 @@ interface TextTrackUpdateCueEvent extends Event<'updatecue'> {
3232
3406
  /**
3233
3407
  * Fired when a cue of the text track has entered.
3234
3408
  *
3409
+ * @category Media and Text Tracks
3410
+ * @category Events
3235
3411
  * @public
3236
3412
  */
3237
3413
  interface TextTrackEnterCueEvent extends Event<'entercue'> {
@@ -3243,6 +3419,8 @@ interface TextTrackEnterCueEvent extends Event<'entercue'> {
3243
3419
  /**
3244
3420
  * Fired when a cue of the text track has exited.
3245
3421
  *
3422
+ * @category Media and Text Tracks
3423
+ * @category Events
3246
3424
  * @public
3247
3425
  */
3248
3426
  interface TextTrackExitCueEvent extends Event<'exitcue'> {
@@ -3254,6 +3432,8 @@ interface TextTrackExitCueEvent extends Event<'exitcue'> {
3254
3432
  /**
3255
3433
  * Fired when the displaying cues of the text track has changed.
3256
3434
  *
3435
+ * @category Media and Text Tracks
3436
+ * @category Events
3257
3437
  * @public
3258
3438
  */
3259
3439
  interface TextTrackCueChangeEvent extends Event<'cuechange'> {
@@ -3265,6 +3445,8 @@ interface TextTrackCueChangeEvent extends Event<'cuechange'> {
3265
3445
  /**
3266
3446
  * Fired when the {@link TextTrack.readyState | ready state} of the text track has changed.
3267
3447
  *
3448
+ * @category Media and Text Tracks
3449
+ * @category Events
3268
3450
  * @public
3269
3451
  */
3270
3452
  interface TextTrackReadyStateChangeEvent extends Event<'readystatechange'> {
@@ -3280,6 +3462,8 @@ interface TextTrackReadyStateChangeEvent extends Event<'readystatechange'> {
3280
3462
  /**
3281
3463
  * Fired when the {@link TextTrack."type" | type} of the text track has changed.
3282
3464
  *
3465
+ * @category Media and Text Tracks
3466
+ * @category Events
3283
3467
  * @public
3284
3468
  */
3285
3469
  interface TextTrackTypeChangeEvent extends Event<'typechange'> {
@@ -3291,6 +3475,7 @@ interface TextTrackTypeChangeEvent extends Event<'typechange'> {
3291
3475
  /**
3292
3476
  * The events fired by a {@link TextTrack}.
3293
3477
  *
3478
+ * @category Media and Text Tracks
3294
3479
  * @public
3295
3480
  */
3296
3481
  interface TextTrackEventMap extends TrackEventMap {
@@ -3334,6 +3519,7 @@ interface TextTrackEventMap extends TrackEventMap {
3334
3519
  /**
3335
3520
  * Represents a text track of a media resource.
3336
3521
  *
3522
+ * @category Media and Text Tracks
3337
3523
  * @public
3338
3524
  */
3339
3525
  interface TextTrack extends Track, EventDispatcher<TextTrackEventMap> {
@@ -3438,6 +3624,7 @@ interface TextTrack extends Track, EventDispatcher<TextTrackEventMap> {
3438
3624
  * @remarks
3439
3625
  * <br/> - Can be a string value representing the URL of a media resource, a {@link TypedSource} or a {@link VerizonMediaSource}.
3440
3626
  *
3627
+ * @category Source
3441
3628
  * @public
3442
3629
  */
3443
3630
  type Source = string | TypedSource | VerizonMediaSource;
@@ -3447,6 +3634,7 @@ type Source = string | TypedSource | VerizonMediaSource;
3447
3634
  * @remarks
3448
3635
  * <br/> - The order of sources when using a list determines their priority when attempting playback.
3449
3636
  *
3637
+ * @category Source
3450
3638
  * @public
3451
3639
  */
3452
3640
  type Sources = Source | Source[];
@@ -3459,12 +3647,14 @@ type Sources = Source | Source[];
3459
3647
  * @remarks
3460
3648
  * <br/> - See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes | The crossorigin attribute: Requesting CORS access to content}
3461
3649
  *
3650
+ * @category Source
3462
3651
  * @public
3463
3652
  */
3464
3653
  type CrossOriginSetting = '' | 'anonymous' | 'use-credentials';
3465
3654
  /**
3466
3655
  * Describes the configuration of a player's source.
3467
3656
  *
3657
+ * @category Source
3468
3658
  * @public
3469
3659
  */
3470
3660
  interface SourceConfiguration {
@@ -3567,6 +3757,7 @@ interface SourceConfiguration {
3567
3757
  /**
3568
3758
  * Describes the configuration of a player's source.
3569
3759
  *
3760
+ * @category Source
3570
3761
  * @public
3571
3762
  */
3572
3763
  interface SourceDescription extends SourceConfiguration {
@@ -3621,6 +3812,7 @@ interface SourceDescription extends SourceConfiguration {
3621
3812
  /**
3622
3813
  * Describes the configuration of a side-loaded text track.
3623
3814
  *
3815
+ * @category Source
3624
3816
  * @public
3625
3817
  */
3626
3818
  interface TextTrackDescription {
@@ -3686,6 +3878,7 @@ interface TextTrackDescription {
3686
3878
  /**
3687
3879
  * Represents the common properties of a media resource.
3688
3880
  *
3881
+ * @category Source
3689
3882
  * @public
3690
3883
  */
3691
3884
  interface BaseSource {
@@ -3879,12 +4072,14 @@ interface BaseSource {
3879
4072
  * Use this if you notice that the player is attempting but failing to preload the next period on the current platform only when
3880
4073
  * content protection is different between discontinuities.
3881
4074
  * This is only supported for MPEG-DASH.
4075
+ * @category Source
3882
4076
  * @public
3883
4077
  */
3884
4078
  type SeamlessSwitchStrategy = 'auto' | 'always' | 'never' | 'clear-only' | 'same-drm-only';
3885
4079
  /**
3886
4080
  * Represents a media resource characterized by a URL to the resource and optionally information about the resource.
3887
4081
  *
4082
+ * @category Source
3888
4083
  * @public
3889
4084
  */
3890
4085
  interface TypedSource extends BaseSource {
@@ -3940,6 +4135,7 @@ interface TypedSource extends BaseSource {
3940
4135
  * <br/> - `'dvr'`: Live content with DVR.
3941
4136
  * <br/> - `'vod'`: On demand content.
3942
4137
  *
4138
+ * @category Source
3943
4139
  * @public
3944
4140
  */
3945
4141
  type StreamType = 'live' | 'dvr' | 'vod';
@@ -3948,6 +4144,7 @@ type StreamType = 'live' | 'dvr' | 'vod';
3948
4144
  * <br/> - `'verizon-media'`: The source is a {@link VerizonMediaSource}
3949
4145
  * <br/> - `'mediatailor'`: The source contains the MediaTailor initialization url
3950
4146
  *
4147
+ * @category Source
3951
4148
  * @public
3952
4149
  */
3953
4150
  type SourceIntegrationId = 'verizon-media' | 'mediatailor';
@@ -3960,12 +4157,14 @@ type SourceIntegrationId = 'verizon-media' | 'mediatailor';
3960
4157
  * <br/> - `'streamone'`: The description is a {@link StreamOneConfiguration}
3961
4158
  * <br/> - `'smartsight'`: The description is a {@link SmartSightConfiguration}
3962
4159
  *
4160
+ * @category Source
3963
4161
  * @public
3964
4162
  */
3965
4163
  type AnalyticsIntegrationID = 'agama' | 'conviva' | 'youbora' | 'moat' | 'streamone' | 'smartsight';
3966
4164
  /**
3967
4165
  * Describes the configuration of an analytics integration.
3968
4166
  *
4167
+ * @category Source
3969
4168
  * @public
3970
4169
  */
3971
4170
  interface AnalyticsDescription {
@@ -3978,24 +4177,31 @@ interface AnalyticsDescription {
3978
4177
  /**
3979
4178
  * Fired when {@link RelatedContent.sources} changes.
3980
4179
  *
4180
+ * @category UI
4181
+ * @category Events
3981
4182
  * @public
3982
4183
  */
3983
4184
  type RelatedChangeEvent = Event<'relatedchange'>;
3984
4185
  /**
3985
4186
  * Fired when the related content panel is shown.
3986
4187
  *
4188
+ * @category UI
4189
+ * @category Events
3987
4190
  * @public
3988
4191
  */
3989
4192
  type RelatedShowEvent = Event<'show'>;
3990
4193
  /**
3991
4194
  * Fired when the related content panel is hidden.
3992
4195
  *
4196
+ * @category UI
4197
+ * @category Events
3993
4198
  * @public
3994
4199
  */
3995
4200
  type RelatedHideEvent = Event<'hide'>;
3996
4201
  /**
3997
4202
  * The events fired by the {@link RelatedContent | related content API}.
3998
4203
  *
4204
+ * @category UI
3999
4205
  * @public
4000
4206
  */
4001
4207
  interface RelatedContentEventMap {
@@ -4010,6 +4216,7 @@ interface RelatedContentEventMap {
4010
4216
  * @remarks
4011
4217
  * <br/> - Available since v2.14.2.
4012
4218
  *
4219
+ * @category UI
4013
4220
  * @public
4014
4221
  */
4015
4222
  interface RelatedContent extends EventDispatcher<RelatedContentEventMap> {
@@ -4021,6 +4228,7 @@ interface RelatedContent extends EventDispatcher<RelatedContentEventMap> {
4021
4228
  /**
4022
4229
  * The events fired by the {@link UIRelatedContent | related content API (with ui)}.
4023
4230
  *
4231
+ * @category UI
4024
4232
  * @public
4025
4233
  */
4026
4234
  interface UIRelatedContentEventMap extends RelatedContentEventMap {
@@ -4039,6 +4247,7 @@ interface UIRelatedContentEventMap extends RelatedContentEventMap {
4039
4247
  * @remarks
4040
4248
  * <br/> - Available since v2.14.2.
4041
4249
  *
4250
+ * @category UI
4042
4251
  * @public
4043
4252
  */
4044
4253
  interface UIRelatedContent extends RelatedContent, EventDispatcher<UIRelatedContentEventMap> {
@@ -4069,6 +4278,7 @@ interface UIRelatedContent extends RelatedContent, EventDispatcher<UIRelatedCont
4069
4278
  * @remarks
4070
4279
  * <br/> - Available since v2.14.2.
4071
4280
  *
4281
+ * @category UI
4072
4282
  * @public
4073
4283
  */
4074
4284
  interface RelatedContentSource {
@@ -4105,6 +4315,7 @@ interface RelatedContentSource {
4105
4315
  /**
4106
4316
  * List of tracks.
4107
4317
  *
4318
+ * @category Media and Text Tracks
4108
4319
  * @public
4109
4320
  */
4110
4321
  interface TrackList<TTrack extends Track> extends ReadonlyArray<TTrack>, EventDispatcher<TrackListEventMap> {
@@ -4128,6 +4339,7 @@ interface TrackList<TTrack extends Track> extends ReadonlyArray<TTrack>, EventDi
4128
4339
  /**
4129
4340
  * List of text tracks.
4130
4341
  *
4342
+ * @category Media and Text Tracks
4131
4343
  * @public
4132
4344
  */
4133
4345
  interface TextTracksList extends TrackList<TextTrack> {
@@ -4158,12 +4370,14 @@ interface TextTracksList extends TrackList<TextTrack> {
4158
4370
  * <br/> - `6` - LICENSE_INVALID: The player's license was determined to be invalid.
4159
4371
  * <br/> - `7` - ADVERTISEMENT_ERROR: Some kind of advertisement related error occurred.
4160
4372
  *
4373
+ * @category Errors
4161
4374
  * @public
4162
4375
  */
4163
4376
  type MediaErrorCode = 1 | 2 | 3 | 4 | 5 | 6 | 7;
4164
4377
  /**
4165
4378
  * Thrown when a media error occurs.
4166
4379
  *
4380
+ * @category Errors
4167
4381
  * @public
4168
4382
  */
4169
4383
  interface MediaError extends Error {
@@ -4184,6 +4398,7 @@ interface MediaError extends Error {
4184
4398
  /**
4185
4399
  * The events fired by a {@link Quality}.
4186
4400
  *
4401
+ * @category Media and Text Tracks
4187
4402
  * @public
4188
4403
  */
4189
4404
  interface QualityEventMap {
@@ -4195,6 +4410,8 @@ interface QualityEventMap {
4195
4410
  /**
4196
4411
  * Fired when the quality updates.
4197
4412
  *
4413
+ * @category Media and Text Tracks
4414
+ * @category Events
4198
4415
  * @public
4199
4416
  */
4200
4417
  interface UpdateQualityEvent extends Event<'update'> {
@@ -4206,6 +4423,7 @@ interface UpdateQualityEvent extends Event<'update'> {
4206
4423
  /**
4207
4424
  * Represents a quality of a media track.
4208
4425
  *
4426
+ * @category Media and Text Tracks
4209
4427
  * @public
4210
4428
  */
4211
4429
  interface Quality extends EventDispatcher<QualityEventMap> {
@@ -4259,6 +4477,7 @@ interface Quality extends EventDispatcher<QualityEventMap> {
4259
4477
  /**
4260
4478
  * Represents a quality of a video track.
4261
4479
  *
4480
+ * @category Media and Text Tracks
4262
4481
  * @public
4263
4482
  */
4264
4483
  interface VideoQuality extends Quality {
@@ -4282,6 +4501,7 @@ interface VideoQuality extends Quality {
4282
4501
  /**
4283
4502
  * Represents a quality of an audio track.
4284
4503
  *
4504
+ * @category Media and Text Tracks
4285
4505
  * @public
4286
4506
  */
4287
4507
  interface AudioQuality extends Quality {
@@ -4294,6 +4514,7 @@ interface AudioQuality extends Quality {
4294
4514
  /**
4295
4515
  * List of qualities.
4296
4516
  *
4517
+ * @category Media and Text Tracks
4297
4518
  * @public
4298
4519
  */
4299
4520
  interface QualityList extends Array<Quality> {
@@ -4311,8 +4532,10 @@ interface QualityList extends Array<Quality> {
4311
4532
  }
4312
4533
 
4313
4534
  /**
4314
- * An quality-related event fired by a {@link MediaTrack}.
4535
+ * A quality-related event fired by a {@link MediaTrack}.
4315
4536
  *
4537
+ * @category Media and Text Tracks
4538
+ * @category Events
4316
4539
  * @public
4317
4540
  */
4318
4541
  interface QualityEvent<TType extends string> extends Event<TType> {
@@ -4324,6 +4547,8 @@ interface QualityEvent<TType extends string> extends Event<TType> {
4324
4547
  /**
4325
4548
  * Fired when the media track's {@link MediaTrack.targetQuality | target quality} changes.
4326
4549
  *
4550
+ * @category Media and Text Tracks
4551
+ * @category Events
4327
4552
  * @public
4328
4553
  */
4329
4554
  interface TargetQualityChangedEvent extends Event<'targetqualitychanged'> {
@@ -4339,6 +4564,7 @@ interface TargetQualityChangedEvent extends Event<'targetqualitychanged'> {
4339
4564
  /**
4340
4565
  * The events fired by a {@link MediaTrack}.
4341
4566
  *
4567
+ * @category Media and Text Tracks
4342
4568
  * @public
4343
4569
  */
4344
4570
  interface MediaTrackEventMap extends TrackEventMap {
@@ -4361,6 +4587,7 @@ interface MediaTrackEventMap extends TrackEventMap {
4361
4587
  /**
4362
4588
  * Represents a media track (audio or video) of a media resource.
4363
4589
  *
4590
+ * @category Media and Text Tracks
4364
4591
  * @public
4365
4592
  */
4366
4593
  interface MediaTrack extends Track, EventDispatcher<MediaTrackEventMap> {
@@ -4431,6 +4658,7 @@ interface MediaTrack extends Track, EventDispatcher<MediaTrackEventMap> {
4431
4658
  /**
4432
4659
  * List of media tracks.
4433
4660
  *
4661
+ * @category Media and Text Tracks
4434
4662
  * @public
4435
4663
  */
4436
4664
  interface MediaTrackList extends TrackList<MediaTrack> {
@@ -4454,6 +4682,8 @@ interface MediaTrackList extends TrackList<MediaTrack> {
4454
4682
  /**
4455
4683
  * Fires when the cast state changes.
4456
4684
  *
4685
+ * @category Casting
4686
+ * @category Events
4457
4687
  * @public
4458
4688
  */
4459
4689
  interface CastStateChangeEvent extends Event<'statechange'> {
@@ -4470,12 +4700,14 @@ interface CastStateChangeEvent extends Event<'statechange'> {
4470
4700
  * <br/> - `'connecting'`: Cast device available and the player is connecting.
4471
4701
  * <br/> - `'connected'`: Cast device available and the player is connected.
4472
4702
  *
4703
+ * @category Casting
4473
4704
  * @public
4474
4705
  */
4475
4706
  type CastState = 'unavailable' | 'available' | 'connecting' | 'connected';
4476
4707
  /**
4477
4708
  * The events fired by the common vendor APIs.
4478
4709
  *
4710
+ * @category Casting
4479
4711
  * @public
4480
4712
  */
4481
4713
  interface VendorCastEventMap {
@@ -4487,6 +4719,7 @@ interface VendorCastEventMap {
4487
4719
  /**
4488
4720
  * Common API for all cast integrations.
4489
4721
  *
4722
+ * @category Casting
4490
4723
  * @public
4491
4724
  */
4492
4725
  interface VendorCast extends EventDispatcher<VendorCastEventMap> {
@@ -4514,6 +4747,7 @@ interface VendorCast extends EventDispatcher<VendorCastEventMap> {
4514
4747
  /**
4515
4748
  * The events fired by the Chromecast API.
4516
4749
  *
4750
+ * @category Casting
4517
4751
  * @public
4518
4752
  */
4519
4753
  interface ChromecastEventMap extends VendorCastEventMap {
@@ -4525,6 +4759,7 @@ interface ChromecastEventMap extends VendorCastEventMap {
4525
4759
  /**
4526
4760
  * The Chromecast API.
4527
4761
  *
4762
+ * @category Casting
4528
4763
  * @public
4529
4764
  */
4530
4765
  interface Chromecast extends VendorCast, EventDispatcher<ChromecastEventMap> {
@@ -4570,6 +4805,7 @@ interface Chromecast extends VendorCast, EventDispatcher<ChromecastEventMap> {
4570
4805
  /**
4571
4806
  * The ChromecastConnectionCallback.
4572
4807
  *
4808
+ * @category Casting
4573
4809
  * @public
4574
4810
  */
4575
4811
  interface ChromecastConnectionCallback {
@@ -4621,6 +4857,7 @@ interface ChromecastConnectionCallback {
4621
4857
  /**
4622
4858
  * The global Chromecast API.
4623
4859
  *
4860
+ * @category Casting
4624
4861
  * @public
4625
4862
  */
4626
4863
  interface GlobalChromecast {
@@ -4648,6 +4885,8 @@ interface GlobalChromecast {
4648
4885
  /**
4649
4886
  * An error that occurred while casting or attempting to cast to Chromecast.
4650
4887
  *
4888
+ * @category Casting
4889
+ * @category Errors
4651
4890
  * @public
4652
4891
  */
4653
4892
  interface ChromecastError {
@@ -4676,12 +4915,14 @@ interface ChromecastError {
4676
4915
  * @remarks
4677
4916
  * <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
4917
  *
4918
+ * @category Casting
4679
4919
  * @public
4680
4920
  */
4681
4921
  type ChromecastErrorCode = 'CANCEL' | 'TIMEOUT' | 'API_NOT_INITIALIZED' | 'INVALID_PARAMETER' | 'EXTENSION_NOT_COMPATIBLE' | 'EXTENSION_MISSING' | 'RECEIVER_UNAVAILABLE' | 'SESSION_ERROR' | 'CHANNEL_ERROR' | 'LOAD_MEDIA_FAILED';
4682
4922
  /**
4683
4923
  * Fired when an error occurs while casting or trying to cast.
4684
4924
  *
4925
+ * @category Casting
4685
4926
  * @public
4686
4927
  */
4687
4928
  interface ChromecastErrorEvent extends Event<'error'> {
@@ -4694,6 +4935,7 @@ interface ChromecastErrorEvent extends Event<'error'> {
4694
4935
  /**
4695
4936
  * The AirPlay API.
4696
4937
  *
4938
+ * @category Casting
4697
4939
  * @public
4698
4940
  */
4699
4941
  interface AirPlay extends VendorCast {
@@ -4702,6 +4944,7 @@ interface AirPlay extends VendorCast {
4702
4944
  /**
4703
4945
  * The events fired by the {@link Cast | cast API}.
4704
4946
  *
4947
+ * @category Casting
4705
4948
  * @public
4706
4949
  */
4707
4950
  interface CastEventMap {
@@ -4713,6 +4956,7 @@ interface CastEventMap {
4713
4956
  /**
4714
4957
  * The cast API.
4715
4958
  *
4959
+ * @category Casting
4716
4960
  * @public
4717
4961
  */
4718
4962
  interface Cast extends EventDispatcher<CastEventMap> {
@@ -4738,6 +4982,7 @@ interface Cast extends EventDispatcher<CastEventMap> {
4738
4982
  /**
4739
4983
  * The global cast API.
4740
4984
  *
4985
+ * @category Casting
4741
4986
  * @public
4742
4987
  */
4743
4988
  interface GlobalCast {
@@ -4753,6 +4998,7 @@ interface GlobalCast {
4753
4998
  /**
4754
4999
  * Represents a direction in the VR feature.
4755
5000
  *
5001
+ * @category VR
4756
5002
  * @public
4757
5003
  */
4758
5004
  interface VRDirection {
@@ -4784,30 +5030,38 @@ interface VRDirection {
4784
5030
  * <br/> - `'available'`
4785
5031
  * <br/> - `'presenting'`
4786
5032
  *
5033
+ * @category VR
4787
5034
  * @public
4788
5035
  */
4789
5036
  type VRState = 'unavailable' | 'available' | 'presenting';
4790
5037
  /**
4791
5038
  * Fired when the {@link VR.direction} changes.
4792
5039
  *
5040
+ * @category VR
5041
+ * @category Events
4793
5042
  * @public
4794
5043
  */
4795
5044
  type DirectionChangeEvent = Event<'directionchange'>;
4796
5045
  /**
4797
5046
  * Fired when the {@link VR.state} changes.
4798
5047
  *
5048
+ * @category VR
5049
+ * @category Events
4799
5050
  * @public
4800
5051
  */
4801
5052
  type StateChangeEvent = Event<'statechange'>;
4802
5053
  /**
4803
5054
  * Fired when the {@link VR.stereo} changes.
4804
5055
  *
5056
+ * @category VR
5057
+ * @category Events
4805
5058
  * @public
4806
5059
  */
4807
5060
  type StereoChangeEvent = Event<'stereochange'>;
4808
5061
  /**
4809
5062
  * The events fired by the {@link VR | VR API}.
4810
5063
  *
5064
+ * @category VR
4811
5065
  * @public
4812
5066
  */
4813
5067
  interface VREventMap {
@@ -4856,6 +5110,7 @@ interface VREventMap {
4856
5110
  * });
4857
5111
  * ```
4858
5112
  *
5113
+ * @category VR
4859
5114
  * @public
4860
5115
  */
4861
5116
  interface VR extends EventDispatcher<VREventMap> {
@@ -4933,6 +5188,7 @@ interface VR extends EventDispatcher<VREventMap> {
4933
5188
  *
4934
5189
  * Available since v2.12.0.
4935
5190
  *
5191
+ * @category Canvas
4936
5192
  * @public
4937
5193
  */
4938
5194
  interface Canvas {
@@ -5024,6 +5280,7 @@ interface Canvas {
5024
5280
  * @param now - The current time in milliseconds, see {@link https://developer.mozilla.org/en-US/docs/Web/API/Performance/now | performance.now()}.
5025
5281
  * @param metadata - The video frame metadata. If `requestVideoFrameCallback()` is not natively supported, this is `undefined`.
5026
5282
  *
5283
+ * @category Canvas
5027
5284
  * @public
5028
5285
  */
5029
5286
  type VideoFrameRequestCallback = (now: DOMHighResTimeStamp, metadata?: VideoFrameCallbackMetadata) => void;
@@ -5033,6 +5290,7 @@ type VideoFrameRequestCallback = (now: DOMHighResTimeStamp, metadata?: VideoFram
5033
5290
  * @remarks
5034
5291
  * <br/> - See {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement/requestVideoFrameCallback#parameters | requestVideoFrameCallback} for more information.
5035
5292
  *
5293
+ * @category Canvas
5036
5294
  * @public
5037
5295
  */
5038
5296
  interface VideoFrameCallbackMetadata {
@@ -5053,12 +5311,14 @@ interface VideoFrameCallbackMetadata {
5053
5311
  *
5054
5312
  * @param ratio - Describes the ratio of visible pixels of the player.
5055
5313
  *
5314
+ * @category Player
5056
5315
  * @public
5057
5316
  */
5058
5317
  type VisibilityObserverCallback = (ratio: number) => void;
5059
5318
  /**
5060
5319
  * The visibility API.
5061
5320
  *
5321
+ * @category Player
5062
5322
  * @public
5063
5323
  */
5064
5324
  interface Visibility {
@@ -5102,6 +5362,7 @@ interface Visibility {
5102
5362
  /**
5103
5363
  * Represents a visibility observer.
5104
5364
  *
5365
+ * @category Player
5105
5366
  * @public
5106
5367
  */
5107
5368
  interface VisibilityObserver {
@@ -5147,6 +5408,7 @@ interface VisibilityObserver {
5147
5408
  *
5148
5409
  * Available since v2.19.4.
5149
5410
  *
5411
+ * @category Player
5150
5412
  * @public
5151
5413
  */
5152
5414
  interface WebAudio {
@@ -5165,12 +5427,15 @@ interface WebAudio {
5165
5427
  * <br/> - `'fullscreen'`: The player fills the entire screen.
5166
5428
  * <br/> - `'picture-in-picture'`: The player is shown on top of the page (see {@link PiPConfiguration} for more options).
5167
5429
  *
5430
+ * @category Player
5168
5431
  * @public
5169
5432
  */
5170
5433
  type PresentationMode = 'inline' | 'fullscreen' | 'picture-in-picture';
5171
5434
  /**
5172
5435
  * Fired when the presentation mode changes.
5173
5436
  *
5437
+ * @category Player
5438
+ * @category Events
5174
5439
  * @public
5175
5440
  */
5176
5441
  interface PresentationModeChangeEvent extends Event<'presentationmodechange'> {
@@ -5182,6 +5447,7 @@ interface PresentationModeChangeEvent extends Event<'presentationmodechange'> {
5182
5447
  /**
5183
5448
  * The events fired by the {@link Presentation | presentation API}.
5184
5449
  *
5450
+ * @category Player
5185
5451
  * @public
5186
5452
  */
5187
5453
  interface PresentationEventMap {
@@ -5197,6 +5463,7 @@ interface PresentationEventMap {
5197
5463
  /**
5198
5464
  * The presentation API.
5199
5465
  *
5466
+ * @category Player
5200
5467
  * @public
5201
5468
  */
5202
5469
  interface Presentation extends EventDispatcher<PresentationEventMap> {
@@ -5224,6 +5491,7 @@ interface Presentation extends EventDispatcher<PresentationEventMap> {
5224
5491
  /**
5225
5492
  * Provides estimates on the current network state.
5226
5493
  *
5494
+ * @category Network
5227
5495
  * @public
5228
5496
  */
5229
5497
  interface NetworkEstimator {
@@ -5240,6 +5508,7 @@ interface NetworkEstimator {
5240
5508
  /**
5241
5509
  * Measures network metrics of an HTTP request and the associated HTTP response.
5242
5510
  *
5511
+ * @category Network
5243
5512
  * @public
5244
5513
  */
5245
5514
  interface RequestMeasurer {
@@ -5278,6 +5547,7 @@ interface RequestMeasurer {
5278
5547
  /**
5279
5548
  * A {@link NetworkEstimator} that allows measuring the current network state.
5280
5549
  *
5550
+ * @category Network
5281
5551
  * @public
5282
5552
  */
5283
5553
  interface MeasurableNetworkEstimator extends NetworkEstimator {
@@ -5291,12 +5561,14 @@ interface MeasurableNetworkEstimator extends NetworkEstimator {
5291
5561
  /**
5292
5562
  * 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
5563
  *
5564
+ * @category Network
5294
5565
  * @public
5295
5566
  */
5296
5567
  type RequestInterceptor = (request: InterceptableRequest) => void | PromiseLike<void>;
5297
5568
  /**
5298
5569
  * 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
5570
  *
5571
+ * @category Network
5300
5572
  * @public
5301
5573
  */
5302
5574
  type ResponseInterceptor = (response: InterceptableResponse) => void | PromiseLike<void>;
@@ -5304,6 +5576,7 @@ type ResponseInterceptor = (response: InterceptableResponse) => void | PromiseLi
5304
5576
  * Record of HTTP headers.
5305
5577
  * Each entry contains the header name and its associated value.
5306
5578
  *
5579
+ * @category Network
5307
5580
  * @public
5308
5581
  */
5309
5582
  interface HTTPHeaders {
@@ -5312,12 +5585,14 @@ interface HTTPHeaders {
5312
5585
  /**
5313
5586
  * The possible types of an HTTP request body.
5314
5587
  *
5588
+ * @category Network
5315
5589
  * @public
5316
5590
  */
5317
5591
  type RequestBody = ArrayBuffer | ArrayBufferView | string | null;
5318
5592
  /**
5319
5593
  * The possible types of an HTTP response body.
5320
5594
  *
5595
+ * @category Network
5321
5596
  * @public
5322
5597
  */
5323
5598
  type ResponseBody = ArrayBuffer | object | string | null;
@@ -5328,6 +5603,7 @@ type ResponseBody = ArrayBuffer | object | string | null;
5328
5603
  * <br/> - `'preload-hint'`
5329
5604
  * <br/> - `'content-protection'`
5330
5605
  *
5606
+ * @category Network
5331
5607
  * @public
5332
5608
  */
5333
5609
  type RequestType = '' | 'manifest' | 'segment' | 'preload-hint' | 'content-protection';
@@ -5341,6 +5617,7 @@ type RequestType = '' | 'manifest' | 'segment' | 'preload-hint' | 'content-prote
5341
5617
  * <br/> - `'clearkey-license'`
5342
5618
  * <br/> - `'aes128-key'`
5343
5619
  *
5620
+ * @category Network
5344
5621
  * @public
5345
5622
  */
5346
5623
  type ContentProtectionRequestSubType = 'fairplay-license' | 'fairplay-certificate' | 'widevine-license' | 'widevine-certificate' | 'playready-license' | 'clearkey-license' | 'aes128-key';
@@ -5350,6 +5627,7 @@ type ContentProtectionRequestSubType = 'fairplay-license' | 'fairplay-certificat
5350
5627
  * <br/> - Any value of {@link ContentProtectionRequestSubType}
5351
5628
  * <br/> - Empty string (`''`) when the subtype is unknown
5352
5629
  *
5630
+ * @category Network
5353
5631
  * @public
5354
5632
  */
5355
5633
  type RequestSubType = '' | 'initialization-segment' | ContentProtectionRequestSubType;
@@ -5361,6 +5639,7 @@ type RequestSubType = '' | 'initialization-segment' | ContentProtectionRequestSu
5361
5639
  * <br/> - `'image'`
5362
5640
  * <br/> - Empty string (`''`) when the media type is unknown
5363
5641
  *
5642
+ * @category Network
5364
5643
  * @public
5365
5644
  */
5366
5645
  type MediaType = '' | 'audio' | 'video' | 'text' | 'image';
@@ -5371,6 +5650,7 @@ type MediaType = '' | 'audio' | 'video' | 'text' | 'image';
5371
5650
  * <br/> - `'stream'`
5372
5651
  * <br/> - `'text'`
5373
5652
  *
5653
+ * @category Network
5374
5654
  * @public
5375
5655
  */
5376
5656
  type ResponseType = 'arraybuffer' | 'json' | 'stream' | 'text';
@@ -5383,18 +5663,21 @@ type ResponseType = 'arraybuffer' | 'json' | 'stream' | 'text';
5383
5663
  * <br/> - `'DELETE'`
5384
5664
  * <br/> - `'OPTIONS'`
5385
5665
  *
5666
+ * @category Network
5386
5667
  * @public
5387
5668
  */
5388
5669
  type RequestMethod = 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'POST' | 'PUT';
5389
5670
  /**
5390
5671
  * The possible types representing an HTTP request.
5391
5672
  *
5673
+ * @category Network
5392
5674
  * @public
5393
5675
  */
5394
5676
  type RequestLike = string | RequestInit;
5395
5677
  /**
5396
5678
  * The possible types representing an HTTP response.
5397
5679
  *
5680
+ * @category Network
5398
5681
  * @public
5399
5682
  */
5400
5683
  type ResponseLike = ResponseInit;
@@ -5403,6 +5686,7 @@ type ResponseLike = ResponseInit;
5403
5686
  *
5404
5687
  * After all asynchronous work is done, the callback *must* call `done`, optionally passing an error argument.
5405
5688
  *
5689
+ * @category Network
5406
5690
  * @public
5407
5691
  */
5408
5692
  type NodeStyleVoidCallback = (done: (error?: any) => void) => void;
@@ -5411,12 +5695,14 @@ type NodeStyleVoidCallback = (done: (error?: any) => void) => void;
5411
5695
  *
5412
5696
  * The callback *must* return a promise that resolves (or rejects) after all asynchronous work is done.
5413
5697
  *
5698
+ * @category Network
5414
5699
  * @public
5415
5700
  */
5416
5701
  type VoidPromiseCallback = () => PromiseLike<void>;
5417
5702
  /**
5418
5703
  * An asynchronous callback to delay a request or response.
5419
5704
  *
5705
+ * @category Network
5420
5706
  * @public
5421
5707
  */
5422
5708
  type WaitUntilCallback = NodeStyleVoidCallback | VoidPromiseCallback;
@@ -5427,6 +5713,7 @@ type WaitUntilCallback = NodeStyleVoidCallback | VoidPromiseCallback;
5427
5713
  * <br/> - Request interceptors will be executed in the order they were added.
5428
5714
  * <br/> - {@link InterceptableRequest.respondWith} can be called at most once, otherwise an error will be thrown.
5429
5715
  *
5716
+ * @category Network
5430
5717
  * @public
5431
5718
  */
5432
5719
  interface NetworkInterceptorController {
@@ -5462,6 +5749,7 @@ interface NetworkInterceptorController {
5462
5749
  * @remarks
5463
5750
  * <br/> - EXPERIMENTAL: Setting an external `MeasurableNetworkEstimator` implementation will only affect playback of HLS streams.
5464
5751
  *
5752
+ * @category Network
5465
5753
  * @public
5466
5754
  */
5467
5755
  interface NetworkEstimatorController {
@@ -5477,6 +5765,7 @@ interface NetworkEstimatorController {
5477
5765
  /**
5478
5766
  * The events fired by the {@link Network | network API}.
5479
5767
  *
5768
+ * @category Network
5480
5769
  * @public
5481
5770
  */
5482
5771
  interface NetworkEventMap {
@@ -5495,6 +5784,7 @@ interface NetworkEventMap {
5495
5784
  * @remarks
5496
5785
  * <br/> - Available since v2.21.0.
5497
5786
  *
5787
+ * @category Network
5498
5788
  * @public
5499
5789
  */
5500
5790
  interface Network extends EventDispatcher<NetworkEventMap>, NetworkInterceptorController, NetworkEstimatorController {
@@ -5506,6 +5796,7 @@ interface Network extends EventDispatcher<NetworkEventMap>, NetworkInterceptorCo
5506
5796
  /**
5507
5797
  * Contains network request properties used to modify an HTTP request.
5508
5798
  *
5799
+ * @category Network
5509
5800
  * @public
5510
5801
  */
5511
5802
  interface RequestInit {
@@ -5570,6 +5861,7 @@ interface RequestInit {
5570
5861
  /**
5571
5862
  * Contains network response properties used to modify an HTTP response.
5572
5863
  *
5864
+ * @category Network
5573
5865
  * @public
5574
5866
  */
5575
5867
  interface ResponseInit {
@@ -5607,6 +5899,7 @@ interface ResponseInit {
5607
5899
  /**
5608
5900
  * Represents an HTTP request.
5609
5901
  *
5902
+ * @category Network
5610
5903
  * @public
5611
5904
  */
5612
5905
  interface Request {
@@ -5650,6 +5943,7 @@ interface Request {
5650
5943
  /**
5651
5944
  * Represents an intercepted HTTP request which can be modified.
5652
5945
  *
5946
+ * @category Network
5653
5947
  * @public
5654
5948
  */
5655
5949
  interface InterceptableRequest extends Request {
@@ -5717,6 +6011,7 @@ interface InterceptableRequest extends Request {
5717
6011
  /**
5718
6012
  * Represents an intercepted HTTP response which can be modified.
5719
6013
  *
6014
+ * @category Network
5720
6015
  * @public
5721
6016
  */
5722
6017
  interface InterceptableResponse {
@@ -5800,6 +6095,7 @@ interface InterceptableResponse {
5800
6095
  /**
5801
6096
  * Events fired by the {@link TextTrackStyle | TextTrackStyle API}.
5802
6097
  *
6098
+ * @category Media and Text Tracks
5803
6099
  * @public
5804
6100
  */
5805
6101
  interface TextTrackStyleEventMap {
@@ -5814,6 +6110,7 @@ interface TextTrackStyleEventMap {
5814
6110
  * @remarks
5815
6111
  * <br/> - Available since v2.27.4.
5816
6112
  *
6113
+ * @category Media and Text Tracks
5817
6114
  * @public
5818
6115
  */
5819
6116
  interface TextTrackStyle extends EventDispatcher<TextTrackStyleEventMap> {
@@ -5915,6 +6212,7 @@ interface TextTrackStyle extends EventDispatcher<TextTrackStyleEventMap> {
5915
6212
  * <br/> - `'depressed'`
5916
6213
  * <br/> - `'uniform'`
5917
6214
  *
6215
+ * @category Media and Text Tracks
5918
6216
  * @public
5919
6217
  */
5920
6218
  type EdgeStyle = 'none' | 'dropshadow' | 'raised' | 'depressed' | 'uniform';
@@ -5925,12 +6223,14 @@ type EdgeStyle = 'none' | 'dropshadow' | 'raised' | 'depressed' | 'uniform';
5925
6223
  * <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
6224
  * <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
6225
  *
6226
+ * @category ABR
5928
6227
  * @public
5929
6228
  */
5930
6229
  type ABRStrategyType = 'performance' | 'quality' | 'bandwidth';
5931
6230
  /**
5932
6231
  * Describes the metadata of the adaptive bitrate strategy.
5933
6232
  *
6233
+ * @category ABR
5934
6234
  * @public
5935
6235
  */
5936
6236
  interface ABRMetadata {
@@ -5944,6 +6244,7 @@ interface ABRMetadata {
5944
6244
  /**
5945
6245
  * Describes the configuration of the adaptive bitrate strategy.
5946
6246
  *
6247
+ * @category ABR
5947
6248
  * @public
5948
6249
  */
5949
6250
  interface ABRStrategyConfiguration {
@@ -5961,6 +6262,7 @@ interface ABRStrategyConfiguration {
5961
6262
  /**
5962
6263
  * The adaptive bitrate stratey.
5963
6264
  *
6265
+ * @category ABR
5964
6266
  * @public
5965
6267
  */
5966
6268
  type ABRStrategy = ABRStrategyConfiguration | ABRStrategyType;
@@ -5970,6 +6272,7 @@ type ABRStrategy = ABRStrategyConfiguration | ABRStrategyType;
5970
6272
  * @remarks
5971
6273
  * <br/> - Available since v2.30.0.
5972
6274
  *
6275
+ * @category ABR
5973
6276
  * @public
5974
6277
  */
5975
6278
  interface ABRConfiguration {
@@ -6024,6 +6327,7 @@ interface ABRConfiguration {
6024
6327
  /**
6025
6328
  * The identifier of the Conviva integration.
6026
6329
  *
6330
+ * @category Analytics
6027
6331
  * @public
6028
6332
  */
6029
6333
  type ConvivaAnalyticsIntegrationID = 'conviva';
@@ -6033,6 +6337,7 @@ type ConvivaAnalyticsIntegrationID = 'conviva';
6033
6337
  * @remarks
6034
6338
  * <br/> - Available since v2.14.4.
6035
6339
  *
6340
+ * @category Analytics
6036
6341
  * @public
6037
6342
  */
6038
6343
  interface ConvivaConfiguration extends AnalyticsDescription {
@@ -6072,6 +6377,7 @@ interface ConvivaConfiguration extends AnalyticsDescription {
6072
6377
  /**
6073
6378
  * The Conviva API.
6074
6379
  *
6380
+ * @category Analytics
6075
6381
  * @public
6076
6382
  */
6077
6383
  interface Conviva {
@@ -6114,6 +6420,7 @@ interface Conviva {
6114
6420
  * @remarks
6115
6421
  * <br/> - Available since v2.14.4.
6116
6422
  *
6423
+ * @category Analytics
6117
6424
  * @public
6118
6425
  */
6119
6426
  interface ConvivaContentMetadata {
@@ -6178,6 +6485,7 @@ interface ConvivaContentMetadata {
6178
6485
  /**
6179
6486
  * The analytics API.
6180
6487
  *
6488
+ * @category Analytics
6181
6489
  * @public
6182
6490
  */
6183
6491
  interface Analytics {
@@ -6193,6 +6501,7 @@ interface Analytics {
6193
6501
  /**
6194
6502
  * The events fired by the {@link Clip | clip API}.
6195
6503
  *
6504
+ * @category Clipping
6196
6505
  * @public
6197
6506
  */
6198
6507
  interface ClipEventMap {
@@ -6204,6 +6513,7 @@ interface ClipEventMap {
6204
6513
  /**
6205
6514
  * The clip API which can be used to clip the playback window of a source.
6206
6515
  *
6516
+ * @category Clipping
6207
6517
  * @public
6208
6518
  */
6209
6519
  interface Clip extends EventDispatcher<ClipEventMap> {
@@ -6220,6 +6530,7 @@ interface Clip extends EventDispatcher<ClipEventMap> {
6220
6530
  /**
6221
6531
  * The number of audio and video segments in the buffer.
6222
6532
  *
6533
+ * @category Analytics
6223
6534
  * @public
6224
6535
  */
6225
6536
  interface BufferedSegments {
@@ -6232,6 +6543,7 @@ interface BufferedSegments {
6232
6543
  * @remarks
6233
6544
  * <br/> - Available since v2.46.0.
6234
6545
  *
6546
+ * @category Analytics
6235
6547
  * @public
6236
6548
  */
6237
6549
  interface Metrics {
@@ -6276,6 +6588,7 @@ interface Metrics {
6276
6588
  * <br/> - `'metadata'` loads enough resources to be able to determine the {@link ChromelessPlayer.duration}.
6277
6589
  * <br/> - `'auto'` loads media up to {@link ABRConfiguration.targetBuffer}.
6278
6590
  *
6591
+ * @category Player
6279
6592
  * @public
6280
6593
  */
6281
6594
  type PreloadType = 'none' | 'metadata' | 'auto' | '';
@@ -6283,6 +6596,8 @@ type PreloadType = 'none' | 'metadata' | 'auto' | '';
6283
6596
  /**
6284
6597
  * Fired when an event related to the Imagine integration occurs.
6285
6598
  *
6599
+ * @category SSAI
6600
+ * @category Events
6286
6601
  * @public
6287
6602
  */
6288
6603
  interface ImagineTrackingEvent extends Event<'start' | 'firstquartile' | 'midpoint' | 'thirdquartile' | 'complete' | 'pause' | 'resume'> {
@@ -6291,6 +6606,7 @@ interface ImagineTrackingEvent extends Event<'start' | 'firstquartile' | 'midpoi
6291
6606
  /**
6292
6607
  * The events fired by the {@link Imagine | Imagine API}.
6293
6608
  *
6609
+ * @category SSAI
6294
6610
  * @public
6295
6611
  */
6296
6612
  interface ImagineEventMap {
@@ -6326,6 +6642,7 @@ interface ImagineEventMap {
6326
6642
  /**
6327
6643
  * The Imagine API.
6328
6644
  *
6645
+ * @category SSAI
6329
6646
  * @public
6330
6647
  */
6331
6648
  interface Imagine extends EventDispatcher<ImagineEventMap> {
@@ -6338,6 +6655,8 @@ interface Imagine extends EventDispatcher<ImagineEventMap> {
6338
6655
  /**
6339
6656
  * Fired when the ad break begins.
6340
6657
  *
6658
+ * @category Verizon Media
6659
+ * @category Events
6341
6660
  * @public
6342
6661
  */
6343
6662
  interface VerizonMediaAdBreakBeginEvent extends Event<'adbreakbegin'> {
@@ -6350,6 +6669,8 @@ interface VerizonMediaAdBreakBeginEvent extends Event<'adbreakbegin'> {
6350
6669
  /**
6351
6670
  * Fired when the ad break ends.
6352
6671
  *
6672
+ * @category Verizon Media
6673
+ * @category Events
6353
6674
  * @public
6354
6675
  */
6355
6676
  interface VerizonMediaAdBreakEndEvent extends Event<'adbreakend'> {
@@ -6362,6 +6683,8 @@ interface VerizonMediaAdBreakEndEvent extends Event<'adbreakend'> {
6362
6683
  /**
6363
6684
  * Fired when the ad break is skipped.
6364
6685
  *
6686
+ * @category Verizon Media
6687
+ * @category Events
6365
6688
  * @public
6366
6689
  */
6367
6690
  interface VerizonMediaAdBreakSkipEvent extends Event<'adbreakskip'> {
@@ -6374,6 +6697,8 @@ interface VerizonMediaAdBreakSkipEvent extends Event<'adbreakskip'> {
6374
6697
  /**
6375
6698
  * Fired when the ad break is updated.
6376
6699
  *
6700
+ * @category Verizon Media
6701
+ * @category Events
6377
6702
  * @public
6378
6703
  */
6379
6704
  interface VerizonMediaUpdateAdBreakEvent extends Event<'updateadbreak'> {
@@ -6414,6 +6739,8 @@ interface EventedList<T, M extends EventMap<StringKeyOf<M>>> extends List<T>, Ev
6414
6739
  /**
6415
6740
  * Fired when an ad begins.
6416
6741
  *
6742
+ * @category Verizon Media
6743
+ * @category Events
6417
6744
  * @public
6418
6745
  */
6419
6746
  interface VerizonMediaAdBeginEvent extends Event<'adbegin'> {
@@ -6426,6 +6753,8 @@ interface VerizonMediaAdBeginEvent extends Event<'adbegin'> {
6426
6753
  /**
6427
6754
  * Fired when the ad ends.
6428
6755
  *
6756
+ * @category Verizon Media
6757
+ * @category Events
6429
6758
  * @public
6430
6759
  */
6431
6760
  interface VerizonMediaAdEndEvent extends Event<'adend'> {
@@ -6438,6 +6767,8 @@ interface VerizonMediaAdEndEvent extends Event<'adend'> {
6438
6767
  /**
6439
6768
  * Fired when the ad reaches the first quartile.
6440
6769
  *
6770
+ * @category Verizon Media
6771
+ * @category Events
6441
6772
  * @public
6442
6773
  */
6443
6774
  interface VerizonMediaAdFirstQuartileEvent extends Event<'adfirstquartile'> {
@@ -6449,6 +6780,8 @@ interface VerizonMediaAdFirstQuartileEvent extends Event<'adfirstquartile'> {
6449
6780
  /**
6450
6781
  * Fired when the ad reaches the mid point.
6451
6782
  *
6783
+ * @category Verizon Media
6784
+ * @category Events
6452
6785
  * @public
6453
6786
  */
6454
6787
  interface VerizonMediaAdMidpointEvent extends Event<'admidpoint'> {
@@ -6460,6 +6793,8 @@ interface VerizonMediaAdMidpointEvent extends Event<'admidpoint'> {
6460
6793
  /**
6461
6794
  * Fired when the ad reaches the third quartile.
6462
6795
  *
6796
+ * @category Verizon Media
6797
+ * @category Events
6463
6798
  * @public
6464
6799
  */
6465
6800
  interface VerizonMediaAdThirdQuartileEvent extends Event<'adthirdquartile'> {
@@ -6471,6 +6806,8 @@ interface VerizonMediaAdThirdQuartileEvent extends Event<'adthirdquartile'> {
6471
6806
  /**
6472
6807
  * Fired when the ad is completed.
6473
6808
  *
6809
+ * @category Verizon Media
6810
+ * @category Events
6474
6811
  * @public
6475
6812
  */
6476
6813
  interface VerizonMediaAdCompleteEvent extends Event<'adcomplete'> {
@@ -6483,6 +6820,7 @@ interface VerizonMediaAdCompleteEvent extends Event<'adcomplete'> {
6483
6820
  /**
6484
6821
  * The events fired by the {@link VerizonMediaAd}.
6485
6822
  *
6823
+ * @category Verizon Media
6486
6824
  * @public
6487
6825
  */
6488
6826
  interface VerizonMediaAdEventMap {
@@ -6514,6 +6852,7 @@ interface VerizonMediaAdEventMap {
6514
6852
  /**
6515
6853
  * Represents a Verizon Media ad.
6516
6854
  *
6855
+ * @category Verizon Media
6517
6856
  * @public
6518
6857
  */
6519
6858
  interface VerizonMediaAd extends EventDispatcher<VerizonMediaAdEventMap> {
@@ -6590,6 +6929,7 @@ interface VerizonMediaAd extends EventDispatcher<VerizonMediaAdEventMap> {
6590
6929
  /**
6591
6930
  * Fired when the ad is removed.
6592
6931
  *
6932
+ * @category Verizon Media
6593
6933
  * @public
6594
6934
  */
6595
6935
  interface VerizonMediaRemoveAdEvent extends Event<'removead'> {
@@ -6599,6 +6939,7 @@ interface VerizonMediaRemoveAdEvent extends Event<'removead'> {
6599
6939
  /**
6600
6940
  * Events fired by the {@link VerizonMediaAdList}.
6601
6941
  *
6942
+ * @category Verizon Media
6602
6943
  * @public
6603
6944
  */
6604
6945
  interface VerizonMediaAdListEventMap {
@@ -6610,6 +6951,7 @@ interface VerizonMediaAdListEventMap {
6610
6951
  /**
6611
6952
  * List of Verizon Media ads.
6612
6953
  *
6954
+ * @category Verizon Media
6613
6955
  * @public
6614
6956
  */
6615
6957
  interface VerizonMediaAdList extends EventedList<VerizonMediaAd, VerizonMediaAdListEventMap> {
@@ -6618,6 +6960,7 @@ interface VerizonMediaAdList extends EventedList<VerizonMediaAd, VerizonMediaAdL
6618
6960
  /**
6619
6961
  * The events fired by the {@link VerizonMediaAdBreak}.
6620
6962
  *
6963
+ * @category Verizon Media
6621
6964
  * @public
6622
6965
  */
6623
6966
  interface VerizonMediaAdBreakEventMap {
@@ -6641,6 +6984,7 @@ interface VerizonMediaAdBreakEventMap {
6641
6984
  /**
6642
6985
  * Represents a Verizon Media ad.
6643
6986
  *
6987
+ * @category Verizon Media
6644
6988
  * @public
6645
6989
  */
6646
6990
  interface VerizonMediaAdBreak extends EventDispatcher<VerizonMediaAdBreakEventMap> {
@@ -6686,6 +7030,8 @@ interface VerizonMediaAdBreak extends EventDispatcher<VerizonMediaAdBreakEventMa
6686
7030
  /**
6687
7031
  * Fired when the ad break is added.
6688
7032
  *
7033
+ * @category Verizon Media
7034
+ * @category Events
6689
7035
  * @public
6690
7036
  */
6691
7037
  interface VerizonMediaAddAdBreakEvent extends Event<'addadbreak'> {
@@ -6698,6 +7044,8 @@ interface VerizonMediaAddAdBreakEvent extends Event<'addadbreak'> {
6698
7044
  /**
6699
7045
  * Fired when the ad break is removed.
6700
7046
  *
7047
+ * @category Verizon Media
7048
+ * @category Events
6701
7049
  * @public
6702
7050
  */
6703
7051
  interface VerizonMediaRemoveAdBreakEvent extends Event<'removeadbreak'> {
@@ -6710,6 +7058,7 @@ interface VerizonMediaRemoveAdBreakEvent extends Event<'removeadbreak'> {
6710
7058
  /**
6711
7059
  * The events fired by the {@link VerizonMediaAdBreakList}.
6712
7060
  *
7061
+ * @category Verizon Media
6713
7062
  * @public
6714
7063
  */
6715
7064
  interface VerizonMediaAdBreakListEventMap {
@@ -6725,6 +7074,7 @@ interface VerizonMediaAdBreakListEventMap {
6725
7074
  /**
6726
7075
  * List with Verizon Media ad breaks.
6727
7076
  *
7077
+ * @category Verizon Media
6728
7078
  * @public
6729
7079
  */
6730
7080
  interface VerizonMediaAdBreakList extends EventedList<VerizonMediaAdBreak, VerizonMediaAdBreakListEventMap> {
@@ -6733,6 +7083,7 @@ interface VerizonMediaAdBreakList extends EventedList<VerizonMediaAdBreak, Veriz
6733
7083
  /**
6734
7084
  * The Verizon Media ads API.
6735
7085
  *
7086
+ * @category Verizon Media
6736
7087
  * @public
6737
7088
  */
6738
7089
  interface VerizonMediaAds {
@@ -6763,6 +7114,7 @@ interface VerizonMediaAds {
6763
7114
  /**
6764
7115
  * Represents a Verizon Media response with advertisement information for VOD assets.
6765
7116
  *
7117
+ * @category Verizon Media
6766
7118
  * @public
6767
7119
  */
6768
7120
  interface VerizonMediaResponseVodAds {
@@ -6785,6 +7137,7 @@ interface VerizonMediaResponseVodAds {
6785
7137
  /**
6786
7138
  * Represents a Verizon Media response with ad break information for VOD assets.
6787
7139
  *
7140
+ * @category Verizon Media
6788
7141
  * @public
6789
7142
  */
6790
7143
  interface VerizonMediaResponseVodAdBreak {
@@ -6823,6 +7176,7 @@ interface VerizonMediaResponseVodAdBreak {
6823
7176
  /**
6824
7177
  * The Verizon Media response with ad information for VOD assets.
6825
7178
  *
7179
+ * @category Verizon Media
6826
7180
  * @public
6827
7181
  */
6828
7182
  interface VerizonMediaResponseVodAd {
@@ -6890,6 +7244,7 @@ interface VerizonMediaResponseVodAd {
6890
7244
  /**
6891
7245
  * Represents the offset of a Verizon Media ad break.
6892
7246
  *
7247
+ * @category Verizon Media
6893
7248
  * @public
6894
7249
  */
6895
7250
  interface VerizonMediaResponseVodAdBreakOffset {
@@ -6910,6 +7265,7 @@ interface VerizonMediaResponseVodAdBreakOffset {
6910
7265
  * <br/> - is a short blank video for non-video ads (e.g. VPAID ads).
6911
7266
  * <br/> - is a system asset which is potentially subject to change.
6912
7267
  *
7268
+ * @category Verizon Media
6913
7269
  * @public
6914
7270
  */
6915
7271
  interface VerizonMediaResponseVodAdPlaceholder {
@@ -6936,18 +7292,21 @@ interface VerizonMediaResponseVodAdPlaceholder {
6936
7292
  * <br/> - `'vod'`
6937
7293
  * <br/> - `'live'`
6938
7294
  *
7295
+ * @category Verizon Media
6939
7296
  * @public
6940
7297
  */
6941
7298
  type VerizonMediaPreplayResponseType = 'vod' | 'live';
6942
7299
  /**
6943
7300
  * Type of a Verizon Media Preplay response.
6944
7301
  *
7302
+ * @category Verizon Media
6945
7303
  * @public
6946
7304
  */
6947
7305
  type VerizonMediaPreplayResponse = VerizonMediaPreplayVodResponse | VerizonMediaPreplayLiveResponse;
6948
7306
  /**
6949
7307
  * Represents a Verizon Media Preplay base response.
6950
7308
  *
7309
+ * @category Verizon Media
6951
7310
  * @public
6952
7311
  */
6953
7312
  interface VerizonMediaPreplayBaseResponse {
@@ -6986,6 +7345,7 @@ interface VerizonMediaPreplayBaseResponse {
6986
7345
  /**
6987
7346
  * Represents a Verizon Media DRM response.
6988
7347
  *
7348
+ * @category Verizon Media
6989
7349
  * @public
6990
7350
  */
6991
7351
  interface VerizonMediaResponseDrm {
@@ -7005,6 +7365,7 @@ interface VerizonMediaResponseDrm {
7005
7365
  /**
7006
7366
  * Represents a Verizon Media Preplay response for VOD assets.
7007
7367
  *
7368
+ * @category Verizon Media
7008
7369
  * @public
7009
7370
  */
7010
7371
  interface VerizonMediaPreplayVodResponse extends VerizonMediaPreplayBaseResponse {
@@ -7029,6 +7390,7 @@ interface VerizonMediaPreplayVodResponse extends VerizonMediaPreplayBaseResponse
7029
7390
  /**
7030
7391
  * Represents a Verizon Media Preplay response for live assets.
7031
7392
  *
7393
+ * @category Verizon Media
7032
7394
  * @public
7033
7395
  */
7034
7396
  interface VerizonMediaPreplayLiveResponse extends VerizonMediaPreplayBaseResponse {
@@ -7041,6 +7403,7 @@ interface VerizonMediaPreplayLiveResponse extends VerizonMediaPreplayBaseRespons
7041
7403
  /**
7042
7404
  * Fired when a Preplay response is received.
7043
7405
  *
7406
+ * @category Verizon Media
7044
7407
  * @public
7045
7408
  */
7046
7409
  interface VerizonMediaPreplayResponseEvent extends Event<'preplayresponse'> {
@@ -7056,6 +7419,7 @@ interface VerizonMediaPreplayResponseEvent extends Event<'preplayresponse'> {
7056
7419
  * @remarks
7057
7420
  * <br/> - See {@link https://docs.vdms.com/video/#Develop/AssetInfo.htm%3FTocPath%3DDevelop%7CClient%2520(Media%2520Player)%7C_____1 | Asset Info}.
7058
7421
  *
7422
+ * @category Verizon Media
7059
7423
  * @public
7060
7424
  */
7061
7425
  interface VerizonMediaAssetInfoResponse {
@@ -7191,12 +7555,14 @@ interface VerizonMediaAssetInfoResponse {
7191
7555
  * @remarks
7192
7556
  * <br/> - See {@link https://docs.vdms.com/video/#Setup/Boundaries-Setup-Playback.htm | Boundaries }
7193
7557
  *
7558
+ * @category Verizon Media
7194
7559
  * @public
7195
7560
  */
7196
7561
  type Boundary = BoundaryC3 | BoundaryC7 | BoundaryHalftime;
7197
7562
  /**
7198
7563
  * Represents the information of an ad boundary.
7199
7564
  *
7565
+ * @category Verizon Media
7200
7566
  * @public
7201
7567
  */
7202
7568
  interface BoundaryInfo {
@@ -7212,6 +7578,7 @@ interface BoundaryInfo {
7212
7578
  /**
7213
7579
  * Represents the boundary of an ad that is relevant for up to three days after the original airing.
7214
7580
  *
7581
+ * @category Verizon Media
7215
7582
  * @public
7216
7583
  */
7217
7584
  interface BoundaryC3 {
@@ -7220,6 +7587,7 @@ interface BoundaryC3 {
7220
7587
  /**
7221
7588
  * Represents the boundary of an ad that is relevant for up to seven days after the original airing.
7222
7589
  *
7590
+ * @category Verizon Media
7223
7591
  * @public
7224
7592
  */
7225
7593
  interface BoundaryC7 {
@@ -7228,6 +7596,7 @@ interface BoundaryC7 {
7228
7596
  /**
7229
7597
  * Represents the boundary that identifies special content.
7230
7598
  *
7599
+ * @category Verizon Media
7231
7600
  * @public
7232
7601
  */
7233
7602
  interface BoundaryHalftime {
@@ -7236,6 +7605,7 @@ interface BoundaryHalftime {
7236
7605
  /**
7237
7606
  * Represents the resolution of a Verizon Media thumbnail.
7238
7607
  *
7608
+ * @category Verizon Media
7239
7609
  * @public
7240
7610
  */
7241
7611
  interface ThumbnailResolution {
@@ -7282,6 +7652,7 @@ interface ThumbnailResolution {
7282
7652
  * In the online documentation the value for 0 is also "NOT RATED". Since this is counter-intuitive, we have assumed
7283
7653
  * this to be erronous and have modeled this according to the Movie Ratings, with 0 being "NOT APPLICABLE".
7284
7654
  *
7655
+ * @category Verizon Media
7285
7656
  * @public
7286
7657
  */
7287
7658
  type VerizonMediaAssetTvRating = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
@@ -7297,6 +7668,7 @@ type VerizonMediaAssetTvRating = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
7297
7668
  * <br/> - `6` (X)
7298
7669
  * <br/> - `7` (NOT_RATED)
7299
7670
  *
7671
+ * @category Verizon Media
7300
7672
  * @public
7301
7673
  */
7302
7674
  type VerizonMediaAssetMovieRating = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
@@ -7304,6 +7676,8 @@ type VerizonMediaAssetMovieRating = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
7304
7676
  /**
7305
7677
  * Fired when an asset info response is received.
7306
7678
  *
7679
+ * @category Verizon Media
7680
+ * @category Events
7307
7681
  * @public
7308
7682
  */
7309
7683
  interface VerizonMediaAssetInfoResponseEvent extends Event<'assetinforesponse'> {
@@ -7316,6 +7690,7 @@ interface VerizonMediaAssetInfoResponseEvent extends Event<'assetinforesponse'>
7316
7690
  /**
7317
7691
  * Represents a Verizon Media response with advertisement information for live assets.
7318
7692
  *
7693
+ * @category Verizon Media
7319
7694
  * @public
7320
7695
  */
7321
7696
  interface VerizonMediaResponseLiveAds {
@@ -7330,6 +7705,7 @@ interface VerizonMediaResponseLiveAds {
7330
7705
  /**
7331
7706
  * Represents a Verizon Media response for live ad breaks.
7332
7707
  *
7708
+ * @category Verizon Media
7333
7709
  * @public
7334
7710
  */
7335
7711
  interface VerizonMediaResponseLiveAdBreak {
@@ -7386,6 +7762,7 @@ interface VerizonMediaResponseLiveAdBreak {
7386
7762
  /**
7387
7763
  * Represents a Verizon Media response with live ads.
7388
7764
  *
7765
+ * @category Verizon Media
7389
7766
  * @public
7390
7767
  */
7391
7768
  interface VerizonMediaResponseLiveAd {
@@ -7456,6 +7833,7 @@ interface VerizonMediaResponseLiveAd {
7456
7833
  * @remarks
7457
7834
  * <br/> - See {@link https://docs.vdms.com/video/#Develop/Pingv2.htm%3FTocPath%3DDevelop%7CClient%2520(Media%2520Player)%7C_____3 | Ping API (Version 2)}.
7458
7835
  *
7836
+ * @category Verizon Media
7459
7837
  * @public
7460
7838
  */
7461
7839
  interface VerizonMediaPingResponse {
@@ -7490,6 +7868,8 @@ interface VerizonMediaPingResponse {
7490
7868
  /**
7491
7869
  * Fired when a Ping response is received.
7492
7870
  *
7871
+ * @category Verizon Media
7872
+ * @category Events
7493
7873
  * @public
7494
7874
  */
7495
7875
  interface VerizonMediaPingResponseEvent extends Event<'pingresponse'> {
@@ -7502,6 +7882,8 @@ interface VerizonMediaPingResponseEvent extends Event<'pingresponse'> {
7502
7882
  /**
7503
7883
  * Fired when an error or invalid response is received from the Ping API.
7504
7884
  *
7885
+ * @category Verizon Media
7886
+ * @category Events
7505
7887
  * @public
7506
7888
  */
7507
7889
  interface VerizonMediaPingErrorEvent extends Event<'pingerror'> {
@@ -7514,6 +7896,7 @@ interface VerizonMediaPingErrorEvent extends Event<'pingerror'> {
7514
7896
  /**
7515
7897
  * Represents a Verizon Media asset.
7516
7898
  *
7899
+ * @category Verizon Media
7517
7900
  * @public
7518
7901
  */
7519
7902
  interface VerizonMediaAsset {
@@ -7649,6 +8032,8 @@ interface VerizonMediaAsset {
7649
8032
  /**
7650
8033
  * Fired when an asset is added.
7651
8034
  *
8035
+ * @category Verizon Media
8036
+ * @category Events
7652
8037
  * @public
7653
8038
  */
7654
8039
  interface VerizonMediaAddAssetEvent extends Event<'addasset'> {
@@ -7661,6 +8046,8 @@ interface VerizonMediaAddAssetEvent extends Event<'addasset'> {
7661
8046
  /**
7662
8047
  * Fired when an asset is removed.
7663
8048
  *
8049
+ * @category Verizon Media
8050
+ * @category Events
7664
8051
  * @public
7665
8052
  */
7666
8053
  interface VerizonMediaRemoveAssetEvent extends Event<'removeasset'> {
@@ -7673,6 +8060,7 @@ interface VerizonMediaRemoveAssetEvent extends Event<'removeasset'> {
7673
8060
  /**
7674
8061
  * The events fired by the {@link VerizonMediaAssetList}.
7675
8062
  *
8063
+ * @category Verizon Media
7676
8064
  * @public
7677
8065
  */
7678
8066
  interface VerizonMediaAssetEventMap {
@@ -7688,6 +8076,7 @@ interface VerizonMediaAssetEventMap {
7688
8076
  /**
7689
8077
  * List of Verizon Media assets.
7690
8078
  *
8079
+ * @category Verizon Media
7691
8080
  * @public
7692
8081
  */
7693
8082
  interface VerizonMediaAssetList extends EventedList<VerizonMediaAsset, VerizonMediaAssetEventMap> {
@@ -7696,6 +8085,7 @@ interface VerizonMediaAssetList extends EventedList<VerizonMediaAsset, VerizonMe
7696
8085
  /**
7697
8086
  * The events fired by the {@link VerizonMedia | Verizon Media API}.
7698
8087
  *
8088
+ * @category Verizon Media
7699
8089
  * @public
7700
8090
  */
7701
8091
  interface VerizonMediaEventMap {
@@ -7722,6 +8112,7 @@ interface VerizonMediaEventMap {
7722
8112
  * @remarks
7723
8113
  * <br/> - Only available with the feature 'verizonmedia'.
7724
8114
  *
8115
+ * @category Verizon Media
7725
8116
  * @public
7726
8117
  */
7727
8118
  interface VerizonMedia extends EventDispatcher<VerizonMediaEventMap> {
@@ -7738,6 +8129,7 @@ interface VerizonMedia extends EventDispatcher<VerizonMediaEventMap> {
7738
8129
  /**
7739
8130
  * The events fired by the {@link Yospace | Yospace API}.
7740
8131
  *
8132
+ * @category SSAI
7741
8133
  * @public
7742
8134
  */
7743
8135
  interface YospaceEventMap {
@@ -7752,6 +8144,7 @@ interface YospaceEventMap {
7752
8144
  * @remarks
7753
8145
  * <br/> - These callbacks will be used by the Yospace SDK to provide feedback to the player.
7754
8146
  *
8147
+ * @category SSAI
7755
8148
  * @public
7756
8149
  */
7757
8150
  interface YospaceCallbackObject {
@@ -7768,6 +8161,7 @@ interface YospaceCallbackObject {
7768
8161
  * @remarks
7769
8162
  * <br/> - Available since v2.14.7.
7770
8163
  *
8164
+ * @category SSAI
7771
8165
  * @public
7772
8166
  */
7773
8167
  interface Yospace extends EventDispatcher<YospaceEventMap> {
@@ -7790,12 +8184,16 @@ interface Yospace extends EventDispatcher<YospaceEventMap> {
7790
8184
  /**
7791
8185
  * An error code whose category is `ErrorCategory.CONTENT_PROTECTION`.
7792
8186
  *
8187
+ * @category Content Protection
8188
+ * @category Errors
7793
8189
  * @public
7794
8190
  */
7795
8191
  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
8192
  /**
7797
8193
  * An error related to content protection.
7798
8194
  *
8195
+ * @category Content Protection
8196
+ * @category Errors
7799
8197
  * @public
7800
8198
  */
7801
8199
  interface ContentProtectionError extends THEOplayerError {
@@ -7843,6 +8241,9 @@ interface ContentProtectionError extends THEOplayerError {
7843
8241
  /**
7844
8242
  * Fired when an error related to content protection occurs.
7845
8243
  *
8244
+ * @category Content Protection
8245
+ * @category Errors
8246
+ * @category Events
7846
8247
  * @public
7847
8248
  */
7848
8249
  interface ContentProtectionErrorEvent extends Event<'contentprotectionerror'> {
@@ -7886,6 +8287,7 @@ interface ContentProtectionErrorEvent extends Event<'contentprotectionerror'> {
7886
8287
  * <br/> - Only available with the feature `'hesp'`.
7887
8288
  * <br/> - Only applies to HESP streams.
7888
8289
  *
8290
+ * @category HESP
7889
8291
  * @public
7890
8292
  */
7891
8293
  interface HespLatencyConfiguration {
@@ -7916,6 +8318,7 @@ interface HespLatencyConfiguration {
7916
8318
  * <br/> - Only available with the feature `'hesp'`.
7917
8319
  * <br/> - Only available when an HESP source is playing.
7918
8320
  *
8321
+ * @category HESP
7919
8322
  * @public
7920
8323
  */
7921
8324
  interface HespApiEventMap {
@@ -7934,6 +8337,7 @@ interface HespApiEventMap {
7934
8337
  * <br/> - Note: This API is in an experimental stage and may be subject to breaking changes.
7935
8338
  * <br/> - Only available with the feature `'hesp'`.
7936
8339
  *
8340
+ * @category HESP
7937
8341
  * @public
7938
8342
  */
7939
8343
  interface HespApi extends EventDispatcher<HespApiEventMap> {
@@ -7986,6 +8390,8 @@ interface HespApi extends EventDispatcher<HespApiEventMap> {
7986
8390
  * <br/> - Only available with the feature `'hesp'`.
7987
8391
  * <br/> - Only applicable when configuring an HESP source.
7988
8392
  *
8393
+ * @category HESP
8394
+ * @category Source
7989
8395
  * @public
7990
8396
  */
7991
8397
  interface HespSourceConfiguration {
@@ -7997,6 +8403,8 @@ interface HespSourceConfiguration {
7997
8403
  * <br/> - Only available with the feature `'hesp'`.
7998
8404
  * <br/> - Only applicable when configuring an HESP source.
7999
8405
  *
8406
+ * @category HESP
8407
+ * @category Source
8000
8408
  * @public
8001
8409
  */
8002
8410
  interface HespTypedSource extends TypedSource {
@@ -8037,6 +8445,7 @@ interface Latencies {
8037
8445
  /**
8038
8446
  * Represents a DASH representation.
8039
8447
  *
8448
+ * @category Media and Text Tracks
8040
8449
  * @public
8041
8450
  */
8042
8451
  interface Representation {
@@ -8081,6 +8490,7 @@ interface Representation {
8081
8490
  /**
8082
8491
  * Fired when `ChromelessPlayer.source` changes.
8083
8492
  *
8493
+ * @category Events
8084
8494
  * @public
8085
8495
  */
8086
8496
  interface SourceChangeEvent extends Event<'sourcechange'> {
@@ -8092,6 +8502,7 @@ interface SourceChangeEvent extends Event<'sourcechange'> {
8092
8502
  /**
8093
8503
  * Fired when the current source, which is chosen from {@link SourceDescription.sources | ChromelessPlayer.source.sources}, changes.
8094
8504
  *
8505
+ * @category Events
8095
8506
  * @public
8096
8507
  */
8097
8508
  interface CurrentSourceChangeEvent extends Event<'currentsourcechange'> {
@@ -8103,6 +8514,7 @@ interface CurrentSourceChangeEvent extends Event<'currentsourcechange'> {
8103
8514
  /**
8104
8515
  * Fired when `ChromelessPlayer.paused` changes to `false`.
8105
8516
  *
8517
+ * @category Events
8106
8518
  * @public
8107
8519
  */
8108
8520
  interface PlayEvent extends Event<'play'> {
@@ -8114,6 +8526,7 @@ interface PlayEvent extends Event<'play'> {
8114
8526
  /**
8115
8527
  * Fired when `ChromelessPlayer.paused` changes to `true`.
8116
8528
  *
8529
+ * @category Events
8117
8530
  * @public
8118
8531
  */
8119
8532
  interface PauseEvent extends Event<'pause'> {
@@ -8125,6 +8538,7 @@ interface PauseEvent extends Event<'pause'> {
8125
8538
  /**
8126
8539
  * Fired when `ChromelessPlayer.seeking` changes to `true`, and the player has started seeking to a new position.
8127
8540
  *
8541
+ * @category Events
8128
8542
  * @public
8129
8543
  */
8130
8544
  interface SeekingEvent extends Event<'seeking'> {
@@ -8136,6 +8550,7 @@ interface SeekingEvent extends Event<'seeking'> {
8136
8550
  /**
8137
8551
  * Fired when `ChromelessPlayer.seeking` changes to `false` after the current playback position was changed.
8138
8552
  *
8553
+ * @category Events
8139
8554
  * @public
8140
8555
  */
8141
8556
  interface SeekedEvent extends Event<'seeked'> {
@@ -8147,6 +8562,7 @@ interface SeekedEvent extends Event<'seeked'> {
8147
8562
  /**
8148
8563
  * Fired when the current playback position changed as part of normal playback or in an especially interesting way, for example discontinuously.
8149
8564
  *
8565
+ * @category Events
8150
8566
  * @public
8151
8567
  */
8152
8568
  interface TimeUpdateEvent extends Event<'timeupdate'> {
@@ -8162,6 +8578,7 @@ interface TimeUpdateEvent extends Event<'timeupdate'> {
8162
8578
  /**
8163
8579
  * Fired when playback has stopped because the end of the media resource was reached.
8164
8580
  *
8581
+ * @category Events
8165
8582
  * @public
8166
8583
  */
8167
8584
  interface EndedEvent extends Event<'ended'> {
@@ -8173,6 +8590,7 @@ interface EndedEvent extends Event<'ended'> {
8173
8590
  /**
8174
8591
  * Fired when playback is ready to start after having been paused or delayed due to lack of media data.
8175
8592
  *
8593
+ * @category Events
8176
8594
  * @public
8177
8595
  */
8178
8596
  interface PlayingEvent extends Event<'playing'> {
@@ -8184,6 +8602,7 @@ interface PlayingEvent extends Event<'playing'> {
8184
8602
  /**
8185
8603
  * 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
8604
  *
8605
+ * @category Events
8187
8606
  * @public
8188
8607
  */
8189
8608
  interface WaitingEvent extends Event<'waiting'> {
@@ -8195,6 +8614,7 @@ interface WaitingEvent extends Event<'waiting'> {
8195
8614
  /**
8196
8615
  * Fired when `ChromelessPlayer.readyState` changes.
8197
8616
  *
8617
+ * @category Events
8198
8618
  * @public
8199
8619
  */
8200
8620
  interface ReadyStateChangeEvent extends Event<'readystatechange'> {
@@ -8210,6 +8630,7 @@ interface ReadyStateChangeEvent extends Event<'readystatechange'> {
8210
8630
  /**
8211
8631
  * Fired when the player determines the duration and dimensions of the media resource.
8212
8632
  *
8633
+ * @category Events
8213
8634
  * @public
8214
8635
  */
8215
8636
  interface LoadedMetadataEvent extends Event<'loadedmetadata'> {
@@ -8225,6 +8646,7 @@ interface LoadedMetadataEvent extends Event<'loadedmetadata'> {
8225
8646
  /**
8226
8647
  * Fired when the player can render the media data at the current playback position for the first time.
8227
8648
  *
8649
+ * @category Events
8228
8650
  * @public
8229
8651
  */
8230
8652
  interface LoadedDataEvent extends Event<'loadeddata'> {
@@ -8240,6 +8662,7 @@ interface LoadedDataEvent extends Event<'loadeddata'> {
8240
8662
  /**
8241
8663
  * Fired when the player can resume playback of the media data.
8242
8664
  *
8665
+ * @category Events
8243
8666
  * @public
8244
8667
  */
8245
8668
  interface CanPlayEvent extends Event<'canplay'> {
@@ -8255,6 +8678,7 @@ interface CanPlayEvent extends Event<'canplay'> {
8255
8678
  /**
8256
8679
  * Fired when the player can resume playback of the media data and buffering is unlikely.
8257
8680
  *
8681
+ * @category Events
8258
8682
  * @public
8259
8683
  */
8260
8684
  interface CanPlayThroughEvent extends Event<'canplaythrough'> {
@@ -8270,6 +8694,7 @@ interface CanPlayThroughEvent extends Event<'canplaythrough'> {
8270
8694
  /**
8271
8695
  * Fired when the player's source is cleared.
8272
8696
  *
8697
+ * @category Events
8273
8698
  * @public
8274
8699
  */
8275
8700
  interface EmptiedEvent extends Event<'emptied'> {
@@ -8285,6 +8710,7 @@ interface EmptiedEvent extends Event<'emptied'> {
8285
8710
  /**
8286
8711
  * Fired when the player loaded media data.
8287
8712
  *
8713
+ * @category Events
8288
8714
  * @public
8289
8715
  */
8290
8716
  interface ProgressEvent extends Event<'progress'> {
@@ -8296,6 +8722,7 @@ interface ProgressEvent extends Event<'progress'> {
8296
8722
  /**
8297
8723
  * Fired when `ChromelessPlayer.duration` changes.
8298
8724
  *
8725
+ * @category Events
8299
8726
  * @public
8300
8727
  */
8301
8728
  interface DurationChangeEvent extends Event<'durationchange'> {
@@ -8307,6 +8734,7 @@ interface DurationChangeEvent extends Event<'durationchange'> {
8307
8734
  /**
8308
8735
  * Fired when `ChromelessPlayer.volume` changes.
8309
8736
  *
8737
+ * @category Events
8310
8738
  * @public
8311
8739
  */
8312
8740
  interface VolumeChangeEvent extends Event<'volumechange'> {
@@ -8318,6 +8746,7 @@ interface VolumeChangeEvent extends Event<'volumechange'> {
8318
8746
  /**
8319
8747
  * Fired when the current representation changes.
8320
8748
  *
8749
+ * @category Events
8321
8750
  * @public
8322
8751
  */
8323
8752
  interface RepresentationChangeEvent extends Event<'representationchange'> {
@@ -8333,6 +8762,7 @@ interface RepresentationChangeEvent extends Event<'representationchange'> {
8333
8762
  /**
8334
8763
  * Fired when `ChromelessPlayer.playbackRate` changes.
8335
8764
  *
8765
+ * @category Events
8336
8766
  * @public
8337
8767
  */
8338
8768
  interface RateChangeEvent extends Event<'ratechange'> {
@@ -8344,6 +8774,7 @@ interface RateChangeEvent extends Event<'ratechange'> {
8344
8774
  /**
8345
8775
  * Fired when the dimensions of the HTML element changes.
8346
8776
  *
8777
+ * @category Events
8347
8778
  * @public
8348
8779
  */
8349
8780
  interface DimensionChangeEvent extends Event<'dimensionchange'> {
@@ -8359,6 +8790,7 @@ interface DimensionChangeEvent extends Event<'dimensionchange'> {
8359
8790
  /**
8360
8791
  * Fired when the player encounters key system initialization data in the media data.
8361
8792
  *
8793
+ * @category Events
8362
8794
  * @public
8363
8795
  */
8364
8796
  interface EncryptedEvent extends Event<'encrypted'> {
@@ -8379,6 +8811,7 @@ interface EncryptedEvent extends Event<'encrypted'> {
8379
8811
  /**
8380
8812
  * The latency manager, used to control low-latency live playback.
8381
8813
  *
8814
+ * @category Player
8382
8815
  * @public
8383
8816
  */
8384
8817
  interface LatencyManager {
@@ -8416,6 +8849,7 @@ interface LatencyManager {
8416
8849
  /**
8417
8850
  * The latency configuration for managing the live offset of the player.
8418
8851
  *
8852
+ * @category Player
8419
8853
  * @public
8420
8854
  */
8421
8855
  interface LatencyConfiguration {
@@ -8481,6 +8915,7 @@ interface TimeRanges {
8481
8915
  /**
8482
8916
  * The events fired by the {@link ChromelessPlayer}.
8483
8917
  *
8918
+ * @category Player
8484
8919
  * @public
8485
8920
  */
8486
8921
  interface PlayerEventMap {
@@ -8682,6 +9117,8 @@ interface PlayerEventMap {
8682
9117
  /**
8683
9118
  * The player API.
8684
9119
  *
9120
+ * @category API
9121
+ * @category Player
8685
9122
  * @public
8686
9123
  */
8687
9124
  declare class ChromelessPlayer implements EventDispatcher<PlayerEventMap> {
@@ -9024,12 +9461,14 @@ declare class ChromelessPlayer implements EventDispatcher<PlayerEventMap> {
9024
9461
  * <br/> - `'bottom-left'`
9025
9462
  * <br/> - `'bottom-right'`
9026
9463
  *
9464
+ * @category UI
9027
9465
  * @public
9028
9466
  */
9029
9467
  type PiPPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
9030
9468
  /**
9031
9469
  * Describes the configuration of the picture-in-picture feature.
9032
9470
  *
9471
+ * @category UI
9033
9472
  * @public
9034
9473
  */
9035
9474
  interface PiPConfiguration {
@@ -9059,6 +9498,7 @@ interface PiPConfiguration {
9059
9498
  /**
9060
9499
  * Describes the UI related configuration of the player.
9061
9500
  *
9501
+ * @category UI
9062
9502
  * @public
9063
9503
  */
9064
9504
  interface UIPlayerConfiguration extends PlayerConfiguration {
@@ -9086,6 +9526,7 @@ interface UIPlayerConfiguration extends PlayerConfiguration {
9086
9526
  /**
9087
9527
  * Describes the UI configuration of the player.
9088
9528
  *
9529
+ * @category UI
9089
9530
  * @public
9090
9531
  */
9091
9532
  interface UIConfiguration {
@@ -9166,7 +9607,7 @@ interface UIConfiguration {
9166
9607
  */
9167
9608
  fullscreenOptions?: FullscreenOptions$1;
9168
9609
  /**
9169
- * Actions that define the behavior of the player
9610
+ * Actions that define the behavior of the player.
9170
9611
  *
9171
9612
  * @remarks
9172
9613
  * <br/> - Available since v4.3.0
@@ -9174,18 +9615,25 @@ interface UIConfiguration {
9174
9615
  userActions?: UserActions;
9175
9616
  }
9176
9617
  /**
9177
- * A record used to map localization.
9178
- * Each entry contains a translation of an English string.
9618
+ * A record used to map localization.
9619
+ * Each entry contains a translation of an English string.
9179
9620
  *
9621
+ * @category UI
9180
9622
  * @public
9181
9623
  */
9182
9624
  type UILanguage = Record<string, string>;
9183
9625
  /**
9626
+ * Options to control transitions to fullscreen mode.
9627
+ *
9628
+ * @remarks
9629
+ * <br/> - Available since v2.90.0.
9630
+ *
9631
+ * @category UI
9184
9632
  * @public
9185
9633
  */
9186
9634
  interface FullscreenOptions$1 {
9187
9635
  /**
9188
- * Whether or not to show navigation UI while in fullscreen.
9636
+ * Whether to show navigation UI while in fullscreen.
9189
9637
  *
9190
9638
  * @remarks
9191
9639
  * <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 +9650,12 @@ interface FullscreenOptions$1 {
9202
9650
  navigationUI?: 'auto' | 'show' | 'hide';
9203
9651
  }
9204
9652
  /**
9653
+ * Actions that define the behavior of the player.
9654
+ *
9655
+ * @remarks
9656
+ * <br/> - Available since v4.3.0
9657
+ *
9658
+ * @category UI
9205
9659
  * @public
9206
9660
  */
9207
9661
  interface UserActions {
@@ -9217,6 +9671,7 @@ interface UserActions {
9217
9671
  /**
9218
9672
  * List of players.
9219
9673
  *
9674
+ * @category Player
9220
9675
  * @public
9221
9676
  */
9222
9677
  interface PlayerList extends Array<ChromelessPlayer> {
@@ -9237,6 +9692,7 @@ interface PlayerList extends Array<ChromelessPlayer> {
9237
9692
  /**
9238
9693
  * The {@link CachingTask}'s license API.
9239
9694
  *
9695
+ * @category Caching
9240
9696
  * @public
9241
9697
  */
9242
9698
  interface CachingTaskLicense {
@@ -9251,6 +9707,7 @@ interface CachingTaskLicense {
9251
9707
  /**
9252
9708
  * Describes the configuration of a caching task.
9253
9709
  *
9710
+ * @category Caching
9254
9711
  * @public
9255
9712
  */
9256
9713
  interface CachingTaskParameters {
@@ -9293,12 +9750,14 @@ interface CachingTaskParameters {
9293
9750
  * <br/> - `'error'`: The task has encountered an error while downloading or evicting content.
9294
9751
  * <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
9752
  *
9753
+ * @category Caching
9296
9754
  * @public
9297
9755
  */
9298
9756
  type CacheTaskStatus = 'idle' | 'loading' | 'done' | 'error' | 'evicted';
9299
9757
  /**
9300
9758
  * The events fired by the {@link CachingTask}.
9301
9759
  *
9760
+ * @category Caching
9302
9761
  * @public
9303
9762
  */
9304
9763
  interface CachingTaskEventMap {
@@ -9314,6 +9773,7 @@ interface CachingTaskEventMap {
9314
9773
  /**
9315
9774
  * Represents a caching task.
9316
9775
  *
9776
+ * @category Caching
9317
9777
  * @public
9318
9778
  */
9319
9779
  interface CachingTask extends EventDispatcher<CachingTaskEventMap> {
@@ -9384,6 +9844,8 @@ interface CachingTask extends EventDispatcher<CachingTaskEventMap> {
9384
9844
  /**
9385
9845
  * Fired when a caching task is added.
9386
9846
  *
9847
+ * @category Caching
9848
+ * @category Events
9387
9849
  * @public
9388
9850
  */
9389
9851
  interface AddCachingTaskEvent extends Event<'addtask'> {
@@ -9396,6 +9858,8 @@ interface AddCachingTaskEvent extends Event<'addtask'> {
9396
9858
  /**
9397
9859
  * Fired when a caching task is removed.
9398
9860
  *
9861
+ * @category Caching
9862
+ * @category Events
9399
9863
  * @public
9400
9864
  */
9401
9865
  interface RemoveCachingTaskEvent extends Event<'removetask'> {
@@ -9408,6 +9872,7 @@ interface RemoveCachingTaskEvent extends Event<'removetask'> {
9408
9872
  /**
9409
9873
  * The events fired by the {@link CachingTaskList}.
9410
9874
  *
9875
+ * @category Caching
9411
9876
  * @public
9412
9877
  */
9413
9878
  interface CachingTaskListEventMap {
@@ -9423,6 +9888,7 @@ interface CachingTaskListEventMap {
9423
9888
  /**
9424
9889
  * List of caching tasks.
9425
9890
  *
9891
+ * @category Caching
9426
9892
  * @public
9427
9893
  */
9428
9894
  interface CachingTaskList extends EventedList<CachingTask, CachingTaskListEventMap> {
@@ -9433,12 +9899,14 @@ interface CachingTaskList extends EventedList<CachingTask, CachingTaskListEventM
9433
9899
  * <br/> - `'uninitialised'`: Previously stored caching tasks are unavailable.
9434
9900
  * <br/> - `'initialised'`: Previously stored caching tasks are now available.
9435
9901
  *
9902
+ * @category Caching
9436
9903
  * @public
9437
9904
  */
9438
9905
  type CacheStatus = 'uninitialised' | 'initialised';
9439
9906
  /**
9440
9907
  * The events fired by the {@link Cache | cache API}.
9441
9908
  *
9909
+ * @category Caching
9442
9910
  * @public
9443
9911
  */
9444
9912
  interface CacheEventMap {
@@ -9453,6 +9921,7 @@ interface CacheEventMap {
9453
9921
  * @remarks
9454
9922
  * <br/> - Available since v2.26.
9455
9923
  *
9924
+ * @category Caching
9456
9925
  * @public
9457
9926
  */
9458
9927
  interface Cache extends EventDispatcher<CacheEventMap> {
@@ -9497,6 +9966,7 @@ interface CommonUtils {
9497
9966
 
9498
9967
  /**
9499
9968
  * A request, either for a certificate or a license.
9969
+ * @category Content Protection
9500
9970
  * @public
9501
9971
  */
9502
9972
  interface ContentProtectionRequest {
@@ -9535,11 +10005,13 @@ interface ContentProtectionRequest {
9535
10005
  /**
9536
10006
  * A request for a certificate.
9537
10007
  *
10008
+ * @category Content Protection
9538
10009
  * @public
9539
10010
  */
9540
10011
  type CertificateRequest = ContentProtectionRequest;
9541
10012
  /**
9542
10013
  * A request for a license.
10014
+ * @category Content Protection
9543
10015
  * @public
9544
10016
  */
9545
10017
  interface LicenseRequest extends ContentProtectionRequest {
@@ -9554,6 +10026,7 @@ interface LicenseRequest extends ContentProtectionRequest {
9554
10026
 
9555
10027
  /**
9556
10028
  * The response, either of a license or for a certificate request.
10029
+ * @category Content Protection
9557
10030
  * @public
9558
10031
  */
9559
10032
  interface ContentProtectionResponse {
@@ -9589,6 +10062,7 @@ interface ContentProtectionResponse {
9589
10062
  }
9590
10063
  /**
9591
10064
  * The response of a certificate request.
10065
+ * @category Content Protection
9592
10066
  * @public
9593
10067
  */
9594
10068
  interface CertificateResponse extends ContentProtectionResponse {
@@ -9599,6 +10073,7 @@ interface CertificateResponse extends ContentProtectionResponse {
9599
10073
  }
9600
10074
  /**
9601
10075
  * The response of a license request.
10076
+ * @category Content Protection
9602
10077
  * @public
9603
10078
  */
9604
10079
  interface LicenseResponse extends ContentProtectionResponse {
@@ -9611,12 +10086,14 @@ interface LicenseResponse extends ContentProtectionResponse {
9611
10086
  /**
9612
10087
  * A synchronous or asynchronous return type
9613
10088
  *
10089
+ * @category Content Protection
9614
10090
  * @public
9615
10091
  */
9616
10092
  type MaybeAsync<T> = T | PromiseLike<T>;
9617
10093
  /**
9618
10094
  * This ContentProtectionIntegration defines some methods to alter license and certificate requests and responses.
9619
10095
  *
10096
+ * @category Content Protection
9620
10097
  * @public
9621
10098
  */
9622
10099
  interface ContentProtectionIntegration {
@@ -9695,6 +10172,7 @@ interface ContentProtectionIntegration {
9695
10172
  /**
9696
10173
  * Factory pattern to create {@link ContentProtectionIntegration}s.
9697
10174
  *
10175
+ * @category Content Protection
9698
10176
  * @public
9699
10177
  */
9700
10178
  interface ContentProtectionIntegrationFactory {
@@ -9709,6 +10187,8 @@ interface ContentProtectionIntegrationFactory {
9709
10187
  /**
9710
10188
  * The identifier of the Axinom integration.
9711
10189
  *
10190
+ * @category Source
10191
+ * @category Content Protection
9712
10192
  * @public
9713
10193
  */
9714
10194
  type AxinomIntegrationID = 'axinom';
@@ -9727,6 +10207,8 @@ type AxinomIntegrationID = 'axinom';
9727
10207
  * }
9728
10208
  * ```
9729
10209
  *
10210
+ * @category Source
10211
+ * @category Content Protection
9730
10212
  * @public
9731
10213
  */
9732
10214
  interface AxinomDRMConfiguration extends DRMConfiguration {
@@ -9746,12 +10228,16 @@ interface AxinomDRMConfiguration extends DRMConfiguration {
9746
10228
  /**
9747
10229
  * The identifier of the Azure Media Services integration.
9748
10230
  *
10231
+ * @category Source
10232
+ * @category Content Protection
9749
10233
  * @public
9750
10234
  */
9751
10235
  type AzureIntegrationID = 'azure';
9752
10236
  /**
9753
10237
  * Describes the configuration of the Azure Media Services DRM integration.
9754
10238
  *
10239
+ * @category Source
10240
+ * @category Content Protection
9755
10241
  * @public
9756
10242
  */
9757
10243
  interface AzureDRMConfiguration extends DRMConfiguration {
@@ -9771,6 +10257,8 @@ interface AzureDRMConfiguration extends DRMConfiguration {
9771
10257
  /**
9772
10258
  * The identifier of the Comcast integration.
9773
10259
  *
10260
+ * @category Source
10261
+ * @category Content Protection
9774
10262
  * @public
9775
10263
  */
9776
10264
  type ComcastIntegrationID = 'comcast';
@@ -9788,6 +10276,8 @@ type ComcastIntegrationID = 'comcast';
9788
10276
  * }
9789
10277
  * ```
9790
10278
  *
10279
+ * @category Source
10280
+ * @category Content Protection
9791
10281
  * @public
9792
10282
  */
9793
10283
  interface ComcastDRMConfiguration extends DRMConfiguration {
@@ -9816,6 +10306,8 @@ interface ComcastDRMConfiguration extends DRMConfiguration {
9816
10306
  /**
9817
10307
  * The identifier of the Conax integration.
9818
10308
  *
10309
+ * @category Source
10310
+ * @category Content Protection
9819
10311
  * @public
9820
10312
  */
9821
10313
  type ConaxIntegrationID = 'conax';
@@ -9845,6 +10337,8 @@ type ConaxIntegrationID = 'conax';
9845
10337
  * }
9846
10338
  * ```
9847
10339
  *
10340
+ * @category Source
10341
+ * @category Content Protection
9848
10342
  * @public
9849
10343
  */
9850
10344
  interface ConaxDRMConfiguration extends DRMConfiguration {
@@ -9874,12 +10368,16 @@ interface ConaxDRMConfiguration extends DRMConfiguration {
9874
10368
  /**
9875
10369
  * The identifier of the DRM Today integration.
9876
10370
  *
10371
+ * @category Source
10372
+ * @category Content Protection
9877
10373
  * @public
9878
10374
  */
9879
10375
  type DRMTodayIntegrationID = 'drmtoday';
9880
10376
  /**
9881
10377
  * Describes the configuration of the DRM Today DRM integration.
9882
10378
  *
10379
+ * @category Source
10380
+ * @category Content Protection
9883
10381
  * @public
9884
10382
  */
9885
10383
  interface DRMTodayDRMConfiguration extends DRMConfiguration {
@@ -9920,12 +10418,16 @@ interface DRMTodayDRMConfiguration extends DRMConfiguration {
9920
10418
  /**
9921
10419
  * The identifier of the ExpressPlay integration.
9922
10420
  *
10421
+ * @category Source
10422
+ * @category Content Protection
9923
10423
  * @public
9924
10424
  */
9925
10425
  type ExpressPlayIntegrationID = 'expressplay';
9926
10426
  /**
9927
10427
  * Describes the configuration of the ExpressPlay DRM integration.
9928
10428
  *
10429
+ * @category Source
10430
+ * @category Content Protection
9929
10431
  * @public
9930
10432
  */
9931
10433
  interface ExpressPlayDRMConfiguration extends DRMConfiguration {
@@ -9938,6 +10440,8 @@ interface ExpressPlayDRMConfiguration extends DRMConfiguration {
9938
10440
  /**
9939
10441
  * The identifier of the Ezdrm integration.
9940
10442
  *
10443
+ * @category Source
10444
+ * @category Content Protection
9941
10445
  * @public
9942
10446
  */
9943
10447
  type EzdrmIntegrationID = 'ezdrm';
@@ -9955,6 +10459,8 @@ type EzdrmIntegrationID = 'ezdrm';
9955
10459
  * }
9956
10460
  * ```
9957
10461
  *
10462
+ * @category Source
10463
+ * @category Content Protection
9958
10464
  * @public
9959
10465
  */
9960
10466
  interface EzdrmDRMConfiguration extends DRMConfiguration {
@@ -9967,6 +10473,8 @@ interface EzdrmDRMConfiguration extends DRMConfiguration {
9967
10473
  /**
9968
10474
  * The identifier of the Irdeto integration.
9969
10475
  *
10476
+ * @category Source
10477
+ * @category Content Protection
9970
10478
  * @public
9971
10479
  */
9972
10480
  type IrdetoIntegrationID = 'irdeto';
@@ -9989,6 +10497,8 @@ type IrdetoIntegrationID = 'irdeto';
9989
10497
  * }
9990
10498
  * ```
9991
10499
  *
10500
+ * @category Source
10501
+ * @category Content Protection
9992
10502
  * @public
9993
10503
  */
9994
10504
  interface IrdetoDRMConfiguration extends DRMConfiguration {
@@ -10046,6 +10556,8 @@ interface IrdetoDRMConfiguration extends DRMConfiguration {
10046
10556
  /**
10047
10557
  * The identifier of the KeyOS integration.
10048
10558
  *
10559
+ * @category Source
10560
+ * @category Content Protection
10049
10561
  * @public
10050
10562
  */
10051
10563
  type KeyOSIntegrationID = 'keyos';
@@ -10074,6 +10586,8 @@ type KeyOSIntegrationID = 'keyos';
10074
10586
  * }
10075
10587
  * ```
10076
10588
  *
10589
+ * @category Source
10590
+ * @category Content Protection
10077
10591
  * @public
10078
10592
  */
10079
10593
  interface KeyOSDRMConfiguration extends DRMConfiguration {
@@ -10106,6 +10620,8 @@ interface KeyOSDRMConfiguration extends DRMConfiguration {
10106
10620
  /**
10107
10621
  * Describes the KeyOS key system configuration.
10108
10622
  *
10623
+ * @category Source
10624
+ * @category Content Protection
10109
10625
  * @public
10110
10626
  */
10111
10627
  interface KeyOSKeySystemConfiguration extends KeySystemConfiguration {
@@ -10117,6 +10633,8 @@ interface KeyOSKeySystemConfiguration extends KeySystemConfiguration {
10117
10633
  /**
10118
10634
  * Describes the KeyOS FairPlay key system configuration.
10119
10635
  *
10636
+ * @category Source
10637
+ * @category Content Protection
10120
10638
  * @public
10121
10639
  */
10122
10640
  interface KeyOSFairplayKeySystemConfiguration extends FairPlayKeySystemConfiguration {
@@ -10129,6 +10647,8 @@ interface KeyOSFairplayKeySystemConfiguration extends FairPlayKeySystemConfigura
10129
10647
  /**
10130
10648
  * The identifier of the Titanium integration.
10131
10649
  *
10650
+ * @category Source
10651
+ * @category Content Protection
10132
10652
  * @public
10133
10653
  */
10134
10654
  type TitaniumIntegrationID = 'titanium';
@@ -10152,6 +10672,8 @@ type TitaniumIntegrationID = 'titanium';
10152
10672
  * }
10153
10673
  * ```
10154
10674
  *
10675
+ * @category Source
10676
+ * @category Content Protection
10155
10677
  * @public
10156
10678
  */
10157
10679
  interface TitaniumDRMConfiguration extends DRMConfiguration {
@@ -10210,6 +10732,8 @@ interface TitaniumDRMConfiguration extends DRMConfiguration {
10210
10732
  /**
10211
10733
  * Describes the configuration of the Titanium DRM integration with device-based authentication.
10212
10734
  *
10735
+ * @category Source
10736
+ * @category Content Protection
10213
10737
  * @public
10214
10738
  */
10215
10739
  interface DeviceBasedTitaniumDRMConfiguration extends TitaniumDRMConfiguration {
@@ -10240,6 +10764,8 @@ interface DeviceBasedTitaniumDRMConfiguration extends TitaniumDRMConfiguration {
10240
10764
  /**
10241
10765
  * Describes the configuration of the Titanium DRM integration with token-based authentication.
10242
10766
  *
10767
+ * @category Source
10768
+ * @category Content Protection
10243
10769
  * @public
10244
10770
  */
10245
10771
  interface TokenBasedTitaniumDRMConfiguration extends TitaniumDRMConfiguration {
@@ -10271,6 +10797,8 @@ interface TokenBasedTitaniumDRMConfiguration extends TitaniumDRMConfiguration {
10271
10797
  /**
10272
10798
  * The identifier of the Uplynk integration.
10273
10799
  *
10800
+ * @category Source
10801
+ * @category Content Protection
10274
10802
  * @public
10275
10803
  */
10276
10804
  type UplynkIntegrationID = 'uplynk';
@@ -10287,6 +10815,8 @@ type UplynkIntegrationID = 'uplynk';
10287
10815
  * }
10288
10816
  * ```
10289
10817
  *
10818
+ * @category Source
10819
+ * @category Content Protection
10290
10820
  * @public
10291
10821
  */
10292
10822
  interface UplynkDRMConfiguration extends DRMConfiguration {
@@ -10299,6 +10829,8 @@ interface UplynkDRMConfiguration extends DRMConfiguration {
10299
10829
  /**
10300
10830
  * The identifier of the Verimatrix integration.
10301
10831
  *
10832
+ * @category Source
10833
+ * @category Content Protection
10302
10834
  * @public
10303
10835
  */
10304
10836
  type VerimatrixIntegrationID = 'verimatrix';
@@ -10316,6 +10848,8 @@ type VerimatrixIntegrationID = 'verimatrix';
10316
10848
  * }
10317
10849
  * ```
10318
10850
  *
10851
+ * @category Source
10852
+ * @category Content Protection
10319
10853
  * @public
10320
10854
  */
10321
10855
  interface VerimatrixDRMConfiguration extends DRMConfiguration {
@@ -10328,12 +10862,16 @@ interface VerimatrixDRMConfiguration extends DRMConfiguration {
10328
10862
  /**
10329
10863
  * The identifier of the Vimond integration.
10330
10864
  *
10865
+ * @category Source
10866
+ * @category Content Protection
10331
10867
  * @public
10332
10868
  */
10333
10869
  type VimondIntegrationID = 'vimond';
10334
10870
  /**
10335
10871
  * Describes the configuration of the Vimond DRM integration.
10336
10872
  *
10873
+ * @category Source
10874
+ * @category Content Protection
10337
10875
  * @public
10338
10876
  */
10339
10877
  interface VimondDRMConfiguration extends DRMConfiguration {
@@ -10346,6 +10884,8 @@ interface VimondDRMConfiguration extends DRMConfiguration {
10346
10884
  /**
10347
10885
  * The identifier of the Vudrm integration.
10348
10886
  *
10887
+ * @category Source
10888
+ * @category Content Protection
10349
10889
  * @public
10350
10890
  */
10351
10891
  type VudrmIntegrationID = 'vudrm';
@@ -10366,6 +10906,8 @@ type VudrmIntegrationID = 'vudrm';
10366
10906
  * }
10367
10907
  * ```
10368
10908
  *
10909
+ * @category Source
10910
+ * @category Content Protection
10369
10911
  * @public
10370
10912
  */
10371
10913
  interface VudrmDRMConfiguration extends DRMConfiguration {
@@ -10389,6 +10931,8 @@ interface VudrmDRMConfiguration extends DRMConfiguration {
10389
10931
  /**
10390
10932
  * The identifier of the Xstream integration.
10391
10933
  *
10934
+ * @category Source
10935
+ * @category Content Protection
10392
10936
  * @public
10393
10937
  */
10394
10938
  type XstreamIntegrationID = 'xstream';
@@ -10408,6 +10952,8 @@ type XstreamIntegrationID = 'xstream';
10408
10952
  * }
10409
10953
  * ```
10410
10954
  *
10955
+ * @category Source
10956
+ * @category Content Protection
10411
10957
  * @public
10412
10958
  */
10413
10959
  interface XstreamDRMConfiguration extends DRMConfiguration {
@@ -10432,6 +10978,8 @@ interface XstreamDRMConfiguration extends DRMConfiguration {
10432
10978
  /**
10433
10979
  * Represents a source for the MediaTailor integration.
10434
10980
  *
10981
+ * @category Source
10982
+ * @category Analytics
10435
10983
  * @public
10436
10984
  */
10437
10985
  interface MediaTailorSource extends TypedSource {
@@ -10449,6 +10997,7 @@ interface MediaTailorSource extends TypedSource {
10449
10997
  /**
10450
10998
  * Represents a cue of a HLS date range metadata text track.
10451
10999
  *
11000
+ * @category Media and Text Tracks
10452
11001
  * @public
10453
11002
  */
10454
11003
  interface DateRangeCue extends TextTrackCue {
@@ -10509,6 +11058,7 @@ interface DateRangeCue extends TextTrackCue {
10509
11058
  /**
10510
11059
  * Represents a cue of an emsg metadata text track.
10511
11060
  *
11061
+ * @category Media and Text Tracks
10512
11062
  * @public
10513
11063
  */
10514
11064
  interface EmsgCue extends TextTrackCue {
@@ -10532,6 +11082,7 @@ interface EmsgCue extends TextTrackCue {
10532
11082
  /**
10533
11083
  * Represents a cue of an Event Stream metadata text track.
10534
11084
  *
11085
+ * @category Media and Text Tracks
10535
11086
  * @public
10536
11087
  */
10537
11088
  interface EventStreamCue extends TextTrackCue {
@@ -10553,6 +11104,7 @@ interface EventStreamCue extends TextTrackCue {
10553
11104
  /**
10554
11105
  * Represents a generic ID3 frame.
10555
11106
  *
11107
+ * @category Media and Text Tracks
10556
11108
  * @public
10557
11109
  */
10558
11110
  interface ID3BaseFrame {
@@ -10567,6 +11119,7 @@ interface ID3BaseFrame {
10567
11119
  /**
10568
11120
  * Represents an unknown ID3 frame.
10569
11121
  *
11122
+ * @category Media and Text Tracks
10570
11123
  * @public
10571
11124
  */
10572
11125
  interface ID3Unknown extends ID3BaseFrame {
@@ -10578,6 +11131,7 @@ interface ID3Unknown extends ID3BaseFrame {
10578
11131
  /**
10579
11132
  * Represents an attached picture ID3 frame.
10580
11133
  *
11134
+ * @category Media and Text Tracks
10581
11135
  * @public
10582
11136
  */
10583
11137
  interface ID3AttachedPicture extends ID3BaseFrame {
@@ -10611,6 +11165,7 @@ interface ID3AttachedPicture extends ID3BaseFrame {
10611
11165
  /**
10612
11166
  * Represents a comments ID3 frame.
10613
11167
  *
11168
+ * @category Media and Text Tracks
10614
11169
  * @public
10615
11170
  */
10616
11171
  interface ID3Comments extends ID3BaseFrame {
@@ -10634,6 +11189,7 @@ interface ID3Comments extends ID3BaseFrame {
10634
11189
  /**
10635
11190
  * Represents a commercial ID3 frame.
10636
11191
  *
11192
+ * @category Media and Text Tracks
10637
11193
  * @public
10638
11194
  */
10639
11195
  interface ID3CommercialFrame extends ID3BaseFrame {
@@ -10693,6 +11249,7 @@ interface ID3CommercialFrame extends ID3BaseFrame {
10693
11249
  /**
10694
11250
  * Represents a general encapsulated object ID3 frame.
10695
11251
  *
11252
+ * @category Media and Text Tracks
10696
11253
  * @public
10697
11254
  */
10698
11255
  interface ID3GenericEncapsulatedObject extends ID3BaseFrame {
@@ -10720,6 +11277,7 @@ interface ID3GenericEncapsulatedObject extends ID3BaseFrame {
10720
11277
  /**
10721
11278
  * Represents an involved people list ID3 frame.
10722
11279
  *
11280
+ * @category Media and Text Tracks
10723
11281
  * @public
10724
11282
  */
10725
11283
  interface ID3InvolvedPeopleList extends ID3BaseFrame {
@@ -10738,6 +11296,7 @@ interface ID3InvolvedPeopleList extends ID3BaseFrame {
10738
11296
  /**
10739
11297
  * Represents a private ID3 frame.
10740
11298
  *
11299
+ * @category Media and Text Tracks
10741
11300
  * @public
10742
11301
  */
10743
11302
  interface ID3PrivateFrame extends ID3BaseFrame {
@@ -10757,6 +11316,7 @@ interface ID3PrivateFrame extends ID3BaseFrame {
10757
11316
  /**
10758
11317
  * Represents an position synchronisation ID3 frame.
10759
11318
  *
11319
+ * @category Media and Text Tracks
10760
11320
  * @public
10761
11321
  */
10762
11322
  interface ID3PositionSynchronisationFrame extends ID3BaseFrame {
@@ -10778,6 +11338,7 @@ interface ID3PositionSynchronisationFrame extends ID3BaseFrame {
10778
11338
  /**
10779
11339
  * Represents a synchronised lyrics/text ID3 frame.
10780
11340
  *
11341
+ * @category Media and Text Tracks
10781
11342
  * @public
10782
11343
  */
10783
11344
  interface ID3SynchronizedLyricsText extends ID3BaseFrame {
@@ -10823,6 +11384,7 @@ interface ID3SynchronizedLyricsText extends ID3BaseFrame {
10823
11384
  /**
10824
11385
  * Represents a text information ID3 frame.
10825
11386
  *
11387
+ * @category Media and Text Tracks
10826
11388
  * @public
10827
11389
  */
10828
11390
  interface ID3Text extends ID3BaseFrame {
@@ -10841,6 +11403,7 @@ interface ID3Text extends ID3BaseFrame {
10841
11403
  /**
10842
11404
  * Represents a used defined text ID3 frame.
10843
11405
  *
11406
+ * @category Media and Text Tracks
10844
11407
  * @public
10845
11408
  */
10846
11409
  interface ID3UserDefinedText extends ID3BaseFrame {
@@ -10860,6 +11423,7 @@ interface ID3UserDefinedText extends ID3BaseFrame {
10860
11423
  /**
10861
11424
  * Represents a unique file identifier ID3 frame.
10862
11425
  *
11426
+ * @category Media and Text Tracks
10863
11427
  * @public
10864
11428
  */
10865
11429
  interface ID3UniqueFileIdentifier extends ID3BaseFrame {
@@ -10879,6 +11443,7 @@ interface ID3UniqueFileIdentifier extends ID3BaseFrame {
10879
11443
  /**
10880
11444
  * Represents a terms of use ID3 frame.
10881
11445
  *
11446
+ * @category Media and Text Tracks
10882
11447
  * @public
10883
11448
  */
10884
11449
  interface ID3TermsOfUse extends ID3BaseFrame {
@@ -10898,6 +11463,7 @@ interface ID3TermsOfUse extends ID3BaseFrame {
10898
11463
  /**
10899
11464
  * Represents a unsynchronised lyrics/text transcription ID3 frame.
10900
11465
  *
11466
+ * @category Media and Text Tracks
10901
11467
  * @public
10902
11468
  */
10903
11469
  interface ID3UnsynchronisedLyricsTextTranscription extends ID3BaseFrame {
@@ -10921,6 +11487,7 @@ interface ID3UnsynchronisedLyricsTextTranscription extends ID3BaseFrame {
10921
11487
  /**
10922
11488
  * Represents a URL link ID3 frame.
10923
11489
  *
11490
+ * @category Media and Text Tracks
10924
11491
  * @public
10925
11492
  */
10926
11493
  interface ID3UrlLink extends ID3BaseFrame {
@@ -10939,6 +11506,7 @@ interface ID3UrlLink extends ID3BaseFrame {
10939
11506
  /**
10940
11507
  * Represents a user defined URL link ID3 frame.
10941
11508
  *
11509
+ * @category Media and Text Tracks
10942
11510
  * @public
10943
11511
  */
10944
11512
  interface ID3UserDefinedUrlLink extends ID3BaseFrame {
@@ -10976,12 +11544,16 @@ interface ID3UserDefinedUrlLink extends ID3BaseFrame {
10976
11544
  * };
10977
11545
  * ```
10978
11546
  *
11547
+ * @category Media and Text Tracks
11548
+ * @category SSAI
10979
11549
  * @public
10980
11550
  */
10981
11551
  type YospaceId = 'YMID' | 'YTYP' | 'YSEQ' | 'YDUR' | 'YCSP';
10982
11552
  /**
10983
11553
  * Represents a Yospace ID3 frame.
10984
11554
  *
11555
+ * @category Media and Text Tracks
11556
+ * @category SSAI
10985
11557
  * @public
10986
11558
  */
10987
11559
  interface ID3Yospace extends ID3BaseFrame {
@@ -10997,6 +11569,7 @@ interface ID3Yospace extends ID3BaseFrame {
10997
11569
  /**
10998
11570
  * The possible types of an ID3 frame.
10999
11571
  *
11572
+ * @category Media and Text Tracks
11000
11573
  * @public
11001
11574
  */
11002
11575
  type ID3Frame = ID3Unknown | ID3AttachedPicture | ID3GenericEncapsulatedObject | ID3Comments | ID3CommercialFrame | ID3InvolvedPeopleList | ID3PositionSynchronisationFrame | ID3PrivateFrame | ID3SynchronizedLyricsText | ID3Text | ID3UserDefinedText | ID3UniqueFileIdentifier | ID3TermsOfUse | ID3UnsynchronisedLyricsTextTranscription | ID3UrlLink | ID3UserDefinedUrlLink | ID3Yospace;
@@ -11004,6 +11577,7 @@ type ID3Frame = ID3Unknown | ID3AttachedPicture | ID3GenericEncapsulatedObject |
11004
11577
  /**
11005
11578
  * Represents a cue of an ID3 metadata text track.
11006
11579
  *
11580
+ * @category Media and Text Tracks
11007
11581
  * @public
11008
11582
  */
11009
11583
  interface ID3Cue extends TextTrackCue {
@@ -11018,12 +11592,14 @@ interface ID3Cue extends TextTrackCue {
11018
11592
  * <br/> - `''`: None. Cues in the region stay fixed at the location they were first painted in.
11019
11593
  * <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
11594
  *
11595
+ * @category Media and Text Tracks
11021
11596
  * @public
11022
11597
  */
11023
11598
  type VTTScrollSetting = '' | /* none */ 'up';
11024
11599
  /**
11025
11600
  * Represents a WebVTT region.
11026
11601
  *
11602
+ * @category Media and Text Tracks
11027
11603
  * @public
11028
11604
  */
11029
11605
  interface WebVTTRegion {
@@ -11073,6 +11649,7 @@ interface WebVTTRegion {
11073
11649
  * <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
11650
  * <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
11651
  *
11652
+ * @category Media and Text Tracks
11076
11653
  * @public
11077
11654
  */
11078
11655
  type VTTDirectionSetting = '' | 'rl' | 'lr';
@@ -11082,6 +11659,7 @@ type VTTDirectionSetting = '' | 'rl' | 'lr';
11082
11659
  * <br/> - `'center'`: The cue box's center is aligned at a specified line.
11083
11660
  * <br/> - `'end'`: The cue box's end is aligned at a specified line.
11084
11661
  *
11662
+ * @category Media and Text Tracks
11085
11663
  * @public
11086
11664
  */
11087
11665
  type VTTLineAlignSetting = 'start' | 'center' | 'end';
@@ -11093,6 +11671,7 @@ type VTTLineAlignSetting = 'start' | 'center' | 'end';
11093
11671
  * <br/> - `'left'`: The text of each line is aligned to the box’s left side for horizontal cues, or top side otherwise.
11094
11672
  * <br/> - `'right'`: The text of each line is aligned to the box’s right side for horizontal cues, or bottom side otherwise.
11095
11673
  *
11674
+ * @category Media and Text Tracks
11096
11675
  * @public
11097
11676
  */
11098
11677
  type VTTAlignSetting = 'start' | 'center' | 'end' | 'left' | 'right';
@@ -11103,6 +11682,7 @@ type VTTAlignSetting = 'start' | 'center' | 'end' | 'left' | 'right';
11103
11682
  * <br/> - `'line-right'`: The cue box's end is aligned at a specified position.
11104
11683
  * <br/> - `'auto'`: The cue box's alignment is dependent on its text alignment setting.
11105
11684
  *
11685
+ * @category Media and Text Tracks
11106
11686
  * @public
11107
11687
  */
11108
11688
  type VTTPositionAlignSetting = 'line-left' | 'center' | 'line-right' | 'auto';
@@ -11114,6 +11694,7 @@ type VTTPositionAlignSetting = 'line-left' | 'center' | 'line-right' | 'auto';
11114
11694
  * @remarks
11115
11695
  * <br/> - The semantics of the `number` variant are dependent on {@link WebVTTCue.snapToLines}.
11116
11696
  *
11697
+ * @category Media and Text Tracks
11117
11698
  * @public
11118
11699
  */
11119
11700
  type VTTLine = number | 'auto';
@@ -11122,12 +11703,14 @@ type VTTLine = number | 'auto';
11122
11703
  * <br/> - a number: The position is expressed as a percentage value.
11123
11704
  * <br/> - `'auto'`: The position depends on the text alignment of the cue.
11124
11705
  *
11706
+ * @category Media and Text Tracks
11125
11707
  * @public
11126
11708
  */
11127
11709
  type VTTPosition = number | 'auto';
11128
11710
  /**
11129
11711
  * Represents a cue of a {@link https://www.w3.org/TR/webvtt1/ | WebVTT} text track.
11130
11712
  *
11713
+ * @category Media and Text Tracks
11131
11714
  * @public
11132
11715
  */
11133
11716
  interface WebVTTCue extends TextTrackCue {
@@ -11187,12 +11770,14 @@ interface WebVTTCue extends TextTrackCue {
11187
11770
  * Record of style properties.
11188
11771
  * Each entry contains the style property name with associated value.
11189
11772
  *
11773
+ * @category Media and Text Tracks
11190
11774
  * @public
11191
11775
  */
11192
11776
  type StylePropertyRecord = Record<string, string>;
11193
11777
  /**
11194
11778
  * Represents a cue of a TTML text track.
11195
11779
  *
11780
+ * @category Media and Text Tracks
11196
11781
  * @public
11197
11782
  */
11198
11783
  interface TTMLCue extends TextTrackCue {
@@ -11220,6 +11805,7 @@ interface TTMLCue extends TextTrackCue {
11220
11805
  }
11221
11806
 
11222
11807
  /**
11808
+ * @category HESP
11223
11809
  * @public
11224
11810
  */
11225
11811
  type HespMediaType = 'audio' | 'video' | 'metadata';
@@ -11227,6 +11813,7 @@ type HespMediaType = 'audio' | 'video' | 'metadata';
11227
11813
  /**
11228
11814
  * The identifier of the Agama integration.
11229
11815
  *
11816
+ * @category Analytics
11230
11817
  * @public
11231
11818
  */
11232
11819
  type AgamaAnalyticsIntegrationID = 'agama';
@@ -11238,12 +11825,14 @@ type AgamaAnalyticsIntegrationID = 'agama';
11238
11825
  * <br/> - `'error'`
11239
11826
  * <br/> - `'fatal'`
11240
11827
  *
11828
+ * @category Analytics
11241
11829
  * @public
11242
11830
  */
11243
11831
  type AgamaLogLevelType = 'info' | 'debug' | 'warning' | 'error' | 'fatal';
11244
11832
  /**
11245
11833
  * Describes the configuration of Agama.
11246
11834
  *
11835
+ * @category Analytics
11247
11836
  * @public
11248
11837
  */
11249
11838
  interface AgamaConfiguration extends AnalyticsDescription {
@@ -11258,6 +11847,7 @@ interface AgamaConfiguration extends AnalyticsDescription {
11258
11847
  * @remarks
11259
11848
  * <br/> - Available since v2.45.6.
11260
11849
  *
11850
+ * @category Analytics
11261
11851
  * @public
11262
11852
  */
11263
11853
  interface AgamaPlayerConfiguration extends AgamaConfiguration {
@@ -11367,6 +11957,7 @@ interface AgamaPlayerConfiguration extends AgamaConfiguration {
11367
11957
  * <br/> - `'live'`
11368
11958
  * <br/> - `'vod'`
11369
11959
  *
11960
+ * @category Analytics
11370
11961
  * @public
11371
11962
  */
11372
11963
  type AgamaStreamType = 'live' | 'vod';
@@ -11379,6 +11970,7 @@ type AgamaStreamType = 'live' | 'vod';
11379
11970
  * <br/> - `'avod'`
11380
11971
  * <br/> - `'catchuptv'`
11381
11972
  *
11973
+ * @category Analytics
11382
11974
  * @public
11383
11975
  */
11384
11976
  type AgamaServiceName = 'live' | 'svod' | 'nvod' | 'tvod' | 'avod' | 'catchuptv';
@@ -11389,6 +11981,7 @@ type AgamaServiceName = 'live' | 'svod' | 'nvod' | 'tvod' | 'avod' | 'catchuptv'
11389
11981
  * <br/> - Available since v2.45.6.
11390
11982
  * <br/> - Overrides the {@link AgamaPlayerConfiguration}.
11391
11983
  *
11984
+ * @category Analytics
11392
11985
  * @public
11393
11986
  */
11394
11987
  interface AgamaSourceConfiguration extends AgamaConfiguration {
@@ -11447,6 +12040,7 @@ interface AgamaSourceConfiguration extends AgamaConfiguration {
11447
12040
  /**
11448
12041
  * The identifier of the Moat integration.
11449
12042
  *
12043
+ * @category Analytics
11450
12044
  * @public
11451
12045
  */
11452
12046
  type MoatAnalyticsIntegrationID = 'moat';
@@ -11456,6 +12050,7 @@ type MoatAnalyticsIntegrationID = 'moat';
11456
12050
  * @remarks
11457
12051
  * <br/> - Available since v2.27.0.
11458
12052
  *
12053
+ * @category Analytics
11459
12054
  * @public
11460
12055
  */
11461
12056
  interface MoatConfiguration extends AnalyticsDescription {
@@ -11472,6 +12067,7 @@ interface MoatConfiguration extends AnalyticsDescription {
11472
12067
  /**
11473
12068
  * Describes the configuration of the Media Melon integration.
11474
12069
  *
12070
+ * @category Analytics
11475
12071
  * @public
11476
12072
  */
11477
12073
  interface MediaMelonConfiguration {
@@ -11509,6 +12105,7 @@ interface MediaMelonConfiguration {
11509
12105
  /**
11510
12106
  * The identifier of the Media Melon SmartSight integration.
11511
12107
  *
12108
+ * @category Analytics
11512
12109
  * @public
11513
12110
  */
11514
12111
  type SmartSightIntegrationID = 'smartsight';
@@ -11518,6 +12115,7 @@ type SmartSightIntegrationID = 'smartsight';
11518
12115
  * @remarks
11519
12116
  * <br/> - Available since v2.33.2.
11520
12117
  *
12118
+ * @category Analytics
11521
12119
  * @public
11522
12120
  */
11523
12121
  interface SmartSightConfiguration extends AnalyticsDescription, MediaMelonConfiguration {
@@ -11530,6 +12128,7 @@ interface SmartSightConfiguration extends AnalyticsDescription, MediaMelonConfig
11530
12128
  /**
11531
12129
  * The identifier of the Stream One integration.
11532
12130
  *
12131
+ * @category Analytics
11533
12132
  * @public
11534
12133
  */
11535
12134
  type StreamOneAnalyticsIntegrationID = 'streamone';
@@ -11539,6 +12138,7 @@ type StreamOneAnalyticsIntegrationID = 'streamone';
11539
12138
  * @remarks
11540
12139
  * <br/> - Available since v2.32.0.
11541
12140
  *
12141
+ * @category Analytics
11542
12142
  * @public
11543
12143
  */
11544
12144
  interface StreamOneConfiguration extends AnalyticsDescription {
@@ -11563,6 +12163,7 @@ interface StreamOneConfiguration extends AnalyticsDescription {
11563
12163
  /**
11564
12164
  * The identifier of the Youbora integration.
11565
12165
  *
12166
+ * @category Analytics
11566
12167
  * @public
11567
12168
  */
11568
12169
  type YouboraAnalyticsIntegrationID = 'youbora';
@@ -11585,6 +12186,7 @@ type YouboraAnalyticsIntegrationID = 'youbora';
11585
12186
  *
11586
12187
  * Available since v2.21.2.
11587
12188
  *
12189
+ * @category Analytics
11588
12190
  * @public
11589
12191
  */
11590
12192
  interface YouboraOptions extends AnalyticsDescription {
@@ -11601,6 +12203,7 @@ interface YouboraOptions extends AnalyticsDescription {
11601
12203
  }
11602
12204
 
11603
12205
  /**
12206
+ * @category Multi-view
11604
12207
  * @public
11605
12208
  */
11606
12209
  declare enum MultiViewPlayerLayout {
@@ -11611,6 +12214,7 @@ declare enum MultiViewPlayerLayout {
11611
12214
  /**
11612
12215
  * The View API
11613
12216
  *
12217
+ * @category Multi-view
11614
12218
  * @public
11615
12219
  */
11616
12220
  interface View {
@@ -11692,6 +12296,7 @@ interface View {
11692
12296
  /**
11693
12297
  * The MultiViewPlayer API
11694
12298
  *
12299
+ * @category Multi-view
11695
12300
  * @public
11696
12301
  */
11697
12302
  interface MultiViewPlayerEventMap {
@@ -11836,9 +12441,11 @@ interface MultiViewPlayerEventMap {
11836
12441
  *
11837
12442
  * @remarks
11838
12443
  * <br/> - Available since v4.3.0
11839
- * <br/> - Only available with the feature `'multiviewplayer'`.
12444
+ * <br/> - Only available with the feature `'multiview'`.
11840
12445
  * <br/> - Only supported on modern browsers such as evergreen Chrome, Firefox and Safari. Not supported on Internet Explorer.
11841
12446
  *
12447
+ * @category API
12448
+ * @category Multi-view
11842
12449
  * @public
11843
12450
  */
11844
12451
  declare class MultiViewPlayer implements EventDispatcher<MultiViewPlayerEventMap> {
@@ -11979,6 +12586,8 @@ declare class MultiViewPlayer implements EventDispatcher<MultiViewPlayerEventMap
11979
12586
  /**
11980
12587
  * Fired when a new {@link View} has been added to the {@link MultiViewPlayer}.
11981
12588
  *
12589
+ * @category Multi-view
12590
+ * @category Events
11982
12591
  * @public
11983
12592
  */
11984
12593
  interface AddViewEvent extends Event<'addview'> {
@@ -11990,6 +12599,8 @@ interface AddViewEvent extends Event<'addview'> {
11990
12599
  /**
11991
12600
  * Fired when a {@link View} has been removed from the {@link MultiViewPlayer}.
11992
12601
  *
12602
+ * @category Multi-view
12603
+ * @category Events
11993
12604
  * @public
11994
12605
  */
11995
12606
  interface RemoveViewEvent extends Event<'removeview'> {
@@ -12001,6 +12612,8 @@ interface RemoveViewEvent extends Event<'removeview'> {
12001
12612
  /**
12002
12613
  * Fired when a view's {@link View.enabled | enabled} changes.
12003
12614
  *
12615
+ * @category Multi-view
12616
+ * @category Events
12004
12617
  * @public
12005
12618
  */
12006
12619
  interface ViewChangeEvent extends Event<'viewchange'> {
@@ -12012,6 +12625,8 @@ interface ViewChangeEvent extends Event<'viewchange'> {
12012
12625
  /**
12013
12626
  * Fired when a {@link View} has swapped positions in the list.
12014
12627
  *
12628
+ * @category Multi-view
12629
+ * @category Events
12015
12630
  * @public
12016
12631
  */
12017
12632
  interface ViewPositionChangeEvent extends Event<'viewpositionchange'> {
@@ -12027,6 +12642,8 @@ interface ViewPositionChangeEvent extends Event<'viewpositionchange'> {
12027
12642
  /**
12028
12643
  * Fired when {@link MultiViewPlayer.layout} changes.
12029
12644
  *
12645
+ * @category Multi-view
12646
+ * @category Events
12030
12647
  * @public
12031
12648
  */
12032
12649
  interface LayoutChangeEvent extends Event<'layoutchange'> {
@@ -12039,12 +12656,14 @@ interface LayoutChangeEvent extends Event<'layoutchange'> {
12039
12656
  /**
12040
12657
  * The version of the THEOplayer SDK.
12041
12658
  *
12659
+ * @category API
12042
12660
  * @public
12043
12661
  */
12044
12662
  declare const version: string;
12045
12663
  /**
12046
12664
  * The player suite version of the THEOplayer SDK.
12047
12665
  *
12666
+ * @category API
12048
12667
  * @public
12049
12668
  * @deprecated Use {@link version | THEOplayer.version} instead.
12050
12669
  */
@@ -12052,24 +12671,30 @@ declare const playerSuiteVersion: string;
12052
12671
  /**
12053
12672
  * The features included in the THEOplayer SDK.
12054
12673
  *
12674
+ * @category API
12055
12675
  * @public
12056
12676
  */
12057
- declare const features: string;
12677
+ declare const features: readonly string[];
12058
12678
  /**
12059
12679
  * List of players.
12060
12680
  *
12681
+ * @category API
12061
12682
  * @public
12062
12683
  */
12063
12684
  declare const players: PlayerList;
12064
12685
  /**
12065
12686
  * The global cast API.
12066
12687
  *
12688
+ * @category API
12689
+ * @category Casting
12067
12690
  * @public
12068
12691
  */
12069
12692
  declare const cast: GlobalCast;
12070
12693
  /**
12071
12694
  * The global cache API.
12072
12695
  *
12696
+ * @category API
12697
+ * @category Caching
12073
12698
  * @public
12074
12699
  */
12075
12700
  declare const cache: Cache;
@@ -12088,11 +12713,15 @@ declare const cache: Cache;
12088
12713
  * {@link ContentProtectionIntegration} based on the {@link DRMConfiguration}. This {@link ContentProtectionIntegration} allows for altering license
12089
12714
  * and certificate requests and responses.
12090
12715
  *
12716
+ * @category API
12717
+ * @category Content Protection
12091
12718
  * @public
12092
12719
  */
12093
12720
  declare function registerContentProtectionIntegration(integrationId: string, keySystem: KeySystemId, integrationFactory: ContentProtectionIntegrationFactory): void;
12094
12721
  /**
12095
12722
  * Utils that serve common use cases. For example encoding and decoding a base64 string to Uint8Array and vice versa.
12723
+ *
12724
+ * @category API
12096
12725
  * @public
12097
12726
  */
12098
12727
  declare const utils: CommonUtils;