@theoplayer/extended 8.10.0 → 8.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -722,16 +722,17 @@ interface AdsManagerLoadedEvent extends Event<'adsmanagerloaded'> {
722
722
  * @remarks
723
723
  * <br/> - Available since v8.2.0.
724
724
  *
725
+ * @deprecated Use {@link TheoAds.replaceAdTagParameters} instead
725
726
  * @category Ads
726
727
  * @public
727
728
  */
728
- interface TheoAds {
729
+ interface LegacyTheoAds {
729
730
  /**
730
731
  * Replaces all the ad tag parameters used for upcoming ad requests for a live stream.
731
732
  *
732
733
  * @param adTagParameters - The new ad tag parameters.
733
734
  *
734
- * @remark
735
+ * @remarks
735
736
  * <br/> - If set, this value overrides any parameters set on the {@link TheoAdDescription.adTagParameters}.
736
737
  */
737
738
  replaceAdTagParameters(adTagParameters?: Record<string, string>): void;
@@ -1424,10 +1425,6 @@ interface AdsEventMap {
1424
1425
  * <br/> - only available in the Google IMA integration.
1425
1426
  */
1426
1427
  adsmanagerloaded: AdsManagerLoadedEvent;
1427
- /**
1428
- * @internal
1429
- */
1430
- overlaybegin: Event<'overlaybegin'>;
1431
1428
  }
1432
1429
  /**
1433
1430
  * Base type for events related to a single ad.
@@ -1514,10 +1511,12 @@ interface Ads extends EventDispatcher<AdsEventMap> {
1514
1511
  /**
1515
1512
  * The THEOads API.
1516
1513
  *
1514
+ * @deprecated use {@link TheoAds} instead.
1515
+ *
1517
1516
  * @remarks
1518
1517
  * <br/> - Only available with the feature `'theoads'`.
1519
1518
  */
1520
- readonly theoads?: TheoAds;
1519
+ readonly theoads?: LegacyTheoAds;
1521
1520
  /**
1522
1521
  * Add an ad break request.
1523
1522
  *
@@ -2225,6 +2224,13 @@ interface DRMConfiguration {
2225
2224
  * Default value is ['widevine', 'playready', 'fairplay'].
2226
2225
  */
2227
2226
  preferredKeySystems?: Array<KeySystemId | (string & {})>;
2227
+ /**
2228
+ * A flag that affects HbbTV enabled devices and indicates whether the OIPF DRM agent should be used for handling DRM protection,
2229
+ * even when EME is available.
2230
+ *
2231
+ * Default value is false.
2232
+ */
2233
+ useOipfDrmAgent?: boolean;
2228
2234
  }
2229
2235
  /**
2230
2236
  * The id of a key system. Possible values are 'widevine', 'fairplay' and 'playready'.
@@ -2278,6 +2284,8 @@ interface GoogleDAIConfiguration extends ServerSideAdInsertionConfiguration {
2278
2284
  * @remarks
2279
2285
  * <br/> - If present, this token is used instead of the API key for stricter content authorization.
2280
2286
  * <br/> - The publisher can control individual content streams authorizations based on this token.
2287
+ * <br/> - See {@link https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/html5/reference/js/StreamRequest#authToken}
2288
+ * for more information.
2281
2289
  */
2282
2290
  authToken?: string;
2283
2291
  /**
@@ -2286,6 +2294,8 @@ interface GoogleDAIConfiguration extends ServerSideAdInsertionConfiguration {
2286
2294
  * @remarks
2287
2295
  * <br/> - This key is used to verify applications that are attempting to access the content.
2288
2296
  * <br/> - This key is configured through the Google Ad Manager UI.
2297
+ * <br/> - See {@link https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/html5/reference/js/StreamRequest#apiKey}
2298
+ * for more information.
2289
2299
  */
2290
2300
  apiKey: string;
2291
2301
  /**
@@ -2293,6 +2303,8 @@ interface GoogleDAIConfiguration extends ServerSideAdInsertionConfiguration {
2293
2303
  *
2294
2304
  * @remarks
2295
2305
  * <br/> - Each entry contains the parameter name with associated value.
2306
+ * <br/> - See {@link https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/html5/reference/js/StreamRequest#adTagParameters}
2307
+ * for more information.
2296
2308
  *
2297
2309
  * Valid parameters:
2298
2310
  * <br/> - {@link https://support.google.com/admanager/answer/7320899 | Supply targeting parameters to your stream}
@@ -2301,10 +2313,26 @@ interface GoogleDAIConfiguration extends ServerSideAdInsertionConfiguration {
2301
2313
  adTagParameters?: Record<string, string>;
2302
2314
  /**
2303
2315
  * The identifier for a stream activity monitor session.
2316
+ *
2317
+ * @remarks
2318
+ * <br/> - See {@link https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/html5/reference/js/StreamRequest#streamActivityMonitorId}
2319
+ * for more information.
2304
2320
  */
2305
2321
  streamActivityMonitorID?: string;
2322
+ /**
2323
+ * The network code for the publisher making this stream request.
2324
+ *
2325
+ * @remarks
2326
+ * <br/> - See {@link https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/html5/reference/js/StreamRequest#networkCode}
2327
+ * for more information.
2328
+ */
2329
+ networkCode?: string;
2306
2330
  /**
2307
2331
  * Optional settings object for mapping verification vendors (google.ima.OmidVerificationVendor) to OMID Access Modes (google.ima.OmidAccessMode).
2332
+ *
2333
+ * @remarks
2334
+ * <br/> - See {@link https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/html5/reference/js/StreamRequest#omidAccessModeRules}
2335
+ * for more information.
2308
2336
  */
2309
2337
  omidAccessModeRules?: Record<number, string>;
2310
2338
  }
@@ -2554,6 +2582,7 @@ interface ChromecastConfiguration {
2554
2582
  * <br/> - `'play-last'`: Plays the last ad break skipped due to a seek.
2555
2583
  *
2556
2584
  * @category Verizon Media
2585
+ * @category Uplynk
2557
2586
  * @public
2558
2587
  */
2559
2588
  type SkippedAdStrategy = 'play-all' | 'play-none' | 'play-last';
@@ -2562,8 +2591,24 @@ type SkippedAdStrategy = 'play-all' | 'play-none' | 'play-last';
2562
2591
  *
2563
2592
  * @category Verizon Media
2564
2593
  * @public
2594
+ * @deprecated Superseded by {@link UplynkConfiguration}
2595
+ */
2596
+ interface VerizonMediaConfiguration extends UplynkConfiguration {
2597
+ /**
2598
+ * The Verizon Media UI configuration.
2599
+ *
2600
+ * @remarks
2601
+ * Only available with the features `'verizon-media'` and `'ui'`.
2602
+ */
2603
+ ui?: VerizonMediaUiConfiguration;
2604
+ }
2605
+ /**
2606
+ * Describes the configuration of the Uplynk integration.
2607
+ *
2608
+ * @category Uplynk
2609
+ * @public
2565
2610
  */
2566
- interface VerizonMediaConfiguration {
2611
+ interface UplynkConfiguration {
2567
2612
  /**
2568
2613
  * The offset after which an ad break may be skipped, in seconds.
2569
2614
  *
@@ -2582,20 +2627,29 @@ interface VerizonMediaConfiguration {
2582
2627
  */
2583
2628
  onSeekOverAd?: SkippedAdStrategy;
2584
2629
  /**
2585
- * The Verizon Media UI configuration.
2630
+ * The Uplynk UI configuration.
2586
2631
  *
2587
2632
  * @remarks
2588
- * Only available with the features `'verizonmedia'` and `'ui'`.
2633
+ * Only available with the features `'uplynk'` and `'ui'`.
2589
2634
  */
2590
- ui?: VerizonMediaUiConfiguration;
2635
+ ui?: UplynkUiConfiguration;
2591
2636
  }
2592
2637
  /**
2593
2638
  * Describes the UI configuration of the Verizon Media integration.
2594
2639
  *
2595
2640
  * @category Verizon Media
2596
2641
  * @public
2642
+ * @deprecated Superseded by {@link UplynkUiConfiguration}
2643
+ */
2644
+ interface VerizonMediaUiConfiguration extends UplynkUiConfiguration {
2645
+ }
2646
+ /**
2647
+ * Describes the UI configuration of the Uplynk integration.
2648
+ *
2649
+ * @category Uplynk
2650
+ * @public
2597
2651
  */
2598
- interface VerizonMediaUiConfiguration {
2652
+ interface UplynkUiConfiguration {
2599
2653
  /**
2600
2654
  * Whether an up next content countdown is shown on the UI.
2601
2655
  *
@@ -2806,8 +2860,14 @@ interface PlayerConfiguration {
2806
2860
  cast?: CastConfiguration;
2807
2861
  /**
2808
2862
  * The Verizon Media configuration for the player.
2863
+ *
2864
+ * @deprecated Superseded by {@link uplynk}
2809
2865
  */
2810
2866
  verizonMedia?: VerizonMediaConfiguration;
2867
+ /**
2868
+ * The Uplynk configuration for the player.
2869
+ */
2870
+ uplynk?: UplynkConfiguration;
2811
2871
  /**
2812
2872
  * Whether `playbackRate` is retained across sources. When `false`, `playbackRate` will be reset to 1 on each source change.
2813
2873
  * Defaults to `false`.
@@ -3105,47 +3165,58 @@ interface ChromecastMetadataDescription extends MetadataDescription {
3105
3165
  * @category Source
3106
3166
  * @category Verizon Media
3107
3167
  * @public
3168
+ * @deprecated Superseded by {@link UplynkSource}
3169
+ */
3170
+ type VerizonMediaSource = UplynkSource;
3171
+ /**
3172
+ * Represents a media resource which is found on the Uplynk Platform.
3173
+ *
3174
+ * @category Source
3175
+ * @category Uplynk
3176
+ * @public
3108
3177
  */
3109
- interface VerizonMediaSource extends BaseSource {
3178
+ interface UplynkSource extends BaseSource {
3110
3179
  /**
3111
- * The integration ID of the source.
3180
+ * The integration ID of the source, represented by a value from the following list:
3181
+ * <br/> - `'uplynk'`: The source is an {@link UplynkSource}.
3182
+ * <br/> - `'verizon-media'`: The source is a {@link VerizonMediaSource}. (Deprecated, superseded by `'uplynk'`)
3112
3183
  */
3113
- integration: 'verizon-media';
3184
+ integration: 'uplynk' | 'verizon-media';
3114
3185
  /**
3115
3186
  * One or multiple asset identifiers for the source.
3116
3187
  *
3117
3188
  * @remarks
3118
3189
  * <br/> - The order of a list of asset identifiers is the order their corresponding assets will be played in.
3119
3190
  */
3120
- id: VerizonMediaAssetId | VerizonMediaAssetId[] | VerizonMediaExternalId;
3191
+ id: UplynkAssetId | UplynkAssetId[] | UplynkExternalId;
3121
3192
  /**
3122
- * The prefix to use for Verizon Media Preplay API and Asset Info API requests.
3193
+ * The prefix to use for Uplynk Preplay API and Asset Info API requests.
3123
3194
  *
3124
3195
  * @defaultValue `'https://content.uplynk.com'`
3125
3196
  */
3126
3197
  prefix?: string;
3127
3198
  /**
3128
- * The query string parameters added to Verizon Media Preplay requests.
3199
+ * The query string parameters added to Uplynk Preplay requests.
3129
3200
  *
3130
3201
  * @remarks
3131
3202
  * Each entry contains the parameter name with associated value.
3132
3203
  *
3133
3204
  * Valid parameters:
3134
- * <br/> - {@link https://docs.vdms.com/video/#Develop/Preplayv2.htm | Uplynk Preplay parameters}
3135
- * <br/> - {@link https://docs.vdms.com/video/#AdIntegration/AOL-One-Video.htm | Uplynk ads with AOL One Video parameters}
3136
- * <br/> - {@link https://docs.vdms.com/video/#AdIntegration/DoubleClick.htm | Uplynk ads with Doubleclick parameters}
3137
- * <br/> - {@link https://docs.vdms.com/video/#AdIntegration/Freewheel.htm | Uplynk ads with FreeWheel parameters}
3205
+ * <br/> - {@link https://api-docs.uplynk.com/index.html#Develop/Preplayv2.htm | Uplynk Preplay parameters}
3206
+ * <br/> - {@link https://api-docs.uplynk.com/index.html#AdIntegration/AOL-One-Video.htm | Uplynk ads with Yahoo SSP (formerly AOL One Video) parameters}
3207
+ * <br/> - {@link https://api-docs.uplynk.com/index.html#AdIntegration/DoubleClick.htm | Uplynk ads with Google Ad Manager (formerly known as DoubleClick for Publishers) parameters}
3208
+ * <br/> - {@link https://api-docs.uplynk.com/index.html#AdIntegration/Freewheel.htm | Uplynk ads with FreeWheel parameters}
3138
3209
  */
3139
3210
  preplayParameters?: Record<string, string> | Array<[string, string]>;
3140
3211
  /**
3141
- * The query string parameters added to Verizon Media playback URL requests.
3212
+ * The query string parameters added to Uplynk playback URL requests.
3142
3213
  *
3143
3214
  * @remarks
3144
3215
  * Each entry contains the parameter name with associated value.
3145
3216
  *
3146
3217
  * Valid parameters:
3147
- * <br/> - {@link https://docs.vdms.com/video/#Setup/Customizing-Playback.htm | Uplynk Playback Customization parameters}
3148
- * <br/> - {@link https://docs.vdms.com/video/#Setup/Playback-URLs.htm | Uplynk Tokens parameters}
3218
+ * <br/> - {@link https://api-docs.uplynk.com/index.html#Setup/Customizing-Playback.htm | Uplynk Playback Customization parameters}
3219
+ * <br/> - {@link https://api-docs.uplynk.com/index.html#Setup/Playback-URLs.htm | Uplynk Playback URLs}
3149
3220
  */
3150
3221
  playbackUrlParameters?: Record<string, string>;
3151
3222
  /**
@@ -3153,7 +3224,7 @@ interface VerizonMediaSource extends BaseSource {
3153
3224
  *
3154
3225
  * @defaultValue `'asset'`
3155
3226
  */
3156
- assetType?: VerizonMediaAssetType;
3227
+ assetType?: UplynkAssetType;
3157
3228
  /**
3158
3229
  * Whether the assets of the source are content protected.
3159
3230
  *
@@ -3167,17 +3238,17 @@ interface VerizonMediaSource extends BaseSource {
3167
3238
  * <br/> - A configuration with all features disabled will prevent Ping requests being sent.
3168
3239
  *
3169
3240
  * @defaultValue
3170
- * A configuration with all features `false` except for `linearAdData`, which will be `true` if {@link VerizonMediaSource.assetType} is
3241
+ * A configuration with all features `false` except for `linearAdData`, which will be `true` if {@link UplynkSource.assetType} is
3171
3242
  * `'channel'` or `'event'` and `false` otherwise.
3172
3243
  */
3173
- ping?: VerizonMediaPingConfiguration;
3244
+ ping?: UplynkPingConfiguration;
3174
3245
  /**
3175
3246
  * Whether asset info will be fetched from the Verizon Media Asset Info API and exposed on the player API.
3176
3247
  *
3177
3248
  * @remarks
3178
- * <br/> - This feature is only available if {@link VerizonMediaSource.assetType} is `'asset'`
3249
+ * <br/> - This feature is only available if {@link UplynkSource.assetType} is `'asset'`
3179
3250
  *
3180
- * @defaultValue `true` if {@link VerizonMediaSource.assetType} is `'asset'` and `false` otherwise
3251
+ * @defaultValue `true` if {@link UplynkSource.assetType} is `'asset'` and `false` otherwise
3181
3252
  */
3182
3253
  assetInfo?: boolean;
3183
3254
  }
@@ -3190,8 +3261,20 @@ interface VerizonMediaSource extends BaseSource {
3190
3261
  * @category Source
3191
3262
  * @category Verizon Media
3192
3263
  * @public
3264
+ * @deprecated Superseded by {@link UplynkAssetId}
3265
+ */
3266
+ type VerizonMediaAssetId = UplynkAssetId;
3267
+ /**
3268
+ * Represents a unique asset identifier for an Uplynk asset.
3269
+ *
3270
+ * @remarks
3271
+ * <br/> - This asset identifier determines a unique asset on the Uplynk Platform.
3272
+ *
3273
+ * @category Source
3274
+ * @category Uplynk
3275
+ * @public
3193
3276
  */
3194
- type VerizonMediaAssetId = string;
3277
+ type UplynkAssetId = string;
3195
3278
  /**
3196
3279
  * Represents a combination of user identifier and one or more external identifiers for Verizon Media assets.
3197
3280
  *
@@ -3201,8 +3284,20 @@ type VerizonMediaAssetId = string;
3201
3284
  * @category Source
3202
3285
  * @category Verizon Media
3203
3286
  * @public
3287
+ * @deprecated Superseded by {@link UplynkExternalId}
3288
+ */
3289
+ type VerizonMediaExternalId = UplynkExternalId;
3290
+ /**
3291
+ * Represents a combination of user identifier and one or more external identifiers for Uplynk assets.
3292
+ *
3293
+ * @remarks
3294
+ * <br/> - Each combination of the user identifier and external identifier determines a unique asset on the Uplynk Platform.
3295
+ *
3296
+ * @category Source
3297
+ * @category Uplynk
3298
+ * @public
3204
3299
  */
3205
- interface VerizonMediaExternalId {
3300
+ interface UplynkExternalId {
3206
3301
  /**
3207
3302
  * The user identifier for the asset(s).
3208
3303
  */
@@ -3218,13 +3313,22 @@ interface VerizonMediaExternalId {
3218
3313
  * @category Source
3219
3314
  * @category Verizon Media
3220
3315
  * @public
3316
+ * @deprecated Superseded by {@link UplynkPingConfiguration}
3317
+ */
3318
+ type VerizonMediaPingConfiguration = UplynkPingConfiguration;
3319
+ /**
3320
+ * Describes the configuration of Uplynk Ping features.
3321
+ *
3322
+ * @category Source
3323
+ * @category Uplynk
3324
+ * @public
3221
3325
  */
3222
- interface VerizonMediaPingConfiguration {
3326
+ interface UplynkPingConfiguration {
3223
3327
  /**
3224
3328
  * Whether to increase the accuracy of ad events by passing the current playback time in Ping requests.
3225
3329
  *
3226
3330
  * @remarks
3227
- * <br/> - Only available when {@link VerizonMediaSource.assetType} is `'asset'`.
3331
+ * <br/> - Only available when {@link UplynkSource.assetType} is `'asset'`.
3228
3332
  *
3229
3333
  * @defaultValue `false`
3230
3334
  *
@@ -3234,7 +3338,7 @@ interface VerizonMediaPingConfiguration {
3234
3338
  * Whether to enable FreeWheel's Video View by Callback feature to send content impressions to the FreeWheel server.
3235
3339
  *
3236
3340
  * @remarks
3237
- * <br/> - Only available when {@link VerizonMediaSource.assetType} is `'asset'`.
3341
+ * <br/> - Only available when {@link UplynkSource.assetType} is `'asset'`.
3238
3342
  *
3239
3343
  * @defaultValue `false`
3240
3344
  */
@@ -3243,10 +3347,10 @@ interface VerizonMediaPingConfiguration {
3243
3347
  * Whether to request information about upcoming ad breaks in the Ping responses.
3244
3348
  *
3245
3349
  * @remarks
3246
- * <br/> - This feature will update the exposed ads found on {@link VerizonMedia.ads | player.verizonMedia.ads }.
3247
- * <br/> - Only available when {@link VerizonMediaSource.assetType} is `'event'` or `'channel'`.
3350
+ * <br/> - This feature will update the exposed ads found on {@link Uplynk.ads | player.uplynk.ads }.
3351
+ * <br/> - Only available when {@link UplynkSource.assetType} is `'event'` or `'channel'`.
3248
3352
  *
3249
- * @defaultValue `true` if {@link VerizonMediaSource.assetType} is `'event'` or `'channel'`, otherwise `false`.
3353
+ * @defaultValue `true` if {@link UplynkSource.assetType} is `'event'` or `'channel'`, otherwise `false`.
3250
3354
  */
3251
3355
  linearAdData?: boolean;
3252
3356
  }
@@ -3259,8 +3363,20 @@ interface VerizonMediaPingConfiguration {
3259
3363
  * @category Source
3260
3364
  * @category Verizon Media
3261
3365
  * @public
3366
+ * @deprecated Superseded by {@link UplynkAssetType}
3262
3367
  */
3263
- type VerizonMediaAssetType = 'asset' | 'channel' | 'event';
3368
+ type VerizonMediaAssetType = UplynkAssetType;
3369
+ /**
3370
+ * The type of an asset on the Uplynk Platform, represented by a value from the following list:
3371
+ * <br/> - `'asset'`: A Video-on-demand content asset.
3372
+ * <br/> - `'channel'`: A Live content channel.
3373
+ * <br/> - `'event'`: A Live event.
3374
+ *
3375
+ * @category Source
3376
+ * @category Uplynk
3377
+ * @public
3378
+ */
3379
+ type UplynkAssetType = 'asset' | 'channel' | 'event';
3264
3380
 
3265
3381
  /**
3266
3382
  * The strategy for period switches (see {@link DashPlaybackConfiguration.useSeamlessPeriodSwitch}), represented by a value from the following list:
@@ -3792,12 +3908,13 @@ interface TextTrackError extends THEOplayerError {
3792
3908
  * <br/> - `'id3'`: The track contains ID3 content.
3793
3909
  * <br/> - `'cea608'`: The track contains CEA608 content.
3794
3910
  * <br/> - `'daterange'`: The track contains HLS EXT-X-DATERANGE content.
3911
+ * <br/> - `'millicast'`: The track contains Millicast metadata content.
3795
3912
  * <br/> - `''`: The type of the track contents is unknown.
3796
3913
  *
3797
3914
  * @category Media and Text Tracks
3798
3915
  * @public
3799
3916
  */
3800
- type TextTrackType = 'srt' | 'ttml' | 'webvtt' | 'emsg' | 'eventstream' | 'id3' | 'cea608' | 'daterange' | '';
3917
+ type TextTrackType = 'srt' | 'ttml' | 'webvtt' | 'emsg' | 'eventstream' | 'id3' | 'cea608' | 'daterange' | 'millicast' | '';
3801
3918
  /**
3802
3919
  * The ready state of a text track, represented by a value from the following list:
3803
3920
  * <br/> - `0`: Indicates that the text track's cues have not been obtained.
@@ -4140,6 +4257,12 @@ interface MillicastSource extends TypedSource {
4140
4257
  * @see https://millicast.github.io/millicast-sdk/View.html#connect
4141
4258
  */
4142
4259
  connectOptions?: Record<string, any>;
4260
+ /**
4261
+ * The URL of the API endpoint that the SDK communicates with for authentication.
4262
+ *
4263
+ * @see https://millicast.github.io/millicast-sdk/module-Director.html#~setEndpoint
4264
+ */
4265
+ apiUrl?: string;
4143
4266
  }
4144
4267
 
4145
4268
  /**
@@ -4207,12 +4330,12 @@ interface SourceLatencyConfiguration {
4207
4330
  * Represents a media resource.
4208
4331
  *
4209
4332
  * @remarks
4210
- * <br/> - Can be a string value representing the URL of a media resource, a {@link TypedSource} or a {@link VerizonMediaSource}.
4333
+ * <br/> - Can be a string value representing the URL of a media resource, a {@link TypedSource} or an {@link UplynkSource}.
4211
4334
  *
4212
4335
  * @category Source
4213
4336
  * @public
4214
4337
  */
4215
- type Source = string | TypedSource | VerizonMediaSource | TheoLiveSource | MillicastSource;
4338
+ type Source = string | TypedSource | UplynkSource | TheoLiveSource | MillicastSource;
4216
4339
  /**
4217
4340
  * A media resource or list of media resources.
4218
4341
  *
@@ -4427,18 +4550,15 @@ interface TextTrackDescription {
4427
4550
  kind?: string;
4428
4551
  /**
4429
4552
  * The format of the track, represented by a value from the following list:
4430
- * <br/> - `'srt'`
4431
- * <br/> - `'ttml'`
4432
- * <br/> - `'webvtt'`
4433
- * <br/> - `'emsg'`
4434
- * <br/> - `'eventstream'`
4435
- * <br/> - `'id3'`
4436
- * <br/> - `'cea608'`
4437
- * <br/> - `'daterange'`
4553
+ * <br/> - `'srt'`: The track contains SRT (SubRip Text) content.
4554
+ * <br/> - `'ttml'`: The track contains TTML (Timed Text Markup Language) content.
4555
+ * <br/> - `'webvtt'`: The track contains WebVTT (Web Video Text Tracks) content.
4556
+ * <br/> - `''` (default): The format is auto-detected based on its content.
4438
4557
  *
4439
4558
  * @defaultValue `''`
4559
+ * @see {@link TextTrackType}
4440
4560
  */
4441
- format?: string;
4561
+ format?: '' | 'srt' | 'ttml' | 'webvtt';
4442
4562
  /**
4443
4563
  * The source URL of the text track.
4444
4564
  */
@@ -4738,14 +4858,15 @@ interface TypedSource extends BaseSource {
4738
4858
  type StreamType = 'live' | 'dvr' | 'vod';
4739
4859
  /**
4740
4860
  * The integration identifier of a source specific to a pre-integration, represented by a value from the following list:
4741
- * <br/> - `'verizon-media'`: The source is a {@link VerizonMediaSource}
4742
- * <br/> - `'mediatailor'`: The source contains the MediaTailor initialization url
4861
+ * <br/> - `'verizon-media'`: The source is a {@link VerizonMediaSource}. (Deprecated, superseded by `'uplynk'`)
4862
+ * <br/> - `'mediatailor'`: The source contains the MediaTailor initialization url.
4743
4863
  * <br/> - `'theolive'`: The source is a {@link TheoLiveSource}. (Deprecated, see {@link TheoLiveSource.integration})
4864
+ * <br/> - `'uplynk'`: The source is an {@link UplynkSource}.
4744
4865
  *
4745
4866
  * @category Source
4746
4867
  * @public
4747
4868
  */
4748
- type SourceIntegrationId = 'verizon-media' | 'mediatailor' | 'theolive';
4869
+ type SourceIntegrationId = 'verizon-media' | 'mediatailor' | 'theolive' | 'uplynk';
4749
4870
  /**
4750
4871
  * The integration identifier of an analytics description, represented by a value from the following list:
4751
4872
  * <br/> - `'agama'`: The description is an {@link AgamaConfiguration}
@@ -7114,12 +7235,21 @@ interface Imagine extends EventDispatcher<ImagineEventMap> {
7114
7235
  * @category Verizon Media
7115
7236
  * @category Events
7116
7237
  * @public
7238
+ * @deprecated Superseded by {@link UplynkAdBreakBeginEvent}
7239
+ */
7240
+ type VerizonMediaAdBreakBeginEvent = UplynkAdBreakBeginEvent;
7241
+ /**
7242
+ * Fired when the ad break begins.
7243
+ *
7244
+ * @category Uplynk
7245
+ * @category Events
7246
+ * @public
7117
7247
  */
7118
- interface VerizonMediaAdBreakBeginEvent extends Event<'adbreakbegin'> {
7248
+ interface UplynkAdBreakBeginEvent extends Event<'adbreakbegin'> {
7119
7249
  /**
7120
7250
  * The ad break which began.
7121
7251
  */
7122
- readonly adBreak: VerizonMediaAdBreak;
7252
+ readonly adBreak: UplynkAdBreak;
7123
7253
  }
7124
7254
 
7125
7255
  /**
@@ -7128,12 +7258,21 @@ interface VerizonMediaAdBreakBeginEvent extends Event<'adbreakbegin'> {
7128
7258
  * @category Verizon Media
7129
7259
  * @category Events
7130
7260
  * @public
7261
+ * @deprecated Superseded by {@link UplynkAdBreakEndEvent}
7262
+ */
7263
+ type VerizonMediaAdBreakEndEvent = UplynkAdBreakEndEvent;
7264
+ /**
7265
+ * Fired when the ad break ends.
7266
+ *
7267
+ * @category Uplynk
7268
+ * @category Events
7269
+ * @public
7131
7270
  */
7132
- interface VerizonMediaAdBreakEndEvent extends Event<'adbreakend'> {
7271
+ interface UplynkAdBreakEndEvent extends Event<'adbreakend'> {
7133
7272
  /**
7134
7273
  * The ad break which ended.
7135
7274
  */
7136
- readonly adBreak: VerizonMediaAdBreak;
7275
+ readonly adBreak: UplynkAdBreak;
7137
7276
  }
7138
7277
 
7139
7278
  /**
@@ -7142,12 +7281,21 @@ interface VerizonMediaAdBreakEndEvent extends Event<'adbreakend'> {
7142
7281
  * @category Verizon Media
7143
7282
  * @category Events
7144
7283
  * @public
7284
+ * @deprecated Superseded by {@link UplynkAdBreakSkipEvent}
7285
+ */
7286
+ type VerizonMediaAdBreakSkipEvent = UplynkAdBreakSkipEvent;
7287
+ /**
7288
+ * Fired when the ad break is skipped.
7289
+ *
7290
+ * @category Uplynk
7291
+ * @category Events
7292
+ * @public
7145
7293
  */
7146
- interface VerizonMediaAdBreakSkipEvent extends Event<'adbreakskip'> {
7294
+ interface UplynkAdBreakSkipEvent extends Event<'adbreakskip'> {
7147
7295
  /**
7148
7296
  * The ad break which has been skipped.
7149
7297
  */
7150
- readonly adBreak: VerizonMediaAdBreak;
7298
+ readonly adBreak: UplynkAdBreak;
7151
7299
  }
7152
7300
 
7153
7301
  /**
@@ -7156,12 +7304,21 @@ interface VerizonMediaAdBreakSkipEvent extends Event<'adbreakskip'> {
7156
7304
  * @category Verizon Media
7157
7305
  * @category Events
7158
7306
  * @public
7307
+ * @deprecated Superseded by {@link UplynkUpdateAdBreakEvent}
7308
+ */
7309
+ type VerizonMediaUpdateAdBreakEvent = UplynkUpdateAdBreakEvent;
7310
+ /**
7311
+ * Fired when the ad break is updated.
7312
+ *
7313
+ * @category Uplynk
7314
+ * @category Events
7315
+ * @public
7159
7316
  */
7160
- interface VerizonMediaUpdateAdBreakEvent extends Event<'updateadbreak'> {
7317
+ interface UplynkUpdateAdBreakEvent extends Event<'updateadbreak'> {
7161
7318
  /**
7162
7319
  * The ad break which has been updated.
7163
7320
  */
7164
- readonly adBreak: VerizonMediaAdBreak;
7321
+ readonly adBreak: UplynkAdBreak;
7165
7322
  }
7166
7323
 
7167
7324
  /**
@@ -7198,12 +7355,21 @@ interface EventedList<T, M extends EventMap<StringKeyOf<M>>> extends List<T>, Ev
7198
7355
  * @category Verizon Media
7199
7356
  * @category Events
7200
7357
  * @public
7358
+ * @deprecated Superseded by {@link UplynkAdBeginEvent}
7359
+ */
7360
+ type VerizonMediaAdBeginEvent = UplynkAdBeginEvent;
7361
+ /**
7362
+ * Fired when an ad begins.
7363
+ *
7364
+ * @category Uplynk
7365
+ * @category Events
7366
+ * @public
7201
7367
  */
7202
- interface VerizonMediaAdBeginEvent extends Event<'adbegin'> {
7368
+ interface UplynkAdBeginEvent extends Event<'adbegin'> {
7203
7369
  /**
7204
7370
  * The ad which began.
7205
7371
  */
7206
- readonly ad: VerizonMediaAd;
7372
+ readonly ad: UplynkAd;
7207
7373
  }
7208
7374
 
7209
7375
  /**
@@ -7212,12 +7378,21 @@ interface VerizonMediaAdBeginEvent extends Event<'adbegin'> {
7212
7378
  * @category Verizon Media
7213
7379
  * @category Events
7214
7380
  * @public
7381
+ * @deprecated Superseded by {@link UplynkAdEndEvent}
7382
+ */
7383
+ type VerizonMediaAdEndEvent = UplynkAdEndEvent;
7384
+ /**
7385
+ * Fired when the ad ends.
7386
+ *
7387
+ * @category Uplynk
7388
+ * @category Events
7389
+ * @public
7215
7390
  */
7216
- interface VerizonMediaAdEndEvent extends Event<'adend'> {
7391
+ interface UplynkAdEndEvent extends Event<'adend'> {
7217
7392
  /**
7218
7393
  * The ad which has ended.
7219
7394
  */
7220
- readonly ad: VerizonMediaAd;
7395
+ readonly ad: UplynkAd;
7221
7396
  }
7222
7397
 
7223
7398
  /**
@@ -7226,12 +7401,21 @@ interface VerizonMediaAdEndEvent extends Event<'adend'> {
7226
7401
  * @category Verizon Media
7227
7402
  * @category Events
7228
7403
  * @public
7404
+ * @deprecated Superseded by {@link UplynkAdFirstQuartileEvent}
7405
+ */
7406
+ type VerizonMediaAdFirstQuartileEvent = UplynkAdFirstQuartileEvent;
7407
+ /**
7408
+ * Fired when the ad reaches the first quartile.
7409
+ *
7410
+ * @category Uplynk
7411
+ * @category Events
7412
+ * @public
7229
7413
  */
7230
- interface VerizonMediaAdFirstQuartileEvent extends Event<'adfirstquartile'> {
7414
+ interface UplynkAdFirstQuartileEvent extends Event<'adfirstquartile'> {
7231
7415
  /**
7232
7416
  * The ad which has progressed.
7233
7417
  */
7234
- readonly ad: VerizonMediaAd;
7418
+ readonly ad: UplynkAd;
7235
7419
  }
7236
7420
  /**
7237
7421
  * Fired when the ad reaches the mid point.
@@ -7239,12 +7423,21 @@ interface VerizonMediaAdFirstQuartileEvent extends Event<'adfirstquartile'> {
7239
7423
  * @category Verizon Media
7240
7424
  * @category Events
7241
7425
  * @public
7426
+ * @deprecated Superseded by {@link UplynkAdMidpointEvent}
7427
+ */
7428
+ type VerizonMediaAdMidpointEvent = UplynkAdMidpointEvent;
7429
+ /**
7430
+ * Fired when the ad reaches the mid point.
7431
+ *
7432
+ * @category Uplynk
7433
+ * @category Events
7434
+ * @public
7242
7435
  */
7243
- interface VerizonMediaAdMidpointEvent extends Event<'admidpoint'> {
7436
+ interface UplynkAdMidpointEvent extends Event<'admidpoint'> {
7244
7437
  /**
7245
7438
  * The ad which has progressed.
7246
7439
  */
7247
- readonly ad: VerizonMediaAd;
7440
+ readonly ad: UplynkAd;
7248
7441
  }
7249
7442
  /**
7250
7443
  * Fired when the ad reaches the third quartile.
@@ -7252,12 +7445,21 @@ interface VerizonMediaAdMidpointEvent extends Event<'admidpoint'> {
7252
7445
  * @category Verizon Media
7253
7446
  * @category Events
7254
7447
  * @public
7448
+ * @deprecated Superseded by {@link UplynkAdThirdQuartileEvent}
7255
7449
  */
7256
- interface VerizonMediaAdThirdQuartileEvent extends Event<'adthirdquartile'> {
7450
+ type VerizonMediaAdThirdQuartileEvent = UplynkAdThirdQuartileEvent;
7451
+ /**
7452
+ * Fired when the ad reaches the third quartile.
7453
+ *
7454
+ * @category Uplynk
7455
+ * @category Events
7456
+ * @public
7457
+ */
7458
+ interface UplynkAdThirdQuartileEvent extends Event<'adthirdquartile'> {
7257
7459
  /**
7258
7460
  * The ad which has progressed.
7259
7461
  */
7260
- readonly ad: VerizonMediaAd;
7462
+ readonly ad: UplynkAd;
7261
7463
  }
7262
7464
  /**
7263
7465
  * Fired when the ad is completed.
@@ -7265,12 +7467,21 @@ interface VerizonMediaAdThirdQuartileEvent extends Event<'adthirdquartile'> {
7265
7467
  * @category Verizon Media
7266
7468
  * @category Events
7267
7469
  * @public
7470
+ * @deprecated Superseded by {@link UplynkAdCompleteEvent}
7471
+ */
7472
+ type VerizonMediaAdCompleteEvent = UplynkAdCompleteEvent;
7473
+ /**
7474
+ * Fired when the ad is completed.
7475
+ *
7476
+ * @category Uplynk
7477
+ * @category Events
7478
+ * @public
7268
7479
  */
7269
- interface VerizonMediaAdCompleteEvent extends Event<'adcomplete'> {
7480
+ interface UplynkAdCompleteEvent extends Event<'adcomplete'> {
7270
7481
  /**
7271
7482
  * The ad which has progressed.
7272
7483
  */
7273
- readonly ad: VerizonMediaAd;
7484
+ readonly ad: UplynkAd;
7274
7485
  }
7275
7486
 
7276
7487
  /**
@@ -7278,40 +7489,56 @@ interface VerizonMediaAdCompleteEvent extends Event<'adcomplete'> {
7278
7489
  *
7279
7490
  * @category Verizon Media
7280
7491
  * @public
7492
+ * @deprecated Superseded by {@link UplynkAdEventMap}
7493
+ */
7494
+ type VerizonMediaAdEventMap = UplynkAdEventMap;
7495
+ /**
7496
+ * The events fired by the {@link UplynkAd}.
7497
+ *
7498
+ * @category Uplynk
7499
+ * @public
7281
7500
  */
7282
- interface VerizonMediaAdEventMap {
7501
+ interface UplynkAdEventMap {
7283
7502
  /**
7284
- * {@inheritDoc VerizonMediaAdBeginEvent}
7503
+ * {@inheritDoc UplynkAdBeginEvent}
7285
7504
  */
7286
- adbegin: VerizonMediaAdBeginEvent;
7505
+ adbegin: UplynkAdBeginEvent;
7287
7506
  /**
7288
- * {@inheritDoc VerizonMediaAdEndEvent}
7507
+ * {@inheritDoc UplynkAdEndEvent}
7289
7508
  */
7290
- adend: VerizonMediaAdEndEvent;
7509
+ adend: UplynkAdEndEvent;
7291
7510
  /**
7292
- * {@inheritDoc VerizonMediaAdFirstQuartileEvent}
7511
+ * {@inheritDoc UplynkAdFirstQuartileEvent}
7293
7512
  */
7294
- adfirstquartile: VerizonMediaAdFirstQuartileEvent;
7513
+ adfirstquartile: UplynkAdFirstQuartileEvent;
7295
7514
  /**
7296
- * {@inheritDoc VerizonMediaAdMidpointEvent}
7515
+ * {@inheritDoc UplynkAdMidpointEvent}
7297
7516
  */
7298
- admidpoint: VerizonMediaAdMidpointEvent;
7517
+ admidpoint: UplynkAdMidpointEvent;
7299
7518
  /**
7300
- * {@inheritDoc VerizonMediaAdThirdQuartileEvent}
7519
+ * {@inheritDoc UplynkAdThirdQuartileEvent}
7301
7520
  */
7302
- adthirdquartile: VerizonMediaAdThirdQuartileEvent;
7521
+ adthirdquartile: UplynkAdThirdQuartileEvent;
7303
7522
  /**
7304
- * {@inheritDoc VerizonMediaAdCompleteEvent}
7523
+ * {@inheritDoc UplynkAdCompleteEvent}
7305
7524
  */
7306
- adcomplete: VerizonMediaAdCompleteEvent;
7525
+ adcomplete: UplynkAdCompleteEvent;
7307
7526
  }
7308
7527
  /**
7309
7528
  * Represents a Verizon Media ad.
7310
7529
  *
7311
7530
  * @category Verizon Media
7312
7531
  * @public
7532
+ * @deprecated Superseded by {@link UplynkAd}
7533
+ */
7534
+ type VerizonMediaAd = UplynkAd;
7535
+ /**
7536
+ * Represents an Uplynk ad.
7537
+ *
7538
+ * @category Uplynk
7539
+ * @public
7313
7540
  */
7314
- interface VerizonMediaAd extends EventDispatcher<VerizonMediaAdEventMap> {
7541
+ interface UplynkAd extends EventDispatcher<UplynkAdEventMap> {
7315
7542
  /**
7316
7543
  * The start time of the ad, in seconds.
7317
7544
  */
@@ -7370,7 +7597,7 @@ interface VerizonMediaAd extends EventDispatcher<VerizonMediaAdEventMap> {
7370
7597
  /**
7371
7598
  * List of companion ads of the ad.
7372
7599
  */
7373
- readonly companions: ReadonlyArray<VerizonMediaAd>;
7600
+ readonly companions: ReadonlyArray<UplynkAd>;
7374
7601
  /**
7375
7602
  * List of VAST extensions returned by the ad server.
7376
7603
  */
@@ -7386,10 +7613,20 @@ interface VerizonMediaAd extends EventDispatcher<VerizonMediaAdEventMap> {
7386
7613
  * Fired when the ad is removed.
7387
7614
  *
7388
7615
  * @category Verizon Media
7616
+ * @category Events
7389
7617
  * @public
7618
+ * @deprecated Superseded by {@link UplynkRemoveAdEvent}
7390
7619
  */
7391
- interface VerizonMediaRemoveAdEvent extends Event<'removead'> {
7392
- readonly ad: VerizonMediaAd;
7620
+ type VerizonMediaRemoveAdEvent = UplynkRemoveAdEvent;
7621
+ /**
7622
+ * Fired when the ad is removed.
7623
+ *
7624
+ * @category Uplynk
7625
+ * @category Events
7626
+ * @public
7627
+ */
7628
+ interface UplynkRemoveAdEvent extends Event<'removead'> {
7629
+ readonly ad: UplynkAd;
7393
7630
  }
7394
7631
 
7395
7632
  /**
@@ -7397,20 +7634,36 @@ interface VerizonMediaRemoveAdEvent extends Event<'removead'> {
7397
7634
  *
7398
7635
  * @category Verizon Media
7399
7636
  * @public
7637
+ * @deprecated Superseded by {@link UplynkAdListEventMap}
7638
+ */
7639
+ type VerizonMediaAdListEventMap = UplynkAdListEventMap;
7640
+ /**
7641
+ * Events fired by the {@link UplynkAdList}.
7642
+ *
7643
+ * @category Uplynk
7644
+ * @public
7400
7645
  */
7401
- interface VerizonMediaAdListEventMap {
7646
+ interface UplynkAdListEventMap {
7402
7647
  /**
7403
- *{@inheritDoc VerizonMediaRemoveAdEvent}
7648
+ *{@inheritDoc UplynkRemoveAdEvent}
7404
7649
  */
7405
- removead: VerizonMediaRemoveAdEvent;
7650
+ removead: UplynkRemoveAdEvent;
7406
7651
  }
7407
7652
  /**
7408
7653
  * List of Verizon Media ads.
7409
7654
  *
7410
7655
  * @category Verizon Media
7411
7656
  * @public
7657
+ * @deprecated Superseded by {@link UplynkAdList}
7658
+ */
7659
+ type VerizonMediaAdList = UplynkAdList;
7660
+ /**
7661
+ * List of Uplynk ads.
7662
+ *
7663
+ * @category Uplynk
7664
+ * @public
7412
7665
  */
7413
- interface VerizonMediaAdList extends EventedList<VerizonMediaAd, VerizonMediaAdListEventMap> {
7666
+ interface UplynkAdList extends EventedList<UplynkAd, UplynkAdListEventMap> {
7414
7667
  }
7415
7668
 
7416
7669
  /**
@@ -7418,32 +7671,48 @@ interface VerizonMediaAdList extends EventedList<VerizonMediaAd, VerizonMediaAdL
7418
7671
  *
7419
7672
  * @category Verizon Media
7420
7673
  * @public
7674
+ * @deprecated Superseded by {@link UplynkAdBreakEventMap}
7675
+ */
7676
+ type VerizonMediaAdBreakEventMap = UplynkAdBreakEventMap;
7677
+ /**
7678
+ * The events fired by the {@link UplynkAdBreak}.
7679
+ *
7680
+ * @category Uplynk
7681
+ * @public
7421
7682
  */
7422
- interface VerizonMediaAdBreakEventMap {
7683
+ interface UplynkAdBreakEventMap {
7423
7684
  /**
7424
- * {@inheritDoc VerizonMediaAdBreakBeginEvent}
7685
+ * {@inheritDoc UplynkAdBreakBeginEvent}
7425
7686
  */
7426
- adbreakbegin: VerizonMediaAdBreakBeginEvent;
7687
+ adbreakbegin: UplynkAdBreakBeginEvent;
7427
7688
  /**
7428
- * {@inheritDoc VerizonMediaAdBreakEndEvent}
7689
+ * {@inheritDoc UplynkAdBreakEndEvent}
7429
7690
  */
7430
- adbreakend: VerizonMediaAdBreakEndEvent;
7691
+ adbreakend: UplynkAdBreakEndEvent;
7431
7692
  /**
7432
- * {@inheritDoc VerizonMediaAdBreakSkipEvent}
7693
+ * {@inheritDoc UplynkAdBreakSkipEvent}
7433
7694
  */
7434
- adbreakskip: VerizonMediaAdBreakSkipEvent;
7695
+ adbreakskip: UplynkAdBreakSkipEvent;
7435
7696
  /**
7436
- * {@inheritDoc VerizonMediaUpdateAdBreakEvent}
7697
+ * {@inheritDoc UplynkUpdateAdBreakEvent}
7437
7698
  */
7438
- updateadbreak: VerizonMediaUpdateAdBreakEvent;
7699
+ updateadbreak: UplynkUpdateAdBreakEvent;
7439
7700
  }
7440
7701
  /**
7441
- * Represents a Verizon Media ad.
7702
+ * Represents a Verizon Media ad break.
7442
7703
  *
7443
7704
  * @category Verizon Media
7444
7705
  * @public
7706
+ * @deprecated Superseded by {@link UplynkAdBreak}
7707
+ */
7708
+ type VerizonMediaAdBreak = UplynkAdBreak;
7709
+ /**
7710
+ * Represents an Uplynk ad break.
7711
+ *
7712
+ * @category Uplynk
7713
+ * @public
7445
7714
  */
7446
- interface VerizonMediaAdBreak extends EventDispatcher<VerizonMediaAdBreakEventMap> {
7715
+ interface UplynkAdBreak extends EventDispatcher<UplynkAdBreakEventMap> {
7447
7716
  /**
7448
7717
  * The start time of the ad break, in seconds.
7449
7718
  */
@@ -7465,14 +7734,14 @@ interface VerizonMediaAdBreak extends EventDispatcher<VerizonMediaAdBreakEventMa
7465
7734
  /**
7466
7735
  * List of ads in the ad break.
7467
7736
  */
7468
- readonly ads: VerizonMediaAdList;
7737
+ readonly ads: UplynkAdList;
7469
7738
  /**
7470
7739
  * Offset after which the ad break may be skipped, in seconds.
7471
7740
  *
7472
7741
  * @remarks
7473
7742
  * If the offset is -1, the ad is unskippable.
7474
7743
  * If the offset is 0, the ad is immediately skippable.
7475
- * Otherwise it must be a positive number indicating the offset.
7744
+ * Otherwise, it must be a positive number indicating the offset.
7476
7745
  * Skipping the ad in live streams is unsupported.
7477
7746
  *
7478
7747
  * @example
@@ -7489,12 +7758,21 @@ interface VerizonMediaAdBreak extends EventDispatcher<VerizonMediaAdBreakEventMa
7489
7758
  * @category Verizon Media
7490
7759
  * @category Events
7491
7760
  * @public
7761
+ * @deprecated Superseded by {@link UplynkAddAdBreakEvent}
7492
7762
  */
7493
- interface VerizonMediaAddAdBreakEvent extends Event<'addadbreak'> {
7763
+ type VerizonMediaAddAdBreakEvent = UplynkAddAdBreakEvent;
7764
+ /**
7765
+ * Fired when the ad break is added.
7766
+ *
7767
+ * @category Uplynk
7768
+ * @category Events
7769
+ * @public
7770
+ */
7771
+ interface UplynkAddAdBreakEvent extends Event<'addadbreak'> {
7494
7772
  /**
7495
7773
  * The ad break which has been added.
7496
7774
  */
7497
- readonly adBreak: VerizonMediaAdBreak;
7775
+ readonly adBreak: UplynkAdBreak;
7498
7776
  }
7499
7777
 
7500
7778
  /**
@@ -7503,12 +7781,21 @@ interface VerizonMediaAddAdBreakEvent extends Event<'addadbreak'> {
7503
7781
  * @category Verizon Media
7504
7782
  * @category Events
7505
7783
  * @public
7784
+ * @deprecated Superseded by {@link UplynkRemoveAdBreakEvent}
7785
+ */
7786
+ type VerizonMediaRemoveAdBreakEvent = UplynkRemoveAdBreakEvent;
7787
+ /**
7788
+ * Fired when the ad break is removed.
7789
+ *
7790
+ * @category Uplynk
7791
+ * @category Events
7792
+ * @public
7506
7793
  */
7507
- interface VerizonMediaRemoveAdBreakEvent extends Event<'removeadbreak'> {
7794
+ interface UplynkRemoveAdBreakEvent extends Event<'removeadbreak'> {
7508
7795
  /**
7509
7796
  * The ad break which has been removed.
7510
7797
  */
7511
- readonly adBreak: VerizonMediaAdBreak;
7798
+ readonly adBreak: UplynkAdBreak;
7512
7799
  }
7513
7800
 
7514
7801
  /**
@@ -7516,24 +7803,40 @@ interface VerizonMediaRemoveAdBreakEvent extends Event<'removeadbreak'> {
7516
7803
  *
7517
7804
  * @category Verizon Media
7518
7805
  * @public
7806
+ * @deprecated Superseded by {@link UplynkAdBreakListEventMap}
7807
+ */
7808
+ type VerizonMediaAdBreakListEventMap = UplynkAdBreakListEventMap;
7809
+ /**
7810
+ * The events fired by the {@link UplynkAdBreakList}.
7811
+ *
7812
+ * @category Uplynk
7813
+ * @public
7519
7814
  */
7520
- interface VerizonMediaAdBreakListEventMap {
7815
+ interface UplynkAdBreakListEventMap {
7521
7816
  /**
7522
- * {@inheritDoc VerizonMediaAddAdBreakEvent}
7817
+ * {@inheritDoc UplynkAddAdBreakEvent}
7523
7818
  */
7524
- addadbreak: VerizonMediaAddAdBreakEvent;
7819
+ addadbreak: UplynkAddAdBreakEvent;
7525
7820
  /**
7526
- * {@inheritDoc VerizonMediaRemoveAdBreakEvent}
7821
+ * {@inheritDoc UplynkRemoveAdBreakEvent}
7527
7822
  */
7528
- removeadbreak: VerizonMediaRemoveAdBreakEvent;
7823
+ removeadbreak: UplynkRemoveAdBreakEvent;
7529
7824
  }
7530
7825
  /**
7531
7826
  * List with Verizon Media ad breaks.
7532
7827
  *
7533
7828
  * @category Verizon Media
7534
7829
  * @public
7830
+ * @deprecated Superseded by {@link UplynkAdBreakList}
7535
7831
  */
7536
- interface VerizonMediaAdBreakList extends EventedList<VerizonMediaAdBreak, VerizonMediaAdBreakListEventMap> {
7832
+ type VerizonMediaAdBreakList = UplynkAdBreakList;
7833
+ /**
7834
+ * List with Uplynk ad breaks.
7835
+ *
7836
+ * @category Uplynk
7837
+ * @public
7838
+ */
7839
+ interface UplynkAdBreakList extends EventedList<UplynkAdBreak, UplynkAdBreakListEventMap> {
7537
7840
  }
7538
7841
 
7539
7842
  /**
@@ -7541,23 +7844,31 @@ interface VerizonMediaAdBreakList extends EventedList<VerizonMediaAdBreak, Veriz
7541
7844
  *
7542
7845
  * @category Verizon Media
7543
7846
  * @public
7847
+ * @deprecated Superseded by {@link UplynkAds}
7848
+ */
7849
+ type VerizonMediaAds = UplynkAds;
7850
+ /**
7851
+ * The Uplynk ads API.
7852
+ *
7853
+ * @category Uplynk
7854
+ * @public
7544
7855
  */
7545
- interface VerizonMediaAds {
7856
+ interface UplynkAds {
7546
7857
  /**
7547
7858
  * List of ad breaks.
7548
7859
  */
7549
- readonly adBreaks: VerizonMediaAdBreakList;
7860
+ readonly adBreaks: UplynkAdBreakList;
7550
7861
  /**
7551
7862
  * The currently playing ad break.
7552
7863
  */
7553
- readonly currentAdBreak: VerizonMediaAdBreak | undefined;
7864
+ readonly currentAdBreak: UplynkAdBreak | undefined;
7554
7865
  /**
7555
7866
  * The currently playing ads.
7556
7867
  *
7557
7868
  * @remarks
7558
- * <br/> - These will always be part of the {@link VerizonMediaAds.currentAdBreak | current ad break}.
7869
+ * <br/> - These will always be part of the {@link UplynkAds.currentAdBreak | current ad break}.
7559
7870
  */
7560
- readonly currentAds: VerizonMediaAdList;
7871
+ readonly currentAds: UplynkAdList;
7561
7872
  /**
7562
7873
  * Seek to the end of the ad if it is skippable.
7563
7874
  *
@@ -7572,31 +7883,47 @@ interface VerizonMediaAds {
7572
7883
  *
7573
7884
  * @category Verizon Media
7574
7885
  * @public
7886
+ * @deprecated Superseded by {@link UplynkResponseVodAds}
7575
7887
  */
7576
- interface VerizonMediaResponseVodAds {
7888
+ type VerizonMediaResponseVodAds = UplynkResponseVodAds;
7889
+ /**
7890
+ * Represents an Uplynk response with advertisement information for VOD assets.
7891
+ *
7892
+ * @category Uplynk
7893
+ * @public
7894
+ */
7895
+ interface UplynkResponseVodAds {
7577
7896
  /**
7578
7897
  * List of ad break information.
7579
7898
  *
7580
7899
  * @remarks
7581
7900
  * <br/> - This includes both linear and non-linear ads.
7582
7901
  */
7583
- breaks: VerizonMediaResponseVodAdBreak[];
7902
+ breaks: UplynkResponseVodAdBreak[];
7584
7903
  /**
7585
7904
  * List of ad break offset information.
7586
7905
  */
7587
- breakOffsets: VerizonMediaResponseVodAdBreakOffset[];
7906
+ breakOffsets?: UplynkResponseVodAdBreakOffset[];
7588
7907
  /**
7589
7908
  * List of placeholder offset information.
7590
7909
  */
7591
- placeholderOffsets: VerizonMediaResponseVodAdPlaceholder[];
7910
+ placeholderOffsets?: UplynkResponseVodAdPlaceholder[];
7592
7911
  }
7593
7912
  /**
7594
7913
  * Represents a Verizon Media response with ad break information for VOD assets.
7595
7914
  *
7596
7915
  * @category Verizon Media
7597
7916
  * @public
7917
+ * @deprecated Superseded by {@link UplynkResponseVodAdBreak}
7918
+ */
7919
+ type VerizonMediaResponseVodAdBreak = UplynkResponseVodAdBreak;
7920
+ /**
7921
+ * Represents an Uplynk response with ad break information for VOD assets.
7922
+ *
7923
+ * @category Uplynk
7924
+ * @public
7598
7925
  */
7599
- interface VerizonMediaResponseVodAdBreak {
7926
+ interface UplynkResponseVodAdBreak {
7600
7927
  /**
7601
7928
  * The type of the ad break.
7602
7929
  */
@@ -7622,7 +7949,7 @@ interface VerizonMediaResponseVodAdBreak {
7622
7949
  /**
7623
7950
  * List of ad information.
7624
7951
  */
7625
- ads: VerizonMediaResponseVodAd[];
7952
+ ads: UplynkResponseVodAd[];
7626
7953
  /**
7627
7954
  * A record of all VAST 3.0 tracking events for the ad break.
7628
7955
  * Each entry contains an event name with associated tracking URLs.
@@ -7634,8 +7961,16 @@ interface VerizonMediaResponseVodAdBreak {
7634
7961
  *
7635
7962
  * @category Verizon Media
7636
7963
  * @public
7964
+ * @deprecated Superseded by {@link UplynkResponseVodAd}
7637
7965
  */
7638
- interface VerizonMediaResponseVodAd {
7966
+ type VerizonMediaResponseVodAd = UplynkResponseVodAd;
7967
+ /**
7968
+ * The Uplynk response with ad information for VOD assets.
7969
+ *
7970
+ * @category Uplynk
7971
+ * @public
7972
+ */
7973
+ interface UplynkResponseVodAd {
7639
7974
  /**
7640
7975
  * The duration of the ad, in seconds.
7641
7976
  */
@@ -7681,7 +8016,7 @@ interface VerizonMediaResponseVodAd {
7681
8016
  /**
7682
8017
  * List of companion ads of the ad.
7683
8018
  */
7684
- companions: VerizonMediaResponseVodAd[];
8019
+ companions: UplynkResponseVodAd[];
7685
8020
  /**
7686
8021
  * List of VAST extensions returned by the ad server.
7687
8022
  */
@@ -7702,8 +8037,16 @@ interface VerizonMediaResponseVodAd {
7702
8037
  *
7703
8038
  * @category Verizon Media
7704
8039
  * @public
8040
+ * @deprecated Superseded by {@link UplynkResponseVodAdBreakOffset}
8041
+ */
8042
+ type VerizonMediaResponseVodAdBreakOffset = UplynkResponseVodAdBreakOffset;
8043
+ /**
8044
+ * Represents the offset of an Uplynk ad break.
8045
+ *
8046
+ * @category Uplynk
8047
+ * @public
7705
8048
  */
7706
- interface VerizonMediaResponseVodAdBreakOffset {
8049
+ interface UplynkResponseVodAdBreakOffset {
7707
8050
  /**
7708
8051
  * The index of the ad break in the ads.breaks array.
7709
8052
  */
@@ -7723,8 +8066,21 @@ interface VerizonMediaResponseVodAdBreakOffset {
7723
8066
  *
7724
8067
  * @category Verizon Media
7725
8068
  * @public
8069
+ * @deprecated Superseded by {@link UplynkResponseVodAdPlaceholder}
7726
8070
  */
7727
- interface VerizonMediaResponseVodAdPlaceholder {
8071
+ type VerizonMediaResponseVodAdPlaceholder = UplynkResponseVodAdPlaceholder;
8072
+ /**
8073
+ * Represents an Uplynk response with a placeholder for an ad for VOD assets.
8074
+ *
8075
+ * @remarks
8076
+ * A placeholder is an ad which
8077
+ * <br/> - is a short blank video for non-video ads (e.g. VPAID ads).
8078
+ * <br/> - is a system asset which is potentially subject to change.
8079
+ *
8080
+ * @category Uplynk
8081
+ * @public
8082
+ */
8083
+ interface UplynkResponseVodAdPlaceholder {
7728
8084
  /**
7729
8085
  * The index of the placeholder's ad break in the `ads.breaks` array.
7730
8086
  */
@@ -7750,26 +8106,52 @@ interface VerizonMediaResponseVodAdPlaceholder {
7750
8106
  *
7751
8107
  * @category Verizon Media
7752
8108
  * @public
8109
+ * @deprecated Superseded by {@link UplynkPreplayResponseType}
8110
+ */
8111
+ type VerizonMediaPreplayResponseType = UplynkPreplayResponseType;
8112
+ /**
8113
+ * The response type of the Uplynk Preplay request, represented by a value from the following list:
8114
+ * <br/> - `'vod'`
8115
+ * <br/> - `'live'`
8116
+ *
8117
+ * @category Uplynk
8118
+ * @public
7753
8119
  */
7754
- type VerizonMediaPreplayResponseType = 'vod' | 'live';
8120
+ type UplynkPreplayResponseType = 'vod' | 'live';
7755
8121
  /**
7756
8122
  * Type of a Verizon Media Preplay response.
7757
8123
  *
7758
8124
  * @category Verizon Media
7759
8125
  * @public
8126
+ * @deprecated Superseded by {@link UplynkPreplayResponse}
7760
8127
  */
7761
- type VerizonMediaPreplayResponse = VerizonMediaPreplayVodResponse | VerizonMediaPreplayLiveResponse;
8128
+ type VerizonMediaPreplayResponse = UplynkPreplayResponse;
8129
+ /**
8130
+ * Type of an Uplynk Preplay response.
8131
+ *
8132
+ * @category Uplynk
8133
+ * @public
8134
+ */
8135
+ type UplynkPreplayResponse = UplynkPreplayVodResponse | UplynkPreplayLiveResponse;
7762
8136
  /**
7763
8137
  * Represents a Verizon Media Preplay base response.
7764
8138
  *
7765
8139
  * @category Verizon Media
7766
8140
  * @public
8141
+ * @deprecated Superseded by {@link UplynkPreplayBaseResponse}
8142
+ */
8143
+ type VerizonMediaPreplayBaseResponse = UplynkPreplayBaseResponse;
8144
+ /**
8145
+ * Represents an Uplynk Preplay base response.
8146
+ *
8147
+ * @category Uplynk
8148
+ * @public
7767
8149
  */
7768
- interface VerizonMediaPreplayBaseResponse {
8150
+ interface UplynkPreplayBaseResponse {
7769
8151
  /**
7770
8152
  * The response type of the request.
7771
8153
  */
7772
- type: VerizonMediaPreplayResponseType;
8154
+ type: UplynkPreplayResponseType;
7773
8155
  /**
7774
8156
  * The manifest's URL.
7775
8157
  */
@@ -7796,15 +8178,27 @@ interface VerizonMediaPreplayBaseResponse {
7796
8178
  * <br/> - Widevine will default to 'https://content.uplynk.com/wv'.
7797
8179
  * <br/> - Playready will default to 'https://content.uplynk.com/pr'.
7798
8180
  */
7799
- drm?: VerizonMediaResponseDrm;
8181
+ drm?: UplynkResponseDrm;
7800
8182
  }
7801
8183
  /**
7802
8184
  * Represents a Verizon Media DRM response.
7803
8185
  *
7804
8186
  * @category Verizon Media
7805
8187
  * @public
8188
+ * @deprecated Superseded by {@link UplynkResponseDrm}
8189
+ */
8190
+ type VerizonMediaResponseDrm = UplynkResponseDrm;
8191
+ /**
8192
+ * Represents an Uplynk DRM response.
8193
+ *
8194
+ * @category Uplynk
8195
+ * @public
7806
8196
  */
7807
- interface VerizonMediaResponseDrm {
8197
+ interface UplynkResponseDrm {
8198
+ /**
8199
+ * Indicates whether {@link https://api-docs.uplynk.com/#Develop/Studio-DRM-API.htm%3FTocPath%3D_____11 | Studio DRM} is required for playback.
8200
+ */
8201
+ required?: boolean;
7808
8202
  /**
7809
8203
  * The Fairplay certificate URL.
7810
8204
  */
@@ -7823,8 +8217,16 @@ interface VerizonMediaResponseDrm {
7823
8217
  *
7824
8218
  * @category Verizon Media
7825
8219
  * @public
8220
+ * @deprecated Superseded by {@link UplynkPreplayVodResponse}
7826
8221
  */
7827
- interface VerizonMediaPreplayVodResponse extends VerizonMediaPreplayBaseResponse {
8222
+ type VerizonMediaPreplayVodResponse = UplynkPreplayVodResponse;
8223
+ /**
8224
+ * Represents an Uplynk Preplay response for VOD assets.
8225
+ *
8226
+ * @category Uplynk
8227
+ * @public
8228
+ */
8229
+ interface UplynkPreplayVodResponse extends UplynkPreplayBaseResponse {
7828
8230
  /**
7829
8231
  * The response type of the request.
7830
8232
  */
@@ -7832,12 +8234,12 @@ interface VerizonMediaPreplayVodResponse extends VerizonMediaPreplayBaseResponse
7832
8234
  /**
7833
8235
  * The advertisement information.
7834
8236
  */
7835
- ads: VerizonMediaResponseVodAds;
8237
+ ads: UplynkResponseVodAds;
7836
8238
  /**
7837
8239
  * The URL to the interstitial information
7838
8240
  *
7839
8241
  * @remarks
7840
- * <br/> - This file is a XML.
8242
+ * <br/> - This is an XML file.
7841
8243
  * <br/> - This parameter reports `null` when ads are not found.
7842
8244
  * <br/> - It should only be used on Apple TV.
7843
8245
  */
@@ -7848,8 +8250,16 @@ interface VerizonMediaPreplayVodResponse extends VerizonMediaPreplayBaseResponse
7848
8250
  *
7849
8251
  * @category Verizon Media
7850
8252
  * @public
8253
+ * @deprecated Superseded by {@link UplynkPreplayLiveResponse}
8254
+ */
8255
+ type VerizonMediaPreplayLiveResponse = UplynkPreplayLiveResponse;
8256
+ /**
8257
+ * Represents an Uplynk Preplay response for live assets.
8258
+ *
8259
+ * @category Uplynk
8260
+ * @public
7851
8261
  */
7852
- interface VerizonMediaPreplayLiveResponse extends VerizonMediaPreplayBaseResponse {
8262
+ interface UplynkPreplayLiveResponse extends UplynkPreplayBaseResponse {
7853
8263
  /**
7854
8264
  * The response type of the request.
7855
8265
  */
@@ -7861,12 +8271,20 @@ interface VerizonMediaPreplayLiveResponse extends VerizonMediaPreplayBaseRespons
7861
8271
  *
7862
8272
  * @category Verizon Media
7863
8273
  * @public
8274
+ * @deprecated Superseded by {@link UplynkPreplayResponseEvent}
7864
8275
  */
7865
- interface VerizonMediaPreplayResponseEvent extends Event<'preplayresponse'> {
8276
+ type VerizonMediaPreplayResponseEvent = UplynkPreplayResponseEvent;
8277
+ /**
8278
+ * Fired when a Preplay response is received.
8279
+ *
8280
+ * @category Uplynk
8281
+ * @public
8282
+ */
8283
+ interface UplynkPreplayResponseEvent extends Event<'preplayresponse'> {
7866
8284
  /**
7867
8285
  * The response which has been received.
7868
8286
  */
7869
- readonly response: VerizonMediaPreplayResponse;
8287
+ readonly response: UplynkPreplayResponse;
7870
8288
  }
7871
8289
 
7872
8290
  /**
@@ -7877,10 +8295,24 @@ interface VerizonMediaPreplayResponseEvent extends Event<'preplayresponse'> {
7877
8295
  *
7878
8296
  * @category Verizon Media
7879
8297
  * @public
8298
+ * @deprecated Superseded by {@link UplynkAssetInfoResponse}
8299
+ */
8300
+ type VerizonMediaAssetInfoResponse = UplynkAssetInfoResponse;
8301
+ /**
8302
+ * Represents an Uplynk Asset Info Response.
8303
+ *
8304
+ * @remarks
8305
+ * <br/> - See {@link https://api-docs.uplynk.com/#Develop/AssetInfo.htm | Asset Info}.
8306
+ *
8307
+ * @category Uplynk
8308
+ * @public
7880
8309
  */
7881
- interface VerizonMediaAssetInfoResponse {
8310
+ interface UplynkAssetInfoResponse {
7882
8311
  /**
7883
- * A flag indicating if the asset is audio only.
8312
+ * Returns 1 when the asset is audio only.
8313
+ *
8314
+ * @remarks
8315
+ * Valid values are: `0` | `1`.
7884
8316
  */
7885
8317
  audio_only: number;
7886
8318
  /**
@@ -7888,14 +8320,14 @@ interface VerizonMediaAssetInfoResponse {
7888
8320
  */
7889
8321
  boundary_details: Boundary[] | undefined;
7890
8322
  /**
7891
- * Whether an error occurred.
8323
+ * Returns 1 when an error occurred with the asset.
7892
8324
  *
7893
8325
  * @remarks
7894
- * <br/> - False if `0`, true otherwise.
8326
+ * Valid values are: `0` | `1`.
7895
8327
  */
7896
8328
  error: number;
7897
8329
  /**
7898
- * The tv-rating of the asset, represented by a value from the following list:
8330
+ * The TV rating of the asset, represented by a value from the following list:
7899
8331
  * <br/> - `-1`: Not Available.
7900
8332
  * <br/> - `0`: Not Rated.
7901
8333
  * <br/> - `1`: TV-Y.
@@ -7906,17 +8338,17 @@ interface VerizonMediaAssetInfoResponse {
7906
8338
  * <br/> - `6`: TV-MA.
7907
8339
  * <br/> - `7`: Not Rated.
7908
8340
  */
7909
- tv_rating: VerizonMediaAssetTvRating;
8341
+ tv_rating: UplynkAssetTvRating;
7910
8342
  /**
7911
8343
  * The number of slices available for the asset.
7912
8344
  */
7913
8345
  max_slice: number;
7914
8346
  /**
7915
- * The prefix URL to the thumbnails.
8347
+ * The base URL to the {@link https://api-docs.uplynk.com/Content/Develop/AssetInfo.htm#Thumbnails | thumbnails}.
7916
8348
  */
7917
8349
  thumb_prefix: string;
7918
8350
  /**
7919
- * The average slice duration.
8351
+ * The average slice duration, in seconds.
7920
8352
  */
7921
8353
  slice_dur: number;
7922
8354
  /**
@@ -7931,7 +8363,7 @@ interface VerizonMediaAssetInfoResponse {
7931
8363
  * <br/> - `6`: X.
7932
8364
  * <br/> - `7`: Not Rated.
7933
8365
  */
7934
- movie_rating: VerizonMediaAssetMovieRating;
8366
+ movie_rating: UplynkAssetMovieRating;
7935
8367
  /**
7936
8368
  * The identifier of the owner.
7937
8369
  */
@@ -7956,7 +8388,7 @@ interface VerizonMediaAssetInfoResponse {
7956
8388
  */
7957
8389
  poster_url: string;
7958
8390
  /**
7959
- * The duration of the asset.
8391
+ * The duration of the asset, in seconds.
7960
8392
  */
7961
8393
  duration: number;
7962
8394
  /**
@@ -7972,18 +8404,18 @@ interface VerizonMediaAssetInfoResponse {
7972
8404
  *
7973
8405
  * @remarks
7974
8406
  * These available flags are the following:
7975
- * <br/> - D: Drug-related themes are present
7976
- * <br/> - V: Violence is present
7977
- * <br/> - S: Sexual situations are present
7978
- * <br/> - L: Adult Language is present
8407
+ * - D: Drug-related themes are present
8408
+ * - V: Violence is present
8409
+ * - S: Sexual situations are present
8410
+ * - L: Adult Language is present
7979
8411
  *
7980
8412
  * This number is a bitwise number to indicate if one or more of these values are present.
7981
- * <br/> - [D][V][S][L] - 0: No rating flag.
7982
- * <br/> - [D][V][S][L] - 1: Language flag.
7983
- * <br/> - [D][V][S][L] - 2: Sex flag.
7984
- * <br/> - [D][V][S][L] - 4: Violence flag.
7985
- * <br/> - [D][V][S][L] - 8: Drugs flag.
7986
- * <br/> - [D][V][S][L] - 15: All flags are on.
8413
+ * - [&nbsp;&nbsp;][&nbsp;&nbsp;][&nbsp;&nbsp;][&nbsp;&nbsp;] - 0: No rating flag.
8414
+ * - [&nbsp;&nbsp;][&nbsp;&nbsp;][&nbsp;&nbsp;][L] - 1: Language flag.
8415
+ * - [&nbsp;&nbsp;][&nbsp;&nbsp;][S][&nbsp;&nbsp;] - 2: Sex flag.
8416
+ * - [&nbsp;&nbsp;][V][&nbsp;&nbsp;][&nbsp;&nbsp;] - 4: Violence flag.
8417
+ * - [D][&nbsp;&nbsp;][&nbsp;&nbsp;][&nbsp;&nbsp;] - 8: Drugs flag.
8418
+ * - [D][V][S][L] - 15: All flags are on.
7987
8419
  */
7988
8420
  rating_flags: number;
7989
8421
  /**
@@ -7991,10 +8423,10 @@ interface VerizonMediaAssetInfoResponse {
7991
8423
  */
7992
8424
  external_id: string;
7993
8425
  /**
7994
- * Whether the asset is an ad.
8426
+ * Returns 1 when asset is an ad.
7995
8427
  *
7996
8428
  * @remarks
7997
- * <br/> - False if `0`, true otherwise
8429
+ * Valid values are: `0` | `1`.
7998
8430
  */
7999
8431
  is_ad: number;
8000
8432
  /**
@@ -8004,14 +8436,15 @@ interface VerizonMediaAssetInfoResponse {
8004
8436
  }
8005
8437
  /**
8006
8438
  * A boundary can be one of 3 possible types:
8007
- * <br/> - c3: An ad that is relevant for up to 3 days after the original airing.
8008
- * <br/> - c7: An ad that is relevant for up to 7 days after the original airing.
8009
- * <br/> - halftime: Identifies special content.
8439
+ * - `c3`: An ad that is relevant for up to 3 days after the original airing.
8440
+ * - `c7`: An ad that is relevant for up to 7 days after the original airing.
8441
+ * - `halftime`: Identifies special content.
8010
8442
  *
8011
8443
  * @remarks
8012
- * <br/> - See {@link https://docs.vdms.com/video/#Setup/Boundaries-Setup-Playback.htm | Boundaries }
8444
+ * <br/> - See {@link https://api-docs.uplynk.com/index.html#Setup/Boundaries-Setup-Playback.htm | Boundaries }
8013
8445
  *
8014
8446
  * @category Verizon Media
8447
+ * @category Uplynk
8015
8448
  * @public
8016
8449
  */
8017
8450
  type Boundary = BoundaryC3 | BoundaryC7 | BoundaryHalftime;
@@ -8019,6 +8452,7 @@ type Boundary = BoundaryC3 | BoundaryC7 | BoundaryHalftime;
8019
8452
  * Represents the information of an ad boundary.
8020
8453
  *
8021
8454
  * @category Verizon Media
8455
+ * @category Uplynk
8022
8456
  * @public
8023
8457
  */
8024
8458
  interface BoundaryInfo {
@@ -8035,6 +8469,7 @@ interface BoundaryInfo {
8035
8469
  * Represents the boundary of an ad that is relevant for up to three days after the original airing.
8036
8470
  *
8037
8471
  * @category Verizon Media
8472
+ * @category Uplynk
8038
8473
  * @public
8039
8474
  */
8040
8475
  interface BoundaryC3 {
@@ -8044,6 +8479,7 @@ interface BoundaryC3 {
8044
8479
  * Represents the boundary of an ad that is relevant for up to seven days after the original airing.
8045
8480
  *
8046
8481
  * @category Verizon Media
8482
+ * @category Uplynk
8047
8483
  * @public
8048
8484
  */
8049
8485
  interface BoundaryC7 {
@@ -8053,15 +8489,17 @@ interface BoundaryC7 {
8053
8489
  * Represents the boundary that identifies special content.
8054
8490
  *
8055
8491
  * @category Verizon Media
8492
+ * @category Uplynk
8056
8493
  * @public
8057
8494
  */
8058
8495
  interface BoundaryHalftime {
8059
8496
  halftime: BoundaryInfo;
8060
8497
  }
8061
8498
  /**
8062
- * Represents the resolution of a Verizon Media thumbnail.
8499
+ * Represents the resolution of an Uplynk thumbnail.
8063
8500
  *
8064
8501
  * @category Verizon Media
8502
+ * @category Uplynk
8065
8503
  * @public
8066
8504
  */
8067
8505
  interface ThumbnailResolution {
@@ -8110,8 +8548,29 @@ interface ThumbnailResolution {
8110
8548
  *
8111
8549
  * @category Verizon Media
8112
8550
  * @public
8551
+ * @deprecated Superseded by {@link UplynkAssetTvRating}
8552
+ */
8553
+ type VerizonMediaAssetTvRating = UplynkAssetTvRating;
8554
+ /**
8555
+ * The TV rating of an asset, represented by a value from the following list:
8556
+ * <br/> - `-1` (NOT_AVAILABLE)
8557
+ * <br/> - `0` (NOT_APPLICABLE)
8558
+ * <br/> - `1` (TV_Y)
8559
+ * <br/> - `2` (TV_Y7)
8560
+ * <br/> - `3` (TV_G)
8561
+ * <br/> - `4` (TV_PG)
8562
+ * <br/> - `5` (TV_14)
8563
+ * <br/> - `6` (TV_MA)
8564
+ * <br/> - `7` (NOT_RATED)
8565
+ *
8566
+ * @remarks
8567
+ * In the online documentation the value for 0 is also "NOT RATED". Since this is counter-intuitive, we have assumed
8568
+ * this to be erronous and have modeled this according to the Movie Ratings, with 0 being "NOT APPLICABLE".
8569
+ *
8570
+ * @category Uplynk
8571
+ * @public
8113
8572
  */
8114
- type VerizonMediaAssetTvRating = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
8573
+ type UplynkAssetTvRating = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
8115
8574
  /**
8116
8575
  * The movie rating of an asset, represented by a value from the following list:
8117
8576
  * <br/> - `-1` (NOT_AVAILABLE)
@@ -8126,8 +8585,25 @@ type VerizonMediaAssetTvRating = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
8126
8585
  *
8127
8586
  * @category Verizon Media
8128
8587
  * @public
8588
+ * @deprecated Superseded by {@link UplynkAssetMovieRating}
8589
+ */
8590
+ type VerizonMediaAssetMovieRating = UplynkAssetMovieRating;
8591
+ /**
8592
+ * The movie rating of an asset, represented by a value from the following list:
8593
+ * <br/> - `-1` (NOT_AVAILABLE)
8594
+ * <br/> - `0` (NOT_APPLICABLE)
8595
+ * <br/> - `1` (G)
8596
+ * <br/> - `2` (PG)
8597
+ * <br/> - `3` (PG_13)
8598
+ * <br/> - `4` (R)
8599
+ * <br/> - `5` (NC_17)
8600
+ * <br/> - `6` (X)
8601
+ * <br/> - `7` (NOT_RATED)
8602
+ *
8603
+ * @category Uplynk
8604
+ * @public
8129
8605
  */
8130
- type VerizonMediaAssetMovieRating = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
8606
+ type UplynkAssetMovieRating = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
8131
8607
 
8132
8608
  /**
8133
8609
  * Fired when an asset info response is received.
@@ -8135,12 +8611,21 @@ type VerizonMediaAssetMovieRating = -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
8135
8611
  * @category Verizon Media
8136
8612
  * @category Events
8137
8613
  * @public
8614
+ * @deprecated Superseded by {@link UplynkAssetInfoResponseEvent}
8615
+ */
8616
+ type VerizonMediaAssetInfoResponseEvent = UplynkAssetInfoResponseEvent;
8617
+ /**
8618
+ * Fired when an asset info response is received.
8619
+ *
8620
+ * @category Uplynk
8621
+ * @category Events
8622
+ * @public
8138
8623
  */
8139
- interface VerizonMediaAssetInfoResponseEvent extends Event<'assetinforesponse'> {
8624
+ interface UplynkAssetInfoResponseEvent extends Event<'assetinforesponse'> {
8140
8625
  /**
8141
8626
  * The response which has been received.
8142
8627
  */
8143
- readonly response: VerizonMediaAssetInfoResponse;
8628
+ readonly response: UplynkAssetInfoResponse;
8144
8629
  }
8145
8630
 
8146
8631
  /**
@@ -8148,23 +8633,39 @@ interface VerizonMediaAssetInfoResponseEvent extends Event<'assetinforesponse'>
8148
8633
  *
8149
8634
  * @category Verizon Media
8150
8635
  * @public
8636
+ * @deprecated Superseded by {@link UplynkResponseLiveAds}
8637
+ */
8638
+ type VerizonMediaResponseLiveAds = UplynkResponseLiveAds;
8639
+ /**
8640
+ * Represents an Uplynk response with advertisement information for live assets.
8641
+ *
8642
+ * @category Uplynk
8643
+ * @public
8151
8644
  */
8152
- interface VerizonMediaResponseLiveAds {
8645
+ interface UplynkResponseLiveAds {
8153
8646
  /**
8154
8647
  * List of ad break information.
8155
8648
  *
8156
8649
  * @remarks
8157
8650
  * <br/> - This includes both linear and non-linear ads.
8158
8651
  */
8159
- breaks: VerizonMediaResponseLiveAdBreak[];
8652
+ breaks: UplynkResponseLiveAdBreak[];
8160
8653
  }
8161
8654
  /**
8162
8655
  * Represents a Verizon Media response for live ad breaks.
8163
8656
  *
8164
8657
  * @category Verizon Media
8165
8658
  * @public
8659
+ * @deprecated Superseded by {@link UplynkResponseLiveAdBreak}
8660
+ */
8661
+ type VerizonMediaResponseLiveAdBreak = UplynkResponseLiveAdBreak;
8662
+ /**
8663
+ * Represents an Uplynk response for live ad breaks.
8664
+ *
8665
+ * @category Uplynk
8666
+ * @public
8166
8667
  */
8167
- interface VerizonMediaResponseLiveAdBreak {
8668
+ interface UplynkResponseLiveAdBreak {
8168
8669
  /**
8169
8670
  * The identifier of the ad break.
8170
8671
  */
@@ -8172,7 +8673,7 @@ interface VerizonMediaResponseLiveAdBreak {
8172
8673
  /**
8173
8674
  * List of ad information.
8174
8675
  */
8175
- ads: VerizonMediaResponseLiveAd[];
8676
+ ads: UplynkResponseLiveAd[];
8176
8677
  /**
8177
8678
  * The type of the ad break.
8178
8679
  */
@@ -8220,8 +8721,16 @@ interface VerizonMediaResponseLiveAdBreak {
8220
8721
  *
8221
8722
  * @category Verizon Media
8222
8723
  * @public
8724
+ * @deprecated Superseded by {@link UplynkResponseLiveAd}
8725
+ */
8726
+ type VerizonMediaResponseLiveAd = UplynkResponseLiveAd;
8727
+ /**
8728
+ * Represents an Uplynk response with live ads.
8729
+ *
8730
+ * @category Uplynk
8731
+ * @public
8223
8732
  */
8224
- interface VerizonMediaResponseLiveAd {
8733
+ interface UplynkResponseLiveAd {
8225
8734
  /**
8226
8735
  * Identifier for the ad.
8227
8736
  */
@@ -8237,7 +8746,7 @@ interface VerizonMediaResponseLiveAd {
8237
8746
  /**
8238
8747
  * List of companion ads of the ad.
8239
8748
  */
8240
- companions: VerizonMediaResponseLiveAd[];
8749
+ companions: UplynkResponseLiveAd[];
8241
8750
  /**
8242
8751
  * The creative identifier.
8243
8752
  *
@@ -8291,8 +8800,19 @@ interface VerizonMediaResponseLiveAd {
8291
8800
  *
8292
8801
  * @category Verizon Media
8293
8802
  * @public
8803
+ * @deprecated Superseded by {@link UplynkPingResponse}
8804
+ */
8805
+ type VerizonMediaPingResponse = UplynkPingResponse;
8806
+ /**
8807
+ * Represents an Uplynk Ping response.
8808
+ *
8809
+ * @remarks
8810
+ * <br/> - See {@link https://api-docs.uplynk.com/#Develop/Pingv2.htm%3FTocPath%3DClient%2520(Media%2520Player)%7C_____3 | Ping API (Version 2)}.
8811
+ *
8812
+ * @category Uplynk
8813
+ * @public
8294
8814
  */
8295
- interface VerizonMediaPingResponse {
8815
+ interface UplynkPingResponse {
8296
8816
  /**
8297
8817
  * The playback position at which the next ping request must be made, in seconds.
8298
8818
  *
@@ -8303,9 +8823,9 @@ interface VerizonMediaPingResponse {
8303
8823
  /**
8304
8824
  * The live ad information.
8305
8825
  */
8306
- ads?: VerizonMediaResponseLiveAds;
8826
+ ads?: UplynkResponseLiveAds;
8307
8827
  /**
8308
- * Whether {@link VerizonMediaAds.currentAdBreak} is ending.
8828
+ * Whether {@link UplynkAds.currentAdBreak} is ending.
8309
8829
  *
8310
8830
  * @remarks
8311
8831
  * <br/> - False if `0`, true otherwise.
@@ -8327,12 +8847,21 @@ interface VerizonMediaPingResponse {
8327
8847
  * @category Verizon Media
8328
8848
  * @category Events
8329
8849
  * @public
8850
+ * @deprecated Superseded by {@link UplynkPingResponseEvent}
8851
+ */
8852
+ type VerizonMediaPingResponseEvent = UplynkPingResponseEvent;
8853
+ /**
8854
+ * Fired when a Ping response is received.
8855
+ *
8856
+ * @category Uplynk
8857
+ * @category Events
8858
+ * @public
8330
8859
  */
8331
- interface VerizonMediaPingResponseEvent extends Event<'pingresponse'> {
8860
+ interface UplynkPingResponseEvent extends Event<'pingresponse'> {
8332
8861
  /**
8333
8862
  * The response which has been received.
8334
8863
  */
8335
- readonly response: VerizonMediaPingResponse;
8864
+ readonly response: UplynkPingResponse;
8336
8865
  }
8337
8866
 
8338
8867
  /**
@@ -8341,8 +8870,17 @@ interface VerizonMediaPingResponseEvent extends Event<'pingresponse'> {
8341
8870
  * @category Verizon Media
8342
8871
  * @category Events
8343
8872
  * @public
8873
+ * @deprecated Superseded by {@link UplynkPingErrorEvent}
8874
+ */
8875
+ type VerizonMediaPingErrorEvent = UplynkPingErrorEvent;
8876
+ /**
8877
+ * Fired when an error or invalid response is received from the Ping API.
8878
+ *
8879
+ * @category Uplynk
8880
+ * @category Events
8881
+ * @public
8344
8882
  */
8345
- interface VerizonMediaPingErrorEvent extends Event<'pingerror'> {
8883
+ interface UplynkPingErrorEvent extends Event<'pingerror'> {
8346
8884
  /**
8347
8885
  * The error message.
8348
8886
  */
@@ -8354,8 +8892,16 @@ interface VerizonMediaPingErrorEvent extends Event<'pingerror'> {
8354
8892
  *
8355
8893
  * @category Verizon Media
8356
8894
  * @public
8895
+ * @deprecated Superseded by {@link UplynkAsset}
8896
+ */
8897
+ type VerizonMediaAsset = UplynkAsset;
8898
+ /**
8899
+ * Represents an Uplynk asset.
8900
+ *
8901
+ * @category Uplynk
8902
+ * @public
8357
8903
  */
8358
- interface VerizonMediaAsset {
8904
+ interface UplynkAsset {
8359
8905
  /**
8360
8906
  * The start time of the asset, in seconds.
8361
8907
  */
@@ -8364,7 +8910,7 @@ interface VerizonMediaAsset {
8364
8910
  * The end time of the asset, in seconds.
8365
8911
  *
8366
8912
  * @remarks
8367
- * <br> - The end time is the sum of {@link VerizonMediaAsset.startTime}, {@link VerizonMediaAsset.duration} and the {@link VerizonMediaAdBreak.duration} of the ad breaks scheduled during the asset.
8913
+ * <br> - The end time is the sum of {@link UplynkAsset.startTime}, {@link UplynkAsset.duration} and the {@link UplynkAdBreak.duration} of the ad breaks scheduled during the asset.
8368
8914
  */
8369
8915
  endTime: number;
8370
8916
  /**
@@ -8379,7 +8925,7 @@ interface VerizonMediaAsset {
8379
8925
  * List of boundaries of the asset.
8380
8926
  *
8381
8927
  * @remarks
8382
- * <br/> - See {@link https://docs.vdms.com/video/#Setup/Boundaries-Setup-Playback.htm | Boundaries}
8928
+ * <br/> - See {@link https://api-docs.uplynk.com/index.html#Setup/Boundaries-Setup-Playback.htm | Boundaries}
8383
8929
  */
8384
8930
  boundaryDetails: Boundary[] | undefined;
8385
8931
  /**
@@ -8491,12 +9037,21 @@ interface VerizonMediaAsset {
8491
9037
  * @category Verizon Media
8492
9038
  * @category Events
8493
9039
  * @public
9040
+ * @deprecated Superseded by {@link UplynkAddAssetEvent}
9041
+ */
9042
+ type VerizonMediaAddAssetEvent = UplynkAddAssetEvent;
9043
+ /**
9044
+ * Fired when an asset is added.
9045
+ *
9046
+ * @category Uplynk
9047
+ * @category Events
9048
+ * @public
8494
9049
  */
8495
- interface VerizonMediaAddAssetEvent extends Event<'addasset'> {
9050
+ interface UplynkAddAssetEvent extends Event<'addasset'> {
8496
9051
  /**
8497
9052
  * The asset which has been added.
8498
9053
  */
8499
- readonly asset: VerizonMediaAsset;
9054
+ readonly asset: UplynkAsset;
8500
9055
  }
8501
9056
 
8502
9057
  /**
@@ -8505,12 +9060,21 @@ interface VerizonMediaAddAssetEvent extends Event<'addasset'> {
8505
9060
  * @category Verizon Media
8506
9061
  * @category Events
8507
9062
  * @public
9063
+ * @deprecated Superseded by {@link UplynkRemoveAssetEvent}
9064
+ */
9065
+ type VerizonMediaRemoveAssetEvent = UplynkRemoveAssetEvent;
9066
+ /**
9067
+ * Fired when an asset is removed.
9068
+ *
9069
+ * @category Uplynk
9070
+ * @category Events
9071
+ * @public
8508
9072
  */
8509
- interface VerizonMediaRemoveAssetEvent extends Event<'removeasset'> {
9073
+ interface UplynkRemoveAssetEvent extends Event<'removeasset'> {
8510
9074
  /**
8511
9075
  * The asset which has been removed.
8512
9076
  */
8513
- readonly asset: VerizonMediaAsset;
9077
+ readonly asset: UplynkAsset;
8514
9078
  }
8515
9079
 
8516
9080
  /**
@@ -8518,24 +9082,40 @@ interface VerizonMediaRemoveAssetEvent extends Event<'removeasset'> {
8518
9082
  *
8519
9083
  * @category Verizon Media
8520
9084
  * @public
9085
+ * @deprecated Superseded by {@link UplynkAssetEventMap}
9086
+ */
9087
+ type VerizonMediaAssetEventMap = UplynkAssetEventMap;
9088
+ /**
9089
+ * The events fired by the {@link UplynkAssetList}.
9090
+ *
9091
+ * @category Uplynk
9092
+ * @public
8521
9093
  */
8522
- interface VerizonMediaAssetEventMap {
9094
+ interface UplynkAssetEventMap {
8523
9095
  /**
8524
- * {@inheritDoc VerizonMediaAddAssetEvent}
9096
+ * {@inheritDoc UplynkAddAssetEvent}
8525
9097
  */
8526
- addasset: VerizonMediaAddAssetEvent;
9098
+ addasset: UplynkAddAssetEvent;
8527
9099
  /**
8528
- * {@inheritDoc VerizonMediaRemoveAssetEvent}
9100
+ * {@inheritDoc UplynkRemoveAssetEvent}
8529
9101
  */
8530
- removeasset: VerizonMediaRemoveAssetEvent;
9102
+ removeasset: UplynkRemoveAssetEvent;
8531
9103
  }
8532
9104
  /**
8533
9105
  * List of Verizon Media assets.
8534
9106
  *
8535
9107
  * @category Verizon Media
8536
9108
  * @public
9109
+ * @deprecated Superseded by {@link UplynkAssetList}
9110
+ */
9111
+ type VerizonMediaAssetList = UplynkAssetList;
9112
+ /**
9113
+ * List of Uplynk assets.
9114
+ *
9115
+ * @category Uplynk
9116
+ * @public
8537
9117
  */
8538
- interface VerizonMediaAssetList extends EventedList<VerizonMediaAsset, VerizonMediaAssetEventMap> {
9118
+ interface UplynkAssetList extends EventedList<UplynkAsset, UplynkAssetEventMap> {
8539
9119
  }
8540
9120
 
8541
9121
  /**
@@ -8543,24 +9123,32 @@ interface VerizonMediaAssetList extends EventedList<VerizonMediaAsset, VerizonMe
8543
9123
  *
8544
9124
  * @category Verizon Media
8545
9125
  * @public
9126
+ * @deprecated Superseded by {@link UplynkEventMap}.
9127
+ */
9128
+ type VerizonMediaEventMap = UplynkEventMap;
9129
+ /**
9130
+ * The events fired by the {@link Uplynk | Uplynk API}.
9131
+ *
9132
+ * @category Uplynk
9133
+ * @public
8546
9134
  */
8547
- interface VerizonMediaEventMap {
9135
+ interface UplynkEventMap {
8548
9136
  /**
8549
- * {@inheritDoc VerizonMediaPreplayResponseEvent}
9137
+ * {@inheritDoc UplynkPreplayResponseEvent}
8550
9138
  */
8551
- preplayresponse: VerizonMediaPreplayResponseEvent;
9139
+ preplayresponse: UplynkPreplayResponseEvent;
8552
9140
  /**
8553
- * {@inheritDoc VerizonMediaAssetInfoResponseEvent}
9141
+ * {@inheritDoc UplynkAssetInfoResponseEvent}
8554
9142
  */
8555
- assetinforesponse: VerizonMediaAssetInfoResponseEvent;
9143
+ assetinforesponse: UplynkAssetInfoResponseEvent;
8556
9144
  /**
8557
- * {@inheritDoc VerizonMediaPingResponseEvent}
9145
+ * {@inheritDoc UplynkPingResponseEvent}
8558
9146
  */
8559
- pingresponse: VerizonMediaPingResponseEvent;
9147
+ pingresponse: UplynkPingResponseEvent;
8560
9148
  /**
8561
- * {@inheritDoc VerizonMediaPingErrorEvent}
9149
+ * {@inheritDoc UplynkPingErrorEvent}
8562
9150
  */
8563
- pingerror: VerizonMediaPingErrorEvent;
9151
+ pingerror: UplynkPingErrorEvent;
8564
9152
  }
8565
9153
  /**
8566
9154
  * The Verizon Media API.
@@ -8570,16 +9158,27 @@ interface VerizonMediaEventMap {
8570
9158
  *
8571
9159
  * @category Verizon Media
8572
9160
  * @public
9161
+ * @deprecated Superseded by {@link Uplynk}.
9162
+ */
9163
+ type VerizonMedia = Uplynk;
9164
+ /**
9165
+ * The Uplynk API.
9166
+ *
9167
+ * @remarks
9168
+ * <br/> - Only available with the feature 'uplynk'.
9169
+ *
9170
+ * @category Uplynk
9171
+ * @public
8573
9172
  */
8574
- interface VerizonMedia extends EventDispatcher<VerizonMediaEventMap> {
9173
+ interface Uplynk extends EventDispatcher<UplynkEventMap> {
8575
9174
  /**
8576
- * The Verizon Media SSAI API.
9175
+ * The Uplynk SSAI API.
8577
9176
  */
8578
- readonly ads: VerizonMediaAds;
9177
+ readonly ads: UplynkAds;
8579
9178
  /**
8580
- * List of Verizon Media assets.
9179
+ * List of Uplynk assets.
8581
9180
  */
8582
- readonly assets: VerizonMediaAssetList;
9181
+ readonly assets: UplynkAssetList;
8583
9182
  }
8584
9183
 
8585
9184
  /**
@@ -9593,6 +10192,186 @@ interface CustomTextTrackMap {
9593
10192
  webvtt: CustomWebVTTTextTrack;
9594
10193
  }
9595
10194
 
10195
+ /**
10196
+ * The THEOads API.
10197
+ *
10198
+ * @remarks
10199
+ * <br/> - Available since v8.12.0.
10200
+ *
10201
+ * @category THEOads
10202
+ * @public
10203
+ */
10204
+ interface TheoAds extends EventDispatcher<TheoAdsEventsMap> {
10205
+ /**
10206
+ * The currently playing interstitials.
10207
+ */
10208
+ currentInterstitials: readonly Interstitial[];
10209
+ /**
10210
+ * List of interstitials which still need to be played.
10211
+ */
10212
+ scheduledInterstitials: readonly Interstitial[];
10213
+ /**
10214
+ * Replaces all the ad tag parameters used for upcoming ad requests for a live stream.
10215
+ *
10216
+ * @param adTagParameters - The new ad tag parameters.
10217
+ *
10218
+ * @remarks
10219
+ * <br/> - If set, this value overrides any parameters set on the {@link TheoAdDescription.adTagParameters}.
10220
+ */
10221
+ replaceAdTagParameters(adTagParameters?: Record<string, string>): void;
10222
+ }
10223
+ /**
10224
+ * The events fired by the {@link TheoAds | THEOads API}.
10225
+ *
10226
+ * @category THEOads
10227
+ * @public
10228
+ */
10229
+ interface TheoAdsEventsMap {
10230
+ /**
10231
+ * Fired when an interstitial is added.
10232
+ */
10233
+ addinterstitial: InterstitialEvent<'addinterstitial'>;
10234
+ /**
10235
+ * Fired when an interstitial begins.
10236
+ */
10237
+ interstitialbegin: InterstitialEvent<'interstitialbegin'>;
10238
+ /**
10239
+ * Fired when an interstitial ends.
10240
+ */
10241
+ interstitialend: InterstitialEvent<'interstitialend'>;
10242
+ /**
10243
+ * Fired when an interstitial is updated.
10244
+ */
10245
+ interstitialupdate: InterstitialEvent<'interstitialupdate'>;
10246
+ /**
10247
+ * Fired when an interstitial has errored.
10248
+ */
10249
+ interstitialerror: InterstitialEvent<'interstitialerror'>;
10250
+ }
10251
+ /**
10252
+ * Base type for events related to an interstitial.
10253
+ *
10254
+ * @category THEOads
10255
+ * @category Events
10256
+ * @public
10257
+ */
10258
+ interface InterstitialEvent<TType extends string> extends Event<TType> {
10259
+ /**
10260
+ * The interstitial.
10261
+ */
10262
+ readonly interstitial: Interstitial;
10263
+ }
10264
+ /**
10265
+ * The type of the interstitial.
10266
+ *
10267
+ * @category THEOads
10268
+ * @public
10269
+ */
10270
+ type InterstitialType = 'adbreak' | 'overlay';
10271
+ /**
10272
+ * The THEOads interstitial.
10273
+ *
10274
+ * @category THEOads
10275
+ * @public
10276
+ */
10277
+ interface Interstitial {
10278
+ /**
10279
+ * The type of the interstitial.
10280
+ */
10281
+ type: InterstitialType;
10282
+ /**
10283
+ * The identifier of the interstitial.
10284
+ */
10285
+ id: string;
10286
+ /**
10287
+ * The start time at which the interstitial will start.
10288
+ */
10289
+ startTime: number;
10290
+ /**
10291
+ * The duration of the interstitial, in seconds.
10292
+ *
10293
+ */
10294
+ duration: number | undefined;
10295
+ }
10296
+ /**
10297
+ * The layout of the THEOad.
10298
+ */
10299
+ type TheoAdsLayout = 'single' | 'l-shape' | 'double';
10300
+ /**
10301
+ * The THEOads interstitial that corresponds with ad playback.
10302
+ *
10303
+ * @category THEOads
10304
+ * @public
10305
+ */
10306
+ interface AdBreakInterstitial extends Interstitial {
10307
+ type: 'adbreak';
10308
+ /**
10309
+ * The layout which is used to play the ads of the interstitial.
10310
+ */
10311
+ layout: TheoAdsLayout;
10312
+ /**
10313
+ * The background when playing an ad.
10314
+ *
10315
+ * @remarks
10316
+ * - <br/> This is only available when playing in double or l-shape layout.
10317
+ */
10318
+ backdropUri: string | undefined;
10319
+ /**
10320
+ * The ads that are part of the interstitial.
10321
+ *
10322
+ * @remarks
10323
+ * - <br/> - Only available during ad playback.
10324
+ */
10325
+ ads: readonly Ad[];
10326
+ }
10327
+ /**
10328
+ * The THEOads interstitial that corresponds with overlay playback.
10329
+ *
10330
+ * @category THEOads
10331
+ * @public
10332
+ */
10333
+ interface OverlayInterstitial extends Interstitial {
10334
+ type: 'overlay';
10335
+ /**
10336
+ * The url of the image of the overlay.
10337
+ */
10338
+ imageUrl: string | undefined;
10339
+ /**
10340
+ * The clickThrough url of the overlay.
10341
+ */
10342
+ clickThrough: string | undefined;
10343
+ /**
10344
+ * The position of the overlay.
10345
+ */
10346
+ position: OverlayPosition;
10347
+ /**
10348
+ * The size of the overlay.
10349
+ */
10350
+ size: OverlaySize;
10351
+ }
10352
+ /**
10353
+ * The position information of the overlay.
10354
+ *
10355
+ * @category THEOads
10356
+ * @public
10357
+ */
10358
+ interface OverlayPosition {
10359
+ left?: number;
10360
+ right?: number;
10361
+ top?: number;
10362
+ bottom?: number;
10363
+ }
10364
+ /**
10365
+ * The size information of the overlay.
10366
+ *
10367
+ * @category THEOads
10368
+ * @public
10369
+ */
10370
+ interface OverlaySize {
10371
+ width?: number;
10372
+ height?: number;
10373
+ }
10374
+
9596
10375
  /**
9597
10376
  * The events fired by the {@link ChromelessPlayer}.
9598
10377
  *
@@ -10121,8 +10900,16 @@ declare class ChromelessPlayer implements EventDispatcher<PlayerEventMap> {
10121
10900
  *
10122
10901
  * @remarks
10123
10902
  * <br/> - Only available with the feature `'verizonmedia'`.
10903
+ * @deprecated Superseded by `uplynk`.
10124
10904
  */
10125
10905
  readonly verizonMedia?: VerizonMedia;
10906
+ /**
10907
+ * The Uplynk API.
10908
+ *
10909
+ * @remarks
10910
+ * <br/> - Only available with the feature `'uplynk'`.
10911
+ */
10912
+ readonly uplynk?: Uplynk;
10126
10913
  /**
10127
10914
  * The HESP API.
10128
10915
  * @remarks
@@ -10130,6 +10917,13 @@ declare class ChromelessPlayer implements EventDispatcher<PlayerEventMap> {
10130
10917
  * <br/> - Only available with the feature `'hesp'`.
10131
10918
  */
10132
10919
  readonly hesp?: HespApi;
10920
+ /**
10921
+ * The THEOads API.
10922
+ *
10923
+ * @remarks
10924
+ * <br/> - Only available with the feature `'theoads''`.
10925
+ */
10926
+ readonly theoads?: TheoAds;
10133
10927
  }
10134
10928
 
10135
10929
  /**
@@ -12327,6 +13121,48 @@ interface TTMLCue extends TextTrackCue {
12327
13121
  metadata: any;
12328
13122
  }
12329
13123
 
13124
+ /**
13125
+ * Represents a metadata cue of a Millicast source.
13126
+ *
13127
+ * @remarks
13128
+ * In order to receive Millicast metadata, you must set `metadata` to `true` in {@link MillicastSource.connectOptions}.
13129
+ *
13130
+ * @see https://docs.dolby.io/streaming-apis/docs/frame-metadata
13131
+ *
13132
+ * @category Media and Text Tracks
13133
+ * @category Millicast
13134
+ * @public
13135
+ */
13136
+ interface MillicastMetadataCue extends TextTrackCue {
13137
+ /**
13138
+ * Unused.
13139
+ *
13140
+ * @remarks
13141
+ * <br/> - Use {@link timecode} and/or {@link unregistered} to retrieve the contents of the Millicast metadata.
13142
+ */
13143
+ readonly content: undefined;
13144
+ /**
13145
+ * The media identifier of the track that contains the metadata.
13146
+ */
13147
+ readonly mid: string;
13148
+ /**
13149
+ * The UUID of the metadata.
13150
+ */
13151
+ readonly uuid: string | undefined;
13152
+ /**
13153
+ * Timecode of when the metadata was generated.
13154
+ */
13155
+ readonly timecode: Date | undefined;
13156
+ /**
13157
+ * Unregistered data.
13158
+ *
13159
+ * @remarks
13160
+ * <br/> - If the metadata content is valid JSON, then this is the parsed JSON object.
13161
+ * Otherwise, it's the raw data as a {@link Uint8Array}.
13162
+ */
13163
+ readonly unregistered: object | Uint8Array | undefined;
13164
+ }
13165
+
12330
13166
  /**
12331
13167
  * Describes a THEOads ad break request.
12332
13168
  *
@@ -12430,7 +13266,7 @@ interface TheoAdDescription extends AdDescription {
12430
13266
  *
12431
13267
  * @category Ads
12432
13268
  */
12433
- type TheoAdsLayoutOverride = 'single' | 'l-shape' | 'double' | 'single-if-mobile';
13269
+ type TheoAdsLayoutOverride = TheoAdsLayout | 'single-if-mobile';
12434
13270
 
12435
13271
  /**
12436
13272
  * @category HESP
@@ -13367,4 +14203,4 @@ declare function registerContentProtectionIntegration(integrationId: string, key
13367
14203
  */
13368
14204
  declare const utils: CommonUtils;
13369
14205
 
13370
- export { ABRConfiguration, ABRMetadata, ABRStrategy, ABRStrategyConfiguration, ABRStrategyType, AES128KeySystemConfiguration, AccessibilityRole, Ad, AdBreak, AdBreakEvent, AdBreakInit, AdBufferingEvent, AdDescription, AdEvent, AdInit, AdIntegrationKind, AdMetadataEvent, AdPreloadType, AdReadyState, AdSkipEvent, AdSource, AdSourceType, AdType, AddCachingTaskEvent, AddTrackEvent, AddViewEvent, Ads, AdsConfiguration, AdsEventMap, AdsManagerLoadedEvent, AgamaAnalyticsIntegrationID, AgamaConfiguration, AgamaLogLevelType, AgamaPlayerConfiguration, AgamaServiceName, AgamaSourceConfiguration, AgamaStreamType, AirPlay, AnalyticsDescription, AnalyticsIntegrationID, AudioQuality, AxinomDRMConfiguration, AxinomIntegrationID, AzureDRMConfiguration, AzureIntegrationID, Base64Util, BaseSource, Boundary, BoundaryC3, BoundaryC7, BoundaryHalftime, BoundaryInfo, BufferSource, BufferedSegments, Cache, CacheEventMap, CacheStatus, CacheTaskStatus, CachingTask, CachingTaskEventMap, CachingTaskLicense, CachingTaskList, CachingTaskListEventMap, CachingTaskParameters, CanPlayEvent, CanPlayThroughEvent, Canvas, Cast, CastConfiguration, CastEventMap, CastState, CastStateChangeEvent, CertificateRequest, CertificateResponse, Chromecast, ChromecastConfiguration, ChromecastConnectionCallback, ChromecastError, ChromecastErrorCode, ChromecastErrorEvent, ChromecastEventMap, ChromecastMetadataDescription, ChromecastMetadataImage, ChromecastMetadataType, ChromelessPlayer, ClearkeyDecryptionKey, ClearkeyKeySystemConfiguration, Clip, ClipEventMap, ComcastDRMConfiguration, ComcastIntegrationID, CommonUtils, CompanionAd, ConaxDRMConfiguration, ConaxIntegrationID, ContentProtectionError, ContentProtectionErrorCode, ContentProtectionErrorEvent, ContentProtectionIntegration, ContentProtectionIntegrationFactory, ContentProtectionRequest, ContentProtectionRequestSubType, ContentProtectionResponse, CrossOriginSetting, CsaiAdDescription, CurrentSourceChangeEvent, CustomAdIntegrationKind, CustomTextTrackMap, CustomTextTrackOptions, CustomWebVTTTextTrack, DAIAvailabilityType, DRMConfiguration, DRMTodayDRMConfiguration, DRMTodayIntegrationID, DashPlaybackConfiguration, DateRangeCue, DeliveryType, DeviceBasedTitaniumDRMConfiguration, DimensionChangeEvent, DirectionChangeEvent, DurationChangeEvent, EdgeStyle, EmptiedEvent, EmsgCue, EncryptedEvent, EndedEvent, EnterBadNetworkModeEvent, ErrorCategory, ErrorCode, ErrorEvent, Event, EventDispatcher, EventListener, EventMap, EventStreamCue, EventedList, ExitBadNetworkModeEvent, ExpressPlayDRMConfiguration, ExpressPlayIntegrationID, EzdrmDRMConfiguration, EzdrmIntegrationID, FairPlayKeySystemConfiguration, FreeWheelAdDescription, FreeWheelAdUnitType, FreeWheelCue, FullscreenOptions$1 as FullscreenOptions, Geo, GlobalCast, GlobalChromecast, GoogleDAI, GoogleDAIConfiguration, GoogleDAILiveConfiguration, GoogleDAISSAIIntegrationID, GoogleDAITypedSource, GoogleDAIVodConfiguration, GoogleImaAd, GoogleImaConfiguration, HTTPHeaders, HespApi, HespApiEventMap, HespMediaType, HespSourceConfiguration, HespTypedSource, HlsDiscontinuityAlignment, HlsPlaybackConfiguration, ID3AttachedPicture, ID3BaseFrame, ID3Comments, ID3CommercialFrame, ID3Cue, ID3Frame, ID3GenericEncapsulatedObject, ID3InvolvedPeopleList, ID3PositionSynchronisationFrame, ID3PrivateFrame, ID3SynchronizedLyricsText, ID3TermsOfUse, ID3Text, ID3UniqueFileIdentifier, ID3Unknown, ID3UnsynchronisedLyricsTextTranscription, ID3UrlLink, ID3UserDefinedText, ID3UserDefinedUrlLink, ID3Yospace, IMAAdDescription, Imagine, ImagineEventMap, ImagineSSAIIntegrationID, ImagineServerSideAdInsertionConfiguration, ImagineTrackingEvent, ImagineTypedSource, IntentToFallbackEvent, InterceptableRequest, InterceptableResponse, IrdetoDRMConfiguration, IrdetoIntegrationID, JoinStrategy, KeyOSDRMConfiguration, KeyOSFairplayKeySystemConfiguration, KeyOSIntegrationID, KeyOSKeySystemConfiguration, KeySystemConfiguration, KeySystemId, Latencies, LatencyConfiguration, LatencyManager, LayoutChangeEvent, LicenseRequest, LicenseResponse, LicenseType, LinearAd, List, LoadedDataEvent, LoadedMetadataEvent, MaybeAsync, MeasurableNetworkEstimator, MediaError, MediaErrorCode, MediaFile, MediaMelonConfiguration, MediaTailorSource, MediaTrack, MediaTrackEventMap, MediaTrackList, MediaType, MetadataDescription, Metrics, MillicastSource, MoatAnalyticsIntegrationID, MoatConfiguration, MultiViewPlayer, MultiViewPlayerEventMap, MultiViewPlayerLayout, MutedAutoplayConfiguration, Network, NetworkEstimator, NetworkEstimatorController, NetworkEventMap, NetworkInterceptorController, NodeStyleVoidCallback, NonLinearAd, PauseEvent, PiPConfiguration, PiPPosition, PlayEvent, PlayReadyKeySystemConfiguration, PlayerConfiguration, PlayerEventMap, PlayerList, PlayingEvent, PreloadType, Presentation, PresentationEventMap, PresentationMode, PresentationModeChangeEvent, ProgressEvent, PublicationLoadStartEvent, PublicationLoadedEvent, PublicationOfflineEvent, Quality, QualityEvent, QualityEventMap, QualityList, RateChangeEvent, ReadyStateChangeEvent, RelatedChangeEvent, RelatedContent, RelatedContentEventMap, RelatedContentSource, RelatedHideEvent, RelatedShowEvent, RemoveCachingTaskEvent, RemoveTrackEvent, RemoveViewEvent, Representation, RepresentationChangeEvent, Request, RequestBody, RequestInit, RequestInterceptor, RequestLike, RequestMeasurer, RequestMethod, RequestSubType, RequestType, ResponseBody, ResponseInit, ResponseInterceptor, ResponseLike, ResponseType, RetryConfiguration, SSAIIntegrationId, SeamlessPeriodSwitchStrategy, SeamlessSwitchStrategy, SeekedEvent, SeekingEvent, ServerSideAdInsertionConfiguration, ServerSideAdIntegrationController, ServerSideAdIntegrationFactory, ServerSideAdIntegrationHandler, SkippedAdStrategy, SmartSightConfiguration, SmartSightIntegrationID, Source, SourceAbrConfiguration, SourceChangeEvent, SourceConfiguration, SourceDescription, SourceIntegrationId, SourceLatencyConfiguration, Sources, SpotXAdDescription, SpotxData, SpotxQueryParameter, StateChangeEvent, StereoChangeEvent, StreamOneAnalyticsIntegrationID, StreamOneConfiguration, StreamType, StringKeyOf, StylePropertyRecord, SupportedCustomTextTrackCueTypes, THEOplayerAdDescription, THEOplayerError, TTMLCue, TTMLExtent, TargetQualityChangedEvent, TextTrack, TextTrackAddCueEvent, TextTrackCue, TextTrackCueChangeEvent, TextTrackCueEnterEvent, TextTrackCueEventMap, TextTrackCueExitEvent, TextTrackCueList, TextTrackCueUpdateEvent, TextTrackDescription, TextTrackEnterCueEvent, TextTrackError, TextTrackErrorCode, TextTrackErrorEvent, TextTrackEventMap, TextTrackExitCueEvent, TextTrackReadyState, TextTrackReadyStateChangeEvent, TextTrackRemoveCueEvent, TextTrackStyle, TextTrackStyleEventMap, TextTrackType, TextTrackTypeChangeEvent, TextTrackUpdateCueEvent, TextTracksList, TheoAdDescription, TheoAdsLayoutOverride, TheoLiveApi, TheoLiveApiEventMap, TheoLiveConfiguration, TheoLivePublication, TheoLiveSource, ThumbnailResolution, TimeRanges, TimeUpdateEvent, TitaniumDRMConfiguration, TitaniumIntegrationID, TokenBasedTitaniumDRMConfiguration, Track, TrackChangeEvent, TrackEventMap, TrackList, TrackListEventMap, TrackUpdateEvent, TypedSource, UIConfiguration, UILanguage, UIPlayerConfiguration, UIRelatedContent, UIRelatedContentEventMap, UniversalAdId, UpdateQualityEvent, UplynkDRMConfiguration, UplynkIntegrationID, UserActions, VPAIDMode, VR, VRConfiguration, VRDirection, VREventMap, VRPanoramaMode, VRPlayerConfiguration, VRState, VRStereoMode, VTTAlignSetting, VTTDirectionSetting, VTTLine, VTTLineAlignSetting, VTTPosition, VTTPositionAlignSetting, VTTScrollSetting, VendorCast, VendorCastEventMap, VerimatrixDRMConfiguration, VerimatrixIntegrationID, VerizonMedia, VerizonMediaAd, VerizonMediaAdBeginEvent, VerizonMediaAdBreak, VerizonMediaAdBreakBeginEvent, VerizonMediaAdBreakEndEvent, VerizonMediaAdBreakEventMap, VerizonMediaAdBreakList, VerizonMediaAdBreakListEventMap, VerizonMediaAdBreakSkipEvent, VerizonMediaAdCompleteEvent, VerizonMediaAdEndEvent, VerizonMediaAdEventMap, VerizonMediaAdFirstQuartileEvent, VerizonMediaAdList, VerizonMediaAdListEventMap, VerizonMediaAdMidpointEvent, VerizonMediaAdThirdQuartileEvent, VerizonMediaAddAdBreakEvent, VerizonMediaAddAssetEvent, VerizonMediaAds, VerizonMediaAsset, VerizonMediaAssetEventMap, VerizonMediaAssetId, VerizonMediaAssetInfoResponse, VerizonMediaAssetInfoResponseEvent, VerizonMediaAssetList, VerizonMediaAssetMovieRating, VerizonMediaAssetTvRating, VerizonMediaAssetType, VerizonMediaConfiguration, VerizonMediaEventMap, VerizonMediaExternalId, VerizonMediaPingConfiguration, VerizonMediaPingErrorEvent, VerizonMediaPingResponse, VerizonMediaPingResponseEvent, VerizonMediaPreplayBaseResponse, VerizonMediaPreplayLiveResponse, VerizonMediaPreplayResponse, VerizonMediaPreplayResponseEvent, VerizonMediaPreplayResponseType, VerizonMediaPreplayVodResponse, VerizonMediaRemoveAdBreakEvent, VerizonMediaRemoveAdEvent, VerizonMediaRemoveAssetEvent, VerizonMediaResponseDrm, VerizonMediaResponseLiveAd, VerizonMediaResponseLiveAdBreak, VerizonMediaResponseLiveAds, VerizonMediaResponseVodAd, VerizonMediaResponseVodAdBreak, VerizonMediaResponseVodAdBreakOffset, VerizonMediaResponseVodAdPlaceholder, VerizonMediaResponseVodAds, VerizonMediaSource, VerizonMediaUiConfiguration, VerizonMediaUpdateAdBreakEvent, VideoFrameCallbackMetadata, VideoFrameRequestCallback, VideoQuality, View, ViewChangeEvent, ViewPositionChangeEvent, VimondDRMConfiguration, VimondIntegrationID, Visibility, VisibilityObserver, VisibilityObserverCallback, VoidPromiseCallback, VolumeChangeEvent, VudrmDRMConfiguration, VudrmIntegrationID, WaitUntilCallback, WaitingEvent, WebAudio, WebVTTCue, WebVTTRegion, WidevineKeySystemConfiguration, XstreamDRMConfiguration, XstreamIntegrationID, YospaceId, YouboraAnalyticsIntegrationID, YouboraOptions, cache, cast, features, playerSuiteVersion, players, registerContentProtectionIntegration, utils, version, videojs };
14206
+ export { ABRConfiguration, ABRMetadata, ABRStrategy, ABRStrategyConfiguration, ABRStrategyType, AES128KeySystemConfiguration, AccessibilityRole, Ad, AdBreak, AdBreakEvent, AdBreakInit, AdBreakInterstitial, AdBufferingEvent, AdDescription, AdEvent, AdInit, AdIntegrationKind, AdMetadataEvent, AdPreloadType, AdReadyState, AdSkipEvent, AdSource, AdSourceType, AdType, AddCachingTaskEvent, AddTrackEvent, AddViewEvent, Ads, AdsConfiguration, AdsEventMap, AdsManagerLoadedEvent, AgamaAnalyticsIntegrationID, AgamaConfiguration, AgamaLogLevelType, AgamaPlayerConfiguration, AgamaServiceName, AgamaSourceConfiguration, AgamaStreamType, AirPlay, AnalyticsDescription, AnalyticsIntegrationID, AudioQuality, AxinomDRMConfiguration, AxinomIntegrationID, AzureDRMConfiguration, AzureIntegrationID, Base64Util, BaseSource, Boundary, BoundaryC3, BoundaryC7, BoundaryHalftime, BoundaryInfo, BufferSource, BufferedSegments, Cache, CacheEventMap, CacheStatus, CacheTaskStatus, CachingTask, CachingTaskEventMap, CachingTaskLicense, CachingTaskList, CachingTaskListEventMap, CachingTaskParameters, CanPlayEvent, CanPlayThroughEvent, Canvas, Cast, CastConfiguration, CastEventMap, CastState, CastStateChangeEvent, CertificateRequest, CertificateResponse, Chromecast, ChromecastConfiguration, ChromecastConnectionCallback, ChromecastError, ChromecastErrorCode, ChromecastErrorEvent, ChromecastEventMap, ChromecastMetadataDescription, ChromecastMetadataImage, ChromecastMetadataType, ChromelessPlayer, ClearkeyDecryptionKey, ClearkeyKeySystemConfiguration, Clip, ClipEventMap, ComcastDRMConfiguration, ComcastIntegrationID, CommonUtils, CompanionAd, ConaxDRMConfiguration, ConaxIntegrationID, ContentProtectionError, ContentProtectionErrorCode, ContentProtectionErrorEvent, ContentProtectionIntegration, ContentProtectionIntegrationFactory, ContentProtectionRequest, ContentProtectionRequestSubType, ContentProtectionResponse, CrossOriginSetting, CsaiAdDescription, CurrentSourceChangeEvent, CustomAdIntegrationKind, CustomTextTrackMap, CustomTextTrackOptions, CustomWebVTTTextTrack, DAIAvailabilityType, DRMConfiguration, DRMTodayDRMConfiguration, DRMTodayIntegrationID, DashPlaybackConfiguration, DateRangeCue, DeliveryType, DeviceBasedTitaniumDRMConfiguration, DimensionChangeEvent, DirectionChangeEvent, DurationChangeEvent, EdgeStyle, EmptiedEvent, EmsgCue, EncryptedEvent, EndedEvent, EnterBadNetworkModeEvent, ErrorCategory, ErrorCode, ErrorEvent, Event, EventDispatcher, EventListener, EventMap, EventStreamCue, EventedList, ExitBadNetworkModeEvent, ExpressPlayDRMConfiguration, ExpressPlayIntegrationID, EzdrmDRMConfiguration, EzdrmIntegrationID, FairPlayKeySystemConfiguration, FreeWheelAdDescription, FreeWheelAdUnitType, FreeWheelCue, FullscreenOptions$1 as FullscreenOptions, Geo, GlobalCast, GlobalChromecast, GoogleDAI, GoogleDAIConfiguration, GoogleDAILiveConfiguration, GoogleDAISSAIIntegrationID, GoogleDAITypedSource, GoogleDAIVodConfiguration, GoogleImaAd, GoogleImaConfiguration, HTTPHeaders, HespApi, HespApiEventMap, HespMediaType, HespSourceConfiguration, HespTypedSource, HlsDiscontinuityAlignment, HlsPlaybackConfiguration, ID3AttachedPicture, ID3BaseFrame, ID3Comments, ID3CommercialFrame, ID3Cue, ID3Frame, ID3GenericEncapsulatedObject, ID3InvolvedPeopleList, ID3PositionSynchronisationFrame, ID3PrivateFrame, ID3SynchronizedLyricsText, ID3TermsOfUse, ID3Text, ID3UniqueFileIdentifier, ID3Unknown, ID3UnsynchronisedLyricsTextTranscription, ID3UrlLink, ID3UserDefinedText, ID3UserDefinedUrlLink, ID3Yospace, IMAAdDescription, Imagine, ImagineEventMap, ImagineSSAIIntegrationID, ImagineServerSideAdInsertionConfiguration, ImagineTrackingEvent, ImagineTypedSource, IntentToFallbackEvent, InterceptableRequest, InterceptableResponse, Interstitial, InterstitialEvent, InterstitialType, IrdetoDRMConfiguration, IrdetoIntegrationID, JoinStrategy, KeyOSDRMConfiguration, KeyOSFairplayKeySystemConfiguration, KeyOSIntegrationID, KeyOSKeySystemConfiguration, KeySystemConfiguration, KeySystemId, Latencies, LatencyConfiguration, LatencyManager, LayoutChangeEvent, LegacyTheoAds, LicenseRequest, LicenseResponse, LicenseType, LinearAd, List, LoadedDataEvent, LoadedMetadataEvent, MaybeAsync, MeasurableNetworkEstimator, MediaError, MediaErrorCode, MediaFile, MediaMelonConfiguration, MediaTailorSource, MediaTrack, MediaTrackEventMap, MediaTrackList, MediaType, MetadataDescription, Metrics, MillicastMetadataCue, MillicastSource, MoatAnalyticsIntegrationID, MoatConfiguration, MultiViewPlayer, MultiViewPlayerEventMap, MultiViewPlayerLayout, MutedAutoplayConfiguration, Network, NetworkEstimator, NetworkEstimatorController, NetworkEventMap, NetworkInterceptorController, NodeStyleVoidCallback, NonLinearAd, OverlayInterstitial, OverlayPosition, OverlaySize, PauseEvent, PiPConfiguration, PiPPosition, PlayEvent, PlayReadyKeySystemConfiguration, PlayerConfiguration, PlayerEventMap, PlayerList, PlayingEvent, PreloadType, Presentation, PresentationEventMap, PresentationMode, PresentationModeChangeEvent, ProgressEvent, PublicationLoadStartEvent, PublicationLoadedEvent, PublicationOfflineEvent, Quality, QualityEvent, QualityEventMap, QualityList, RateChangeEvent, ReadyStateChangeEvent, RelatedChangeEvent, RelatedContent, RelatedContentEventMap, RelatedContentSource, RelatedHideEvent, RelatedShowEvent, RemoveCachingTaskEvent, RemoveTrackEvent, RemoveViewEvent, Representation, RepresentationChangeEvent, Request, RequestBody, RequestInit, RequestInterceptor, RequestLike, RequestMeasurer, RequestMethod, RequestSubType, RequestType, ResponseBody, ResponseInit, ResponseInterceptor, ResponseLike, ResponseType, RetryConfiguration, SSAIIntegrationId, SeamlessPeriodSwitchStrategy, SeamlessSwitchStrategy, SeekedEvent, SeekingEvent, ServerSideAdInsertionConfiguration, ServerSideAdIntegrationController, ServerSideAdIntegrationFactory, ServerSideAdIntegrationHandler, SkippedAdStrategy, SmartSightConfiguration, SmartSightIntegrationID, Source, SourceAbrConfiguration, SourceChangeEvent, SourceConfiguration, SourceDescription, SourceIntegrationId, SourceLatencyConfiguration, Sources, SpotXAdDescription, SpotxData, SpotxQueryParameter, StateChangeEvent, StereoChangeEvent, StreamOneAnalyticsIntegrationID, StreamOneConfiguration, StreamType, StringKeyOf, StylePropertyRecord, SupportedCustomTextTrackCueTypes, THEOplayerAdDescription, THEOplayerError, TTMLCue, TTMLExtent, TargetQualityChangedEvent, TextTrack, TextTrackAddCueEvent, TextTrackCue, TextTrackCueChangeEvent, TextTrackCueEnterEvent, TextTrackCueEventMap, TextTrackCueExitEvent, TextTrackCueList, TextTrackCueUpdateEvent, TextTrackDescription, TextTrackEnterCueEvent, TextTrackError, TextTrackErrorCode, TextTrackErrorEvent, TextTrackEventMap, TextTrackExitCueEvent, TextTrackReadyState, TextTrackReadyStateChangeEvent, TextTrackRemoveCueEvent, TextTrackStyle, TextTrackStyleEventMap, TextTrackType, TextTrackTypeChangeEvent, TextTrackUpdateCueEvent, TextTracksList, TheoAdDescription, TheoAds, TheoAdsEventsMap, TheoAdsLayout, TheoAdsLayoutOverride, TheoLiveApi, TheoLiveApiEventMap, TheoLiveConfiguration, TheoLivePublication, TheoLiveSource, ThumbnailResolution, TimeRanges, TimeUpdateEvent, TitaniumDRMConfiguration, TitaniumIntegrationID, TokenBasedTitaniumDRMConfiguration, Track, TrackChangeEvent, TrackEventMap, TrackList, TrackListEventMap, TrackUpdateEvent, TypedSource, UIConfiguration, UILanguage, UIPlayerConfiguration, UIRelatedContent, UIRelatedContentEventMap, UniversalAdId, UpdateQualityEvent, Uplynk, UplynkAd, UplynkAdBeginEvent, UplynkAdBreak, UplynkAdBreakBeginEvent, UplynkAdBreakEndEvent, UplynkAdBreakEventMap, UplynkAdBreakList, UplynkAdBreakListEventMap, UplynkAdBreakSkipEvent, UplynkAdCompleteEvent, UplynkAdEndEvent, UplynkAdEventMap, UplynkAdFirstQuartileEvent, UplynkAdList, UplynkAdListEventMap, UplynkAdMidpointEvent, UplynkAdThirdQuartileEvent, UplynkAddAdBreakEvent, UplynkAddAssetEvent, UplynkAds, UplynkAsset, UplynkAssetEventMap, UplynkAssetId, UplynkAssetInfoResponse, UplynkAssetInfoResponseEvent, UplynkAssetList, UplynkAssetMovieRating, UplynkAssetTvRating, UplynkAssetType, UplynkConfiguration, UplynkDRMConfiguration, UplynkEventMap, UplynkExternalId, UplynkIntegrationID, UplynkPingConfiguration, UplynkPingErrorEvent, UplynkPingResponse, UplynkPingResponseEvent, UplynkPreplayBaseResponse, UplynkPreplayLiveResponse, UplynkPreplayResponse, UplynkPreplayResponseEvent, UplynkPreplayResponseType, UplynkPreplayVodResponse, UplynkRemoveAdBreakEvent, UplynkRemoveAdEvent, UplynkRemoveAssetEvent, UplynkResponseDrm, UplynkResponseLiveAd, UplynkResponseLiveAdBreak, UplynkResponseLiveAds, UplynkResponseVodAd, UplynkResponseVodAdBreak, UplynkResponseVodAdBreakOffset, UplynkResponseVodAdPlaceholder, UplynkResponseVodAds, UplynkSource, UplynkUiConfiguration, UplynkUpdateAdBreakEvent, UserActions, VPAIDMode, VR, VRConfiguration, VRDirection, VREventMap, VRPanoramaMode, VRPlayerConfiguration, VRState, VRStereoMode, VTTAlignSetting, VTTDirectionSetting, VTTLine, VTTLineAlignSetting, VTTPosition, VTTPositionAlignSetting, VTTScrollSetting, VendorCast, VendorCastEventMap, VerimatrixDRMConfiguration, VerimatrixIntegrationID, VerizonMedia, VerizonMediaAd, VerizonMediaAdBeginEvent, VerizonMediaAdBreak, VerizonMediaAdBreakBeginEvent, VerizonMediaAdBreakEndEvent, VerizonMediaAdBreakEventMap, VerizonMediaAdBreakList, VerizonMediaAdBreakListEventMap, VerizonMediaAdBreakSkipEvent, VerizonMediaAdCompleteEvent, VerizonMediaAdEndEvent, VerizonMediaAdEventMap, VerizonMediaAdFirstQuartileEvent, VerizonMediaAdList, VerizonMediaAdListEventMap, VerizonMediaAdMidpointEvent, VerizonMediaAdThirdQuartileEvent, VerizonMediaAddAdBreakEvent, VerizonMediaAddAssetEvent, VerizonMediaAds, VerizonMediaAsset, VerizonMediaAssetEventMap, VerizonMediaAssetId, VerizonMediaAssetInfoResponse, VerizonMediaAssetInfoResponseEvent, VerizonMediaAssetList, VerizonMediaAssetMovieRating, VerizonMediaAssetTvRating, VerizonMediaAssetType, VerizonMediaConfiguration, VerizonMediaEventMap, VerizonMediaExternalId, VerizonMediaPingConfiguration, VerizonMediaPingErrorEvent, VerizonMediaPingResponse, VerizonMediaPingResponseEvent, VerizonMediaPreplayBaseResponse, VerizonMediaPreplayLiveResponse, VerizonMediaPreplayResponse, VerizonMediaPreplayResponseEvent, VerizonMediaPreplayResponseType, VerizonMediaPreplayVodResponse, VerizonMediaRemoveAdBreakEvent, VerizonMediaRemoveAdEvent, VerizonMediaRemoveAssetEvent, VerizonMediaResponseDrm, VerizonMediaResponseLiveAd, VerizonMediaResponseLiveAdBreak, VerizonMediaResponseLiveAds, VerizonMediaResponseVodAd, VerizonMediaResponseVodAdBreak, VerizonMediaResponseVodAdBreakOffset, VerizonMediaResponseVodAdPlaceholder, VerizonMediaResponseVodAds, VerizonMediaSource, VerizonMediaUiConfiguration, VerizonMediaUpdateAdBreakEvent, VideoFrameCallbackMetadata, VideoFrameRequestCallback, VideoQuality, View, ViewChangeEvent, ViewPositionChangeEvent, VimondDRMConfiguration, VimondIntegrationID, Visibility, VisibilityObserver, VisibilityObserverCallback, VoidPromiseCallback, VolumeChangeEvent, VudrmDRMConfiguration, VudrmIntegrationID, WaitUntilCallback, WaitingEvent, WebAudio, WebVTTCue, WebVTTRegion, WidevineKeySystemConfiguration, XstreamDRMConfiguration, XstreamIntegrationID, YospaceId, YouboraAnalyticsIntegrationID, YouboraOptions, cache, cast, features, playerSuiteVersion, players, registerContentProtectionIntegration, utils, version, videojs };