f0f9cd0beb
I learned the hard way that this module does not work with thumbnail-per-segment VTTs; it's better to do sprites anyway but the thumbnails will load but not appear (no dimensions are set for the applicable DOM node) unless the VTT file contains the `xywh` info.
2.3 KiB
videojs-vtt-thumbnails
Video.js plugin that displays thumbnails on progress bar hover, driven by external VTT files. Based on this JW Player spec. Note, this plugin currently only supports sprited thumbnails.
Note: Plugin hides the default skin's mouse display timestamp on hover.
Table of Contents
Installation
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.js, 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>