videojs-hls-quality-selector

Note: v2.x.x is compatible with VideoJS 8.x.x.

Description

Adds a quality selector menu for HLS sources played in videojs. Requires videojs-contrib-quality-levels plugins.

Any HLS manifest with multiple playlists/renditions should be selectable from within the added control.

Native HLS

Does not yet support browsers using native HLS (Safari, Edge, etc). To enable plugin in browsers with native HLS, you must force non-native HLS playback:

Options

displayCurrentQuality boolean - false

Set to true to display the currently selected resolution in the menu button. When not enabled, displayed an included VJS "HD" icon.

placementIndex integer

Set this to override the default positioning of the menu button in the control bar relative to the other components in the control bar.

vjsIconClass string - "vjs-icon-hd"

Set this to one of the custom VJS icons (https://videojs.github.io/font/) to override the icon for the menu button.

Methods

getCurrentQuality string - 'auto'_

Return the current set quality or 'auto'

Screenshots

Default setup - Menu selected:

Display Current Quality option enabled:

Table of Contents

Installation

• Installation
• Usage
  • <script> Tag
  • Browserify/CommonJS
  • RequireJS/AMD
• License

Installation

npm install --save videojs-hls-quality-selector

Usage

To include videojs-hls-quality-selector on your website or web application, use any of the following methods.

<script> Tag

This is the simplest case. Get the script in whatever way you prefer and include the plugin after you include video.js, so that the videojs global is available.

<script src="//path/to/video.min.js"></script>
<script src="//path/to/videojs-contrib-quality-levels.min.js"></script>
<script src="//path/to/videojs-hls-quality-selector.min.js"></script>
<script>
  var player = videojs('my-video');

  player.hlsQualitySelector();
</script>

Browserify/CommonJS

When using with Browserify, install videojs-hls-quality-selector via npm and require the plugin as you would any other module.

var videojs = require('video.js');

// The actual plugin function is exported by this module, but it is also
// attached to the `Player.prototype`; so, there is no need to assign it
// to a variable.
require('videojs-hls-quality-selector');

var player = videojs('my-video');

player.hlsQualitySelector({
    displayCurrentQuality: true,
});

RequireJS/AMD

When using with RequireJS (or another AMD library), get the script in whatever way you prefer and require the plugin as you normally would:

require(['video.js', 'videojs-hls-quality-selector'], function(videojs) {
  var player = videojs('my-video');

  player.hlsQualitySelector({
       displayCurrentQuality: true,
    });
});

Change icon

It is possible to change the icon for example to a gear with:

player.hlsQualitySelector({
    vjsIconClass: 'vjs-icon-cog',
});

License

MIT. Copyright (c) Chris Boustead ([email protected])