@amazon/vinyl 3.0.1 → 3.1.0

package/dist/vinylTestUtil/types/current/util/playback/eventPromises.js

@@ -10,7 +10,7 @@ import { nextEventAsPromise } from '@amazon/vinyl-util';
  * @param playbackController The playbackController reference. Can be the player.
  * @param timeout The timeout (in seconds) before the promise will reject with a timeout.
  */
-export async function onPlaying(playbackController, timeout = 10) {
+export async function onPlaying(playbackController, timeout = 30) {
     if (playbackController.playing)
         return Promise.resolve();
     return nextEventAsPromise(playbackController, 'playing', {

package/dist/vinylTestUtil/types/current/util/playback/expectTrackCanSeek.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"expectTrackCanSeek.d.ts","sourceRoot":"","sources":["../../../../../../test/vinylTestUtil/util/playback/expectTrackCanSeek.ts"],"names":[],"mappings":"AAKA,OAAO,EAA+B,KAAK,WAAW,EAAE,MAAM,eAAe,CAAA;AAe7E,wBAAsB,oBAAoB,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,iBAgE3E"}
+{"version":3,"file":"expectTrackCanSeek.d.ts","sourceRoot":"","sources":["../../../../../../test/vinylTestUtil/util/playback/expectTrackCanSeek.ts"],"names":[],"mappings":"AAKA,OAAO,EAA+B,KAAK,WAAW,EAAE,MAAM,eAAe,CAAA;AAe7E,wBAAsB,oBAAoB,CAAC,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,iBAwE3E"}

package/dist/vinylTestUtil/types/current/util/playback/expectTrackCanSeek.js

@@ -17,6 +17,13 @@ export async function expectTrackCanSeekTo(player, time) {
     const playedSpy = add(createEventSpy(player, 'played'));
     const seekingSpy = add(createEventSpy(player, 'seeking'));
     const seekedSpy = add(createEventSpy(player, 'seeked'));
+    // A seek can be re-issued (WebKit sometimes lands the play head off
+    // target), producing several seeking/seeked pairs. Track order so we can
+    // assert a seeking preceded the first seeked without requiring a single,
+    // non-interleaved pair.
+    const eventOrder = [];
+    add(player.on('seeking', () => eventOrder.push('seeking')));
+    add(player.on('seeked', () => eventOrder.push('seeked')));
     const wasPaused = player.paused;
     if (player.playing) {
         seekingSpy
@@ -52,7 +59,8 @@ export async function expectTrackCanSeekTo(player, time) {
         // Event expectations:
         // If playing before seekTo: played, seeking, seeked
         // If paused: seeking, seeked.
-        expect(seekingSpy).toHaveBeenCalledBefore(seekedSpy);
+        // A seeking must precede the first seeked (re-issued seeks allowed).
+        expect(eventOrder[0]).withContext('first seek event').toBe('seeking');
         expect(player.paused).withContext('paused').toBe(wasPaused);
         if (wasPaused) {
             expectPausedState(player);

package/dist/vinylTestUtil/types/ts3.7/assets/vinylTestAssets.d.ts

@@ -24,6 +24,7 @@ export declare const vinylTestAssets: {
     readonly dash: {
         readonly live_static_aac_opus_flac_60s_segmentTemplate: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_aac_opus_flac_60s_segmentTemplate/manifest.mpd";
         readonly live_static_aac_opus_flac_60s_segmentBase: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_aac_opus_flac_60s_segmentBase/manifest.mpd";
+        readonly live_static_webm_vp9_opus_60s_segmentBase: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_webm_vp9_opus_60s_segmentBase/manifest.mpd";
         readonly live_static_video_audio_60s_2s_segmentTemplate: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_video_audio_60s_2s_segmentTemplate/manifest.mpd";
         readonly live_static_video_audio_60s_4s_segmentTemplate: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_video_audio_60s_4s_segmentTemplate/manifest.mpd";
         readonly live_static_video_audio_60s_2s_segmentTemplate_widevine_cl10: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_video_audio_60s_2s_segmentTemplate_widevine_cl10/manifest.mpd";

package/dist/vinylTestUtil/types/ts3.7/mock/streaming/MockContentStream.d.ts

@@ -9,7 +9,6 @@ export declare class MockContentStream extends MockEventHost<StreamingEventMap>
     playbackQuality: MediaQualityMetadata | null;
     streamingQuality: MediaQualityMetadata | null;
     bufferingEnded: boolean;
-    hasData: boolean;
     clearPrefetch: import("@amazon/vinyl-util/browserTestUtil").Spy2<() => void>;
     activate: import("@amazon/vinyl-util/browserTestUtil").Spy2<(options: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl").ContentStreamActivateOptions>) => void>;
     deactivate: import("@amazon/vinyl-util/browserTestUtil").Spy2<() => void>;

package/dist/vinylTestUtil/types/ts3.7/mock/streaming/buffering/MockBufferingController.d.ts

@@ -4,7 +4,6 @@ export declare class MockBufferingController extends MockEventHost<BufferingCont
     error: Error | null;
     active: boolean;
     bufferingEnded: boolean;
-    hasData: boolean;
     playbackQuality: MediaQualityMetadata | null;
     bufferingQuality: MediaQualityMetadata | null;
     activate: import("@amazon/vinyl-util/browserTestUtil").Spy2<() => void>;

package/dist/vinylTestUtil/types/ts4.1/assets/vinylTestAssets.d.ts

@@ -24,6 +24,7 @@ export declare const vinylTestAssets: {
     readonly dash: {
         readonly live_static_aac_opus_flac_60s_segmentTemplate: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_aac_opus_flac_60s_segmentTemplate/manifest.mpd";
         readonly live_static_aac_opus_flac_60s_segmentBase: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_aac_opus_flac_60s_segmentBase/manifest.mpd";
+        readonly live_static_webm_vp9_opus_60s_segmentBase: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_webm_vp9_opus_60s_segmentBase/manifest.mpd";
         readonly live_static_video_audio_60s_2s_segmentTemplate: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_video_audio_60s_2s_segmentTemplate/manifest.mpd";
         readonly live_static_video_audio_60s_4s_segmentTemplate: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_video_audio_60s_4s_segmentTemplate/manifest.mpd";
         readonly live_static_video_audio_60s_2s_segmentTemplate_widevine_cl10: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_video_audio_60s_2s_segmentTemplate_widevine_cl10/manifest.mpd";

package/dist/vinylTestUtil/types/ts4.1/mock/streaming/MockContentStream.d.ts

@@ -9,7 +9,6 @@ export declare class MockContentStream extends MockEventHost<StreamingEventMap>
     playbackQuality: MediaQualityMetadata | null;
     streamingQuality: MediaQualityMetadata | null;
     bufferingEnded: boolean;
-    hasData: boolean;
     clearPrefetch: import("@amazon/vinyl-util/browserTestUtil").Spy2<() => void>;
     activate: import("@amazon/vinyl-util/browserTestUtil").Spy2<(options: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl").ContentStreamActivateOptions>) => void>;
     deactivate: import("@amazon/vinyl-util/browserTestUtil").Spy2<() => void>;

package/dist/vinylTestUtil/types/ts4.1/mock/streaming/buffering/MockBufferingController.d.ts

@@ -4,7 +4,6 @@ export declare class MockBufferingController extends MockEventHost<BufferingCont
     error: Error | null;
     active: boolean;
     bufferingEnded: boolean;
-    hasData: boolean;
     playbackQuality: MediaQualityMetadata | null;
     bufferingQuality: MediaQualityMetadata | null;
     activate: import("@amazon/vinyl-util/browserTestUtil").Spy2<() => void>;

package/dist/vinylTestUtil/types/ts4.7/assets/vinylTestAssets.d.ts

@@ -24,6 +24,7 @@ export declare const vinylTestAssets: {
     readonly dash: {
         readonly live_static_aac_opus_flac_60s_segmentTemplate: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_aac_opus_flac_60s_segmentTemplate/manifest.mpd";
         readonly live_static_aac_opus_flac_60s_segmentBase: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_aac_opus_flac_60s_segmentBase/manifest.mpd";
+        readonly live_static_webm_vp9_opus_60s_segmentBase: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_webm_vp9_opus_60s_segmentBase/manifest.mpd";
         readonly live_static_video_audio_60s_2s_segmentTemplate: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_video_audio_60s_2s_segmentTemplate/manifest.mpd";
         readonly live_static_video_audio_60s_4s_segmentTemplate: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_video_audio_60s_4s_segmentTemplate/manifest.mpd";
         readonly live_static_video_audio_60s_2s_segmentTemplate_widevine_cl10: "https://assets.dev.vinyl.music.amazon.dev/dash/live_static_video_audio_60s_2s_segmentTemplate_widevine_cl10/manifest.mpd";

package/dist/vinylTestUtil/types/ts4.7/mock/streaming/MockContentStream.d.ts

@@ -9,7 +9,6 @@ export declare class MockContentStream extends MockEventHost<StreamingEventMap>
     playbackQuality: MediaQualityMetadata | null;
     streamingQuality: MediaQualityMetadata | null;
     bufferingEnded: boolean;
-    hasData: boolean;
     clearPrefetch: import("@amazon/vinyl-util/browserTestUtil").Spy2<() => void>;
     activate: import("@amazon/vinyl-util/browserTestUtil").Spy2<(options: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl").ContentStreamActivateOptions>) => void>;
     deactivate: import("@amazon/vinyl-util/browserTestUtil").Spy2<() => void>;

package/dist/vinylTestUtil/types/ts4.7/mock/streaming/buffering/MockBufferingController.d.ts

@@ -4,7 +4,6 @@ export declare class MockBufferingController extends MockEventHost<BufferingCont
     error: Error | null;
     active: boolean;
     bufferingEnded: boolean;
-    hasData: boolean;
     playbackQuality: MediaQualityMetadata | null;
     bufferingQuality: MediaQualityMetadata | null;
     activate: import("@amazon/vinyl-util/browserTestUtil").Spy2<() => void>;

package/docs/USAGE.md

@@ -113,6 +113,12 @@ Dash track default behavior is to treat the `uri` as the Dash MPD location. This
 can be overridden with a custom manifest provider, which is returns a parsed
 dash manifest.
 
+DASH streams may use ISO-BMFF (MP4/fMP4) or WebM containers, with
+`SegmentTemplate`, `SegmentList`, or `SegmentBase` addressing. `SegmentBase`
+streams are indexed from their ISO-BMFF `sidx` box or WebM `Cues` element as
+appropriate. Codec support (e.g. AVC/HEVC/VP9 video, AAC/Opus/FLAC audio) is
+gated by the browser's Media Source Extensions support.
+
 ```typescript
 player.load({
     type: 'dash',
@@ -322,6 +328,29 @@ Read the API Docs on `PlaybackControllerEventMap` for the full list of playback
 events. Most events are directly from the media element, but there are
 additional second-order events such as 'played', 'waited', or 'mutedChange'.
 
+### Stall Detection
+
+Vinyl detects when the play head freezes during playback (no `timeUpdate` for
+longer than a threshold) and reports it as a `stallEntered`/`stallEnded` pair.
+Unlike the media's `waiting`/`waited` events, a stall is only reported once
+playback has actually been observed — never during initial loading or while
+awaiting a seek — and `stallEnded` carries the full frozen duration.
+
+```typescript
+player.on('stallEntered', () => {
+    // The play head has frozen mid-playback; e.g. show a buffering spinner.
+})
+player.on('stallEnded', (event) => {
+    // event.reason is one of 'playing' (resumed), 'pause', 'seeking', 'emptied'.
+    // event.duration is the number of seconds the play head was frozen,
+    // measured from the last timeUpdate before the freeze.
+    console.log(`stalled for ${event.duration}s, ended by ${event.reason}`)
+})
+```
+
+The freeze threshold defaults to 1 second and is configurable via the
+`stallThreshold` playback option.
+
 ### Buffer Status
 
 There are two concepts to understand when talking about how much data is

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@amazon/vinyl",
-    "version": "3.0.1",
+    "version": "3.1.0",
     "description": "An HTML5 streaming media player",
     "repository": {
         "type": "git",
@@ -90,17 +90,18 @@
         "oxlint:write": "oxlint --type-aware --fix"
     },
     "devDependencies": {
-        "@amazon/vinyl-build-utils": "^3.0.1",
-        "commander": "^9.5.0"
+        "@amazon/vinyl-browserstack": "^3.1.0",
+        "@amazon/vinyl-build-utils": "^3.1.0",
+        "commander": "^15.0.0"
     },
     "dependencies": {
-        "@amazon/vinyl-di": "^3.0.1",
-        "@amazon/vinyl-hls-parser": "^3.0.1",
-        "@amazon/vinyl-mpd-parser": "^3.0.1",
-        "@amazon/vinyl-observable": "^3.0.1",
-        "@amazon/vinyl-transmux": "^3.0.1",
-        "@amazon/vinyl-util": "^3.0.1",
-        "@amazon/vinyl-validation": "^3.0.1"
+        "@amazon/vinyl-di": "^3.1.0",
+        "@amazon/vinyl-hls-parser": "^3.1.0",
+        "@amazon/vinyl-mpd-parser": "^3.1.0",
+        "@amazon/vinyl-observable": "^3.1.0",
+        "@amazon/vinyl-transmux": "^3.1.0",
+        "@amazon/vinyl-util": "^3.1.0",
+        "@amazon/vinyl-validation": "^3.1.0"
     },
     "publishConfig": {
         "access": "public"

package/dist/types/current/patch/media/HtmlMediaElementPatch.d.ts

@@ -1,3 +0,0 @@
-import type { Patch } from '@amazon/vinyl-util';
-export type HtmlMediaElementPatch = Patch<HTMLMediaElement, HTMLMediaElementEventMap>;
-//# sourceMappingURL=HtmlMediaElementPatch.d.ts.map

package/dist/types/current/patch/media/HtmlMediaElementPatch.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HtmlMediaElementPatch.d.ts","sourceRoot":"","sources":["../../../../../src/patch/media/HtmlMediaElementPatch.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAA;AAE/C,MAAM,MAAM,qBAAqB,GAAG,KAAK,CACrC,gBAAgB,EAChB,wBAAwB,CAC3B,CAAA"}

package/dist/types/current/patch/media/HtmlMediaElementPatch.js

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

package/dist/types/current/patch/media/MediaElementPatchOptions.d.ts

@@ -1,19 +0,0 @@
-export interface MediaElementPatchOptions {
-    /**
-     * Playback events 'playing' and 'waiting' are unreliable after seeking.
-     *
-     * Risks for false positive: LOW. Timing of emitted playing events may be subtly
-     * different, but they will not be duplicated.
-     * Risks for false negative: MEDIUM. Certain playback events on affected platforms will be missed.
-     */
-    readonly unreliablePlaybackEvents?: boolean;
-    /**
-     * The affected user agent gets into a state where playback can become stalled and needs help getting unstuck.
-     */
-    readonly preventStalls?: boolean;
-}
-/**
- * Aggregates flags for toggling patches.
- */
-export declare const defaultMediaElementPatchOptions: import("@amazon/vinyl-util").Lazy<Required<MediaElementPatchOptions>>;
-//# sourceMappingURL=MediaElementPatchOptions.d.ts.map

package/dist/types/current/patch/media/MediaElementPatchOptions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"MediaElementPatchOptions.d.ts","sourceRoot":"","sources":["../../../../../src/patch/media/MediaElementPatchOptions.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,wBAAwB;IACrC;;;;;;OAMG;IACH,QAAQ,CAAC,wBAAwB,CAAC,EAAE,OAAO,CAAA;IAE3C;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAA;CACnC;AAED;;GAEG;AACH,eAAO,MAAM,+BAA+B,uEAO1C,CAAA"}

package/dist/types/current/patch/media/MediaElementPatchOptions.js

@@ -1,16 +0,0 @@
-/*
- * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-import { lazy } from '@amazon/vinyl-util';
-import { requiresUnreliablePlaybackEventsPatch } from './patches/createUnreliablePlaybackEventsPatch';
-import { requiresPreventStallsPatch } from './patches/createPreventStallsPatch';
-/**
- * Aggregates flags for toggling patches.
- */
-export const defaultMediaElementPatchOptions = lazy(() => {
-    return {
-        unreliablePlaybackEvents: requiresUnreliablePlaybackEventsPatch(),
-        preventStalls: requiresPreventStallsPatch(),
-    };
-});

package/dist/types/current/patch/media/patchMediaElement.d.ts

@@ -1,9 +0,0 @@
-import { type PatchedRef } from '@amazon/vinyl-util';
-import type { MediaElementPatchOptions } from './MediaElementPatchOptions';
-/**
- * Applies patches corresponding to the patch flags on the given media element.
- *
- * Adds logging for fabricated or squelched events.
- */
-export declare function patchMediaElement<T extends HTMLMediaElement = HTMLMediaElement>(media: T, options: MediaElementPatchOptions): PatchedRef<T>;
-//# sourceMappingURL=patchMediaElement.d.ts.map

package/dist/types/current/patch/media/patchMediaElement.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"patchMediaElement.d.ts","sourceRoot":"","sources":["../../../../../src/patch/media/patchMediaElement.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,UAAU,EAAwB,MAAM,oBAAoB,CAAA;AAC1E,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAI1E;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC7B,CAAC,SAAS,gBAAgB,GAAG,gBAAgB,EAC/C,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,wBAAwB,GAAG,UAAU,CAAC,CAAC,CAAC,CAO5D"}

package/dist/types/current/patch/media/patchMediaElement.js

@@ -1,15 +0,0 @@
-/*
- * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-import { patchTargetFromFlags } from '@amazon/vinyl-util';
-import { createUnreliablePlaybackEventsPatch } from './patches/createUnreliablePlaybackEventsPatch';
-import { createPreventStallsPatch } from './patches/createPreventStallsPatch';
-/**
- * Applies patches corresponding to the patch flags on the given media element.
- *
- * Adds logging for fabricated or squelched events.
- */
-export function patchMediaElement(media, options) {
-    return patchTargetFromFlags(media, options, ['unreliablePlaybackEvents', createUnreliablePlaybackEventsPatch], ['preventStalls', createPreventStallsPatch]);
-}

package/dist/types/current/patch/media/patches/createPreventStallsPatch.d.ts

@@ -1,17 +0,0 @@
-import type { HtmlMediaElementPatch } from '../HtmlMediaElementPatch';
-/**
- * The number of timeupdate events stuck at the same position before attempting to jiggle the playhead.
- * @private
- */
-export declare const MAX_UNCHANGED_COUNT = 10;
-/**
- * On affected UAs, playback can become stuck. timeupdate events are observed but playback position is never changing.
- * This patch applies a workaround which will pause and play again after max number of timeupdate events with no
- * actual time progression.
- */
-export declare function createPreventStallsPatch(media: HTMLMediaElement): HtmlMediaElementPatch;
-/**
- * Returns true if stall detection should be enabled for the current user agent.
- */
-export declare function requiresPreventStallsPatch(): boolean;
-//# sourceMappingURL=createPreventStallsPatch.d.ts.map

package/dist/types/current/patch/media/patches/createPreventStallsPatch.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createPreventStallsPatch.d.ts","sourceRoot":"","sources":["../../../../../../src/patch/media/patches/createPreventStallsPatch.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAA;AAErE;;;GAGG;AACH,eAAO,MAAM,mBAAmB,KAAK,CAAA;AAErC;;;;GAIG;AACH,wBAAgB,wBAAwB,CACpC,KAAK,EAAE,gBAAgB,GACxB,qBAAqB,CAmCvB;AAED;;GAEG;AACH,wBAAgB,0BAA0B,IAAI,OAAO,CAEpD"}

package/dist/types/current/patch/media/patches/createPreventStallsPatch.js

@@ -1,55 +0,0 @@
-/*
- * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-import { Browser, closeTo, createDisposer, createLogPrefix, DomEventHost, hasBrowser, logInfo, logWarn, noop, } from '@amazon/vinyl-util';
-/**
- * The number of timeupdate events stuck at the same position before attempting to jiggle the playhead.
- * @private
- */
-export const MAX_UNCHANGED_COUNT = 10;
-/**
- * On affected UAs, playback can become stuck. timeupdate events are observed but playback position is never changing.
- * This patch applies a workaround which will pause and play again after max number of timeupdate events with no
- * actual time progression.
- */
-export function createPreventStallsPatch(media) {
-    const { add, dispose } = createDisposer();
-    const domEvents = add(new DomEventHost(media));
-    const pathTarget = {
-        logPrefix: createLogPrefix('createPreventStallsPatch'),
-    };
-    let unchangedCount = 0;
-    let attemptedFix = false;
-    let previousTime = media.currentTime;
-    domEvents.on('timeupdate', () => {
-        if (media.paused)
-            return;
-        if (closeTo(media.currentTime, previousTime, 0.01)) {
-            if (++unchangedCount >= MAX_UNCHANGED_COUNT && !attemptedFix) {
-                logWarn(pathTarget, `Detected stall at time ${media.currentTime}, attempting fix`);
-                attemptedFix = true;
-                unchangedCount = 0;
-                media.pause();
-                media.play().catch(noop);
-            }
-        }
-        else {
-            if (attemptedFix) {
-                logInfo(pathTarget, 'stall ended');
-                attemptedFix = false;
-            } // Unstuck
-            unchangedCount = 0;
-            previousTime = media.currentTime;
-        }
-    });
-    return {
-        dispose,
-    };
-}
-/**
- * Returns true if stall detection should be enabled for the current user agent.
- */
-export function requiresPreventStallsPatch() {
-    return hasBrowser(Browser.EDGE_LEGACY);
-}

package/dist/types/current/patch/media/patches/createUnreliablePlaybackEventsPatch.d.ts

@@ -1,26 +0,0 @@
-import type { HtmlMediaElementPatch } from '../HtmlMediaElementPatch';
-/**
- * The interval (in seconds) to poll for time progress in a media element.
- *
- * @private
- */
-export declare const UNRELIABLE_EVENTS_POLL_INTERVAL = 0.2;
-/**
- * Minimum amount of time playback must be stalled before fabricating a waiting event.
- */
-export declare const MIN_STALLED_BEFORE_FAB = 0.8;
-/**
- * Minimum amount of time playback must be progressing before fabricating a playing event.
- */
-export declare const MIN_PLAYING_BEFORE_FAB = 0.4;
-/**
- * Playback events such as playing, canPlay, and waiting are unreliable on this platform.
- * Watch playback state and fabricate events when necessary.
- */
-export declare function createUnreliablePlaybackEventsPatch(media: HTMLMediaElement): HtmlMediaElementPatch;
-/**
- * Chrome <= 53 has unreliable waiting events.
- * Safari, and Edge Legacy miss playing events after seeking.
- */
-export declare function requiresUnreliablePlaybackEventsPatch(): boolean;
-//# sourceMappingURL=createUnreliablePlaybackEventsPatch.d.ts.map

package/dist/types/current/patch/media/patches/createUnreliablePlaybackEventsPatch.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createUnreliablePlaybackEventsPatch.d.ts","sourceRoot":"","sources":["../../../../../../src/patch/media/patches/createUnreliablePlaybackEventsPatch.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAA;AAErE;;;;GAIG;AACH,eAAO,MAAM,+BAA+B,MAAM,CAAA;AAElD;;GAEG;AACH,eAAO,MAAM,sBAAsB,MAAM,CAAA;AAEzC;;GAEG;AACH,eAAO,MAAM,sBAAsB,MAAM,CAAA;AA6BzC;;;GAGG;AACH,wBAAgB,mCAAmC,CAC/C,KAAK,EAAE,gBAAgB,GACxB,qBAAqB,CAyMvB;AAED;;;GAGG;AACH,wBAAgB,qCAAqC,IAAI,OAAO,CAM/D"}

package/dist/types/current/patch/media/patches/createUnreliablePlaybackEventsPatch.js

@@ -1,218 +0,0 @@
-/*
- * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
- * SPDX-License-Identifier: Apache-2.0
- */
-import { Browser, hasBrowser } from '@amazon/vinyl-util';
-import { closeTo, createDisposer, DomEventHost, onAny, SignalImpl, } from '@amazon/vinyl-util';
-/**
- * The interval (in seconds) to poll for time progress in a media element.
- *
- * @private
- */
-export const UNRELIABLE_EVENTS_POLL_INTERVAL = 0.2;
-/**
- * Minimum amount of time playback must be stalled before fabricating a waiting event.
- */
-export const MIN_STALLED_BEFORE_FAB = 0.8;
-/**
- * Minimum amount of time playback must be progressing before fabricating a playing event.
- */
-export const MIN_PLAYING_BEFORE_FAB = 0.4;
-/**
- * If currentTime does not change larger than this value, it will be considered to be stalled.
- */
-const MIN_PLAYING_DELTA = 0.05;
-/**
- * If currentTime changes beyond this tolerance the apparent state will be considered to be seeking.
- */
-const MIN_SEEKING_DELTA = 0.5;
-var PlayHeadState;
-(function (PlayHeadState) {
-    /**
-     * The last time update was an increment from the previous.
-     */
-    PlayHeadState[PlayHeadState["PLAYING"] = 0] = "PLAYING";
-    /**
-     * The last time update was close to the previous.
-     */
-    PlayHeadState[PlayHeadState["STOPPED"] = 1] = "STOPPED";
-    /**
-     * The last time update was a non-incremental change.
-     */
-    PlayHeadState[PlayHeadState["SEEKING"] = 2] = "SEEKING";
-})(PlayHeadState || (PlayHeadState = {}));
-/**
- * Playback events such as playing, canPlay, and waiting are unreliable on this platform.
- * Watch playback state and fabricate events when necessary.
- */
-export function createUnreliablePlaybackEventsPatch(media) {
-    const { add, dispose } = createDisposer();
-    const domEvents = add(new DomEventHost(media));
-    const eventFabricated = add(new SignalImpl());
-    // The timestamp of the last change.
-    let stateChangedAt = Date.now();
-    // The current observed state based on the play head progress.
-    let currentApparentState = PlayHeadState.STOPPED;
-    /**
-     * @param state The new apparent state.
-     * @param changedAt The timestamp the apparent state was changed.
-     */
-    function setApparentState(state, changedAt = Date.now()) {
-        if (currentApparentState !== state) {
-            currentApparentState = state;
-            stateChangedAt = changedAt;
-        }
-    }
-    /**
-     * Returns the number of seconds since the last state change.
-     */
-    function elapsedStateTime() {
-        return (Date.now() - stateChangedAt) / 1000;
-    }
-    let lastTimestamp = Date.now();
-    let lastTime = media.currentTime;
-    let waiting = false;
-    let seeking = false;
-    onAny(domEvents, ['emptied', 'ended', 'pause', 'playing', 'seeking'], () => {
-        waiting = false;
-    });
-    let playing = false;
-    onAny(domEvents, ['emptied', 'ended', 'pause', 'seeking', 'waiting'], () => {
-        playing = false;
-    });
-    domEvents.on('seeking', () => {
-        seeking = true;
-    });
-    domEvents.on('seeked', () => {
-        seeking = false;
-        setApparentState(PlayHeadState.SEEKING);
-    });
-    domEvents.on('play', () => {
-        // Resets the timer so that the !paused state does not immediately trigger a 'waiting' event.
-        stateChangedAt = Date.now();
-    });
-    // All events that can affect the ready state.
-    // canplay and canplaythrough are handled in the overridden events map.
-    const readyStateEvents = [
-        'emptied',
-        'loadeddata',
-        'loadedmetadata',
-        'waiting',
-    ];
-    let lastReadyStateEvent = 'emptied';
-    add(onAny(domEvents, readyStateEvents, (_, type) => {
-        lastReadyStateEvent = type;
-    }));
-    const checkApparentState = () => {
-        const progressed = (media.currentTime - lastTime) / media.playbackRate;
-        const now = Date.now();
-        if (Math.abs(progressed) > MIN_SEEKING_DELTA) {
-            setApparentState(PlayHeadState.SEEKING, lastTimestamp);
-        }
-        else if (progressed >= MIN_PLAYING_DELTA) {
-            setApparentState(PlayHeadState.PLAYING, lastTimestamp);
-        }
-        else if (closeTo(progressed, 0, MIN_PLAYING_DELTA)) {
-            setApparentState(PlayHeadState.STOPPED, lastTimestamp);
-        }
-        lastTime = media.currentTime;
-        lastTimestamp = now;
-        if (!playing &&
-            !seeking &&
-            !media.paused &&
-            !media.ended &&
-            media.readyState >= media.HAVE_FUTURE_DATA &&
-            currentApparentState === PlayHeadState.PLAYING &&
-            elapsedStateTime() >= MIN_PLAYING_BEFORE_FAB) {
-            // The play head is progressing but a playing event was never observed.
-            waiting = false;
-            playing = true;
-            if (lastReadyStateEvent !== 'canplay' &&
-                lastReadyStateEvent !== 'canplaythrough') {
-                lastReadyStateEvent = 'canplay';
-                eventFabricated.dispatch(new CustomEvent('canplay'));
-            }
-            if (media.readyState >= media.HAVE_ENOUGH_DATA) {
-                if (lastReadyStateEvent !== 'canplaythrough') {
-                    lastReadyStateEvent = 'canplaythrough';
-                    eventFabricated.dispatch(new CustomEvent('canplaythrough'));
-                }
-            }
-            eventFabricated.dispatch(new CustomEvent('playing'));
-        }
-        if (!waiting &&
-            !media.paused &&
-            !media.ended &&
-            currentApparentState === PlayHeadState.STOPPED &&
-            elapsedStateTime() >= MIN_STALLED_BEFORE_FAB) {
-            waiting = true;
-            playing = false;
-            // currentTime is not changing; playback has stopped but no 'waiting' event
-            // was observed.
-            eventFabricated.dispatch(new CustomEvent('waiting'));
-        }
-    };
-    const playbackWatchIntervalId = setInterval(checkApparentState, UNRELIABLE_EVENTS_POLL_INTERVAL * 1000);
-    add(() => {
-        clearInterval(playbackWatchIntervalId);
-    });
-    return {
-        eventFabricated,
-        properties: {
-            /**
-             * Platforms that have unreliable waiting events, also have unreliable ready state
-             * when the end of buffered data has been reached. If the media is in a waiting state,
-             * the highest ready state that is possible is HAVE_METADATA.
-             */
-            readyState: {
-                get() {
-                    return waiting
-                        ? Math.min(media.readyState, media.HAVE_METADATA)
-                        : media.readyState;
-                },
-            },
-        },
-        events: {
-            canplay(event) {
-                // Do not emit the canplay event if one was fabricated.
-                const eventOrNull = lastReadyStateEvent === 'canplay' ? null : event;
-                lastReadyStateEvent = 'canplay';
-                return eventOrNull;
-            },
-            canplaythrough(event) {
-                // Do not emit the canplaythrough event if one was fabricated.
-                const eventOrNull = lastReadyStateEvent === 'canplaythrough' ? null : event;
-                lastReadyStateEvent = 'canplaythrough';
-                return eventOrNull;
-            },
-            playing(event) {
-                if (playing) {
-                    // Do not emit the playing event if one was fabricated.
-                    return null;
-                }
-                setApparentState(PlayHeadState.PLAYING);
-                playing = true;
-                return event;
-            },
-            waiting(event) {
-                if (waiting) {
-                    // Do not emit the waiting event if one was fabricated.
-                    return null;
-                }
-                waiting = true;
-                setApparentState(PlayHeadState.STOPPED);
-                return event;
-            },
-        },
-        dispose,
-    };
-}
-/**
- * Chrome <= 53 has unreliable waiting events.
- * Safari, and Edge Legacy miss playing events after seeking.
- */
-export function requiresUnreliablePlaybackEventsPatch() {
-    return (hasBrowser(Browser.SAFARI) ||
-        hasBrowser(Browser.EDGE_LEGACY) ||
-        hasBrowser(Browser.CHROMIUM, null, '53'));
-}

package/dist/types/current/vinyl/VinylPatchOptions.d.ts

@@ -1,10 +0,0 @@
-import type { MediaElementPatchOptions } from '../patch/media/MediaElementPatchOptions';
-/**
- * Flags for applying patches.
- * Default flags will be applied based on user agent, but may be overridden during player creation.
- */
-export interface VinylPatchOptions {
-    readonly media: MediaElementPatchOptions;
-}
-export declare const defaultPatchOptions: import("@amazon/vinyl-util").Lazy<VinylPatchOptions>;
-//# sourceMappingURL=VinylPatchOptions.d.ts.map

package/dist/types/current/vinyl/VinylPatchOptions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"VinylPatchOptions.d.ts","sourceRoot":"","sources":["../../../../src/vinyl/VinylPatchOptions.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,yCAAyC,CAAA;AAIvF;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,QAAQ,CAAC,KAAK,EAAE,wBAAwB,CAAA;CAC3C;AAED,eAAO,MAAM,mBAAmB,sDAI9B,CAAA"}