@amazon/vinyl 1.2.0 → 2.0.4

package/dist/types/ts3.7/text/TextTrack.d.ts

@@ -0,0 +1,129 @@
+import { ChangeEvent } from '../event/ChangeEvent';
+import { ReadonlyEventHost } from '@amazon/vinyl-util';
+/**
+ * Categorizes the role of a text track. Mirrors HTMLMediaElement.TextTrackKind.
+ */
+export type TextTrackKind = 'subtitles' | 'captions' | 'descriptions' | 'chapters' | 'metadata';
+/**
+ * Identifies and describes an available text track.
+ * One TextTrackInfo is produced per discovered subtitle rendition.
+ */
+export interface TextTrackInfo {
+    /**
+     * A stable, unique identifier within the current media presentation.
+     */
+    readonly id: string;
+    /**
+     * The text track kind. Defaults to 'subtitles' when not otherwise specified.
+     */
+    readonly kind: TextTrackKind;
+    /**
+     * The BCP 47 language tag for the cues in this track, or null if unknown.
+     */
+    readonly language: string | null;
+    /**
+     * A human-readable label for the track.
+     */
+    readonly label: string;
+    /**
+     * Set when the source manifest signals this track as the default selection.
+     */
+    readonly default: boolean;
+    /**
+     * Whether this is a forced track: it carries essential text (e.g.
+     * translations of foreign-language dialogue) meant to be shown even when
+     * the user has not enabled subtitles. Two tracks may share a language and
+     * differ only by this flag, so selection must distinguish them.
+     */
+    readonly forced: boolean;
+    /**
+     * Media characteristics / accessibility roles describing the track, e.g.
+     * `public.accessibility.transcribes-spoken-dialog` (HLS CHARACTERISTICS) or
+     * a DASH role/accessibility scheme value. Empty when none are signaled.
+     */
+    readonly characteristics: readonly string[];
+    /**
+     * The full URL of the underlying text resource (typically a WebVTT file).
+     */
+    readonly uri: string;
+    /**
+     * The MIME type signaled by the source manifest, when known.
+     */
+    readonly mimeType: string | null;
+    /**
+     * HLS EXT-X-DEFINE variables inherited from the parent multivariant
+     * playlist. Sidecar text-track media playlists commonly `IMPORT` these
+     * names and reference them in segment URIs. Present only for HLS-sourced
+     * tracks whose parent playlist declared any variables.
+     */
+    readonly variables?: Readonly<Record<string, string>>;
+}
+/**
+ * Events dispatched by a {@link TextTrackController}.
+ */
+export interface TextTrackEventMap {
+    /**
+     * Emitted when the available text tracks change.
+     */
+    readonly textTracksChange: ChangeEvent<readonly TextTrackInfo[]>;
+    /**
+     * Emitted when the active text track changes.
+     */
+    readonly activeTextTrackChange: ChangeEvent<TextTrackInfo | null>;
+    /**
+     * Emitted when an error occurs while loading or activating a text track.
+     */
+    readonly textTrackError: TextTrackErrorEvent;
+}
+export interface TextTrackErrorEvent {
+    readonly track: TextTrackInfo;
+    readonly error: Error;
+}
+export declare const ALL_TEXT_TRACK_EVENTS: readonly [
+    "textTracksChange",
+    "activeTextTrackChange",
+    "textTrackError"
+];
+/**
+ * Read-only view of available text tracks and the active selection.
+ */
+export interface ReadonlyTextTrackController extends ReadonlyEventHost<TextTrackEventMap> {
+    /**
+     * The list of currently discovered text tracks.
+     */
+    readonly textTracks: readonly TextTrackInfo[];
+    /**
+     * The currently active text track, or null if none is active.
+     */
+    readonly activeTextTrack: TextTrackInfo | null;
+}
+/**
+ * Provides access to the text tracks of the current media and allows
+ * selecting one for playback.
+ *
+ * Selection is persisted across track changes only when applications choose
+ * to call {@link setActiveTextTrack} again on the new track. This matches
+ * how audio tracks are typically driven.
+ */
+export interface TextTrackController extends ReadonlyTextTrackController {
+    /**
+     * Selects the text track with the given id, or clears the active text
+     * track when called with null. No-op if the id does not match a known
+     * text track.
+     */
+    setActiveTextTrack(id: string | null): void;
+    /**
+     * Suspends cue rendering without changing the active selection: cancels any
+     * in-flight load and tears down the DOM text track (so its cues stop
+     * showing). Called when the owning media track is deactivated — e.g. while
+     * an ad plays over the suspended content. {@link resume} rebuilds it.
+     */
+    suspend(): void;
+    /**
+     * Rebuilds the DOM text track for the active selection after a
+     * {@link suspend}, reloading its cues. No-op when nothing is active or when
+     * already rendering. Called when the owning media track is reactivated.
+     */
+    resume(): void;
+}
+//# sourceMappingURL=TextTrack.d.ts.map

package/dist/types/ts3.7/text/VttCueStyle.d.ts

@@ -0,0 +1,41 @@
+import { ObjectSchema } from '@amazon/vinyl-validation';
+/**
+ * Layout style applied to each rendered WebVTT cue, mirroring the settable
+ * positioning properties of the DOM `VTTCue`. Only the properties that are set
+ * are applied; the rest keep the browser defaults.
+ *
+ * These are the WebVTT cue-box layout controls (not text color/font, which are
+ * only reachable via the non-configurable `::cue` pseudo-element). See
+ * {@link https://developer.mozilla.org/docs/Web/API/VTTCue}.
+ */
+export interface VttCueStyle {
+    /** Text alignment within the cue box. */
+    readonly align?: AlignSetting;
+    /** Line (vertical) position, as a line number/percentage or `'auto'`. */
+    readonly line?: number | AutoKeyword;
+    /** How `line` is anchored. */
+    readonly lineAlign?: LineAlignSetting;
+    /** Inline position of the cue box, as a percentage or `'auto'`. */
+    readonly position?: number | AutoKeyword;
+    /** How `position` is anchored. */
+    readonly positionAlign?: PositionAlignSetting;
+    /** Size of the cue box as a percentage of the video dimension. */
+    readonly size?: number;
+    /** Whether `line` is a line number (true) or a percentage (false). */
+    readonly snapToLines?: boolean;
+    /** Writing direction. */
+    readonly vertical?: DirectionSetting;
+}
+/**
+ * Type guard for a DOM cue that is a `VTTCue` (and so carries the WebVTT layout
+ * properties). On platforms without `VTTCue`, cues are plain `TextTrackCue`s
+ * that cannot be styled.
+ */
+export declare function isVttCue(cue: TextTrackCue): cue is VTTCue;
+/**
+ * Applies the configured layout style to a `VTTCue`, setting only the
+ * properties present in `style`.
+ */
+export declare function applyVttCueStyle(cue: VTTCue, style: VttCueStyle): void;
+export declare const vttCueStyleValidator: ObjectSchema<VttCueStyle>;
+//# sourceMappingURL=VttCueStyle.d.ts.map

package/dist/types/ts3.7/text/discoverDashTextTracks.d.ts

@@ -0,0 +1,24 @@
+import { DashManifest } from '@amazon/vinyl-mpd-parser';
+import { TextTrackInfo } from './TextTrack';
+/**
+ * Discovers sidecar text tracks from a DASH manifest.
+ *
+ * Considers an `<AdaptationSet>` to carry text when one of:
+ *  - `contentType="text"`
+ *  - `mimeType` starts with `text/` (e.g. `text/vtt`)
+ *  - `mimeType` is `application/mp4` *and* the codec/role indicates text
+ *
+ * Within a text adaptation set, each `<Representation>` becomes one
+ * {@link TextTrackInfo}. The `BaseURL` chain (MPD → Period → AdaptationSet →
+ * Representation) is resolved against the supplied `baseUrl`.
+ *
+ * Only sidecar (single-file) WebVTT renditions are surfaced. Segmented text
+ * tracks (`stpp`/`wvtt` codecs) are ignored - they would require streaming
+ * through MSE which the sidecar pipeline does not support.
+ *
+ * @param manifest The parsed DASH manifest.
+ * @param baseUrl The URL of the manifest, used as the root for `BaseURL`
+ * resolution.
+ */
+export declare function discoverDashTextTracks(manifest: DashManifest, baseUrl: string): readonly TextTrackInfo[];
+//# sourceMappingURL=discoverDashTextTracks.d.ts.map

package/dist/types/ts3.7/text/discoverHlsTextTracks.d.ts

@@ -0,0 +1,19 @@
+import { HlsMainPlaylist } from '@amazon/vinyl-hls-parser';
+import { TextTrackInfo } from './TextTrack';
+/**
+ * Discovers sidecar text tracks from an HLS multivariant playlist.
+ *
+ * Per RFC 8216 §4.3.4.2, subtitle renditions are signaled with
+ * `EXT-X-MEDIA:TYPE=SUBTITLES` and (when usable as sidecar) carry a `URI`
+ * attribute pointing at a media playlist or, in the simplified single-file
+ * case, a `.vtt` file directly.
+ *
+ * Closed captions (`TYPE=CLOSED-CAPTIONS`) are intentionally excluded - they
+ * are delivered in-band with the video stream and are surfaced by the browser
+ * automatically, not through a sidecar fetch.
+ *
+ * @param mainPlaylist The parsed HLS main playlist.
+ * @param baseUrl The URL of the main playlist, used to resolve relative URIs.
+ */
+export declare function discoverHlsTextTracks(mainPlaylist: HlsMainPlaylist, baseUrl: string): readonly TextTrackInfo[];
+//# sourceMappingURL=discoverHlsTextTracks.d.ts.map

package/dist/types/ts3.7/text/parseWebVtt.d.ts

@@ -0,0 +1,46 @@
+/**
+ * A single WebVTT cue.
+ *
+ * @see https://www.w3.org/TR/webvtt1/
+ */
+export interface WebVttCue {
+    /**
+     * Optional cue identifier, the line that appears before the timing line.
+     */
+    readonly id: string | null;
+    /**
+     * Cue start time in seconds.
+     */
+    readonly startTime: number;
+    /**
+     * Cue end time in seconds.
+     */
+    readonly endTime: number;
+    /**
+     * The cue text payload, with line breaks preserved as `\n`.
+     */
+    readonly text: string;
+}
+/**
+ * The result of parsing a WebVTT document.
+ */
+export interface WebVttDocument {
+    /**
+     * Parsed cues in document order.
+     */
+    readonly cues: readonly WebVttCue[];
+}
+/**
+ * Parses a WebVTT document into a list of cues.
+ *
+ * Implements a forgiving subset of the WebVTT 1.0 specification: header
+ * detection, comment blocks (lines starting with `NOTE`), styling/region
+ * blocks (skipped), cue identifiers, and HH:MM:SS.mmm or MM:SS.mmm timestamps.
+ * Cue settings on the timing line are tolerated and ignored.
+ *
+ * @param input The raw WebVTT document text. Both LF and CRLF line endings
+ * are supported, and a leading BOM is stripped if present.
+ * @throws ValidationError if the input is missing the WEBVTT header.
+ */
+export declare function parseWebVtt(input: string): WebVttDocument;
+//# sourceMappingURL=parseWebVtt.d.ts.map

package/dist/types/ts3.7/text/pickPreferredTextTrack.d.ts

@@ -0,0 +1,14 @@
+import { TextTrackInfo } from './TextTrack';
+/**
+ * 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 declare function pickPreferredTextTrack(tracks: readonly TextTrackInfo[], preferred: string | readonly string[] | null): TextTrackInfo | null;
+//# sourceMappingURL=pickPreferredTextTrack.d.ts.map

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

@@ -1,11 +1,18 @@
-import { AnyRecord, Disposable, LogTarget, ReadonlyEventHost, ReadonlyRanges, ReadonlySet } from '@amazon/vinyl-util';
+import { AnyRecord, Covariant, Disposable, EventHandler, LogTarget, Maybe, ReadonlyEventHost, ReadonlyRanges, ReadonlySet, SignalOptions, Unsubscribe } from '@amazon/vinyl-util';
 import { ContentType, MediaQualityMetadata } from '../streaming/MediaQualityMetadata';
 import { StreamingEventMap } from '../streaming/StreamingEventMap';
+import { ReadonlyTextTrackController, TextTrackController } from '../text/TextTrack';
+import { SeekRange } from './SeekRange';
+import { TrackAds } from '../ad/AdBreakInfo';
+import { TrackConfigOptions } from './TrackFactory';
+export { 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/ts3.7/track/TrackBase.d.ts

@@ -1,10 +1,12 @@
-import { ObjectSchema } from '@amazon/vinyl-validation';
 import { EventHostImpl, Maybe, ReadonlyRanges, ReadonlySet } from '@amazon/vinyl-util';
 import { PlaybackController } from '../playback/PlaybackController';
 import { Track, TrackEventMap, TrackPreloadOptions, TrackTypeId, TrackUri } from './Track';
+import { SeekRange } from './SeekRange';
 import { DrmController } from '../drm/DrmController';
 import { ContentType, MediaQualityMetadata } from '../streaming/MediaQualityMetadata';
-import { DrmOptions } from '../drm/DrmOptions';
+import { TextTrackController } from '../text/TextTrack';
+import { TrackAds } from '../ad/AdBreakInfo';
+import { 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,13 @@ 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;
+    get textTrackController(): (TextTrackController | null);
+    get seekRange(): (SeekRange | null);
     abstract get contentTypes(): ReadonlySet<ContentType>;
     abstract get qualities(): (readonly MediaQualityMetadata[] | null);
     abstract get qualitiesUnfiltered(): (readonly MediaQualityMetadata[] | null);
@@ -70,6 +55,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 +65,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