videojs-vtt-thumbnails

Display thumnails on progress bar hover, driven by external VTT files.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
videojs-vtt-thumbnails
53290.0.135 years ago6 years agoMinified + gzip package size for videojs-vtt-thumbnails in KB

Readme

videojs-vtt-thumbnails
Video.js plugin that displays thumbnails on progress bar hover, driven by external VTT files. Based on the spec at: https://support.jwplayer.com/customer/portal/articles/1407439-adding-preview-thumbnails
Note: Plugin hides the default skin's mouse display timestamp on hover.

Table of Contents

Installation

- <script> Tag - Browserify/CommonJS - RequireJS/AMD

Installation

npm install --save videojs-vtt-thumbnails

Usage

To include videojs-vtt-thumbnails 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.jsvideojs, so that the videojs global is available.
<script src="//path/to/video.min.js"></script>
<script src="//path/to/videojs-vtt-thumbnails.min.js"></script>
<script>
  var player = videojs('my-video');
  player.vttThumbnails({
    src: 'example/thumbs.vtt'
  });
</script>

Browserify/CommonJS

When using with Browserify, install videojs-vtt-thumbnails 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-vtt-thumbnails');

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

player.vttThumbnails();

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

  player.vttThumbnails();
});

License

MIT. Copyright (c) Chris Boustead <chris@forgemotion.com>