@amazon/vinyl 1.1.1 → 2.0.0

package/dist/types/current/track/TrackBase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TrackBase.d.ts","sourceRoot":"","sources":["../../../../src/track/TrackBase.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAE5D,OAAO,EAIH,aAAa,EAGb,KAAK,KAAK,EAEV,KAAK,cAAc,EACnB,KAAK,WAAW,EACnB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,KAAK,EACR,KAAK,EACL,aAAa,EACb,mBAAmB,EACnB,WAAW,EACX,QAAQ,EACX,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACxD,OAAO,KAAK,EACR,WAAW,EACX,oBAAoB,EACvB,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,KAAK,UAAU,EAAuB,MAAM,kBAAkB,CAAA;AAEvE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAA;IAE/C;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAA;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IAElC;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,GAAG,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;CACrC;AAED,eAAO,MAAM,yBAAyB,EAAE,YAAY,CAAC,gBAAgB,CAMpE,CAAA;AAED;;GAEG;AACH,8BAAsB,SAAS,CAC3B,QAAQ,SAAS,aAAa,GAAG,aAAa,EAC9C,eAAe,SAAS,gBAAgB,GAAG,gBAAgB,CAE3D,SAAQ,aAAa,CAAC,QAAQ,CAC9B,YAAW,KAAK,CAAC,eAAe,CAAC;IAmD7B;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,QAAQ;IAEtB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,WAAW;IAE1B,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa;IA3D1C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI,CAAO;IAEpD,SAAS,CAAC,QAAQ,CAAC,YAAY,GAAI,OAAO,GAAG,KAAG,IAAI,CASnD;IACD,SAAS,CAAC,QAAQ,CAAC,QAAQ,wCAAmB;IAC9C,SAAS,CAAC,eAAe,yCAAoB;IAE7C,IAAI,aAAa,IAAI,cAAc,CAElC;IAED,QAAQ,KAAK,YAAY,IAAI,WAAW,CAAC,WAAW,CAAC,CAAA;IAErD,QAAQ,KAAK,SAAS,IAAI,SAAS,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAChE,QAAQ,KAAK,mBAAmB,IAAI,SAAS,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAE1E,QAAQ,CAAC,mBAAmB,CACxB,WAAW,EAAE,WAAW,GACzB,oBAAoB,GAAG,IAAI;IAC9B,QAAQ,CAAC,mBAAmB,CACxB,WAAW,EAAE,WAAW,GACzB,oBAAoB,GAAG,IAAI;IAC9B,QAAQ,CAAC,kBAAkB,CACvB,WAAW,EAAE,WAAW,GACzB,oBAAoB,GAAG,IAAI;IAE9B;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,KAAK,GAAG,IAAI,CAAO;IAErC,OAAO,CAAC,OAAO,CAAQ;IAEvB,SAAS;IACL;;OAEG;IACM,GAAG,EAAE,QAAQ;IAEtB;;OAEG;IACM,IAAI,EAAE,WAAW,EAEP,IAAI,EAAE,aAAa;IAK1C,IAAI,KAAK,IAAI,KAAK,GAAG,IAAI,CAExB;IAED,OAAO,CACH,aAAa,EAAE,mBAAmB,EAClC,YAAY,EAAE,eAAe,GAC9B,IAAI;IAEP,IAAI,KAAK,IAAI,GAAG,CAEf;IAED,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,QAAQ,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI;IAa5C;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI;IAExD,UAAU,IAAI,IAAI;IAUlB,QAAQ,CAAC,aAAa,IAAI,IAAI;IAE9B,QAAQ,IAAI,MAAM;IAIlB,SAAS,CAAC,gBAAgB;IAI1B,QAAQ,CAAC,aAAa,IAAI,IAAI;IAE9B;;;;;OAKG;IACH,KAAK,IAAI,IAAI;IAUb,OAAO;CAMV"}
+{"version":3,"file":"TrackBase.d.ts","sourceRoot":"","sources":["../../../../src/track/TrackBase.ts"],"names":[],"mappings":"AAKA,OAAO,EAKH,aAAa,EAGb,KAAK,KAAK,EAEV,KAAK,cAAc,EACnB,KAAK,WAAW,EACnB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AACxE,OAAO,KAAK,EACR,KAAK,EACL,aAAa,EACb,mBAAmB,EACnB,WAAW,EACX,QAAQ,EACX,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,KAAK,EACR,WAAW,EACX,oBAAoB,EACvB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AAC5D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAExD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAA;IAE/C;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAA;CACxC;AAED;;GAEG;AACH,8BAAsB,SAAS,CAC3B,QAAQ,SAAS,aAAa,GAAG,aAAa,EAC9C,UAAU,SAAS,kBAAkB,GAAG,kBAAkB,CAE1D,SAAQ,aAAa,CAAC,QAAQ,CAC9B,YAAW,KAAK,CAAC,UAAU,CAAC;IAoExB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,QAAQ;IAEtB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,WAAW;IAE1B,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,aAAa;IA5E1C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED;;OAEG;IACH,SAAS,CAAC,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,CAAO;IAE/C,SAAS,CAAC,QAAQ,CAAC,YAAY,GAAI,OAAO,GAAG,KAAG,IAAI,CASnD;IACD,SAAS,CAAC,QAAQ,CAAC,QAAQ,wCAAmB;IAC9C,SAAS,CAAC,eAAe,yCAAoB;IAE7C,IAAI,aAAa,IAAI,cAAc,CAElC;IAED;;;OAGG;IACH,IAAI,mBAAmB,IAAI,mBAAmB,GAAG,IAAI,CAEpD;IAED;;;;OAIG;IACH,IAAI,SAAS,IAAI,SAAS,GAAG,IAAI,CAEhC;IAED,QAAQ,KAAK,YAAY,IAAI,WAAW,CAAC,WAAW,CAAC,CAAA;IAErD,QAAQ,KAAK,SAAS,IAAI,SAAS,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAChE,QAAQ,KAAK,mBAAmB,IAAI,SAAS,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAE1E,QAAQ,CAAC,mBAAmB,CACxB,WAAW,EAAE,WAAW,GACzB,oBAAoB,GAAG,IAAI;IAC9B,QAAQ,CAAC,mBAAmB,CACxB,WAAW,EAAE,WAAW,GACzB,oBAAoB,GAAG,IAAI;IAC9B,QAAQ,CAAC,kBAAkB,CACvB,WAAW,EAAE,WAAW,GACzB,oBAAoB,GAAG,IAAI;IAE9B;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,KAAK,GAAG,IAAI,CAAO;IACrC,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,UAAU,CAAyB;IAE3C,SAAS;IACL;;OAEG;IACM,GAAG,EAAE,QAAQ;IAEtB;;OAEG;IACM,IAAI,EAAE,WAAW,EAEP,IAAI,EAAE,aAAa;IAK1C,QAAQ,IAAI,MAAM;IAIlB,IAAI,KAAK,IAAI,KAAK,GAAG,IAAI,CAExB;IAED,OAAO,CACH,aAAa,EAAE,mBAAmB,EAClC,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC,GAChC,IAAI;IAEP,IAAI,KAAK,IAAI,GAAG,CAEf;IAED,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,QAAQ,CAAC,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,IAAI;IAa9C;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,IAAI;IAE1D,UAAU,IAAI,IAAI;IAUlB,QAAQ,CAAC,aAAa,IAAI,IAAI;IAE9B,QAAQ,CAAC,aAAa,IAAI,IAAI;IAE9B,SAAS,CAAC,gBAAgB;IAI1B;;;OAGG;IACH,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC;IAO3B,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAY9C;;;;;OAKG;IACH,KAAK,CAAC,IAAI,UAAQ,GAAG,IAAI;IA8BzB,OAAO;CAMV"}

package/dist/types/current/track/TrackBase.js

@@ -2,14 +2,7 @@
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-import { any, number, object } from '@amazon/vinyl-validation';
-import { createAbortSlot, createDisposer, emptyRanges, EventHostImpl, isSilentError, logDebug, noop, } from '@amazon/vinyl-util';
-import { drmOptionsValidator } from '../drm/DrmOptions';
-export const trackBaseOptionsValidator = object({
-    extra: any().optional(),
-    startTime: number().maybe().optional(),
-    drm: drmOptionsValidator.partial().optional(),
-});
+import { createAbortSlot, createDisposer, emptyRanges, equalDeep, EventHostImpl, isSilentError, logDebug, noop, } from '@amazon/vinyl-util';
 /**
  * A base class for all tracks.
  */
@@ -40,11 +33,27 @@ export class TrackBase extends EventHostImpl {
     get fetchedRanges() {
         return emptyRanges;
     }
+    /**
+     * Default text track controller is null. Tracks that surface text tracks
+     * (e.g. {@link MseTrack}) override this getter.
+     */
+    get textTrackController() {
+        return null;
+    }
+    /**
+     * The presentation seek range of the media.
+     * Most often {start=0, end=duration} but may be different depending on the
+     * media timeline.
+     */
+    get seekRange() {
+        return this._seekRange;
+    }
     /**
      * Sets on handleError, cleared on 'reset'.
      */
     _error = null;
     _active = false;
+    _seekRange = null;
     constructor(
     /**
      * The identifier of this track, used as the key in the track cache.
@@ -59,6 +68,9 @@ export class TrackBase extends EventHostImpl {
         this.type = type;
         this.deps = deps;
     }
+    toString() {
+        return `[${this[Symbol.toStringTag]}#${this.uri}]`;
+    }
     get error() {
         return this._error;
     }
@@ -80,9 +92,9 @@ export class TrackBase extends EventHostImpl {
         this._active = true;
         logDebug(this, 'activate', this.uri);
         this.deps.playbackController
-            .seekTo(loadOptions.startTime ?? 0)
+            .seekTo(loadOptions?.startTime ?? 0)
             .catch(noop);
-        this.deps.drmController.configure(loadOptions.drm);
+        this.deps.drmController.configure(loadOptions?.drm);
         this.onActivated(loadOptions);
     }
     deactivate() {
@@ -95,24 +107,64 @@ export class TrackBase extends EventHostImpl {
         this.onDeactivated();
         this.closeDrmSessions();
     }
-    toString() {
-        return `[${this[Symbol.toStringTag]}#${this.uri}]`;
-    }
     closeDrmSessions() {
         this.drmSessionAbort.abort();
     }
+    /**
+     * Resolves to this track's ads.
+     * Implementations may override to provide ad breaks.
+     */
+    getAds() {
+        return Promise.resolve({
+            adBreaks: [],
+            trackUri: this.uri,
+        });
+    }
+    setSeekRange(value) {
+        const prev = this._seekRange;
+        if (equalDeep(prev, value))
+            return;
+        const previous = this._seekRange;
+        this._seekRange = value;
+        logDebug(this, `seekRangeChange start=${value.start}, end=${value.end}`);
+        this.dispatch('seekRangeChange', {
+            previous,
+            current: value,
+        });
+    }
     /**
      * Resets the track to recover from error states.
      * Base implementation does nothing.
      *
      * Overrides should dispatch 'reset' after resetting error state.
      */
-    reset() {
-        if (this._error == null) {
+    reset(hard = false) {
+        if (!hard && !this._error) {
             logDebug(this, 'reset no-op');
             return;
         }
-        logDebug(this, 'reset');
+        if (hard) {
+            // On a hard reset, deactivate/activate the track,
+            // restore playback seek and playing state.
+            if (this._active) {
+                const loadOptions = this.loadOptions;
+                const { playbackController } = this.deps;
+                const wasPaused = playbackController.paused || playbackController.ended;
+                const time = playbackController.currentTime;
+                this.onDeactivated();
+                // Clear the prefetch on a hard reset, in the case of codecs unsupported, the prefetch would
+                // otherwise contain unsupported segments.
+                this.clearPrefetch();
+                this.onActivated(loadOptions);
+                playbackController.seekTo(time).catch(noop);
+                if (!wasPaused)
+                    playbackController.play().catch(noop);
+            }
+            else {
+                this.clearPrefetch();
+            }
+        }
+        logDebug(this, 'reset, hard:', hard);
         this._error = null;
         this.dispatch('reset', {});
     }

package/dist/types/current/track/TrackController.d.ts

@@ -1,42 +1,63 @@
 import { type AnyRecord, type Disposable, EventHostImpl, type Maybe, type ReadonlyEventHost } from '@amazon/vinyl-util';
 import type { PlaybackController } from '../playback/PlaybackController';
-import type { ReadonlyTrack, TrackUri } from '../track/Track';
-import type { TrackFactory, TrackLoadOptions } from '../track/TrackFactory';
+import type { ReadonlyTrack, TrackUri } from './Track';
+import type { TrackFactory, TrackLoadOptions } from './TrackFactory';
 import type { ChangeEvent } from '../event/ChangeEvent';
+import type { AdController } from '../ad/AdController';
+import type { AdInfo } from '../ad/AdBreakInfo';
 export interface TrackControllerEventMap<TrackLoadOptionsType extends TrackLoadOptions> {
     /**
-     * Emitted when the current track is changing.
-     * This is emitted before the previous track has been deactivated and
-     * new track has been activated.
+     * A track became active. For content this may be deferred behind a preroll;
+     * for an ad it fires as the ad activates. {@link queueChange} precedes it.
      */
-    readonly currentTrackChanging: ChangeEvent<ReadonlyTrack | null>;
+    readonly trackActivated: TrackLifecycleEvent;
     /**
-     * Emitted when the current track has changed.
-     * If there is a queue change, the currentTrackChange event is always emitted first.
-     * This is emitted after the previous track has been deactivated and
-     * new track has been activated.
+     * A previously-active track was torn down (superseded or unloaded).
      */
-    readonly currentTrackChange: ChangeEvent<ReadonlyTrack | null>;
+    readonly trackDeactivated: TrackLifecycleEvent;
     /**
      * Dispatched when the queue has changed.
+     *
+     * Will be emitted before {@link trackActivated}.
      */
     readonly queueChange: ChangeEvent<readonly TrackLoadOptionsType[]>;
     /**
-     * Emitted when the last track of the playback queue has ended.
-     * When the last track in a queue has ended, the track will not change and therefore a `currentTrackChange`
-     * event will not be emitted.
+     * Emitted when the current track — including any postroll ads — has finished
+     * playing. Fires once per track: as the queue advances it precedes the
+     * resulting {@link trackActivated}, and for the final track it precedes
+     * `queueEnded`. Distinct from the media element's `ended` (which also fires
+     * for each ad) and from an individual ad's `adEnded`, so applications can act
+     * on true track completion (e.g. logging a play) without confusing it with
+     * an ad ending or the content ending before its postroll plays.
+     */
+    readonly trackEnded: TrackEndedEvent;
+    /**
+     * Emitted when the last track of the playback queue (and any of its
+     * postroll ads) have ended.
      */
     readonly queueEnded: AnyRecord;
 }
-export declare const ALL_TRACK_CONTROLLER_EVENTS: readonly ["currentTrackChanging", "currentTrackChange", "queueChange", "queueEnded"];
+export declare const ALL_TRACK_CONTROLLER_EVENTS: readonly ["trackActivated", "trackDeactivated", "queueChange", "trackEnded", "queueEnded"];
+/** Payload for {@link trackActivated} / {@link trackDeactivated}. */
+export interface TrackLifecycleEvent {
+    readonly track: ReadonlyTrack;
+}
+/**
+ * Payload for the {@link TrackControllerEventMap.trackEnded} event: the load
+ * options of the track that finished playing (including any postroll ads).
+ */
+export interface TrackEndedEvent {
+    readonly track: TrackLoadOptions;
+}
 /**
  * A readonly interface to the track controller.
  */
 export interface ReadonlyTrackController<TrackLoadOptionsType extends TrackLoadOptions> extends ReadonlyEventHost<TrackControllerEventMap<TrackLoadOptionsType>> {
     /**
-     * Returns the current track.
+     * The active track, or null when the selected track has not yet activated
+     * (e.g. behind a preroll) or nothing is loaded.
      */
-    readonly currentTrack: ReadonlyTrack | null;
+    readonly activeTrack: ReadonlyTrack | null;
     /**
      * Returns the current queue of TrackLoadOptions.
      * Observe 'queueChange' for changes to this queue.
@@ -119,7 +140,7 @@ export interface TrackController<TrackLoadOptionsType extends TrackLoadOptions>
      */
     clearPrefetch(): void;
     /**
-     * Clears the track cache and unloads the current track.
+     * Clears the track cache, unloads the current track, and clears the queue.
      */
     clearTrackCache(): void;
     /**
@@ -129,25 +150,25 @@ export interface TrackController<TrackLoadOptionsType extends TrackLoadOptions>
     clearQueue(): void;
     /**
      * Resets the current track's error state.
+     *
+     * @param hard If true, the track will reset the playback state and
+     * recreate media sources.
      */
-    reset(): void;
+    reset(hard?: boolean): void;
 }
 export interface TrackControllerImplDeps<TrackLoadOptionsType extends TrackLoadOptions> {
     readonly trackFactory: TrackFactory<TrackLoadOptionsType>;
     readonly playbackController: PlaybackController;
+    readonly adController: AdController;
+    readonly adTrackLoadOptionsProvider: AdTrackLoadOptionsProvider<TrackLoadOptionsType>;
 }
+export type AdTrackLoadOptionsProvider<TrackLoadOptionsType extends TrackLoadOptions> = (adInfo: AdInfo) => Promise<TrackLoadOptionsType>;
 export interface TrackControllerImplOptions {
     /**
      * When tracks are queued, the number of tracks to prefetch ahead of the current track.
      * Default: 2
      */
     readonly trackPrefetchCount: number;
-    /**
-     * The number of seconds before load calls will time out if the first track's metadata is not loaded within
-     * this time.
-     * Default: 60
-     */
-    readonly loadTimeout: number;
     /**
      * The number of tracks that may be preloaded at one time (not counting queue prefetch).
      * This extends the track cache capacity and allows a certain number of tracks no longer in the queue to remain
@@ -170,13 +191,21 @@ export declare class TrackControllerImpl<TrackLoadOptionsType extends TrackLoadO
     get [Symbol.toStringTag](): string;
     private _autoPreloadCapacity;
     private readonly trackCache;
+    private queueIdx;
     private _queue;
     private _current;
+    private _currentTrack;
+    private adParent;
+    private currentTrackSub;
+    private readonly adTracksByParent;
     private readonly disposer;
     private _options;
-    private trackEndedTimeoutId;
     constructor(deps: TrackControllerImplDeps<TrackLoadOptionsType>, initialOptions?: Partial<TrackControllerImplOptions>);
-    private clearTrackEndedTimeout;
+    private initializeAdHandling;
+    /**
+     * The current track has ended naturally. On the next tick advance the queue or emit queue ended.
+     */
+    private onEnded;
     /**
      * Returns the currently set configuration.
      */
@@ -196,7 +225,7 @@ export declare class TrackControllerImpl<TrackLoadOptionsType extends TrackLoadO
      * Returns the subset of the queue that should be prefetched.
      * @private
      */
-    private get prefetched();
+    private getPrefetched;
     isTrackCached(uri: TrackUri): boolean;
     getCachedTrack(uri: TrackUri): ReadonlyTrack | null;
     getCachedTracks(): IterableIterator<ReadonlyTrack>;
@@ -208,6 +237,16 @@ export declare class TrackControllerImpl<TrackLoadOptionsType extends TrackLoadO
     private validateLoadOptions;
     preload(...loadOptionsList: readonly TrackLoadOptionsType[]): void;
     private _preload;
+    private preloadPrerollAds;
+    /**
+     * Warms the ad tracks for an approaching midroll/postroll break (driven by
+     * the ad controller's `adPreload`). Best-effort: an ad-list or ad-options
+     * failure is logged, not thrown. The break is imminent, so its ad tracks
+     * get a prefetch priority above the current content prefetch window.
+     */
+    private preloadBreakAds;
+    /** Preloads an ad for a parent track. Aborts if the parent track is disposed before the ad load options resolve. **/
+    private preloadAd;
     load(...loadOptionsList: readonly TrackLoadOptionsType[]): void;
     unload(): void;
     enqueue(...loadOptionsList: readonly TrackLoadOptionsType[]): void;
@@ -220,25 +259,50 @@ export declare class TrackControllerImpl<TrackLoadOptionsType extends TrackLoadO
      * If the given track id is the current track or in the cache, returns that track.
      * Otherwise, constructs a new track, adds it to the cache, and returns it.
      *
-     * @param uri The unique resource identifier.
      * @param loadOptions
      * @private
      */
     private getOrCreateTrack;
     /**
-     * Get the current track from cache or create a new track, then activates that track.
+     * Gets the cached ad track, or creates a new one and sets it in the
+     * parent track mapping.
+     * When the parent track is disposed, this ad track will be as well.
+     *
+     * @param parentUri The URI of the parent track.
+     * @param loadOptions
+     * @private
      */
-    private activateCurrent;
-    private _currentTrack;
-    get currentTrack(): ReadonlyTrack | null;
+    private getOrCreateAdTrack;
+    /**
+     * Sets the current track and following queue.
+     *
+     * If the given track is already current, it will be de-activated and re-activated and the
+     * trackDeactivated/trackActivated events will still be emitted. The same track may be in the
+     * queue multiple times.
+     */
+    private setQueue;
+    private get currentTrackIsAdTrack();
     /**
-     * Sets the current track. If the given track is already current, it will be de-activated and re-activated and
-     * the currentTrackChange event will still be emitted.
-     * The same track may be in the queue multiple times.
+     * Sets the active track.
+     * This may either be a content track created from `setQueue` or an ad track created from `adEntered`.
+     *
+     * @param newTrack
+     * @param options
+     * @private
      */
     private setCurrentTrack;
-    private clearCurrentTrack;
-    reset(): void;
+    /**
+     * Disposes all preloaded ad tracks belonging to the given parent content
+     * URI and drops the parent's entry from the ad map.
+     */
+    private disposeAdTracksFor;
+    /**
+     * Returns a callback that returns true if the queue has changed or the controller disposed.
+     */
+    private getQueueInterrupted;
+    get activeTrack(): ReadonlyTrack | null;
+    reset(hard?: boolean): void;
+    get disposed(): boolean;
     dispose(): void;
 }
 //# sourceMappingURL=TrackController.d.ts.map

package/dist/types/current/track/TrackController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TrackController.d.ts","sourceRoot":"","sources":["../../../../src/track/TrackController.ts"],"names":[],"mappings":"AAKA,OAAO,EACH,KAAK,SAAS,EAGd,KAAK,UAAU,EACf,aAAa,EAMb,KAAK,KAAK,EAEV,KAAK,iBAAiB,EAEzB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,KAAK,EAAE,aAAa,EAAS,QAAQ,EAAE,MAAM,eAAe,CAAA;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAEtD,MAAM,WAAW,uBAAuB,CACpC,oBAAoB,SAAS,gBAAgB;IAE7C;;;;OAIG;IACH,QAAQ,CAAC,oBAAoB,EAAE,WAAW,CAAC,aAAa,GAAG,IAAI,CAAC,CAAA;IAEhE;;;;;OAKG;IACH,QAAQ,CAAC,kBAAkB,EAAE,WAAW,CAAC,aAAa,GAAG,IAAI,CAAC,CAAA;IAE9D;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,SAAS,oBAAoB,EAAE,CAAC,CAAA;IAElE;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAA;CACjC;AAED,eAAO,MAAM,2BAA2B,sFAK4B,CAAA;AAEpE;;GAEG;AACH,MAAM,WAAW,uBAAuB,CACpC,oBAAoB,SAAS,gBAAgB,CAC/C,SAAQ,iBAAiB,CAAC,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;IACtE;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,aAAa,GAAG,IAAI,CAAA;IAE3C;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,oBAAoB,EAAE,CAAA;IAE/C;;OAEG;IACH,OAAO,IAAI,OAAO,CAAA;IAElB;;OAEG;IACH,aAAa,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAA;IAErC;;OAEG;IACH,cAAc,CAAC,GAAG,EAAE,QAAQ,GAAG,aAAa,GAAG,IAAI,CAAA;IAEnD;;OAEG;IACH,eAAe,IAAI,gBAAgB,CAAC,aAAa,CAAC,CAAA;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe,CAC5B,oBAAoB,SAAS,gBAAgB,CAC/C,SAAQ,uBAAuB,CAAC,oBAAoB,CAAC;IACnD;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,GAAG,eAAe,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAElE;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,GAAG,eAAe,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAE/D;;;OAGG;IACH,MAAM,IAAI,IAAI,CAAA;IAEd;;;;OAIG;IACH,OAAO,CAAC,GAAG,eAAe,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAElE;;;;;OAKG;IACH,IAAI,IAAI,IAAI,CAAA;IAEZ;;;;;;;OAOG;IACH,aAAa,IAAI,IAAI,CAAA;IAErB;;OAEG;IACH,eAAe,IAAI,IAAI,CAAA;IAEvB;;;OAGG;IACH,UAAU,IAAI,IAAI,CAAA;IAElB;;OAEG;IACH,KAAK,IAAI,IAAI,CAAA;CAChB;AAED,MAAM,WAAW,uBAAuB,CACpC,oBAAoB,SAAS,gBAAgB;IAE7C,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,oBAAoB,CAAC,CAAA;IAEzD,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAA;CAClD;AAED,MAAM,WAAW,0BAA0B;IACvC;;;OAGG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAA;IAEnC;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAE5B;;;;;;OAMG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;CACnC;AAQD;;;;GAIG;AACH,eAAO,MAAM,aAAa;;CAEzB,CAAA;AAED,qBAAa,mBAAmB,CAAC,oBAAoB,SAAS,gBAAgB,CAC1E,SAAQ,aAAa,CAAC,uBAAuB,CAAC,oBAAoB,CAAC,CACnE,YAAW,eAAe,CAAC,oBAAoB,CAAC,EAAE,UAAU;IAkBxD,OAAO,CAAC,QAAQ,CAAC,IAAI;IAhBzB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAGD,OAAO,CAAC,oBAAoB,CAAI;IAChC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAiC;IAC5D,OAAO,CAAC,MAAM,CAAsC;IACpD,OAAO,CAAC,QAAQ,CAAoC;IACpD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CACqB;IAErC,OAAO,CAAC,mBAAmB,CAAyB;gBAG/B,IAAI,EAAE,uBAAuB,CAAC,oBAAoB,CAAC,EACpE,cAAc,CAAC,EAAE,OAAO,CAAC,0BAA0B,CAAC;IAoCxD,OAAO,CAAC,sBAAsB;IAO9B;;OAEG;IACH,IAAI,OAAO,IAAI,0BAA0B,CAExC;IAED;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAS7D;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAS1B,IAAI,KAAK,IAAI,SAAS,oBAAoB,EAAE,CAE3C;IAED;;;OAGG;IACH,OAAO,KAAK,UAAU,GAKrB;IAED,aAAa,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO;IAIrC,cAAc,CAAC,GAAG,EAAE,QAAQ,GAAG,aAAa,GAAG,IAAI;IAInD,eAAe,IAAI,gBAAgB,CAAC,aAAa,CAAC;IAIlD;;;OAGG;IACH,IAAI,eAAe,IAAI,MAAM,CAK5B;IAED,OAAO,CAAC,mBAAmB,CACqB;IAEhD,OAAO,CAAC,GAAG,eAAe,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI;IAMlE,OAAO,CAAC,QAAQ;IAiChB,IAAI,CAAC,GAAG,eAAe,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI;IAe/D,MAAM;IAIN,OAAO,CAAC,GAAG,eAAe,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI;IAalE,OAAO,IAAI,OAAO;IAIlB,IAAI,IAAI,IAAI;IAwBZ,eAAe;IAkBf,aAAa,IAAI,IAAI;IAMrB,UAAU,IAAI,IAAI;IAUlB;;;;;;;OAOG;IACH,OAAO,CAAC,gBAAgB;IAWxB;;OAEG;IACH,OAAO,CAAC,eAAe;IAYvB,OAAO,CAAC,aAAa,CAAqB;IAC1C,IAAI,YAAY,IAAI,aAAa,GAAG,IAAI,CAEvC;IAED;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAuBvB,OAAO,CAAC,iBAAiB;IAIzB,KAAK;IAIL,OAAO;CAMV"}
+{"version":3,"file":"TrackController.d.ts","sourceRoot":"","sources":["../../../../src/track/TrackController.ts"],"names":[],"mappings":"AAKA,OAAO,EACH,KAAK,SAAS,EAGd,KAAK,UAAU,EACf,aAAa,EAUb,KAAK,KAAK,EAEV,KAAK,iBAAiB,EAGzB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AACxE,OAAO,KAAK,EAAE,aAAa,EAAS,QAAQ,EAAE,MAAM,SAAS,CAAA;AAC7D,OAAO,KAAK,EAER,YAAY,EACZ,gBAAgB,EACnB,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,KAAK,EAAe,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE5D,MAAM,WAAW,uBAAuB,CACpC,oBAAoB,SAAS,gBAAgB;IAE7C;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,mBAAmB,CAAA;IAE5C;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,mBAAmB,CAAA;IAE9C;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,SAAS,oBAAoB,EAAE,CAAC,CAAA;IAElE;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAA;IAEpC;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAA;CACjC;AAED,eAAO,MAAM,2BAA2B,4FAM4B,CAAA;AAEpE,qEAAqE;AACrE,MAAM,WAAW,mBAAmB;IAChC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAA;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,QAAQ,CAAC,KAAK,EAAE,gBAAgB,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB,CACpC,oBAAoB,SAAS,gBAAgB,CAC/C,SAAQ,iBAAiB,CAAC,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;IACtE;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,aAAa,GAAG,IAAI,CAAA;IAE1C;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,oBAAoB,EAAE,CAAA;IAE/C;;OAEG;IACH,OAAO,IAAI,OAAO,CAAA;IAElB;;OAEG;IACH,aAAa,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAA;IAErC;;OAEG;IACH,cAAc,CAAC,GAAG,EAAE,QAAQ,GAAG,aAAa,GAAG,IAAI,CAAA;IAEnD;;OAEG;IACH,eAAe,IAAI,gBAAgB,CAAC,aAAa,CAAC,CAAA;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe,CAC5B,oBAAoB,SAAS,gBAAgB,CAC/C,SAAQ,uBAAuB,CAAC,oBAAoB,CAAC;IACnD;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,GAAG,eAAe,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAElE;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,GAAG,eAAe,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAE/D;;;OAGG;IACH,MAAM,IAAI,IAAI,CAAA;IAEd;;;;OAIG;IACH,OAAO,CAAC,GAAG,eAAe,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAElE;;;;;OAKG;IACH,IAAI,IAAI,IAAI,CAAA;IAEZ;;;;;;;OAOG;IACH,aAAa,IAAI,IAAI,CAAA;IAErB;;OAEG;IACH,eAAe,IAAI,IAAI,CAAA;IAEvB;;;OAGG;IACH,UAAU,IAAI,IAAI,CAAA;IAElB;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;CAC9B;AAED,MAAM,WAAW,uBAAuB,CACpC,oBAAoB,SAAS,gBAAgB;IAE7C,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,oBAAoB,CAAC,CAAA;IAEzD,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAA;IAE/C,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAA;IAEnC,QAAQ,CAAC,0BAA0B,EAAE,0BAA0B,CAAC,oBAAoB,CAAC,CAAA;CACxF;AAED,MAAM,MAAM,0BAA0B,CAClC,oBAAoB,SAAS,gBAAgB,IAC7C,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAA;AAErD,MAAM,WAAW,0BAA0B;IACvC;;;OAGG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAA;IAEnC;;;;;;OAMG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;CACnC;AAOD;;;;GAIG;AACH,eAAO,MAAM,aAAa;;CAEzB,CAAA;AAED,qBAAa,mBAAmB,CAAC,oBAAoB,SAAS,gBAAgB,CAC1E,SAAQ,aAAa,CAAC,uBAAuB,CAAC,oBAAoB,CAAC,CACnE,YAAW,eAAe,CAAC,oBAAoB,CAAC,EAAE,UAAU;IAoCxD,OAAO,CAAC,QAAQ,CAAC,IAAI;IAlCzB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAGD,OAAO,CAAC,oBAAoB,CAAI;IAEhC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAiC;IAE5D,OAAO,CAAC,QAAQ,CAAI;IACpB,OAAO,CAAC,MAAM,CAAsC;IAEpD,OAAO,CAAC,QAAQ,CAAoC;IAEpD,OAAO,CAAC,aAAa,CAAqB;IAE1C,OAAO,CAAC,QAAQ,CAAqB;IAIrC,OAAO,CAAC,eAAe,CAA2B;IAIlD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAG9B;IAEH,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CACqB;gBAGhB,IAAI,EAAE,uBAAuB,CAAC,oBAAoB,CAAC,EACpE,cAAc,CAAC,EAAE,OAAO,CAAC,0BAA0B,CAAC;IA6BxD,OAAO,CAAC,oBAAoB;IAwG5B;;OAEG;IACH,OAAO,CAAC,OAAO,CAuCd;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,0BAA0B,CAExC;IAED;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,0BAA0B,CAAC,CAAC;IAS7D;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAS1B,IAAI,KAAK,IAAI,SAAS,oBAAoB,EAAE,CAE3C;IAED;;;OAGG;IACH,OAAO,CAAC,aAAa;IAOrB,aAAa,CAAC,GAAG,EAAE,QAAQ,GAAG,OAAO;IAIrC,cAAc,CAAC,GAAG,EAAE,QAAQ,GAAG,aAAa,GAAG,IAAI;IAInD,eAAe,IAAI,gBAAgB,CAAC,aAAa,CAAC;IAIlD;;;OAGG;IACH,IAAI,eAAe,IAAI,MAAM,CAK5B;IAED,OAAO,CAAC,mBAAmB,CACqB;IAEhD,OAAO,CAAC,GAAG,eAAe,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI;IAMlE,OAAO,CAAC,QAAQ;IAuChB,OAAO,CAAC,iBAAiB;IAmCzB;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAqBvB,qHAAqH;YACvG,SAAS;IAyBvB,IAAI,CAAC,GAAG,eAAe,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI;IAM/D,MAAM;IAIN,OAAO,CAAC,GAAG,eAAe,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI;IAOlE,OAAO,IAAI,OAAO;IAIlB,IAAI,IAAI,IAAI;IASZ,eAAe;IAYf,aAAa,IAAI,IAAI;IAMrB,UAAU,IAAI,IAAI;IAKlB;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAMxB;;;;;;;;OAQG;IACH,OAAO,CAAC,kBAAkB;IAc1B;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ;IAyDhB,OAAO,KAAK,qBAAqB,GAEhC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,eAAe;IAwDvB;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAO1B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAK3B,IAAI,WAAW,IAAI,aAAa,GAAG,IAAI,CAEtC;IAED,KAAK,CAAC,IAAI,UAAQ;IAIlB,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,OAAO;CAMV"}