videojs-title-overlay

Table of Contents

Installation

npm install --save @viostream/videojs-title-overlay

Usage

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

  player.titleOverlay();
</script>

Browserify/CommonJS

When using with Browserify, install videojs-title-overlay 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('@viostream/videojs-title-overlay');

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

player.titleOverlay();

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

  player.titleOverlay();
});

License

MIT. Copyright (c) Paul Vecchiato <[email protected]>