@amazon/vinyl 1.1.0 → 1.1.1

package/README.md

@@ -1,11 +1,52 @@
-# Amazon Vinyl
+# @amazon/vinyl
 
-Amazon Vinyl is an HTML5 playback engine for media streaming.
+[![Website](https://img.shields.io/badge/website-amazonmusic.github.io%2Fvinyl-blue)](https://amazonmusic.github.io/vinyl)
+[![npm](https://img.shields.io/npm/v/@amazon/vinyl.svg)](https://www.npmjs.com/package/@amazon/vinyl)
+[![size](https://img.shields.io/bundlejs/size/@amazon/vinyl.svg?label=size)](https://bundlejs.com/?q=@amazon/vinyl)
 
-Current features supported:
+An HTML5 playback engine for DASH and HLS streaming with first-class TypeScript
+support, zero runtime dependencies, and adaptive bitrate, prefetching, and
+gapless playback built in.
 
-- Dash streaming
-- HLS streaming (fMP4 via MSE on all browsers, native on Safari)
-- Progressive streaming
-- ABR - Adaptive Bitrate Switching for Dash and HLS tracks
-- Prefetching for Dash tracks
+## Install
+
+```shell
+npm install @amazon/vinyl
+```
+
+## Quick Start
+
+```typescript
+import { createVinylPlayer } from '@amazon/vinyl'
+
+const media = new Audio()
+media.controls = true
+document.body.appendChild(media)
+
+const player = createVinylPlayer({ media })
+player.load({
+    type: 'dash',
+    uri: 'https://example.com/manifest.mpd',
+})
+```
+
+## Documentation
+
+- [Usage Guide](./docs/USAGE.md) — installation, loading tracks, queueing,
+  prefetching, and configuration.
+- [Architecture](./docs/ARCHITECTURE.md) — pipeline, controllers, and
+  extensibility.
+- [DRM Configuration](./docs/DRM_CONFIGURATION.md) — Widevine, FairPlay, and
+  PlayReady setup.
+- [DRM Controller](./docs/DRM_CONTROLLER.md) — implementing custom license
+  acquisition.
+- [DASH Manifest Transforms](./docs/DASH_MANIFEST_TRANSFORM_GUIDE.md) —
+  rewriting manifests before parsing.
+- [Auto Reset](./docs/AUTO_RESET.md) — recovering from terminal playback errors.
+
+Browse the full docs and TypeDoc API reference at
+[amazonmusic.github.io/vinyl](https://amazonmusic.github.io/vinyl).
+
+## License
+
+Apache-2.0

package/dist/index.cjs

@@ -7533,7 +7533,7 @@ var import_vinyl_util91 = require("@amazon/vinyl-util");
 var import_vinyl_util90 = require("@amazon/vinyl-util");
 var vinylVersion = /* @__PURE__ */ (0, import_vinyl_util90.parseVersion)(
   /* istanbul ignore next */
-  "1.1.0"
+  "1.1.1"
 );
 
 // src/global/globalRef.ts

package/dist/index.js

@@ -7594,7 +7594,7 @@ import {
 import { parseVersion } from "@amazon/vinyl-util";
 var vinylVersion = /* @__PURE__ */ parseVersion(
   /* istanbul ignore next */
-  "1.1.0"
+  "1.1.1"
 );
 
 // src/global/globalRef.ts

package/dist/test/integ.es5.js

@@ -1261,7 +1261,7 @@ function createVinylFactories(options){var _a3;var patches=mergeDeep([defaultPat
 var locale13={maxPlayersWarning:"{count} Vinyl Players have been constructed without disposal. Check that player.dispose is properly being called, then increase the maxPlayersWarning option if this was intentional."};var DEFAULT_MAX_PLAYERS=5;var PlayerRegistryImpl=/*#__PURE__*/function(){function PlayerRegistryImpl(){var maxPlayersWarning=arguments.length>0&&arguments[0]!==undefined?arguments[0]:DEFAULT_MAX_PLAYERS;_classCallCheck(this,PlayerRegistryImpl);this.maxPlayersWarning=maxPlayersWarning;__publicField(this,"_players",[]);__publicField(this,"gaveMaxPlayersWarning",false)}return _createClass(PlayerRegistryImpl,[{key:"players",get:function get(){return this._players}},{key:"addPlayer",value:function addPlayer(player){this._players.push(player);var n=this._players.length;if(n>this.maxPlayersWarning&&!this.gaveMaxPlayersWarning){this.gaveMaxPlayersWarning=true;logWarn(globalTarget,substitute(locale13.maxPlayersWarning,{count:n}))}}},{key:"removePlayer",value:function removePlayer(player){remove(this._players,player)}/**
      * @throws An IllegalStateError if all players have not been removed.
      */},{key:"dispose",value:function dispose(){if(this._players.length)throw new IllegalStateError("All players must be removed before disposing VinylGlobal")}}])}();var playerRegistryRef=globalRef(function(){return new PlayerRegistryImpl});// src/global/environment.ts
-var vinylVersion=parseVersion(/* istanbul ignore next */"1.1.0");// src/global/globalRef.ts
+var vinylVersion=parseVersion(/* istanbul ignore next */"1.1.1");// src/global/globalRef.ts
 var VinylGlobal=/*#__PURE__*/function(){function VinylGlobal(){_classCallCheck(this,VinylGlobal)}return _createClass(VinylGlobal,[{key:"players",get:function get(){return playerRegistryRef.value.players}/**
      * Returns the first player.
      */},{key:"player",get:function get(){return playerRegistryRef.value.players[0]}},{key:"logs",get:function get(){var _a3;return(_a3=historyLogHandler.value)==null?void 0:_a3.history}},{key:"version",get:function get(){return vinylVersion.str}},{key:"userAgentInfo",get:function get(){return getUserAgentInfo()}},{key:"network",get:function get(){return getNetworkMetrics()}/**

package/dist/test/integ.js

@@ -20903,7 +20903,7 @@ ${(_a3 = this.failedResult.failedExpectations[0]) == null ? void 0 : _a3.message
   // src/global/environment.ts
   var vinylVersion = parseVersion(
     /* istanbul ignore next */
-    "1.1.0"
+    "1.1.1"
   );
 
   // src/global/globalRef.ts

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@amazon/vinyl",
-    "version": "1.1.0",
+    "version": "1.1.1",
     "description": "An HTML5 streaming media player",
     "repository": {
         "type": "git",
@@ -91,20 +91,20 @@
         "watch:release": "tsx buildSrc/build.ts --watch --release"
     },
     "devDependencies": {
-        "@amazon/vinyl-build-utils": "^1.1.0",
+        "@amazon/vinyl-build-utils": "^1.1.1",
         "commander": "^9.5.0"
     },
     "dependencies": {
-        "@amazon/vinyl-di": "^1.1.0",
-        "@amazon/vinyl-hls-parser": "^1.1.0",
-        "@amazon/vinyl-mpd-parser": "^1.1.0",
-        "@amazon/vinyl-observable": "^1.1.0",
-        "@amazon/vinyl-transmux": "^1.1.0",
-        "@amazon/vinyl-util": "^1.1.0",
-        "@amazon/vinyl-validation": "^1.1.0"
+        "@amazon/vinyl-di": "^1.1.1",
+        "@amazon/vinyl-hls-parser": "^1.1.1",
+        "@amazon/vinyl-mpd-parser": "^1.1.1",
+        "@amazon/vinyl-observable": "^1.1.1",
+        "@amazon/vinyl-transmux": "^1.1.1",
+        "@amazon/vinyl-util": "^1.1.1",
+        "@amazon/vinyl-validation": "^1.1.1"
     },
     "browserslist": [
         "defaults, chrome 52, firefox 54, edge 15, safari 8"
     ],
-    "gitHead": "ea13070fb52c1903723f08f31c356465d2f3279e"
+    "gitHead": "e5a3429d802564132b16808a5b8a8e15a023a548"
 }