@filmgardi/videojs-controls-badge

videojs-controls-badge

The controls-badge plugin show current value of multiple value component as badge icon.

Table of Contents

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

Installation

npm install --save @filmgardi/videojs-controls-badge

Usage

To include videojs-controls-badge 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-controls-badge.min.js"></script>
<script>
	var player = videojs('my-video');

	const badgeConf = {
		volume: true,
		subtitle: true,
		quality: true
	};
	
	player.controlsBadge(badgeConf);
</script>

Screenshot

Result of using videojs-controls-badge plugin:

Browserify/CommonJS

When using with Browserify, install videojs-controls-badge 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('@filmgardi/videojs-controls-badge');

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

const badgeConf = {
	volume: true,
	subtitle: true,
	quality: true
};

player.controlsBadge(badgeConf);

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', '@filmgardi/videojs-controls-badge'], function(videojs) {
	var player = videojs('my-video');

	const badgeConf = {
		volume: true,
		subtitle: true,
		quality: true
	};

	player.controlsBadge(badgeConf);
});

License

MIT. Copyright (c) m-saffari <[e-mail]>