@theoplayer/extended 4.6.0 → 4.8.0

package/THEOplayer.d.ts

@@ -2,7 +2,7 @@
  * THEOplayer
  * https://www.theoplayer.com
  *
- * Version: 2023.1.0 (4.6.0)
+ * Version: 2023.1.2 (4.8.0)
  */
 
 /**
@@ -121,6 +121,7 @@ export declare interface Ad {
      * <br/> - `'google-ima'`
      * <br/> - `'google-dai'`
      * <br/> - `'freewheel'`
+     * <br/> - `'mediatailor'`
      *
      * @defaultValue `'theo'`
      */
@@ -172,7 +173,7 @@ export declare interface Ad {
      */
     height: number | undefined;
     /**
-     * The URI of the the ad content.
+     * The URI of the ad content.
      *
      * @remarks
      * <br/> - Available when the {@link Ad.readyState} is `'ready'`.
@@ -231,6 +232,7 @@ export declare interface AdBreak {
      * <br/> - `'google-ima'`
      * <br/> - `'google-dai'`
      * <br/> - `'freewheel'`
+     * <br/> - `'mediatailor'`
      */
     integration: string | undefined;
     /**
@@ -1168,7 +1170,7 @@ export declare interface BufferedSegments {
 
 /**
  * Helper type that represents either an ArrayBuffer or an ArrayBufferView.
- * Inspired by https://developer.mozilla.org/en-US/docs/Web/API/BufferSource.
+ * Inspired by {@link https://webidl.spec.whatwg.org/#common-BufferSource}.
  *
  * @public
  */
@@ -1275,7 +1277,7 @@ export declare interface CachingTask extends EventDispatcher<CachingTaskEventMap
     /**
      * The time ranges cached.
      */
-    readonly cached: NativeTimeRanges;
+    readonly cached: TimeRanges_2;
     /**
      * The duration cached, in seconds.
      */
@@ -1919,7 +1921,7 @@ export declare class ChromelessPlayer implements EventDispatcher<PlayerEventMap>
     /**
      * Returns a TimeRanges object that represents the ranges of the media resource that the player has buffered.
      */
-    readonly buffered: TimeRanges;
+    readonly buffered: TimeRanges_2;
     /**
      * The clip API.
      */
@@ -2020,7 +2022,7 @@ export declare class ChromelessPlayer implements EventDispatcher<PlayerEventMap>
     /**
      * Returns a TimeRanges object that represents the ranges of the media resource that the player has played.
      */
-    played: TimeRanges;
+    played: TimeRanges_2;
     /**
      * The poster of the current source.
      *
@@ -2051,7 +2053,7 @@ export declare class ChromelessPlayer implements EventDispatcher<PlayerEventMap>
      * @remarks
      * <br/> - On source change, seekable becomes available after {@link ChromelessPlayer.readyState} is at least `1`.
      */
-    seekable: TimeRanges;
+    seekable: TimeRanges_2;
     /**
      * Whether the player is seeking.
      */
@@ -3141,7 +3143,7 @@ export declare interface DRMConfiguration {
         [parameterName: string]: any;
     };
     /**
-     * An ordered list of URNs of key systems as specified by https://dashif.org/identifiers/content_protection/, or one of the following identifiers:
+     * An ordered list of URNs of key systems as specified by {@link https://dashif.org/identifiers/content_protection/}, or one of the following identifiers:
      *
      * `"widevine"` alias for `"urn:uuid:edef8ba9-79d6-4ace-a3c8-27dcd51d21ed"`
      * `"fairplay"` alias for `"urn:uuid:94ce86fb-07bb-4b43-adb8-93d2fa968ca2"`
@@ -5861,7 +5863,7 @@ export declare class MultiViewPlayer implements EventDispatcher<MultiViewPlayerE
     /**
      * Returns a TimeRanges object that represents the intersection of all buffered properties of the underlying players.
      */
-    readonly buffered: TimeRanges;
+    readonly buffered: TimeRanges_2;
     /**
      * The current playback position of the player currently at position zero.
      */
@@ -5901,7 +5903,7 @@ export declare class MultiViewPlayer implements EventDispatcher<MultiViewPlayerE
     /**
      * Returns the intersection of all played properties of the underlying players.
      */
-    readonly played: TimeRanges;
+    readonly played: TimeRanges_2;
     /**
      * Returns the minimum of all readyState properties of the underlying players.
      */
@@ -5909,7 +5911,7 @@ export declare class MultiViewPlayer implements EventDispatcher<MultiViewPlayerE
     /**
      * Returns the intersection of all seekable properties of the underlying players.
      */
-    readonly seekable: TimeRanges;
+    readonly seekable: TimeRanges_2;
     /**
      * Whether any of the underlying players is seeking.
      */
@@ -6130,12 +6132,6 @@ export declare enum MultiViewPlayerLayout {
  */
 export declare type MutedAutoplayConfiguration = 'none' | 'all' | 'content';
 
-declare interface NativeTimeRanges {
-    readonly length: number;
-    start(index: number): number;
-    end(index: number): number;
-}
-
 /**
  * The network API.
  *
@@ -6680,7 +6676,7 @@ export declare interface PlayerEventMap {
      */
     error: ErrorEvent_2;
     /**
-     * Fired when the the player is destroyed.
+     * Fired when the player is destroyed.
      *
      * @remarks
      * <br/> - Available since v2.33.3.
@@ -8739,6 +8735,32 @@ export declare interface ThumbnailResolution {
     height?: number;
 }
 
+/**
+ * Represents one or more ranges of time, each specified by a start time and an end time.
+ *
+ * @remarks
+ * This is equivalent to the {@link https://developer.mozilla.org/en-US/docs/Web/API/TimeRanges | TimeRanges} interface used by an HTML video element.
+ *
+ * @public
+ */
+declare interface TimeRanges_2 {
+    /** Returns the number of ranges in the object. */
+    readonly length: number;
+    /**
+     * Returns the time for the start of the range with the given index.
+     *
+     * @throws Throws an Error if the index is out of bounds.
+     */
+    start(index: number): number;
+    /**
+     * Returns the time for the end of the range with the given index.
+     *
+     * @throws Throws an Error if the index is out of bounds.
+     */
+    end(index: number): number;
+}
+export { TimeRanges_2 as TimeRanges }
+
 /**
  * Fired when the current playback position changed as part of normal playback or in an especially interesting way, for example discontinuously.
  *
@@ -10520,7 +10542,7 @@ export declare interface VerizonMediaPreplayLiveResponse extends VerizonMediaPre
     /**
      * The response type of the request.
      */
-    type: VerizonMediaPreplayResponseType.LIVE;
+    type: 'live';
 }
 
 /**
@@ -10549,10 +10571,7 @@ export declare interface VerizonMediaPreplayResponseEvent extends Event_2<'prepl
  *
  * @public
  */
-export declare enum VerizonMediaPreplayResponseType {
-    VOD = "vod",
-    LIVE = "live"
-}
+export declare type VerizonMediaPreplayResponseType = 'vod' | 'live';
 
 /**
  * Represents a Verizon Media Preplay response for VOD assets.
@@ -10563,7 +10582,7 @@ export declare interface VerizonMediaPreplayVodResponse extends VerizonMediaPrep
     /**
      * The response type of the request.
      */
-    type: VerizonMediaPreplayResponseType.VOD;
+    type: 'vod';
     /**
      * The advertisement information.
      */
@@ -11866,8 +11885,6 @@ export declare interface Yospace extends EventDispatcher<YospaceEventMap> {
     /**
      * The Yospace session.
      *
-     * @remarks
-     * <br/> - For the full API of this object, see {@link http://demo.yospace.com/SDK/javascript/docs/classes/YSSession.html | YSSession Class - Yospace JavaScript AdManagement SDK} for more information and examples
      */
     readonly session: object;
     /**
@@ -11886,7 +11903,6 @@ export declare interface Yospace extends EventDispatcher<YospaceEventMap> {
  *
  * @remarks
  * <br/> - These callbacks will be used by the Yospace SDK to provide feedback to the player.
- * <br/> - See {@link http://demo.yospace.com/SDK/javascript/docs/classes/YSSessionManager.html#method_registerPlayer | YSSessionManager Class - Yospace JavaScript AdManagement SDK} for more information and examples
  *
  * @public
  */