@clappr/hlsjs-playback 3.0.3 → 3.1.0

package/README.md

@@ -27,11 +27,11 @@ or as an npm package:
 
 ### Which artifact to load
 
-| Scenario | Artifact |
-|---|---|
-| `<script>` / CDN, after `@clappr/core` and `hls.js` | `dist/hlsjs-playback.min.js` |
-| Bundler, CommonJS / UMD entry | `dist/hlsjs-playback.js` (package `main`) |
-| Bundler, ESM entry | `dist/hlsjs-playback.esm.js` (package `module`) |
+| Scenario                                            | Artifact                                        |
+| --------------------------------------------------- | ----------------------------------------------- |
+| `<script>` / CDN, after `@clappr/core` and `hls.js` | `dist/hlsjs-playback.min.js`                    |
+| Bundler, CommonJS / UMD entry                       | `dist/hlsjs-playback.js` (package `main`)       |
+| Bundler, ESM entry                                  | `dist/hlsjs-playback.esm.js` (package `module`) |
 
 **Migration note (3.0+):** Every artifact now expects `hls.js` from the page or bundler. If you loaded `hlsjs-playback.min.js` with a single script tag, add `hls.js` before it. If you aliased the deep path to avoid the bundled copy, remove that entry from your bundler's `resolve.alias` (webpack) or equivalent (Vite `resolve.alias`, Rollup `alias`) — the default entry is external now:
 
@@ -42,11 +42,10 @@ or as an npm package:
 Then just add `HlsjsPlayback` into the list of plugins of your player instance:
 
 ```javascript
-var player = new Clappr.Player(
-  {
-    source: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8',
-    plugins: [HlsjsPlayback],
-  });
+var player = new Clappr.Player({
+  source: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8',
+  plugins: [HlsjsPlayback]
+})
 ```
 
 ## Configuration
@@ -54,38 +53,40 @@ var player = new Clappr.Player(
 The options for this playback are shown below:
 
 ```javascript
-var player = new Clappr.Player(
-  {
-    source: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8',
-    plugins: [HlsjsPlayback],
-    hlsUseNextLevel: false,
-    hlsMinimumDvrSize: 60,
-    hlsRecoverAttempts: 16,
-    hlsPlayback: {
-      preload: true,
-      customListeners: [],
-    },
-    playback: {
-      extrapolatedWindowNumSegments: 2,
-      triggerFatalErrorOnResourceDenied: false,
-      hlsjsConfig: {
-        // hls.js specific options
-      },
-    },
-  });
+var player = new Clappr.Player({
+  source: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8',
+  plugins: [HlsjsPlayback],
+  hlsUseNextLevel: false,
+  hlsMinimumDvrSize: 60,
+  hlsRecoverAttempts: 16,
+  hlsPlayback: {
+    preload: true,
+    customListeners: []
+  },
+  playback: {
+    extrapolatedWindowNumSegments: 2,
+    triggerFatalErrorOnResourceDenied: false,
+    hlsjsConfig: {
+      // hls.js specific options
+    }
+  }
+})
 ```
 
 #### hlsUseNextLevel
+
 > Default value: `false`
 
 The default behavior for the HLS playback is to use [hls.currentLevel](https://github.com/video-dev/hls.js/blob/master/docs/API.md#hlscurrentlevel) to switch current level. To change this behaviour and force HLS playback to use [hls.nextLevel](https://github.com/video-dev/hls.js/blob/master/docs/API.md#hlsnextlevel), add `hlsUseNextLevel: true` to embed parameters.
 
 #### hlsMinimumDvrSize
+
 > Default value: `60 (seconds)`
 
 Option to define the minimum DVR size to active seek on Clappr live mode.
 
 #### extrapolatedWindowNumSegments
+
 > Default value: `2`
 
 Configure the size of the start time extrapolation window measured as a multiple of segments.
@@ -95,17 +96,20 @@ Should be 2 or higher, or 0 to disable. It should only need to be increased abov
 E.g.: If the playlist is cached for 10 seconds and new chunks are added/removed every 5.
 
 #### hlsRecoverAttempts
+
 > Default value: `16`
 
 The `hls.js` have recover approaches for some fatal errors. This option sets the max recovery attempts number for those errors.
 
 #### triggerFatalErrorOnResourceDenied
+
 > Default value: `false`
 
 If this option is set to true, the playback will triggers fatal error event if decrypt key http response code is greater than or equal to 400. This option is used to attempt to reproduce iOS devices behaviour which internally use html5 video playback.
 
 #### hlsPlayback
->  Soon (in a new breaking change version), all options related to this playback that are declared in the scope of the `options` object will have to be declared necessarily within this new scope!
+
+> Soon (in a new breaking change version), all options related to this playback that are declared in the scope of the `options` object will have to be declared necessarily within this new scope!
 
 Groups all options related directly to `HlsjsPlayback` configs.
 
@@ -121,6 +125,7 @@ var player = new Clappr.Player(
 ```
 
 #### `hlsPlayback.preload`
+
 > Default value: `true`
 
 Configures whether the source should be loaded as soon as the `HLS.JS` internal reference is setup or only after the first play.
@@ -145,9 +150,9 @@ var player = new Clappr.Player(
 
 The listener object parameters are:
 
-* `eventName`: A valid event name of `hls.js` [events API](https://github.com/video-dev/hls.js/blob/master/docs/API.md#runtime-events);
-* `callback`: The callback that should be called  when the event listened happen.
-* `once`: Flag to configure if the listener needs to be valid just for one time.
+- `eventName`: A valid event name of `hls.js` [events API](https://github.com/video-dev/hls.js/blob/master/docs/API.md#runtime-events);
+- `callback`: The callback that should be called when the event listened happen.
+- `once`: Flag to configure if the listener needs to be valid just for one time.
 
 #### hlsjsConfig
 
@@ -177,11 +182,11 @@ Enter the project directory and install the dependencies:
 
 `yarn install`
 
-Make your changes and run the tests:
+Make your changes and run the tests (Vitest):
 
 `yarn test`
 
-Build your own version:
+Build your own version (Vite library mode):
 
 `yarn build`
 
@@ -191,7 +196,7 @@ Starting a local server:
 
 `yarn start`
 
-This command will start an HTTP Server on port 8080. You can check a sample page with Clappr-core using the HlsjsPlayback on http://localhost:8080/
+This command will start a Vite dev server on port 8080. You can check a sample page with Clappr-core using the HlsjsPlayback on http://localhost:8080/
 
 ## Release