@amazon/vinyl 1.0.0

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

@@ -0,0 +1,83 @@
+import { type AnyRecord, type Clearable, type Disposable, EventHostImpl, type ReadonlyEventHost } from '@amazon/vinyl-util';
+import type { PlaybackController } from '../playback/PlaybackController';
+export interface AutoResetControllerEventMap {
+    /**
+     * Notifies that playback errors should be reset and retried.
+     */
+    readonly reset: AnyRecord;
+}
+/**
+ * Notifies when playback should be reset and retried.
+ *
+ * The controller monitors for retry opportunities after an error is set:
+ * - Immediately on network 'online' events
+ * - After a timeout interval if online
+ * - Immediately on user playback actions (play, pause, seeking, playing)
+ *
+ * Each error triggers a single timeout. If another error occurs after a reset,
+ * setError() should be called again to schedule the next retry attempt.
+ */
+export interface AutoResetController extends ReadonlyEventHost<AutoResetControllerEventMap>, Clearable {
+    /**
+     * Sets the current playback error and begins monitoring for retry opportunities.
+     *
+     * Only SERVICE_INTERNAL ReportableErrors are monitored. Subsequent calls while
+     * an error is already set are ignored until the error is cleared via reset or clear().
+     *
+     * After a reset, if another error occurs, this method should be called again
+     * to schedule the next retry attempt.
+     *
+     * @param error The error to monitor for retry opportunities
+     */
+    setError(error: Error): void;
+}
+export interface AutoResetControllerImplDeps {
+    readonly playbackController: PlaybackController;
+}
+export interface AutoResetControllerImplOptions {
+    /**
+     * If false, disables auto reset behavior.
+     * default: true
+     */
+    readonly enabled: boolean;
+    /**
+     * The total number of times to reset when there has not been successful
+     * playback.
+     *
+     * E.g. a retryInterval of 30 and maxRetries of 30 will retry for 15 minutes before stopping.
+     *
+     * default: 30
+     */
+    readonly maxRetries: number;
+    /**
+     * The number of seconds between retries.
+     *
+     * When an error is set, a single timeout is scheduled for this interval.
+     * If the retry limit hasn't been reached and the device is online, a reset
+     * event is emitted. For subsequent errors after reset, setError() must be
+     * called again to schedule the next retry timeout.
+     */
+    readonly retryInterval: number;
+}
+export declare const defaultResetControllerOptions: {
+    readonly enabled: true;
+    readonly maxRetries: 30;
+    readonly retryInterval: 30;
+};
+export declare class AutoResetControllerImpl extends EventHostImpl<AutoResetControllerEventMap> implements AutoResetController, Disposable {
+    readonly deps: AutoResetControllerImplDeps;
+    get [Symbol.toStringTag](): string;
+    private readonly options;
+    private _error;
+    private watchSub;
+    private currentRetry;
+    private disposer;
+    constructor(deps: AutoResetControllerImplDeps, options?: Partial<AutoResetControllerImplOptions>);
+    setError(error: Error): void;
+    private setWatching;
+    private reset;
+    clear(): void;
+    get disposed(): boolean;
+    dispose(): void;
+}
+//# sourceMappingURL=AutoResetController.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AutoResetController.d.ts","sourceRoot":"","sources":["../../../../src/track/AutoResetController.ts"],"names":[],"mappings":"AAKA,OAAO,EACH,KAAK,SAAS,EACd,KAAK,SAAS,EAEd,KAAK,UAAU,EAEf,aAAa,EAIb,KAAK,iBAAiB,EAGzB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAEvE,MAAM,WAAW,2BAA2B;IACxC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAA;CAC5B;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,mBACb,SAAQ,iBAAiB,CAAC,2BAA2B,CAAC,EAAE,SAAS;IACjE;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;CAC/B;AAED,MAAM,WAAW,2BAA2B;IACxC,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAA;CAClD;AAED,MAAM,WAAW,8BAA8B;IAC3C;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IAEzB;;;;;;;OAOG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAE3B;;;;;;;OAOG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;CACjC;AAED,eAAO,MAAM,6BAA6B;;;;CAIS,CAAA;AAEnD,qBAAa,uBACT,SAAQ,aAAa,CAAC,2BAA2B,CACjD,YAAW,mBAAmB,EAAE,UAAU;IAatC,QAAQ,CAAC,IAAI,EAAE,2BAA2B;IAX9C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgC;IACxD,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,QAAQ,CAA2B;IAC3C,OAAO,CAAC,YAAY,CAAI;IACxB,OAAO,CAAC,QAAQ,CAAmB;gBAGtB,IAAI,EAAE,2BAA2B,EAC1C,OAAO,CAAC,EAAE,OAAO,CAAC,8BAA8B,CAAC;IAuBrD,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAW5B,OAAO,CAAC,WAAW;IA6BnB,OAAO,CAAC,KAAK;IAMb,KAAK;IAML,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED,OAAO,IAAI,IAAI;CAIlB"}

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

@@ -0,0 +1,91 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { createDisposer, ErrorOrigin, EventHostImpl, getNetworkState, logDebug, onAny, ReportableError, } from '@amazon/vinyl-util';
+export const defaultResetControllerOptions = {
+    enabled: true,
+    maxRetries: 30,
+    retryInterval: 30,
+};
+export class AutoResetControllerImpl extends EventHostImpl {
+    deps;
+    get [Symbol.toStringTag]() {
+        return 'AutoResetControllerImpl';
+    }
+    options;
+    _error = null;
+    watchSub = null;
+    currentRetry = 0;
+    disposer = createDisposer();
+    constructor(deps, options) {
+        super();
+        this.deps = deps;
+        logDebug(this, 'constructor');
+        this.options = {
+            ...defaultResetControllerOptions,
+            ...options,
+        };
+        this.disposer.add(onAny(deps.playbackController, ['play', 'pause', 'seeking', 'playing'], (_event) => {
+            // On certain user-initiated playback events, reset the currentRetry count and emit a reset event
+            // if in an error state.
+            this.currentRetry = 0;
+            this.reset();
+        }));
+    }
+    setError(error) {
+        if (!this.options.enabled || this._error)
+            return;
+        if (error instanceof ReportableError &&
+            error.origin === ErrorOrigin.SERVICE_INTERNAL) {
+            this._error = error;
+            this.setWatching(true);
+        }
+    }
+    setWatching(value) {
+        logDebug(this, 'setWatching', value);
+        this.watchSub?.();
+        this.watchSub = null;
+        if (!value)
+            return;
+        const networkState = getNetworkState();
+        const { add, dispose: watchSub } = createDisposer();
+        this.watchSub = watchSub;
+        add(networkState.on('online', () => {
+            logDebug(this, 'online, emitting reset');
+            this.reset();
+        }));
+        const intervalId = setTimeout(() => {
+            if (this.currentRetry++ < this.options.maxRetries) {
+                if (networkState.onLine) {
+                    logDebug(this, 'interval, emitting reset');
+                    this.reset();
+                }
+            }
+            else {
+                logDebug(this, 'max retries exhausted, pausing playback');
+                this.setWatching(false);
+            }
+        }, this.options.retryInterval * 1000);
+        add(() => clearTimeout(intervalId));
+    }
+    reset() {
+        if (!this._error)
+            return;
+        this.clear();
+        this.dispatch('reset', {});
+    }
+    clear() {
+        if (!this._error)
+            return;
+        this._error = null;
+        this.setWatching(false);
+    }
+    get disposed() {
+        return this.disposer.disposed;
+    }
+    dispose() {
+        this.disposer.dispose();
+        this.clear();
+    }
+}

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

@@ -0,0 +1,153 @@
+import type { AnyRecord, Disposable, LogTarget, ReadonlyEventHost, ReadonlyRanges, ReadonlySet } from '@amazon/vinyl-util';
+import type { ContentType, MediaQualityMetadata } from '../streaming/MediaQualityMetadata';
+import type { StreamingEventMap } from '../streaming/StreamingEventMap';
+/**
+ * All events a track may emit.
+ * Streaming-related events are separated as they will be bubbled by the player.
+ */
+export type TrackEventMap = StreamingEventMap;
+/**
+ * An identifier for a Track, used for referencing a track.
+ */
+export type TrackUri = string;
+/**
+ * A track type identifier. Used to match a track type to its registered factory function.
+ */
+export type TrackTypeId = string;
+/**
+ * Track prefetch configuration provided by the track controller.
+ */
+export interface TrackPreloadOptions {
+    /**
+     * Track priority for prefetching.
+     * Higher values take precedence.
+     */
+    readonly prefetchPriority: number;
+}
+/**
+ * Represents the streaming-related state for a single track.
+ *
+ * Provides read-only access to:
+ * - The currently fetched media time ranges
+ * - The current streaming, buffering, and playback quality metadata
+ *
+ * To observe changes over time, listen to events defined in {@link StreamingEventMap},
+ * including:
+ * - `streamingQualityChange`
+ * - `bufferingQualityChange`
+ * - `playbackQualityChange`
+ */
+export interface ReadonlyStreamingState extends ReadonlyEventHost<StreamingEventMap> {
+    /**
+     * The time ranges the track has fetched.
+     * This will be a snapshot of the fetched ranges at the time this property is accessed.
+     */
+    readonly fetchedRanges: ReadonlyRanges;
+    /**
+     * The current content types for the active streams, e.g. Set(['audio', 'video'])
+     */
+    readonly contentTypes: ReadonlySet<ContentType>;
+    /**
+     * The available qualities for the current period, after filtering.
+     * Null if the timeline is not yet available.
+     */
+    readonly qualities: readonly MediaQualityMetadata[] | null;
+    /**
+     * The available unfiltered qualities for the current period.
+     * Null if the timeline is not yet available.
+     */
+    readonly qualitiesUnfiltered: readonly MediaQualityMetadata[] | null;
+    /**
+     * The currently streaming media quality for the given content stream.
+     * This is set when a new quality is being requested.
+     *
+     * Quality metadata progresses as follows:
+     * streamingQuality -> bufferingQuality -> playbackQuality
+     *
+     * Listen to {@link TrackEventMap.streamingQualityChange} events for changes.
+     * @param contentType 'video' | 'audio' | 'text'
+     */
+    getStreamingQuality(contentType: ContentType): MediaQualityMetadata | null;
+    /**
+     * The currently buffering media quality for the given content stream.
+     * This is set immediately before a segment of a new quality is appended.
+     *
+     * Listen to {@link TrackEventMap.bufferingQualityChange} events for changes.
+     * @param contentType 'video' | 'audio' | 'text'
+     */
+    getBufferingQuality(contentType: ContentType): MediaQualityMetadata | null;
+    /**
+     * When this track is active, provides the currently playing media metadata
+     * for the given content type.
+     *
+     * Listen to {@link TrackEventMap.playbackQualityChange} events for changes.
+     * @param contentType 'video' | 'audio' | 'text'
+     */
+    getPlaybackQuality(contentType: ContentType): MediaQualityMetadata | null;
+}
+export interface StreamingState extends ReadonlyStreamingState {
+    /**
+     * Clears any buffered or prefetched data, if applicable.
+     */
+    clearPrefetch(): void;
+    /**
+     * Resets the track to recover from error states.
+     * This will reset failed segments and clear error conditions to allow streaming to resume.
+     */
+    reset(): void;
+}
+export interface ReadonlyTrack extends ReadonlyStreamingState, LogTarget {
+    /**
+     * The track identifier.
+     */
+    readonly uri: TrackUri;
+    /**
+     * The type of track.
+     */
+    readonly type: TrackTypeId;
+    /**
+     * True if the track is the currently playing track.
+     */
+    readonly active: boolean;
+    /**
+     * True if the track has been disposed.
+     */
+    readonly disposed: boolean;
+    /**
+     * Returns the `extra` object from the load configuration's `config` when
+     * this track is active, or null if this track is not active.
+     */
+    readonly extra: any;
+    /**
+     * The last error that occurred in this track, or null if no error.
+     */
+    readonly error: Error | null;
+}
+/**
+ * One track is active on the track controller at a time.
+ */
+export interface Track<LoadOptionsType extends AnyRecord = AnyRecord> extends ReadonlyTrack, StreamingState, Disposable {
+    /**
+     * 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;
+    /**
+     * 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
+     * resources.
+     *
+     * @param loadOptions Configuration from `TrackLoadOptions.config`, provided by the Application.
+     */
+    activate(loadOptions: LoadOptionsType): void;
+    /**
+     * Sets this track as inactive.
+     * This should unset sources, and remove any listeners. Tracks do not implement disposable,
+     * when they are deactivated they are expected to be free for garbage collection if there
+     * are no longer references to the track.
+     */
+    deactivate(): void;
+}
+//# sourceMappingURL=Track.d.ts.map

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

@@ -0,0 +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,kCAAkC,CAAA;AACzC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA;AAEtE;;;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"}

package/dist/types/current/track/Track.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/TrackBase.d.ts

@@ -0,0 +1,109 @@
+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 DrmController } from '../drm/DrmController';
+import type { ContentType, MediaQualityMetadata } from '../streaming/MediaQualityMetadata';
+import { type DrmOptions } from '../drm/DrmOptions';
+/**
+ * Dependencies for TrackBase.
+ */
+export interface TrackBaseDeps {
+    /**
+     * When the track is activated, playback will seek to the track's start time.
+     */
+    readonly playbackController: PlaybackController;
+    /**
+     * DrmController manages track encryption.
+     */
+    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> {
+    /**
+     * The identifier of this track, used as the key in the track cache.
+     */
+    readonly uri: TrackUri;
+    /**
+     * The track type.
+     */
+    readonly type: TrackTypeId;
+    protected readonly deps: TrackBaseDeps;
+    get [Symbol.toStringTag](): string;
+    /**
+     * The current load options, if this is an active track.
+     */
+    protected loadOptions: LoadOptionsType | null;
+    protected readonly errorHandler: (error: any) => void;
+    protected readonly disposer: import("@amazon/vinyl-util").Disposer;
+    protected drmSessionAbort: import("@amazon/vinyl-util").AbortSlot;
+    get fetchedRanges(): ReadonlyRanges;
+    abstract get contentTypes(): ReadonlySet<ContentType>;
+    abstract get qualities(): readonly MediaQualityMetadata[] | null;
+    abstract get qualitiesUnfiltered(): readonly MediaQualityMetadata[] | null;
+    abstract getStreamingQuality(contentType: ContentType): MediaQualityMetadata | null;
+    abstract getBufferingQuality(contentType: ContentType): MediaQualityMetadata | null;
+    abstract getPlaybackQuality(contentType: ContentType): MediaQualityMetadata | null;
+    /**
+     * Sets on handleError, cleared on 'reset'.
+     */
+    protected _error: Error | null;
+    private _active;
+    protected constructor(
+    /**
+     * The identifier of this track, used as the key in the track cache.
+     */
+    uri: TrackUri, 
+    /**
+     * The track type.
+     */
+    type: TrackTypeId, deps: TrackBaseDeps);
+    get error(): Error | null;
+    preload(_trackOptions: TrackPreloadOptions, _loadOptions: LoadOptionsType): void;
+    get extra(): any;
+    get active(): boolean;
+    get disposed(): boolean;
+    activate(loadOptions: LoadOptionsType): 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;
+    deactivate(): void;
+    abstract onDeactivated(): void;
+    toString(): string;
+    protected closeDrmSessions(): void;
+    abstract clearPrefetch(): void;
+    /**
+     * Resets the track to recover from error states.
+     * Base implementation does nothing.
+     *
+     * Overrides should dispatch 'reset' after resetting error state.
+     */
+    reset(): void;
+    dispose(): void;
+}
+//# sourceMappingURL=TrackBase.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,127 @@
+/*
+ * 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(),
+});
+/**
+ * A base class for all tracks.
+ */
+export class TrackBase extends EventHostImpl {
+    uri;
+    type;
+    deps;
+    get [Symbol.toStringTag]() {
+        return 'TrackBase';
+    }
+    /**
+     * The current load options, if this is an active track.
+     */
+    loadOptions = null;
+    errorHandler = (error) => {
+        if (this._error)
+            return; // Already in an error state
+        if (!isSilentError(error)) {
+            this._error = error;
+            this.dispatch('error', {
+                target: this,
+                error,
+            });
+        }
+    };
+    disposer = createDisposer();
+    drmSessionAbort = createAbortSlot();
+    get fetchedRanges() {
+        return emptyRanges;
+    }
+    /**
+     * Sets on handleError, cleared on 'reset'.
+     */
+    _error = null;
+    _active = false;
+    constructor(
+    /**
+     * The identifier of this track, used as the key in the track cache.
+     */
+    uri, 
+    /**
+     * The track type.
+     */
+    type, deps) {
+        super();
+        this.uri = uri;
+        this.type = type;
+        this.deps = deps;
+    }
+    get error() {
+        return this._error;
+    }
+    preload(_trackOptions, _loadOptions) { }
+    get extra() {
+        return this.loadOptions?.extra ?? null;
+    }
+    get active() {
+        return this._active;
+    }
+    get disposed() {
+        return this.disposer.disposed;
+    }
+    activate(loadOptions) {
+        if (this._active)
+            return;
+        this.loadOptions = loadOptions;
+        this.reset(); // Reset error state on activate
+        this._active = true;
+        logDebug(this, 'activate', this.uri);
+        this.deps.playbackController
+            .seekTo(loadOptions.startTime ?? 0)
+            .catch(noop);
+        this.deps.drmController.configure(loadOptions.drm);
+        this.onActivated(loadOptions);
+    }
+    deactivate() {
+        if (!this._active)
+            return;
+        this._active = false;
+        this.loadOptions = null;
+        logDebug(this, 'deactivate', this.uri);
+        this.deps.playbackController.pause();
+        this.onDeactivated();
+        this.closeDrmSessions();
+    }
+    toString() {
+        return `[${this[Symbol.toStringTag]}#${this.uri}]`;
+    }
+    closeDrmSessions() {
+        this.drmSessionAbort.abort();
+    }
+    /**
+     * 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) {
+            logDebug(this, 'reset no-op');
+            return;
+        }
+        logDebug(this, 'reset');
+        this._error = null;
+        this.dispatch('reset', {});
+    }
+    dispose() {
+        if (this.active)
+            this.deactivate();
+        else
+            this.closeDrmSessions(); // closes sessions created from prefetch.
+        this.disposer.dispose();
+        super.dispose();
+    }
+}