@amazon/vinyl 1.0.0

package/dist/types/current/playback/ReadonlyPlaybackController.d.ts

@@ -0,0 +1,421 @@
+import type { AnyRecord, ReadonlyEventHost, ReadonlyRanges, Timestamp } from '@amazon/vinyl-util';
+import type { ChangeEvent } from '../event/ChangeEvent';
+import type { BasicErrorEvent } from '../event/BasicErrorEvent';
+export interface ProgressEvent {
+    readonly loaded: number;
+    readonly total: number;
+}
+export interface OperationCompletedEvent<K> {
+    /**
+     * The timestamp the operation began.
+     */
+    readonly started: Timestamp;
+    /**
+     * The timestamp the operation completed.
+     */
+    readonly ended: Timestamp;
+    /**
+     * The total number of seconds the operation took.
+     */
+    readonly duration: number;
+    /**
+     * The reason the operation completed.
+     */
+    readonly reason: K;
+}
+export interface PlayedEvent extends OperationCompletedEvent<PlayedReason> {
+    /**
+     * The total number of seconds elapsed for the track (using `currentTime`).
+     */
+    readonly playbackTime: number;
+}
+/**
+ * The reason playback has stopped.
+ * These are source event types from the media element that all indicate playback has stopped.
+ * @see PlaybackControllerEventMap
+ */
+export declare enum PlayedReason {
+    EMPTIED = "emptied",
+    /**
+     * Note - 'ended' reason is generally unused, however it is not part of the w3c spec to guarantee a 'pause' event
+     * before 'ended'.
+     */
+    ENDED = "ended",
+    PAUSE = "pause",
+    SEEKING = "seeking",
+    WAITING = "waiting"
+}
+/**
+ * A list of all events that cause the 2nd-order 'played' event.
+ */
+export declare const playedReasons: readonly [PlayedReason.EMPTIED, PlayedReason.ENDED, PlayedReason.PAUSE, PlayedReason.SEEKING, PlayedReason.WAITING];
+export interface PlayRejectedEvent {
+    /**
+     * The reason for the play() rejection.
+     *
+     * @see #isNotAllowedError
+     */
+    reason: any;
+}
+export interface PlaybackControllerEventMap {
+    /**
+     * Fired when the resource was not fully loaded, but not as the result of an error.
+     */
+    readonly abort: AnyRecord;
+    /**
+     * Fired when the user agent can play the media, but estimates that not enough data has been
+     * loaded to play the media up to its end without having to stop for further buffering of
+     * content.
+     *
+     * readyState will be at least {@link PlaybackReadyState.HAVE_FUTURE_DATA}
+     */
+    readonly canPlay: AnyRecord;
+    /**
+     * Fired when the user agent can play the media, and estimates that enough data has been
+     * loaded to play the media up to its end without having to stop for further buffering of content.
+     *
+     * readyState will be at least {@link PlaybackReadyState.HAVE_ENOUGH_DATA}
+     */
+    readonly canPlayThrough: AnyRecord;
+    /**
+     * Fired when the duration attribute has been updated.
+     */
+    readonly durationChange: ChangeEvent<number>;
+    /**
+     * Fired when the media has become empty; for example, this event is sent if the media has
+     * already been loaded (or partially loaded), and the load() method is called to reload it.
+     *
+     * readyState will be {@link PlaybackReadyState.HAVE_NOTHING}
+     */
+    readonly emptied: AnyRecord;
+    /**
+     * Fired when playback or streaming has stopped because the end of the media was reached or
+     * because no further data is available.
+     */
+    readonly ended: AnyRecord;
+    /**
+     * Dispatched when the media element dispatches an error.
+     */
+    readonly error: BasicErrorEvent;
+    /**
+     * Fired when {@link ReadonlyPlaybackController.playIsPending} has changed.
+     */
+    readonly playIsPendingChange: ChangeEvent<boolean>;
+    /**
+     * Fired when the frame at the current playback position of the media has finished loading;
+     * often the first frame.
+     *
+     * readyState will be at least {@link PlaybackReadyState.HAVE_CURRENT_DATA}
+     */
+    readonly loadedData: AnyRecord;
+    /**
+     * Fired when the metadata has been loaded.
+     *
+     * readyState will be at least {@link PlaybackReadyState.HAVE_METADATA}
+     */
+    readonly loadedMetadata: AnyRecord;
+    /**
+     * Fired when the browser has started to load a resource.
+     */
+    readonly loadStart: AnyRecord;
+    /**
+     * Fired when {@link ReadonlyPlaybackController.loop} is true and playback has looped to track beginning.
+     */
+    readonly looped: AnyRecord;
+    /**
+     * Fired when the mute status has changed.
+     */
+    readonly mutedChange: ChangeEvent<boolean>;
+    /**
+     * Fired when a request to pause an activity is handled and the activity has entered its paused
+     * state, most commonly after the media has been paused through a call to the element's
+     * pause() method.
+     */
+    readonly pause: AnyRecord;
+    /**
+     * Fired when the paused property is changed from true to false, as a result of the play
+     * method, or the autoplay attribute.
+     */
+    readonly play: AnyRecord;
+    /**
+     * Fired if play() has been attempted, but rejected.
+     */
+    readonly playRejected: PlayRejectedEvent;
+    /**
+     * Fired when playback has stopped, for any reason.
+     *
+     * When media begins playing, a `playing` event is emitted. If playback stops due to 'pause',
+     * 'seeking', 'emptied', 'waiting', or 'ended', then `played` will be fired.
+     */
+    readonly played: PlayedEvent;
+    /**
+     * Fired after playback is first started, and whenever it is restarted. For example, it is
+     * fired when playback resumes after having been paused or delayed due to lack of data.
+     */
+    readonly playing: AnyRecord;
+    /**
+     * Fired periodically as the browser loads a resource.
+     */
+    readonly progress: ProgressEvent;
+    /**
+     * Fired when the playback rate has changed.
+     */
+    readonly rateChange: ChangeEvent<number>;
+    /**
+     * Fired when {@link ReadonlyPlaybackController.readyState} has changed.
+     *
+     * This is fired when any of the following events have fired:
+     * {@link loadedData},
+     * {@link loadedMetadata}
+     * {@link canPlay}
+     * {@link canPlayThrough}
+     * {@link emptied}
+     * {@link waiting}
+     */
+    readonly readyStateChange: ChangeEvent<PlaybackReadyState>;
+    /**
+     * Fired when a seek operation completed, the current playback position has changed, and the
+     * Boolean seeking attribute is changed to false.
+     */
+    readonly seeked: OperationCompletedEvent<'seeked' | 'playing' | 'emptied'>;
+    /**
+     * Fired when a seek operation starts, meaning the Boolean seeking attribute has changed to
+     * true and the media is seeking a new position.
+     */
+    readonly seeking: AnyRecord;
+    /**
+     * Fired when the time indicated by the currentTime attribute has been updated.
+     */
+    readonly timeUpdate: ChangeEvent<number>;
+    /**
+     * Fired when the volume has changed.
+     */
+    readonly volumeChange: ChangeEvent<number>;
+    /**
+     * Fired when playback has stopped because of a temporary lack of data.
+     *
+     * Note: this includes during initial loading or after a seek and data is needed to buffer.
+     * Will not be emitted when paused.
+     */
+    readonly waiting: AnyRecord;
+    /**
+     * Fired when waiting has completed.
+     * This will be emitted after a waiting event when playback has resumed, paused, or unloaded.
+     */
+    readonly waited: OperationCompletedEvent<WaitedReason>;
+    /**
+     * Playback is blocked waiting for a key.
+     */
+    readonly waitingForKey: AnyRecord;
+    /**
+     * Emitted when the error state has been reset.
+     */
+    readonly reset: AnyRecord;
+}
+/**
+ * Reasons why a 'waiting' operation has ended.
+ */
+export declare enum WaitedReason {
+    PLAYING = "playing",
+    PAUSE = "pause",
+    EMPTIED = "emptied",
+    SEEKING = "seeking"
+}
+/**
+ * A list of all events that cause the 2nd-order 'waited' event.
+ */
+export declare const waitedReasons: readonly [WaitedReason.PLAYING, WaitedReason.PAUSE, WaitedReason.EMPTIED, WaitedReason.SEEKING];
+export declare const ALL_PLAYBACK_STATE_EVENTS: readonly ["abort", "canPlay", "canPlayThrough", "durationChange", "emptied", "ended", "error", "playIsPendingChange", "loadedData", "loadedMetadata", "loadStart", "looped", "mutedChange", "pause", "play", "playRejected", "played", "playing", "progress", "rateChange", "readyStateChange", "reset", "seeked", "seeking", "timeUpdate", "volumeChange", "waited", "waiting", "waitingForKey"];
+export declare enum PlaybackReadyState {
+    /**
+     * No information is available about the media resource.
+     *
+     * readyState will be this after `emptied`
+     */
+    HAVE_NOTHING = 0,
+    /**
+     * Enough of the media resource has been retrieved that the metadata attributes are initialized
+     * Seeking will no longer raise an exception.
+     *
+     * readyState will be at least this after `loadedMetadata`
+     */
+    HAVE_METADATA = 1,
+    /**
+     * Data is available for the current playback position, but not enough to actually play more
+     * than one frame.
+     *
+     * readyState will be at least this after `loadedData`
+     */
+    HAVE_CURRENT_DATA = 2,
+    /**
+     * Data for the current playback position as well as for at least a little bit of time into the
+     * future is available (in other words, at least two frames of video, for example).
+     *
+     * readyState will be at least this after `canPlay`
+     */
+    HAVE_FUTURE_DATA = 3,
+    /**
+     * Enough data is available—and the download rate is high enough—that the media can be played
+     * through to the end without interruption.
+     *
+     * readyState will be at least this after `canPlayThrough`
+     */
+    HAVE_ENOUGH_DATA = 4
+}
+/**
+ * An enumeration of possible networkState values on a media element.
+ */
+export declare enum PlaybackNetworkState {
+    /**
+     * There is no data yet. Also, readyState is HAVE_NOTHING.
+     */
+    NETWORK_EMPTY = 0,
+    /**
+     * HTMLMediaElement is active and has selected a resource, but is not using the network.
+     */
+    NETWORK_IDLE = 1,
+    /**
+     * The browser is downloading HTMLMediaElement data.
+     */
+    NETWORK_LOADING = 2,
+    /**
+     * No HTMLMediaElement src found.
+     */
+    NETWORK_NO_SOURCE = 3
+}
+export interface ReadonlyPlaybackController extends ReadonlyEventHost<PlaybackControllerEventMap> {
+    /**
+     * Returns a new static normalized ReadonlyRanges object that represents the ranges of the
+     * media resource, if any, that the user agent has buffered at the moment the buffered
+     * property is accessed.
+     *
+     * Note: `ReadonlyRanges` is a view to the DOM `TimeRanges` object.
+     */
+    readonly buffered: ReadonlyRanges;
+    /**
+     * True if the {@link readyState} is {@link PlaybackReadyState.HAVE_FUTURE_DATA}
+     * This will be true after a {@link PlaybackControllerEventMap.canPlay} event.
+     *
+     * Note that security permissions may not allow a track to load past metadata before there has
+     * been a user interaction. This should not be relied upon before invoking
+     * {@link PlaybackController.play}.
+     */
+    readonly canPlay: boolean;
+    /**
+     * True if the {@link readyState} is {@link PlaybackReadyState.HAVE_ENOUGH_DATA}
+     * This will be true after a {@link PlaybackControllerEventMap.canPlayThrough} event.
+     *
+     * Note that security permissions may not allow a track to load past metadata before there has
+     * been a user interaction. This should not be relied upon before invoking
+     * {@link PlaybackController.play}.
+     */
+    readonly canPlayThrough: boolean;
+    /**
+     * The current playback time in seconds.
+     * When changed, a 'timeUpdate' event is emitted.
+     */
+    readonly currentTime: number;
+    /**
+     * Returns current time as a percent of the total duration.
+     *
+     * @return A number between 0-1
+     */
+    readonly currentTimePercent: number;
+    /**
+     * The default playback rate when the user is not using fast forward or reverse for a
+     * video or audio resource.
+     */
+    readonly defaultPlaybackRate: number;
+    /**
+     * The length of the element's media in seconds.
+     * Observe changes with `durationChange` events.
+     */
+    readonly duration: number;
+    /**
+     * Indicates whether the media element has ended playback.
+     */
+    readonly ended: boolean;
+    /**
+     * The Error object for the most recent error, or null if there has not been an error.
+     * When an error event is received by the element, you can determine details about what
+     * happened by examining this object.
+     */
+    readonly error: Error | null;
+    /**
+     * True if the {@link readyState} is at least {@link PlaybackReadyState.HAVE_METADATA}
+     *
+     * This will be true after a {@link PlaybackControllerEventMap.loadedMetadata} event and
+     * false after an {@link PlaybackControllerEventMap.emptied} event.
+     */
+    readonly hasMetadata: boolean;
+    /**
+     * Controls whether the media element should start over when it reaches the end.
+     */
+    readonly loop: boolean;
+    /**
+     * Indicates whether the media element muted.
+     * Observe changes with `mutedChange` events.
+     */
+    readonly muted: boolean;
+    /**
+     * Indicates the current state of the fetching of media over the network.
+     */
+    readonly networkState: PlaybackNetworkState;
+    /**
+     * Indicates whether the media element is paused.
+     * Observe changes with `play` and `pause` events.
+     */
+    readonly paused: boolean;
+    /**
+     * Sets the rate at which the media is being played back. This is used to implement user
+     * controls for fast-forward, slow motion, and so forth. The normal playback rate is
+     * multiplied by this value to obtain the current rate, so a value of 1.0 indicates normal
+     * speed.
+     */
+    readonly playbackRate: number;
+    /**
+     * True if playback has started, is not paused, stalled, or seeking.
+     * Observe changes with 'playing' and 'played' events.
+     */
+    readonly playing: boolean;
+    /**
+     * True if `play` has been called and the returned promise is currently in a pending state.
+     * Observe changes with {@link PlaybackControllerEventMap.playIsPendingChange} events.
+     */
+    readonly playIsPending: boolean;
+    /**
+     * Determines whether the browser should adjust the pitch of the audio to compensate
+     * for changes to the playback rate.
+     * Default: true
+     */
+    readonly preservesPitch: boolean;
+    /**
+     * Indicates the readiness state of the media.
+     * Observe changes with {@link PlaybackControllerEventMap.readyStateChange} events.
+     */
+    readonly readyState: PlaybackReadyState;
+    /**
+     * Returns a new static normalized `ReadonlyRanges` object that represents the ranges of the
+     * media resource, if any, that the user agent is able to seek to at the time seekable
+     * property is accessed.
+     *
+     * Note: `ReadonlyRanges` is a view to the DOM `TimeRanges` object.
+     */
+    readonly seekable: ReadonlyRanges;
+    /**
+     * True if the element is currently seeking.
+     * Observe changes with `seeking` and `seeked` events.
+     */
+    readonly seeking: boolean;
+    /**
+     * The volume level for audio portions of the media element.
+     * Observe changes with `volumeChange` events.
+     */
+    readonly volume: number;
+    /**
+     * True if playback is stopped due to waiting for data.
+     * Observe changes with `waiting` and `waited` events.
+     */
+    readonly waiting: boolean;
+}
+//# sourceMappingURL=ReadonlyPlaybackController.d.ts.map

package/dist/types/current/playback/ReadonlyPlaybackController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadonlyPlaybackController.d.ts","sourceRoot":"","sources":["../../../../src/playback/ReadonlyPlaybackController.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACR,SAAS,EACT,iBAAiB,EACjB,cAAc,EACd,SAAS,EACZ,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAE9D,MAAM,WAAW,aAAa;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,uBAAuB,CAAC,CAAC;IACtC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;CACrB;AAED,MAAM,WAAW,WAAY,SAAQ,uBAAuB,CAAC,YAAY,CAAC;IACtE;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;CAChC;AAED;;;;GAIG;AACH,oBAAY,YAAY;IACpB,OAAO,YAAY;IACnB;;;OAGG;IACH,KAAK,UAAU;IACf,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,OAAO,YAAY;CACtB;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,qHAMkB,CAAA;AAE5C,MAAM,WAAW,iBAAiB;IAC9B;;;;OAIG;IACH,MAAM,EAAE,GAAG,CAAA;CACd;AAED,MAAM,WAAW,0BAA0B;IACvC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAA;IAEzB;;;;;;OAMG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAA;IAE3B;;;;;OAKG;IACH,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAA;IAElC;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAE5C;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAA;IAE3B;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAA;IAE/B;;OAEG;IACH,QAAQ,CAAC,mBAAmB,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAElD;;;;;OAKG;IACH,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAA;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAA;IAElC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAE7B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAE1C;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAA;IAEzB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,iBAAiB,CAAA;IAExC;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAA;IAE5B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAExC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,gBAAgB,EAAE,WAAW,CAAC,kBAAkB,CAAC,CAAA;IAE1D;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,uBAAuB,CAAC,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC,CAAA;IAE1E;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAExC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAE1C;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAA;IAE3B;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,uBAAuB,CAAC,YAAY,CAAC,CAAA;IAEtD;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAA;IAEjC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAA;CAC5B;AAED;;GAEG;AACH,oBAAY,YAAY;IACpB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,OAAO,YAAY;CACtB;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,iGAKkB,CAAA;AAE5C,eAAO,MAAM,yBAAyB,mYA8B4B,CAAA;AAElE,oBAAY,kBAAkB;IAC1B;;;;OAIG;IACH,YAAY,IAAI;IAEhB;;;;;OAKG;IACH,aAAa,IAAI;IAEjB;;;;;OAKG;IACH,iBAAiB,IAAI;IAErB;;;;;OAKG;IACH,gBAAgB,IAAI;IAEpB;;;;;OAKG;IACH,gBAAgB,IAAI;CACvB;AAED;;GAEG;AACH,oBAAY,oBAAoB;IAC5B;;OAEG;IACH,aAAa,IAAI;IAEjB;;OAEG;IACH,YAAY,IAAI;IAEhB;;OAEG;IACH,eAAe,IAAI;IAEnB;;OAEG;IACH,iBAAiB,IAAI;CACxB;AAED,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB,CAAC,0BAA0B,CAAC;IAC7F;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAA;IAEjC;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IAEzB;;;;;;;OAOG;IACH,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAA;IAEhC;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAE5B;;;;OAIG;IACH,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAA;IAEnC;;;OAGG;IACH,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAA;IAEpC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;IAEvB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;IAE5B;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAA;IAE7B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IAEtB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;IAEvB;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,oBAAoB,CAAA;IAE3C;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IAExB;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAE7B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IAEzB;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAA;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAA;IAEhC;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAA;IAEvC;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAA;IAEjC;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IAEzB;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IAEvB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAC5B"}

package/dist/types/current/playback/ReadonlyPlaybackController.js

@@ -0,0 +1,140 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * The reason playback has stopped.
+ * These are source event types from the media element that all indicate playback has stopped.
+ * @see PlaybackControllerEventMap
+ */
+export var PlayedReason;
+(function (PlayedReason) {
+    PlayedReason["EMPTIED"] = "emptied";
+    /**
+     * Note - 'ended' reason is generally unused, however it is not part of the w3c spec to guarantee a 'pause' event
+     * before 'ended'.
+     */
+    PlayedReason["ENDED"] = "ended";
+    PlayedReason["PAUSE"] = "pause";
+    PlayedReason["SEEKING"] = "seeking";
+    PlayedReason["WAITING"] = "waiting";
+})(PlayedReason || (PlayedReason = {}));
+/**
+ * A list of all events that cause the 2nd-order 'played' event.
+ */
+export const playedReasons = [
+    PlayedReason.EMPTIED,
+    PlayedReason.ENDED,
+    PlayedReason.PAUSE,
+    PlayedReason.SEEKING,
+    PlayedReason.WAITING,
+];
+/**
+ * Reasons why a 'waiting' operation has ended.
+ */
+export var WaitedReason;
+(function (WaitedReason) {
+    WaitedReason["PLAYING"] = "playing";
+    WaitedReason["PAUSE"] = "pause";
+    WaitedReason["EMPTIED"] = "emptied";
+    WaitedReason["SEEKING"] = "seeking";
+})(WaitedReason || (WaitedReason = {}));
+/**
+ * A list of all events that cause the 2nd-order 'waited' event.
+ */
+export const waitedReasons = [
+    WaitedReason.PLAYING,
+    WaitedReason.PAUSE,
+    WaitedReason.EMPTIED,
+    WaitedReason.SEEKING,
+];
+export const ALL_PLAYBACK_STATE_EVENTS = [
+    'abort',
+    'canPlay',
+    'canPlayThrough',
+    'durationChange',
+    'emptied',
+    'ended',
+    'error',
+    'playIsPendingChange',
+    'loadedData',
+    'loadedMetadata',
+    'loadStart',
+    'looped',
+    'mutedChange',
+    'pause',
+    'play',
+    'playRejected',
+    'played',
+    'playing',
+    'progress',
+    'rateChange',
+    'readyStateChange',
+    'reset',
+    'seeked',
+    'seeking',
+    'timeUpdate',
+    'volumeChange',
+    'waited',
+    'waiting',
+    'waitingForKey',
+];
+export var PlaybackReadyState;
+(function (PlaybackReadyState) {
+    /**
+     * No information is available about the media resource.
+     *
+     * readyState will be this after `emptied`
+     */
+    PlaybackReadyState[PlaybackReadyState["HAVE_NOTHING"] = 0] = "HAVE_NOTHING";
+    /**
+     * Enough of the media resource has been retrieved that the metadata attributes are initialized
+     * Seeking will no longer raise an exception.
+     *
+     * readyState will be at least this after `loadedMetadata`
+     */
+    PlaybackReadyState[PlaybackReadyState["HAVE_METADATA"] = 1] = "HAVE_METADATA";
+    /**
+     * Data is available for the current playback position, but not enough to actually play more
+     * than one frame.
+     *
+     * readyState will be at least this after `loadedData`
+     */
+    PlaybackReadyState[PlaybackReadyState["HAVE_CURRENT_DATA"] = 2] = "HAVE_CURRENT_DATA";
+    /**
+     * Data for the current playback position as well as for at least a little bit of time into the
+     * future is available (in other words, at least two frames of video, for example).
+     *
+     * readyState will be at least this after `canPlay`
+     */
+    PlaybackReadyState[PlaybackReadyState["HAVE_FUTURE_DATA"] = 3] = "HAVE_FUTURE_DATA";
+    /**
+     * Enough data is available—and the download rate is high enough—that the media can be played
+     * through to the end without interruption.
+     *
+     * readyState will be at least this after `canPlayThrough`
+     */
+    PlaybackReadyState[PlaybackReadyState["HAVE_ENOUGH_DATA"] = 4] = "HAVE_ENOUGH_DATA";
+})(PlaybackReadyState || (PlaybackReadyState = {}));
+/**
+ * An enumeration of possible networkState values on a media element.
+ */
+export var PlaybackNetworkState;
+(function (PlaybackNetworkState) {
+    /**
+     * There is no data yet. Also, readyState is HAVE_NOTHING.
+     */
+    PlaybackNetworkState[PlaybackNetworkState["NETWORK_EMPTY"] = 0] = "NETWORK_EMPTY";
+    /**
+     * HTMLMediaElement is active and has selected a resource, but is not using the network.
+     */
+    PlaybackNetworkState[PlaybackNetworkState["NETWORK_IDLE"] = 1] = "NETWORK_IDLE";
+    /**
+     * The browser is downloading HTMLMediaElement data.
+     */
+    PlaybackNetworkState[PlaybackNetworkState["NETWORK_LOADING"] = 2] = "NETWORK_LOADING";
+    /**
+     * No HTMLMediaElement src found.
+     */
+    PlaybackNetworkState[PlaybackNetworkState["NETWORK_NO_SOURCE"] = 3] = "NETWORK_NO_SOURCE";
+})(PlaybackNetworkState || (PlaybackNetworkState = {}));

package/dist/types/current/playback/error/InvalidSeekError.d.ts

@@ -0,0 +1,16 @@
+import { type Json, ReportableError } from '@amazon/vinyl-util';
+import type { ReadonlyRanges } from '@amazon/vinyl-util';
+/**
+ * An error indicating a seek was out of range.
+ * This will have an error level of `ErrorLevel.WARN`.
+ * This indicates a bad seek request, but is recoverable.
+ */
+export declare class InvalidSeekError extends ReportableError {
+    readonly time: number;
+    readonly seekable: ReadonlyRanges;
+    readonly tolerance: number;
+    get [Symbol.toStringTag](): string;
+    constructor(time: number, seekable: ReadonlyRanges, tolerance: number);
+    toJSON(): Json;
+}
+//# sourceMappingURL=InvalidSeekError.d.ts.map

package/dist/types/current/playback/error/InvalidSeekError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InvalidSeekError.d.ts","sourceRoot":"","sources":["../../../../../src/playback/error/InvalidSeekError.ts"],"names":[],"mappings":"AAKA,OAAO,EAAc,KAAK,IAAI,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAE3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,eAAe;IAM7C,QAAQ,CAAC,IAAI,EAAE,MAAM;IACrB,QAAQ,CAAC,QAAQ,EAAE,cAAc;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM;IAP9B,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;gBAGY,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,cAAc,EACxB,SAAS,EAAE,MAAM;IAU9B,MAAM,IAAI,IAAI;CAOjB"}

package/dist/types/current/playback/error/InvalidSeekError.js

@@ -0,0 +1,33 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ErrorLevel, ReportableError } from '@amazon/vinyl-util';
+import { ErrorOrigin } from '@amazon/vinyl-util';
+/**
+ * An error indicating a seek was out of range.
+ * This will have an error level of `ErrorLevel.WARN`.
+ * This indicates a bad seek request, but is recoverable.
+ */
+export class InvalidSeekError extends ReportableError {
+    time;
+    seekable;
+    tolerance;
+    get [Symbol.toStringTag]() {
+        return 'InvalidSeekError';
+    }
+    constructor(time, seekable, tolerance) {
+        super(`Could not seek to time: ${time}, outside of seekable ranges ${seekable} with tolerance ${tolerance}`, ErrorOrigin.API, ErrorLevel.WARN);
+        this.time = time;
+        this.seekable = seekable;
+        this.tolerance = tolerance;
+        Object.setPrototypeOf(this, InvalidSeekError.prototype);
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            time: this.time,
+            seekable: Array.from(this.seekable),
+        };
+    }
+}

package/dist/types/current/playback/error/ReportableMediaError.d.ts

@@ -0,0 +1,16 @@
+import { type Json, type Maybe, ReportableError } from '@amazon/vinyl-util';
+/**
+ * An error from the media element
+ */
+export declare class ReportableMediaError extends ReportableError {
+    static readonly MEDIA_ERR_ABORTED = 1;
+    static readonly MEDIA_ERR_NETWORK = 2;
+    static readonly MEDIA_ERR_DECODE = 3;
+    static readonly MEDIA_ERR_SRC_NOT_SUPPORTED = 4;
+    get [Symbol.toStringTag](): string;
+    readonly reason: string;
+    readonly code: number;
+    constructor(error: Maybe<MediaError>);
+    toJSON(): Json;
+}
+//# sourceMappingURL=ReportableMediaError.d.ts.map

package/dist/types/current/playback/error/ReportableMediaError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReportableMediaError.d.ts","sourceRoot":"","sources":["../../../../../src/playback/error/ReportableMediaError.ts"],"names":[],"mappings":"AAKA,OAAO,EAGH,KAAK,IAAI,EACT,KAAK,KAAK,EACV,eAAe,EAClB,MAAM,oBAAoB,CAAA;AAG3B;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,eAAe;IAErD,MAAM,CAAC,QAAQ,CAAC,iBAAiB,KAAI;IACrC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,KAAI;IACrC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,KAAI;IACpC,MAAM,CAAC,QAAQ,CAAC,2BAA2B,KAAI;IAE/C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;gBAET,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC;IAYpC,MAAM,IAAI,IAAI;CAOjB"}

package/dist/types/current/playback/error/ReportableMediaError.js

@@ -0,0 +1,38 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ErrorLevel, ErrorOrigin, ReportableError, } from '@amazon/vinyl-util';
+import { mediaErrorToJson } from '../../playback/logging/mediaErrorToJson';
+/**
+ * An error from the media element
+ */
+export class ReportableMediaError extends ReportableError {
+    // Copied from MediaError to ensure compatibility in Node
+    static MEDIA_ERR_ABORTED = 1;
+    static MEDIA_ERR_NETWORK = 2;
+    static MEDIA_ERR_DECODE = 3;
+    static MEDIA_ERR_SRC_NOT_SUPPORTED = 4;
+    get [Symbol.toStringTag]() {
+        return 'ReportableMediaError';
+    }
+    reason;
+    code;
+    constructor(error) {
+        const { name, code, message } = mediaErrorToJson(error);
+        const level = error == null || code === ReportableMediaError.MEDIA_ERR_ABORTED
+            ? ErrorLevel.SILENT
+            : ErrorLevel.FATAL;
+        super(message, ErrorOrigin.MEDIA, level);
+        this.reason = name;
+        this.code = code;
+        Object.setPrototypeOf(this, ReportableMediaError.prototype);
+    }
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            reason: this.reason,
+            code: this.code,
+        };
+    }
+}