@amazon/vinyl 4.0.0 → 4.0.1-next.20261016184530

package/dist/vinylTestUtil/types/current/media/FrequencyAnalyzer.d.ts

@@ -35,6 +35,11 @@ export declare class FrequencyAnalyzer implements LogTarget {
      */
     assertFrequency(timeout?: number): Promise<void>;
 }
+/**
+ * The volume integ tests play at when checkAudio is set. Analyzers do not work at volume 0 or muted, and the
+ * measured dB is affected at very low volumes.
+ */
+export declare const ANALYZER_VOLUME = 0.01;
 /**
  * A query param, if present, will indicate that audio should be analyzed. Does not work in CI environments.
  */
@@ -45,12 +50,10 @@ export declare const shouldCheckAudio: boolean;
  */
 export declare function assertFrequency(): Promise<void>;
 /**
- * Displays an interaction prompt if checkAudio is present in the query params.
+ * Attaches an analyzer to the shared media element if checkAudio is present in the query params.
  *
- * The checkAudio query param, if present, indicates that the actual sound output should be analyzed. This requires
- * a user gesture unless the UA doesn't require it. Most browsers require the gesture, but some platforms this
- * requirement may be skipped with a flag. Note that Google deprecated --autoplay-policy=no-user-gesture-required
- * March 2023, but older versions may still support it.
+ * The checkAudio query param, if present, indicates that the actual sound output should be analyzed. The analyzer is
+ * created after the media element is unlocked, so `initializeMediaUnlock` must be called first.
  */
 export declare function initializeFrequencyAnalyzer(): void;
 //# sourceMappingURL=FrequencyAnalyzer.d.ts.map

package/dist/vinylTestUtil/types/current/media/FrequencyAnalyzer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FrequencyAnalyzer.d.ts","sourceRoot":"","sources":["../../../../../test/vinylTestUtil/media/FrequencyAnalyzer.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,SAAS,EAAgB,MAAM,oBAAoB,CAAA;AAgBjE,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAE/B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAE7B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EACZ,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,KAAK,CAAA;CAC5E;AAQD,qBAAa,iBAAkB,YAAW,SAAS;IAS3C,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAT3B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA2B;IAChD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAc;IAEvC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAElD,QAAQ,CAAC,SAAS,SAAuC;gBAGpC,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,2BAA2B,EACpD,OAAO,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC;IAc/C;;;;;OAKG;IACH,IAAI,SAAS,IAAI,MAAM,CAUtB;IAED,IAAI,aAAa,IAAI,MAAM,CAQ1B;IAED;;OAEG;IACG,eAAe,CAAC,OAAO,SAAK;CA8DrC;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,SAE5B,CAAA;AAID;;;GAGG;AACH,wBAAgB,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC,CAE/C;AAED;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,SAwB1C"}
+{"version":3,"file":"FrequencyAnalyzer.d.ts","sourceRoot":"","sources":["../../../../../test/vinylTestUtil/media/FrequencyAnalyzer.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,SAAS,EAAgB,MAAM,oBAAoB,CAAA;AAajE,MAAM,WAAW,wBAAwB;IACrC;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAE/B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAE7B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EACZ,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,KAAK,CAAA;CAC5E;AAQD,qBAAa,iBAAkB,YAAW,SAAS;IAS3C,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IAT3B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA2B;IAChD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAc;IAEvC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAElD,QAAQ,CAAC,SAAS,SAAuC;gBAGpC,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,2BAA2B,EACpD,OAAO,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC;IAc/C;;;;;OAKG;IACH,IAAI,SAAS,IAAI,MAAM,CAUtB;IAED,IAAI,aAAa,IAAI,MAAM,CAQ1B;IAED;;OAEG;IACG,eAAe,CAAC,OAAO,SAAK;CA8DrC;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe,OAAO,CAAA;AAEnC;;GAEG;AACH,eAAO,MAAM,gBAAgB,SAE5B,CAAA;AAID;;;GAGG;AACH,wBAAgB,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC,CAE/C;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,SAc1C"}

package/dist/vinylTestUtil/types/current/media/FrequencyAnalyzer.js

@@ -10,9 +10,6 @@ import { logDebug } from '@amazon/vinyl-util';
 import { getSearchParams } from '@amazon/vinyl-util';
 import { createLogPrefix } from '@amazon/vinyl-util';
 import { mediaRef } from '../player/mediaRef';
-import { requireUserInteraction } from '../ui/requireUserInteraction';
-import { unlockMediaElement } from './unlockMediaElement';
-import { setNextTestTimeout } from '@amazon/vinyl-util/browserTestUtil';
 /**
  * The percent tolerance the time estimate based on the analyzed frequency can be off from the actual currentTime.
  */
@@ -112,6 +109,11 @@ export class FrequencyAnalyzer {
         }
     }
 }
+/**
+ * The volume integ tests play at when checkAudio is set. Analyzers do not work at volume 0 or muted, and the
+ * measured dB is affected at very low volumes.
+ */
+export const ANALYZER_VOLUME = 0.01;
 /**
  * A query param, if present, will indicate that audio should be analyzed. Does not work in CI environments.
  */
@@ -125,33 +127,25 @@ export function assertFrequency() {
     return frequencyAnalyzer?.assertFrequency() ?? Promise.resolve();
 }
 /**
- * Displays an interaction prompt if checkAudio is present in the query params.
+ * Attaches an analyzer to the shared media element if checkAudio is present in the query params.
  *
- * The checkAudio query param, if present, indicates that the actual sound output should be analyzed. This requires
- * a user gesture unless the UA doesn't require it. Most browsers require the gesture, but some platforms this
- * requirement may be skipped with a flag. Note that Google deprecated --autoplay-policy=no-user-gesture-required
- * March 2023, but older versions may still support it.
+ * The checkAudio query param, if present, indicates that the actual sound output should be analyzed. The analyzer is
+ * created after the media element is unlocked, so `initializeMediaUnlock` must be called first.
  */
 export function initializeFrequencyAnalyzer() {
-    if (shouldCheckAudio) {
-        // If a user interaction is required, give extra time to interact before a timeout.
-        setNextTestTimeout(300);
-        beforeAll(async () => {
-            // Creates the audio context and 'unlocks' the media element in response to a user gesture.
-            const media = mediaRef.value;
-            media.crossOrigin = 'anonymous';
-            media.muted = false;
-            media.volume = 0.01; // Save your ears. Analyzers do not work at volume 0 or muted; measured dB is affected.
-            await requireUserInteraction();
-            const audioContext = getAudioContext();
-            await unlockMediaElement();
-            if (audioContext) {
-                const source = audioContext.createMediaElementSource(mediaRef.value);
-                frequencyAnalyzer = new FrequencyAnalyzer(audioContext, source);
-            }
-            else {
-                console.warn('AudioContext not supported');
-            }
-        });
-    }
+    if (!shouldCheckAudio)
+        return;
+    beforeAll(() => {
+        const media = mediaRef.value;
+        media.crossOrigin = 'anonymous';
+        media.volume = ANALYZER_VOLUME;
+        const audioContext = getAudioContext();
+        if (audioContext) {
+            const source = audioContext.createMediaElementSource(media);
+            frequencyAnalyzer = new FrequencyAnalyzer(audioContext, source);
+        }
+        else {
+            console.warn('AudioContext not supported');
+        }
+    });
 }

package/dist/vinylTestUtil/types/current/media/unlockMediaElement.d.ts

@@ -1,6 +1,15 @@
 /**
- * In response to a user-gesture, 'unlocks' the media element by playing and immediately pausing a src track.
+ * 'Unlocks' the media element by playing and immediately pausing a src track, and resumes the AudioContext.
  * This allows play() to settle on the media element without a user gesture later.
+ *
+ * Must be called synchronously from a user gesture handler. Rejects if the browser did not accept the gesture.
  */
 export declare function unlockMediaElement(): Promise<void>;
+/**
+ * In a browser, prompts for a click before any spec runs, unlocking the shared media element in response.
+ *
+ * Starting playback without a user gesture is only allowed for muted media, and some browsers (Safari 27)
+ * end progressive playback that starts silently without one, so integ tests play unmuted after this unlock.
+ */
+export declare function initializeMediaUnlock(): void;
 //# sourceMappingURL=unlockMediaElement.d.ts.map

package/dist/vinylTestUtil/types/current/media/unlockMediaElement.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unlockMediaElement.d.ts","sourceRoot":"","sources":["../../../../../test/vinylTestUtil/media/unlockMediaElement.ts"],"names":[],"mappings":"AASA;;;GAGG;AACH,wBAAsB,kBAAkB,kBAQvC"}
+{"version":3,"file":"unlockMediaElement.d.ts","sourceRoot":"","sources":["../../../../../test/vinylTestUtil/media/unlockMediaElement.ts"],"names":[],"mappings":"AAgBA;;;;;GAKG;AACH,wBAAsB,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAaxD;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,SAMpC"}

package/dist/vinylTestUtil/types/current/media/unlockMediaElement.js

@@ -2,19 +2,47 @@
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
+import { getAudioContext } from '@amazon/vinyl';
 import { mediaRef } from '../player/mediaRef';
 import { vinylTestAssets } from '../assets/vinylTestAssets';
+import { requireUserInteraction } from '../ui/requireUserInteraction';
 import { noop } from '@amazon/vinyl-util';
 /**
- * In response to a user-gesture, 'unlocks' the media element by playing and immediately pausing a src track.
+ * The largest timeout jasmine accepts; there is no limit to how long a person may take to click.
+ */
+const MAX_TIMEOUT_MS = 2_147_483_647;
+/**
+ * 'Unlocks' the media element by playing and immediately pausing a src track, and resumes the AudioContext.
  * This allows play() to settle on the media element without a user gesture later.
+ *
+ * Must be called synchronously from a user gesture handler. Rejects if the browser did not accept the gesture.
  */
 export async function unlockMediaElement() {
     const media = mediaRef.value;
-    // Unlocks the media element.
     media.src = vinylTestAssets.prog.libmp3lame_60s_2ch_16bit_44100Hz_48kbps;
-    await media.play().catch(noop);
-    media.pause();
-    media.removeAttribute('src');
-    media.load();
+    const played = media.play();
+    const resumed = getAudioContext()?.resume().catch(noop);
+    try {
+        await played;
+    }
+    finally {
+        media.pause();
+        media.removeAttribute('src');
+        media.load();
+    }
+    await resumed;
+}
+/**
+ * In a browser, prompts for a click before any spec runs, unlocking the shared media element in response.
+ *
+ * Starting playback without a user gesture is only allowed for muted media, and some browsers (Safari 27)
+ * end progressive playback that starts silently without one, so integ tests play unmuted after this unlock.
+ */
+export function initializeMediaUnlock() {
+    if (typeof document === 'undefined')
+        return;
+    beforeAll(async () => {
+        await requireUserInteraction(unlockMediaElement);
+        console.info('Media element unlocked');
+    }, MAX_TIMEOUT_MS);
 }

package/dist/vinylTestUtil/types/current/player/createVinylSuite.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createVinylSuite.d.ts","sourceRoot":"","sources":["../../../../../test/vinylTestUtil/player/createVinylSuite.ts"],"names":[],"mappings":"AAKA,OAAO,EAEH,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EACnB,MAAM,eAAe,CAAA;AAmBtB,MAAM,WAAW,iBAAiB;IAC9B;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IAEzB;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CACjC;AAED,qBAAa,UAAU,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,WAAW;IAuB7D;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB;IA1BlD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IACD,QAAQ,CAAC,SAAS,SAAwB;IAE1C,OAAO,CAAC,OAAO,CAAiB;IAEhC,IAAI,MAAM,IAAI,CAAC,CAMd;IAED,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAIvC;;IAGG;;OAEG;IACc,aAAa,EAAE,MAAM,CAAC,EACpB,OAAO,CAAC,EAAE,iBAAiB,YAAA;IAGlD;;OAEG;IACH,IAAI;CA4CP;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC5B,uBAAuB,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,EACzD,OAAO,CAAC,EAAE,iBAAiB,GAC5B,UAAU,CASZ"}
+{"version":3,"file":"createVinylSuite.d.ts","sourceRoot":"","sources":["../../../../../test/vinylTestUtil/player/createVinylSuite.ts"],"names":[],"mappings":"AAKA,OAAO,EAEH,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EACnB,MAAM,eAAe,CAAA;AAoBtB,MAAM,WAAW,iBAAiB;IAC9B;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IAEzB;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CACjC;AAED,qBAAa,UAAU,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,WAAW;IAuB7D;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB;IA1BlD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IACD,QAAQ,CAAC,SAAS,SAAwB;IAE1C,OAAO,CAAC,OAAO,CAAiB;IAEhC,IAAI,MAAM,IAAI,CAAC,CAMd;IAED,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAIvC;;IAGG;;OAEG;IACc,aAAa,EAAE,MAAM,CAAC,EACpB,OAAO,CAAC,EAAE,iBAAiB,YAAA;IAGlD;;OAEG;IACH,IAAI;CAgDP;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC5B,uBAAuB,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,EACzD,OAAO,CAAC,EAAE,iBAAiB,GAC5B,UAAU,CASZ"}

package/dist/vinylTestUtil/types/current/player/createVinylSuite.js

@@ -6,7 +6,8 @@ import { createVinylPlayer, } from '@amazon/vinyl';
 import { createDisposer, logError, toJson, } from '@amazon/vinyl-util';
 import { createLogPrefix, createRequester, getGlobalRegistry, IllegalStateError, logDebug, requesterWithRetryRef, RetryStrategy, } from '@amazon/vinyl-util';
 import { setTestTimeout } from '@amazon/vinyl-util/browserTestUtil';
-import { mediaRef } from './mediaRef';
+import { MEDIA_VOLUME, mediaRef } from './mediaRef';
+import { ANALYZER_VOLUME, shouldCheckAudio } from '../media/FrequencyAnalyzer';
 export class VinylSuite {
     playerFactory;
     options;
@@ -49,6 +50,10 @@ export class VinylSuite {
             }));
             document.addEventListener('visibilitychange', this.visibilityChangeHandler);
             this._player = this.playerFactory();
+            // Through the player, so loudness normalization scales this volume rather than replacing it.
+            this._player.volume = shouldCheckAudio
+                ? ANALYZER_VOLUME
+                : MEDIA_VOLUME;
             add(this._player.on('error', (e) => {
                 logError(this, 'player emitted error event', toJson(e));
             }));

package/dist/vinylTestUtil/types/current/player/mediaRef.d.ts

@@ -1,6 +1,13 @@
+/**
+ * The volume integ tests play at: low enough not to be heard, but not 0 or muted. Safari 27 ends progressive
+ * playback that starts silently without a user gesture, and the media element is unlocked at this volume.
+ */
+export declare const MEDIA_VOLUME = 0.0001;
 /**
  * For reliable integ tests on 3P devices, there should be a single media element.
  * When using the media element, unload any sources and reset any state after each test.
+ *
+ * The element is unmuted at {@link MEDIA_VOLUME}; see `initializeMediaUnlock`.
  */
 export declare const mediaRef: import("@amazon/vinyl-util").Lazy<HTMLMediaElement>;
 //# sourceMappingURL=mediaRef.d.ts.map

package/dist/vinylTestUtil/types/current/player/mediaRef.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mediaRef.d.ts","sourceRoot":"","sources":["../../../../../test/vinylTestUtil/player/mediaRef.ts"],"names":[],"mappings":"AAOA;;;GAGG;AACH,eAAO,MAAM,QAAQ,qDAMnB,CAAA"}
+{"version":3,"file":"mediaRef.d.ts","sourceRoot":"","sources":["../../../../../test/vinylTestUtil/player/mediaRef.ts"],"names":[],"mappings":"AAOA;;;GAGG;AACH,eAAO,MAAM,YAAY,SAAS,CAAA;AAElC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,qDAMnB,CAAA"}

package/dist/vinylTestUtil/types/current/player/mediaRef.js

@@ -3,13 +3,20 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import { lazy } from '@amazon/vinyl-util';
+/**
+ * The volume integ tests play at: low enough not to be heard, but not 0 or muted. Safari 27 ends progressive
+ * playback that starts silently without a user gesture, and the media element is unlocked at this volume.
+ */
+export const MEDIA_VOLUME = 0.0001;
 /**
  * For reliable integ tests on 3P devices, there should be a single media element.
  * When using the media element, unload any sources and reset any state after each test.
+ *
+ * The element is unmuted at {@link MEDIA_VOLUME}; see `initializeMediaUnlock`.
  */
 export const mediaRef = lazy(() => {
     const media = document.createElement('video');
-    media.muted = true;
+    media.volume = MEDIA_VOLUME;
     media.playsInline = true; // needed for iOS
     media.disableRemotePlayback = true; // Disables casting. Needed for ManagedMediaSource
     return media;