README

videojs-hlsjs-source-handler

Hls.js from Dailymotion Source Handler for Video.js

Installation

NPM Package: https://www.npmjs.com/package/videojs-hlsjs-source-handler

npm install videojs-hlsjs-source-handler --save

Dependencies

This source handler assumes you have the following dependencies already loaded:

Api

The source handler will expose two properties on the video.js tech:

hls - A reference to the current hls.js instance.
isHlsJs - This property will be defined and have the boolean value true when the source handler/hls.js is being used.

Usage

videojs('video', {
    html5: {
        hlsJs: { // Hls.js options
            debug: true
        }
    }
});

Options

shouldHandle - Disable this source handler by setting this value to false. Default: true.

For a full list of possible hls.js options, see the hls.js documentation.

Full Example

<!DOCTYPE html>
<html>
    <head>
        <title>videojs-hlsjs-source-handler</title>
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <style type="text/css">
            body {
                margin: 0;
                padding: 0;
            }
        </style>
        <link href="//some.domain.com/path/to/video-js.min.css" rel="stylesheet">
        
        <script src="//some.domain.com/path/to/video.min.js" type="text/javascript"></script>
        <script src="//some.domain.com/path/to/videojs-contrib-hls.min.js" type="text/javascript"></script>
        <script src="//some.domain.com/path/to/videojs-contrib-media-sources.min.js" type="text/javascript"></script>
        <script src="//some.domain.com/path/to/hls.min.js" type="text/javascript"></script>
        <script src="//some.domain.com/path/to/videojs-hlsjs-source-handler.min.js" type="text/javascript"></script>
    </head>
    <body>
        <video id="video" class="video-js vjs-default-skin" height="360" width="640" controls>
            <source src="//some.domain.com/path/to/manifest.m3u8" type="application/x-mpegURL"></source>
        </video>
        <script type="text/javascript">
            var player = videojs('video', {
                html5: {
                    hlsJs: {
                        debug: true
                    }
                }
            });
        </script>
    </body>
</html>

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.

Release History

2018-10-18 v1.4.0 Improved network error recovery when failing to load the manifest.
2017-12-05 v1.3.0 Fixed bug where Hls.js might not start loading if autoStartLoad is false and _loadStarter is triggered before the lop level manifest is loaded.
2017-11-22 v1.2.0 Added support for Video.Js 6 (Video.Js 5 still supported). && Fixed bug where Hls.js might not start loading if autoStartLoad is false and preroll ad timed out.
2017-02-27 v1.1.0 Fixed publish configuration.
2017-02-27 v1.0.8 Call startLoad() if autoStartLoad is false.
2016-10-24 v1.0.7 Added option to disable source handler.
2016-10-19 v1.0.6 Added license.
2016-10-19 v1.0.5 README formatting.
2016-10-19 v1.0.4 Updated README with npm installation and examples.
2016-10-17 v1.0.3 Better network error handling.
2016-10-14 v1.0.2 Correct seekable start point for DVR controls.
2016-10-14 v1.0.1 Bugfix in recovery mechanism.
2016-10-13 v1.0.0 Initial version.

Usage no npm install needed!