Flowplayer HLS.js plugin
Clone or download
Latest commit a27e663 Sep 6, 2018

README.md

Flowplayer hlsjs plugin

deprecated

The development of this plugins is discontinued. You should use the hlsjs-lite plugin available in Flowplayer Core now.

deprecated

This plugin provides the hlsjs engine for playback of HLS streams in browsers which do not support playback of HLS in a VIDEO tag, and without the need for Flash.

The plugin relies on the hls.js client library.

Usage

See: https://flowplayer.org/docs/plugins.html#hlsjs

Installation

The plugin can be installed with:

npm install --save flowplayer/flowplayer-hlsjs

CommonJS

The plugin can be used in a browserify and/or webpack environment with a commonjs loader:

var flowplayer = require('flowplayer');
var engine = require('flowplayer-hlsjs');
engine(flowplayer);

flowplayer('#container', {
  clip: {
    sources: [{
      type: 'application/x-mpegurl',
      src: '//stream.flowplayer.org/bauhaus.m3u8'
    }]
  }
});

Demo

A fully documented demo can be found here.

Features

  • packs a compatibility tested version - current: v0.8.4 - of hls.js
  • by default the engine is only loaded if the browser supports MediaSource extensions reliably for playback
  • configurable manual HLS quality selection
  • manual audio track selection and optional audio ABR
  • display of HLS subtitles, Flowplayer style or native
  • ID3 metadata processing to string
  • optional light build - flowplayer.hlsjs.light.min.js - without multiple audio track, subtitles, and ID3 support

Debugging

A quick way to find out whether there's a problem with the actual plugin component is to run your stream in the hls.js demo player.

For fine grained debugging load the unminified components and turn hlsjs debugging on:

<script src="//releases.flowplayer.org/7.1.0/flowplayer.min.js"></script>
<!-- test a hls.js release -->
<script src="//cdnjs.cloudflare.com/ajax/libs/hls.js/0.8.4/hls.min.js"></script>
<!-- separate hlsjs plugin component -->
<script src="//releases.flowplayer.org/hlsjs/flowplayer.hlsjs.light.js"></script>

<script>
// turn on hlsjs debugging
flowplayer.conf.hlsjs = {
  debug: true
};
</script>

If you need to debug features only available from the full plugin you have to build the plugin.

Building the plugin

Build requirement:

cd flowplayer-hlsjs
make deps
make