A Clappr playback to play HTTP Live Streaming (HLS) based on the hls.js.
You can use it from JSDelivr:
https://cdn.jsdelivr.net/npm/@clappr/hlsjs-playback@latest/dist/hlsjs-playback.min.js
or as an npm package:
yarn add @clappr/hlsjs-playback
Then just add HlsjsPlayback
into the list of plugins of your player instance:
var player = new Clappr.Player(
{
source: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8',
plugins: [HlsjsPlayback],
});
The options for this playback are shown below:
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
},
},
});
Default value:
false
The default behavior for the HLS playback is to use hls.currentLevel to switch current level. To change this behaviour and force HLS playback to use hls.nextLevel, add hlsUseNextLevel: true
to embed parameters.
Default value:
60 (seconds)
Option to define the minimum DVR size to active seek on Clappr live mode.
Default value:
2
Configure the size of the start time extrapolation window measured as a multiple of segments.
Should be 2 or higher, or 0 to disable. It should only need to be increased above 2 if more than one segment is removed from the start of the playlist at a time.
E.g.: If the playlist is cached for 10 seconds and new chunks are added/removed every 5.
Default value:
16
The hls.js
have recover approaches for some fatal errors. This option sets the max recovery attempts number for those errors.
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.
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.
var player = new Clappr.Player(
{
...
hlsPlayback: {
preload: true,
customListeners: [],
},
});
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.
An array of listeners object with specific parameters to add on HLS.JS
instance.
var player = new Clappr.Player(
{
...
hlsPlayback: {
...
customListeners: [
// "hlsFragLoaded" is the value of HlsjsPlayback.HLSJS.Events.FRAG_LOADED constant.
{ eventName: 'hlsFragLoaded', callback: (event, data) => { console.log('>>>>>> data: ', data) }, once: true }
],
},
});
The listener object parameters are:
eventName
: A valid event name ofhls.js
events API;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.
As HlsjsPlayback
is based on hls.js
, it's possible to use the available hls.js
configs too. You can check them out here.
To use these settings, use the hlsjsConfig
object.
Example:
var player = new Clappr.Player(
{
...
playback: {
hlsjsConfig: {
debug: true, // https://github.com/video-dev/hls.js/blob/master/docs/API.md#debug
enableworker: false, // https://github.com/video-dev/hls.js/blob/master/docs/API.md#enableworker
...
},
},
});
Enter the project directory and install the dependencies:
yarn install
Make your changes and run the tests:
yarn test
Build your own version:
yarn build
Check the result on dist/
folder.
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/
To release a new version, first create a new tag by running:
npm version [patch | minor | major]
Choose between patch
, minor
, or major
according to the changes for the new version.
After that, publish the new version to NPM by running:
npm publish
Check the new version on npmjs @clappr/hlsjs-playback.