@theoplayer/extended 4.3.1 → 4.5.0

package/THEOplayer.d.ts

@@ -2,7 +2,7 @@
  * THEOplayer
  * https://www.theoplayer.com
  *
- * Version: 2022.4.1 (4.3.1)
+ * Version: 2022.4.3 (4.5.0)
  */
 
 /**
@@ -102,23 +102,6 @@ export declare interface ABRStrategyConfiguration {
  */
 export declare type ABRStrategyType = 'performance' | 'quality' | 'bandwidth';
 
-/**
- * @public
- */
-export declare interface ActiveTrackInfoLabel extends MetricLabel {
-    readonly audioSwitchingSetId: string;
-    readonly audioTrackId: string;
-    readonly videoSwitchingSetId: string;
-    readonly videoTrackId: string;
-}
-
-/**
- * @public
- */
-export declare interface ActiveTrackLabeledMetric extends Metric {
-    readonly labelData: ActiveTrackInfoLabel;
-}
-
 /**
  * Represents a VAST creative. It is either a linear or non-linear ad.
  *
@@ -528,7 +511,10 @@ export declare interface AdsConfiguration {
      * @defaultValue `'enabled'`
      */
     vpaidMode?: VPAIDMode;
-
+    /**
+     * The Google IMA configuration.
+     */
+    googleIma?: GoogleImaConfiguration;
 }
 
 /**
@@ -869,32 +855,6 @@ export declare type AgamaStreamType = 'live' | 'vod';
 export declare interface AirPlay extends VendorCast {
 }
 
-/**
- * @public
- */
-export declare type Analytic = AnalyticMap[keyof AnalyticMap];
-
-/**
- * @public
- */
-export declare interface AnalyticBase<N extends AnalyticType, V> {
-    readonly name: N;
-    readonly value: V;
-    readonly unit: string;
-    readonly description: string;
-}
-
-/**
- * @public
- */
-export declare interface AnalyticMap {
-    [AnalyticType.LIVE_OFFSET]: AnalyticBase<AnalyticType.LIVE_OFFSET, number>;
-    [AnalyticType.TRACK_BYTES_DOWNLOADED]: AnalyticBase<AnalyticType.TRACK_BYTES_DOWNLOADED, TrackBytesDownloadedData>;
-    [AnalyticType.ESTIMATED_TRACK_NETWORK_BANDWIDTH]: AnalyticBase<AnalyticType.ESTIMATED_TRACK_NETWORK_BANDWIDTH, number>;
-    [AnalyticType.ESTIMATED_TRACK_MEDIA_DATA_BANDWIDTH]: AnalyticBase<AnalyticType.ESTIMATED_TRACK_MEDIA_DATA_BANDWIDTH, number>;
-    [AnalyticType.SEGMENT_RECEIVE_INTERVAL]: AnalyticBase<AnalyticType.SEGMENT_RECEIVE_INTERVAL, SegmentReceiveIntervalData>;
-}
-
 /**
  * The analytics API.
  *
@@ -935,17 +895,6 @@ export declare interface AnalyticsDescription {
  */
 export declare type AnalyticsIntegrationID = 'agama' | 'conviva' | 'youbora' | 'moat' | 'streamone' | 'smartsight';
 
-/**
- * @public
- */
-export declare enum AnalyticType {
-    LIVE_OFFSET = "liveoffset",
-    TRACK_BYTES_DOWNLOADED = "trackbytesdownloaded",
-    ESTIMATED_TRACK_NETWORK_BANDWIDTH = "estimatedtracknetworkbandwidth",
-    ESTIMATED_TRACK_MEDIA_DATA_BANDWIDTH = "estimatedtrackmediadatabandwidth",
-    SEGMENT_RECEIVE_INTERVAL = "segmentreceiveinterval"
-}
-
 /**
  * Represents a quality of an audio track.
  *
@@ -1151,13 +1100,6 @@ export declare interface BaseSource {
     lcevc?: boolean;
 }
 
-/**
- * @public
- */
-export declare interface BaseUriLabel extends MetricLabel {
-    baseUri: string;
-}
-
 /**
  * A boundary can be one of 3 possible types:
  * <br/> - c3: An ad that is relevant for up to 3 days after the original airing.
@@ -3035,13 +2977,6 @@ export declare interface DashPlaybackConfiguration {
     needsTimescaleShifting?: boolean | null;
 }
 
-/**
- * @public
- */
-export declare interface DataEvent<TType extends string, DataType> extends Event_2<TType> {
-    readonly data: DataType;
-}
-
 /**
  * Represents a cue of a HLS date range metadata text track.
  *
@@ -3610,11 +3545,6 @@ declare interface ErrorEvent_2 extends Event_2<'error'> {
 }
 export { ErrorEvent_2 as ErrorEvent }
 
-/**
- * @public
- */
-export declare type ErrorType = string;
-
 /**
  * Fired when an event occurs.
  *
@@ -3777,21 +3707,6 @@ export declare interface FairPlayKeySystemConfiguration extends KeySystemConfigu
  */
 export declare const features: string;
 
-/**
- * @public
- */
-export declare interface FirstResponseLabel extends MetricLabel {
-    readonly uri: string;
-    readonly type: HespRequestType;
-}
-
-/**
- * @public
- */
-export declare interface FirstResponseMetric extends Metric {
-    labelData: FirstResponseLabel;
-}
-
 /**
  * Describes a FreeWheel ad break request.
  *
@@ -3982,6 +3897,12 @@ export declare interface GoogleDAI {
      * @param time - The content time without any ads (in seconds).
      */
     streamTimeForContentTime(time: number): number;
+    /**
+     * Replaces all the ad tag parameters used for upcoming ad requests for a live stream.
+     *
+     * @param adTagParameters - The new ad tag parameters.
+     */
+    replaceAdTagParameters(adTagParameters?: Record<string, string>): void;
     /**
      * Whether snapback is enabled. When enabled and the user seeks over multiple ad breaks, the last ad break that was seeked past will be played.
      */
@@ -4041,6 +3962,10 @@ export declare interface GoogleDAIConfiguration extends ServerSideAdInsertionCon
      * The identifier for a stream activity monitor session.
      */
     streamActivityMonitorID?: string;
+    /**
+     * Optional settings object for mapping verification vendors (google.ima.OmidVerificationVendor) to OMID Access Modes (google.ima.OmidAccessMode).
+     */
+    omidAccessModeRules?: Record<number, string>;
 }
 
 /**
@@ -4196,6 +4121,25 @@ export declare interface GoogleImaAd extends Ad {
     apiFramework: string | undefined;
 }
 
+/**
+ * Describes the configuration of Google IMA.
+ *
+ * @public
+ */
+export declare interface GoogleImaConfiguration {
+
+    /**
+     * The maximum recommended bitrate in kbit/s. Ads with a bitrate below the specified maximum will be picked.
+     *
+     * @remarks
+     * <br/> - When set to -1, it will select the ad with the highest bitrate.
+     * <br/> - If there is no ad below the specified maximum, the ad closest to the bitrate will be picked.
+     *
+     * @defaultValue -1
+     */
+    bitrate?: number;
+}
+
 /**
  * The HESP API.
  * @remarks
@@ -4240,12 +4184,6 @@ export declare interface HespApi extends EventDispatcher<HespApiEventMap> {
      * <br/> - Undefined if no HESP source is configured.
      */
     readonly manifest: Object | undefined;
-    /**
-     * A HespMetricsApi object which gives player metrics.
-     * @remarks
-     * <br/> - Undefined if no HESP source is configured.
-     */
-    readonly metrics: HespMetricsApi | undefined;
 }
 
 /**
@@ -4258,22 +4196,10 @@ export declare interface HespApi extends EventDispatcher<HespApiEventMap> {
  * @public
  */
 export declare interface HespApiEventMap {
-    /**
-     * Fired when a new analytic sample is available.
-     */
-    analytic: DataEvent<'analytic', Analytic>;
     /**
      * Fired when the player enters the HESP live playback mode.
      */
     golive: Event_2<'golive'>;
-    /**
-     * Fired when the player exits the HESP live playback mode, e.g. when going into DVR playback mode.
-     */
-    nogolive: Event_2<'nogolive'>;
-    /**
-     * Fired whenever the player buffer changes.
-     */
-    bufferedchange: Event_2<'bufferedchange'>;
 }
 
 /**
@@ -4313,66 +4239,6 @@ export declare interface HespLatencyConfiguration {
  */
 export declare type HespMediaType = 'audio' | 'video' | 'metadata';
 
-/**
- * HESP metrics.
- * @remarks
- * <br/> - Note: This API is in an experimental stage and may be subject to breaking changes.
- * <br/> - Only available with the feature `'hesp'`.
- * <br/> - Only applies to HESP streams.
- *
- * @public
- */
-export declare interface HespMetricMap {
-    totalTimePlayed: TotalTimePlayedMetric;
-    totalTimeStalled: ActiveTrackLabeledMetric;
-    totalTimePaused: UnlabeledMetric;
-    numberOfStalls: UnlabeledMetric;
-    numberOfWifiSleeps: UnlabeledMetric;
-    numberOfPlayPauseToggle: UnlabeledMetric;
-    numberOfAbrChanges: QualityChangeMetric;
-    qualityActive: ActiveTrackLabeledMetric;
-    numberOfErrors: TypedMetric<ErrorType>;
-    numberOfLiveSeeks: UnlabeledMetric;
-    totalTimeSeeking: TypedMetric<SeekReason>;
-    droppedVideoFrames: ActiveTrackLabeledMetric;
-    totalVideoFrames: ActiveTrackLabeledMetric;
-    timeToFirstFrame: UnlabeledMetric;
-    timeToFirstResponse: FirstResponseMetric;
-    timeToGoLive: HistogramMetric;
-    numberOfImpressions: StreamLabeledMetric;
-    numberOfRateChanges: UnlabeledMetric;
-    segmentIntervals: HistogramTrackLabeledMetric;
-}
-
-/**
- * The names of HESP metrics.
- * @remarks
- * <br/> - Note: This API is in an experimental stage and may be subject to breaking changes.
- * <br/> - Only available with the feature `'hesp'`.
- * <br/> - Only applies to HESP streams.
- *
- * @public
- */
-export declare type HespMetricName = StringKeyOf<HespMetricMap>;
-
-/**
- * An object with {@link HespMetricName} as key and {@link Metric} as value.
- * @remarks
- * <br/> - Note: This API is in an experimental stage and may be subject to breaking changes.
- * <br/> - Only available with the feature `'hesp'`.
- * <br/> - Only applies to HESP streams.
- *
- * @public
- */
-export declare type HespMetricsApi = {
-    readonly [name in HespMetricName]: Array<HespMetricMap[name]>;
-};
-
-/**
- * @public
- */
-export declare type HespRequestType = 'manifest' | 'stream' | 'keyframe';
-
 /**
  * Specific source configuration for an HESP media resource.
  * @remarks
@@ -4406,28 +4272,6 @@ export declare interface HespTypedSource extends TypedSource {
     hesp?: HespSourceConfiguration;
 }
 
-/**
- * @public
- */
-export declare interface HistogramLabel extends MetricLabel {
-    readonly upperBound: number;
-    readonly lowerBound: number;
-}
-
-/**
- * @public
- */
-export declare interface HistogramMetric extends Metric {
-    readonly labelData: HistogramLabel;
-}
-
-/**
- * @public
- */
-export declare interface HistogramTrackLabeledMetric extends Metric {
-    readonly labelData: HistogramLabel & TrackInfoLabel;
-}
-
 /**
  * The strategy for aligning HLS discontinuities, represented by a value from the following list:
  * <br/> - `'playlist'`: The first segment after a discontinuity is aligned with the segment's start time according to the HLS playlist,
@@ -4967,9 +4811,7 @@ export declare interface IMAAdDescription extends AdDescription {
     /**
      * Optional settings object for mapping verification vendors (google.ima.OmidVerificationVendor) to OMID Access Modes (google.ima.OmidAccessMode).
      */
-    omidAccessModeRules?: {
-        [key: number]: string;
-    };
+    omidAccessModeRules?: Record<number, string>;
 }
 
 /**
@@ -5297,13 +5139,6 @@ export declare type IrdetoIntegrationID = 'irdeto';
  */
 export declare type JoinStrategy = 'auto' | 'manual' | 'disabled';
 
-/**
- * @public
- */
-export declare interface KeyFrameLabel extends MetricLabel {
-    readonly keyFrame: boolean;
-}
-
 /**
  * Describes the configuration of the KeyOS DRM integration
  *
@@ -5938,31 +5773,6 @@ export declare interface MetadataDescription {
     readonly title?: string;
 }
 
-/**
- * @public
- */
-export declare interface Metric<MN extends HespMetricName = HespMetricName> {
-    /**
-     * A metric name which will be one of {@link HespMetricName}.
-     */
-    readonly name: MN;
-    /**
-     * The value of metric.
-     */
-    readonly value: number;
-    /**
-     * A label data as an additional information of Metric.
-     */
-    readonly labelData: MetricLabel;
-}
-
-/**
- * @public
- */
-export declare interface MetricLabel {
-    [key: string]: string | number | boolean;
-}
-
 /**
  * The metrics API which can be used to gather information related to the quality-of-service and video playback experience.
  *
@@ -6520,13 +6330,6 @@ export declare interface PiPConfiguration {
  */
 export declare type PiPPosition = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
 
-/**
- * @public
- */
-export declare interface PlayBackRateLabel {
-    readonly playbackRate: number;
-}
-
 /**
  * The player API extended with UI functionality.
  *
@@ -7093,18 +6896,6 @@ export declare interface Quality extends EventDispatcher<QualityEventMap> {
     readonly available: boolean;
 }
 
-/**
- * @public
- */
-export declare interface QualityChangeMetric extends Metric {
-    labelData: ReasonLabel;
-}
-
-/**
- * @public
- */
-export declare type QualityChangeReason = 'automatic' | 'manual';
-
 /**
  * An quality-related event fired by a {@link MediaTrack}.
  *
@@ -7176,13 +6967,6 @@ export declare interface ReadyStateChangeEvent extends Event_2<'readystatechange
     readonly readyState: number;
 }
 
-/**
- * @public
- */
-export declare interface ReasonLabel extends MetricLabel {
-    reason: QualityChangeReason;
-}
-
 /**
  * Register a content protection integration
  *
@@ -7668,10 +7452,18 @@ export { ResponseType_2 as ResponseType }
  * <br/> - `'always'`: The player always uses a seamless switch, and never uses a hard switch.
  *                     Use this if you notice that the player never preloads the next period, even though you know that the current platform
  *                     should support it.
+ * <br/> - `'clear-only'`: The player only uses a seamless switch when no content protection is used in the current and next period. Otherwise
+ *                      it always uses a hard switch.
+ *                      Use this if you notice that the player is attempting but failing to preload the next period on the current platform only when
+ *                      content protection is involved.
+ * <br/> - `'same-drm-only'`: The player only uses a seamless switch when the same or no content protection is used in the current and next period. Otherwise
+ *                      it always uses a hard switch.
+ *                      Use this if you notice that the player is attempting but failing to preload the next period on the current platform only when
+ *                      content protection is different between periods.
  *
  * @public
  */
-export declare type SeamlessPeriodSwitchStrategy = 'auto' | 'always' | 'never';
+export declare type SeamlessPeriodSwitchStrategy = 'auto' | 'always' | 'never' | 'clear-only' | 'same-drm-only';
 
 /**
  * Fired when `ChromelessPlayer.seeking` changes to `false` after the current playback position was changed.
@@ -7697,19 +7489,6 @@ export declare interface SeekingEvent extends Event_2<'seeking'> {
     readonly currentTime: number;
 }
 
-/**
- * @public
- */
-export declare type SeekReason = 'user' | 'golive' | 'init';
-
-/**
- * @public
- */
-export declare interface SegmentReceiveIntervalData {
-    time: number;
-    mediaType: HespMediaType;
-}
-
 /**
  * Represents a configuration for server-side ad insertion (SSAI).
  *
@@ -8188,13 +7967,6 @@ export declare type StateChangeEvent = Event_2<'statechange'>;
  */
 export declare type StereoChangeEvent = Event_2<'stereochange'>;
 
-/**
- * @public
- */
-export declare interface StreamLabeledMetric extends Metric {
-    readonly labelData: BaseUriLabel;
-}
-
 /**
  * The identifier of the Stream One integration.
  *
@@ -9097,13 +8869,6 @@ export declare interface TokenBasedTitaniumDRMConfiguration extends TitaniumDRMC
     authToken: string;
 }
 
-/**
- * @public
- */
-export declare interface TotalTimePlayedMetric extends ActiveTrackLabeledMetric {
-    readonly labelData: ActiveTrackInfoLabel & MetricLabel & PlayBackRateLabel;
-}
-
 /**
  * Represents a track of a media resource.
  *
@@ -9145,15 +8910,6 @@ export declare interface Track extends EventDispatcher<TrackEventMap> {
     language: string;
 }
 
-/**
- * @public
- */
-export declare interface TrackBytesDownloadedData {
-    date: Date;
-    newBytes: number;
-    trackInfo: TrackInfoLabel;
-}
-
 /**
  * Fired when a track has been changed.
  *
@@ -9185,15 +8941,6 @@ export declare interface TrackEventMap {
     update: TrackUpdateEvent;
 }
 
-/**
- * @public
- */
-export declare interface TrackInfoLabel extends MetricLabel {
-    readonly mediaType: HespMediaType;
-    readonly switchingSetId: string;
-    readonly trackId: string;
-}
-
 /**
  * List of tracks.
  *
@@ -9278,13 +9025,6 @@ export declare interface TTMLCue extends TextTrackCue_2 {
     metadata: any;
 }
 
-/**
- * @public
- */
-export declare interface TypedMetric<T extends string> extends Metric {
-    labelData: TypeLabel<T>;
-}
-
 /**
  * Represents a media resource characterized by a URL to the resource and optionally information about the resource.
  *
@@ -9333,13 +9073,6 @@ export declare interface TypedSource extends BaseSource {
 
 }
 
-/**
- * @public
- */
-export declare interface TypeLabel<T extends string> extends MetricLabel {
-    type: T;
-}
-
 /**
  * Describes the UI configuration of the player.
  *
@@ -9536,13 +9269,6 @@ export declare interface UniversalAdId {
     adIdValue: string;
 }
 
-/**
- * @public
- */
-export declare interface UnlabeledMetric extends Metric {
-    readonly labelData: Exclude<{}, MetricLabel>;
-}
-
 /**
  * Fired when the quality updates.
  *