mjneil/videojs-contrib-quality-levels

videojs-contrib-quality-levels

Exposes a list of quality levels available for the source.

Table of Contents

Installation

npm install --save videojs-contrib-quality-levels

The npm installation is preferred, but Bower works, too.

bower install  --save videojs-contrib-quality-levels

Using

The list of QualiyLevels can be accessed using qualityLevels() on the Player object. With this list, you can:

• see which quality levels are available for the current source
• enable or disable specific quality levels to change which levels are selected by ABR
• see which quality level is currently selected by ABR

Example

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

let qualityLevels = player.qualityLevels();

// Loop through the list of quality levels and disable all qualities with more than
// 720 horizontal lines of resolution.
for (let i = 0; i < qualityLevels.length; i++) {
  let qualityLevel = qualityLevels[i];
  if (qualityLevel.height > 720) {
    qualityLevel.enabled = false;
  } else {
    qualityLevel.enabled = true;
  }
}

let currentSelectedQualityLevelIndex = qualityLevels.selectedIndex;

Populating the list

Initially the list of quality levels will be empty. You can add quality levels to the list by using QualityLevelList.addQualityLevel for each quality level specific to your source. QualityLevelList.addQualityLevel takes in a Representation object (or generic object with the required properties). All properties are required except width and height.

Example Representation

Representation {
  id: string,
  width: number,
  height: number,
  bitrate: number,
  enabled: function
}

The enabled function should take an optional boolean to enable or disable the representation and return whether it is currently enabled.

HLS

Quality levels for an HLS source will be automatically populated when using videojs-contrib-hls version 4.1 or greater.

Including the Plugin

To include videojs-contrib-quality-levels 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>
  var player = videojs('my-video');

  player.qualityLevels();
</script>

Browserify

When using with Browserify, install videojs-contrib-quality-levels 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-contrib-quality-levels');

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

player.qualityLevels();

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-contrib-quality-levels'], function(videojs) {
  var player = videojs('my-video');

  player.qualityLevels();
});

License

Apache-2.0. Copyright (c) Brightcove, Inc.