@amazon/vinyl 1.2.0 → 2.0.4

package/dist/types/current/text/pickPreferredTextTrack.js

@@ -0,0 +1,68 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { languageRelatedness } from '../track/filters/languageFilter';
+/**
+ * Resolves the preferred-text-language option to an ordered list of BCP 47
+ * tags, most-preferred first. Unlike the audio equivalent, `null` resolves to
+ * an empty list (no preference) rather than falling back to
+ * `navigator.languages` — captions default to off.
+ */
+function resolvePreferredTextLanguages(preferred) {
+    if (typeof preferred === 'string')
+        return [preferred];
+    if (preferred)
+        return preferred;
+    return [];
+}
+/**
+ * Chooses the text track that best matches the preferred language(s), or null
+ * when none relate (or there is no preference / no tracks).
+ *
+ * Language dominates: a track is ranked first by which preference it relates to
+ * (earlier entries win) and how closely (see {@link languageRelatedness}).
+ * Within a single language, a full track is preferred over a forced-only track
+ * (a user asking for a caption language wants the full captions, not just the
+ * forced foreign-dialogue cues), and a manifest-default track breaks any
+ * remaining tie.
+ */
+export function pickPreferredTextTrack(tracks, preferred) {
+    const prefs = resolvePreferredTextLanguages(preferred);
+    if (tracks.length === 0 || prefs.length === 0)
+        return null;
+    let best = null;
+    let bestScore = 0;
+    for (const track of tracks) {
+        const score = scoreTextTrack(track, prefs);
+        if (score > bestScore) {
+            bestScore = score;
+            best = track;
+        }
+    }
+    return best;
+}
+/**
+ * Scores a track against the ordered preference list. 0 means unrelated to
+ * every preference (never selected). Preference position and language
+ * relatedness are weighted so they dominate the full/forced/default tiebreaks.
+ */
+function scoreTextTrack(track, prefs) {
+    if (track.language == null)
+        return 0;
+    let best = 0;
+    for (let i = 0; i < prefs.length; i++) {
+        const rel = languageRelatedness(prefs[i], track.language);
+        if (rel > 0) {
+            best = Math.max(best, (prefs.length - i) * 100 + rel * 10);
+        }
+    }
+    if (best === 0)
+        return 0;
+    // Tiebreaks within the same language: prefer full over forced, then default.
+    if (!track.forced)
+        best += 2;
+    if (track.default)
+        best += 1;
+    return best;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * The seekable time range on the media timeline, in seconds.
+ * `end` will be `Infinity` when a live stream.
+ */
+export type SeekRange = {
+    readonly start: number;
+    readonly end: number;
+};
+//# sourceMappingURL=SeekRange.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SeekRange.d.ts","sourceRoot":"","sources":["../../../../src/track/SeekRange.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAA"}

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

@@ -0,0 +1,5 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export {};

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

@@ -1,11 +1,18 @@
-import type { AnyRecord, Disposable, LogTarget, ReadonlyEventHost, ReadonlyRanges, ReadonlySet } from '@amazon/vinyl-util';
+import type { AnyRecord, Covariant, Disposable, EventHandler, LogTarget, Maybe, ReadonlyEventHost, ReadonlyRanges, ReadonlySet, SignalOptions, Unsubscribe } from '@amazon/vinyl-util';
 import type { ContentType, MediaQualityMetadata } from '../streaming/MediaQualityMetadata';
 import type { StreamingEventMap } from '../streaming/StreamingEventMap';
+import type { ReadonlyTextTrackController, TextTrackController } from '../text/TextTrack';
+import type { SeekRange } from './SeekRange';
+import type { TrackAds } from '../ad/AdBreakInfo';
+import type { TrackConfigOptions } from './TrackFactory';
+export type { SeekRange } from './SeekRange';
 /**
  * All events a track may emit.
  * Streaming-related events are separated as they will be bubbled by the player.
  */
-export type TrackEventMap = StreamingEventMap;
+export type TrackEventMap = StreamingEventMap & {
+    readonly adsChange: AnyRecord;
+};
 /**
  * An identifier for a Track, used for referencing a track.
  */
@@ -93,10 +100,13 @@ export interface StreamingState extends ReadonlyStreamingState {
     /**
      * Resets the track to recover from error states.
      * This will reset failed segments and clear error conditions to allow streaming to resume.
+     *
+     * @param hard If true, the track will reset the playback state and
+     * recreate media sources.
      */
-    reset(): void;
+    reset(hard?: boolean): void;
 }
-export interface ReadonlyTrack extends ReadonlyStreamingState, LogTarget {
+export interface ReadonlyTrack extends ReadonlyEventHost<TrackEventMap>, ReadonlyStreamingState, LogTarget {
     /**
      * The track identifier.
      */
@@ -122,18 +132,44 @@ export interface ReadonlyTrack extends ReadonlyStreamingState, LogTarget {
      * The last error that occurred in this track, or null if no error.
      */
     readonly error: Error | null;
+    /**
+     * Controller for sidecar text tracks discovered for this track, or null
+     * if the track type does not surface text tracks.
+     */
+    readonly textTrackController: ReadonlyTextTrackController | null;
+    /**
+     * The seekable range on the media timeline, or null when not yet known
+     * (e.g. before the manifest is loaded). Based on the media timeline, not
+     * the element's native seekable ranges.
+     */
+    readonly seekRange: SeekRange | null;
+    /**
+     * Resolves to the ads for this track.
+     * The track's ads may change if the media timeline changes.
+     *
+     * @see {@link TrackEventMap} — the `adsChange` event.
+     */
+    getAds(): Promise<TrackAds>;
+    readonly __eventMapType: Covariant<TrackEventMap>;
+    hasListeners(type: keyof TrackEventMap): boolean;
+    on<K extends keyof TrackEventMap>(type: K, handler: EventHandler<TrackEventMap[K]>, options?: SignalOptions): Unsubscribe;
 }
 /**
  * One track is active on the track controller at a time.
  */
-export interface Track<LoadOptionsType extends AnyRecord = AnyRecord> extends ReadonlyTrack, StreamingState, Disposable {
+export interface Track<ConfigType extends TrackConfigOptions = TrackConfigOptions> extends ReadonlyTrack, StreamingState, Disposable {
+    /**
+     * Mutable view of {@link ReadonlyTrack.textTrackController} that allows
+     * selecting the active text track.
+     */
+    readonly textTrackController: TextTrackController | null;
     /**
      * Provides configuration to the track and begins preloading (if applicable).
      *
      * @param trackOptions Configuration provided by the TrackController.
      * @param loadOptions Configuration from `TrackLoadOptions.config`, provided by the Application.
      */
-    preload(trackOptions: TrackPreloadOptions, loadOptions: LoadOptionsType): void;
+    preload(trackOptions: TrackPreloadOptions, loadOptions: Maybe<ConfigType>): void;
     /**
      * Sets this track as active, deactivating any currently active track.
      * This should set sources on the playback source and add any listeners needed for shared
@@ -141,7 +177,7 @@ export interface Track<LoadOptionsType extends AnyRecord = AnyRecord> extends Re
      *
      * @param loadOptions Configuration from `TrackLoadOptions.config`, provided by the Application.
      */
-    activate(loadOptions: LoadOptionsType): void;
+    activate(loadOptions: Maybe<ConfigType>): void;
     /**
      * Sets this track as inactive.
      * This should unset sources, and remove any listeners. Tracks do not implement disposable,
@@ -149,5 +185,12 @@ export interface Track<LoadOptionsType extends AnyRecord = AnyRecord> extends Re
      * are no longer references to the track.
      */
     deactivate(): void;
+    /**
+     * True if this track is disposed.
+     */
+    readonly disposed: boolean;
+    readonly __eventMapType: Covariant<TrackEventMap>;
+    hasListeners(type: keyof TrackEventMap): boolean;
+    on<K extends keyof TrackEventMap>(type: K, handler: EventHandler<TrackEventMap[K]>, options?: SignalOptions): Unsubscribe;
 }
 //# sourceMappingURL=Track.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Track.d.ts","sourceRoot":"","sources":["../../../../src/track/Track.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACR,SAAS,EACT,UAAU,EACV,SAAS,EACT,iBAAiB,EACjB,cAAc,EACd,WAAW,EACd,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EACR,WAAW,EACX,oBAAoB,EACvB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAEvE;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,CAAA;AAE7C;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAE7B;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAA;AAEhC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAA;CACpC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,sBAAuB,SAAQ,iBAAiB,CAAC,iBAAiB,CAAC;IAChF;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAA;IAEtC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,WAAW,CAAC,WAAW,CAAC,CAAA;IAE/C;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAE1D;;;OAGG;IACH,QAAQ,CAAC,mBAAmB,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAEpE;;;;;;;;;OASG;IACH,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,oBAAoB,GAAG,IAAI,CAAA;IAE1E;;;;;;OAMG;IACH,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,oBAAoB,GAAG,IAAI,CAAA;IAE1E;;;;;;OAMG;IACH,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,oBAAoB,GAAG,IAAI,CAAA;CAC5E;AAED,MAAM,WAAW,cAAe,SAAQ,sBAAsB;IAC1D;;OAEG;IACH,aAAa,IAAI,IAAI,CAAA;IAErB;;;OAGG;IACH,KAAK,IAAI,IAAI,CAAA;CAChB;AAED,MAAM,WAAW,aAAc,SAAQ,sBAAsB,EAAE,SAAS;IACpE;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAA;IAEtB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAE1B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,KAAK,CAAC,eAAe,SAAS,SAAS,GAAG,SAAS,CAChE,SAAQ,aAAa,EAAE,cAAc,EAAE,UAAU;IACjD;;;;;OAKG;IACH,OAAO,CACH,YAAY,EAAE,mBAAmB,EACjC,WAAW,EAAE,eAAe,GAC7B,IAAI,CAAA;IAEP;;;;;;OAMG;IACH,QAAQ,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI,CAAA;IAE5C;;;;;OAKG;IACH,UAAU,IAAI,IAAI,CAAA;CACrB"}
+{"version":3,"file":"Track.d.ts","sourceRoot":"","sources":["../../../../src/track/Track.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACR,SAAS,EACT,SAAS,EACT,UAAU,EACV,YAAY,EACZ,SAAS,EACT,KAAK,EACL,iBAAiB,EACjB,cAAc,EACd,WAAW,EACX,aAAa,EACb,WAAW,EACd,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EACR,WAAW,EACX,oBAAoB,EACvB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AACvE,OAAO,KAAK,EACR,2BAA2B,EAC3B,mBAAmB,EACtB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAExD,YAAY,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE5C;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG;IAC5C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;CAChC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAA;AAE7B;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAA;AAEhC;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAA;CACpC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,sBAAuB,SAAQ,iBAAiB,CAAC,iBAAiB,CAAC;IAChF;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAA;IAEtC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,WAAW,CAAC,WAAW,CAAC,CAAA;IAE/C;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAE1D;;;OAGG;IACH,QAAQ,CAAC,mBAAmB,EAAE,SAAS,oBAAoB,EAAE,GAAG,IAAI,CAAA;IAEpE;;;;;;;;;OASG;IACH,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,oBAAoB,GAAG,IAAI,CAAA;IAE1E;;;;;;OAMG;IACH,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,oBAAoB,GAAG,IAAI,CAAA;IAE1E;;;;;;OAMG;IACH,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,oBAAoB,GAAG,IAAI,CAAA;CAC5E;AAED,MAAM,WAAW,cAAe,SAAQ,sBAAsB;IAC1D;;OAEG;IACH,aAAa,IAAI,IAAI,CAAA;IAErB;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;CAC9B;AAED,MAAM,WAAW,aACb,SACI,iBAAiB,CAAC,aAAa,CAAC,EAChC,sBAAsB,EACtB,SAAS;IACb;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAA;IAEtB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAE1B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAA;IAEnB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;IAE5B;;;OAGG;IACH,QAAQ,CAAC,mBAAmB,EAAE,2BAA2B,GAAG,IAAI,CAAA;IAEhE;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAA;IAEpC;;;;;OAKG;IACH,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAA;IAE3B,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC,aAAa,CAAC,CAAA;IACjD,YAAY,CAAC,IAAI,EAAE,MAAM,aAAa,GAAG,OAAO,CAAA;IAChD,EAAE,CAAC,CAAC,SAAS,MAAM,aAAa,EAC5B,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EACvC,OAAO,CAAC,EAAE,aAAa,GACxB,WAAW,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK,CAClB,UAAU,SAAS,kBAAkB,GAAG,kBAAkB,CAE1D,SAAQ,aAAa,EAAE,cAAc,EAAE,UAAU;IACjD;;;OAGG;IACH,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,IAAI,CAAA;IAExD;;;;;OAKG;IACH,OAAO,CACH,YAAY,EAAE,mBAAmB,EACjC,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,GAC/B,IAAI,CAAA;IAEP;;;;;;OAMG;IACH,QAAQ,CAAC,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,IAAI,CAAA;IAE9C;;;;;OAKG;IACH,UAAU,IAAI,IAAI,CAAA;IAElB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAE1B,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC,aAAa,CAAC,CAAA;IACjD,YAAY,CAAC,IAAI,EAAE,MAAM,aAAa,GAAG,OAAO,CAAA;IAChD,EAAE,CAAC,CAAC,SAAS,MAAM,aAAa,EAC5B,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EACvC,OAAO,CAAC,EAAE,aAAa,GACxB,WAAW,CAAA;CACjB"}

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

@@ -1,10 +1,12 @@
-import type { ObjectSchema } from '@amazon/vinyl-validation';
 import { EventHostImpl, type Maybe, type ReadonlyRanges, type ReadonlySet } from '@amazon/vinyl-util';
 import type { PlaybackController } from '../playback/PlaybackController';
 import type { Track, TrackEventMap, TrackPreloadOptions, TrackTypeId, TrackUri } from './Track';
+import type { SeekRange } from './SeekRange';
 import { type DrmController } from '../drm/DrmController';
 import type { ContentType, MediaQualityMetadata } from '../streaming/MediaQualityMetadata';
-import { type DrmOptions } from '../drm/DrmOptions';
+import type { TextTrackController } from '../text/TextTrack';
+import type { TrackAds } from '../ad/AdBreakInfo';
+import type { TrackConfigOptions } from './TrackFactory';
 /**
  * Dependencies for TrackBase.
  */
@@ -18,29 +20,10 @@ export interface TrackBaseDeps {
      */
     readonly drmController: DrmController;
 }
-/**
- * General configuration for tracks set in track load options.
- */
-export interface TrackBaseOptions {
-    /**
-     * The time to seek to when the track has been activated.
-     * For MSE tracks this will affect pre-fetching.
-     */
-    readonly startTime?: Maybe<number>;
-    /**
-     * Extra application data to associate with the track.
-     */
-    readonly extra?: any;
-    /**
-     * DRM Configuration overrides for this track.
-     */
-    readonly drm?: Partial<DrmOptions>;
-}
-export declare const trackBaseOptionsValidator: ObjectSchema<TrackBaseOptions>;
 /**
  * A base class for all tracks.
  */
-export declare abstract class TrackBase<EventMap extends TrackEventMap = TrackEventMap, LoadOptionsType extends TrackBaseOptions = TrackBaseOptions> extends EventHostImpl<EventMap> implements Track<LoadOptionsType> {
+export declare abstract class TrackBase<EventMap extends TrackEventMap = TrackEventMap, ConfigType extends TrackConfigOptions = TrackConfigOptions> extends EventHostImpl<EventMap> implements Track<ConfigType> {
     /**
      * The identifier of this track, used as the key in the track cache.
      */
@@ -54,11 +37,22 @@ export declare abstract class TrackBase<EventMap extends TrackEventMap = TrackEv
     /**
      * The current load options, if this is an active track.
      */
-    protected loadOptions: LoadOptionsType | null;
+    protected loadOptions: Maybe<ConfigType>;
     protected readonly errorHandler: (error: any) => void;
     protected readonly disposer: import("@amazon/vinyl-util").Disposer;
     protected drmSessionAbort: import("@amazon/vinyl-util").AbortSlot;
     get fetchedRanges(): ReadonlyRanges;
+    /**
+     * Default text track controller is null. Tracks that surface text tracks
+     * (e.g. {@link MseTrack}) override this getter.
+     */
+    get textTrackController(): TextTrackController | 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(): SeekRange | null;
     abstract get contentTypes(): ReadonlySet<ContentType>;
     abstract get qualities(): readonly MediaQualityMetadata[] | null;
     abstract get qualitiesUnfiltered(): readonly MediaQualityMetadata[] | null;
@@ -70,6 +64,7 @@ export declare abstract class TrackBase<EventMap extends TrackEventMap = TrackEv
      */
     protected _error: Error | null;
     private _active;
+    private _seekRange;
     protected constructor(
     /**
      * The identifier of this track, used as the key in the track cache.
@@ -79,31 +74,37 @@ export declare abstract class TrackBase<EventMap extends TrackEventMap = TrackEv
      * The track type.
      */
     type: TrackTypeId, deps: TrackBaseDeps);
+    toString(): string;
     get error(): Error | null;
-    preload(_trackOptions: TrackPreloadOptions, _loadOptions: LoadOptionsType): void;
+    preload(_trackOptions: TrackPreloadOptions, _loadOptions: Maybe<ConfigType>): void;
     get extra(): any;
     get active(): boolean;
     get disposed(): boolean;
-    activate(loadOptions: LoadOptionsType): void;
+    activate(loadOptions: Maybe<ConfigType>): void;
     /**
      * The track has been activated.
      * Operations on shared resources such as the playback controller may only be done while the
      * track is currently active. For example if there is a loading operation before the
      * playback source is set, isActive must be checked before the property is changed.
      */
-    abstract onActivated(loadOptions: LoadOptionsType): void;
+    abstract onActivated(loadOptions: Maybe<ConfigType>): void;
     deactivate(): void;
     abstract onDeactivated(): void;
-    toString(): string;
-    protected closeDrmSessions(): void;
     abstract clearPrefetch(): void;
+    protected closeDrmSessions(): void;
+    /**
+     * Resolves to this track's ads.
+     * Implementations may override to provide ad breaks.
+     */
+    getAds(): Promise<TrackAds>;
+    protected setSeekRange(value: SeekRange): void;
     /**
      * Resets the track to recover from error states.
      * Base implementation does nothing.
      *
      * Overrides should dispatch 'reset' after resetting error state.
      */
-    reset(): void;
+    reset(hard?: boolean): void;
     dispose(): void;
 }
 //# sourceMappingURL=TrackBase.d.ts.map

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,gCAAgC,CAAA;AACxE,OAAO,KAAK,EACR,KAAK,EACL,aAAa,EACb,mBAAmB,EACnB,WAAW,EACX,QAAQ,EACX,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,KAAK,EACR,WAAW,EACX,oBAAoB,EACvB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAE,KAAK,UAAU,EAAuB,MAAM,mBAAmB,CAAA;AAExE;;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', {});
     }