Need private packages and team management tools?Check out npm Teams »

videojs-hlsjs

1.4.8 • Public • Published

Videojs hls.js Plugin

An HLS plugin for video.jas based on hls.js

Videojs hls.js offers hls playback using hls.js. For more details on browser compatibility see th hls.js github page.

Getting Started

Download videojs-hlsjs and include it in your page along with video.js:

<video id="video" preload="auto" class="video-js vjs-default-skin" controls>
    <source src="http://www.streambox.fr/playlists/x36xhzz/x36xhzz.m3u8" type="application/vnd.apple.mpegurl">
</video>
<script src="hlsjs.min.js"></script>
<script src="video.min.js"></script>
<script src="videojs-hlsjs.min.js"></script>
<script>
    var player = videojs('video', {
        // hlsjs tech should come before html5, if you want to give precedence to native HLS playback
        // use the favorNativeHLS option.
        techOrder: ["hlsjs", "html5", "flash"]
    });
</script> 

There's also a demo of the plugin that you can check out.

Changelog

  • 1.4.5: Added text and audio tracks compatibility.

Documentation

Dependencies

This project depends on:

CORS Considerations

All HLS resources must be delivered with CORS headers allowing GET requests.

Options

You may pass in an options object to the hls playback technology at player initialization.

hlsjs.favorNativeHLS

Type: Boolean

When the favorNativeHLS property is set to true, the plugin will prioritize native hls over MSE. Note that in the case native streaming is available other options won't have any effect.

hlsjs.disableAutoLevel

Type: Boolean

When the disableAutoLevel property is set to true, the plugin will completely disable auto leveling based on bandwidth and remove it from the list of available level options. If no level is specified in hlsjs.startLevelByHeight or hlsjs.setLevelByHeight the plugin will start with the best quality available when this property is set to true. Useful for browsers that have trouble switching between different qualities.

hlsjs.startLevelByHeight

Type: Number

When the startLevelByHeight property is present, the plugin will start the video on the closest quality to the specified height but the auto leveling will still be enabled unless hlsjs.disableAutoLevel was set to true. If height metadata is not present in the HLS playlist this property will be ignored.

hlsjs.setLevelByHeight

Type: Number

When the setLevelByHeight property is present, the plugin will start the video on the closest quality to the specified height. The auto leveling will be disabled but it will still be selectable unless hlsjs.disableAutoLevel was set to true. If height metadata is not present in the HLS playlist this property will be ignored.

This property takes precedence over hlsjs.startLevelByHeight.

hlsjs.hls

Type object

An object containing hls.js configuration parameters, see in detail: Hls.js Fine Tuning.

Exceptions:

  • autoStartLoad the loading is done through the preload attribute of the video tag. This property is always set to false when using this plugin.
  • startLevel if you set any of the level options above this property will be ignored.

Event listeners

This plugin offers the possibility to attach a callback to any hls.js runtime event, see the documetation about the different events here: Hls.js Runtime Events. Simply precede the name of the event in camel case by on, see an example:

var player = videojs('video', {
    hlsjs: {
        /**
         * Will be called on Hls.Events.MEDIA_ATTACHED.
         *
         * @param {Hls} hls      The hls instance from hls.js
         * @param {Object} data  The data from this HLS runtime event
         */
        onMediaAttached: function(hls, data) {
            // do stuff...
        }
    }
});

Original Author

This project was orginally forked from: videojs-hlsjs, credits to the original author.

Install

npm i videojs-hlsjs

DownloadsWeekly Downloads

16

Version

1.4.8

License

MIT

Last publish

Collaborators

  • avatar