Need private packages and team management tools?Check out npm Teams »

@youon/videojs-sprite-thumbnails

1.0.2 • Public • Published

videojs-sprite-thumbnails

Plugin to display thumbnails from a sprite image when hovering over the progress bar.

Features

  • easy to configure
  • uses existing hover position display element
  • focuses on use case of thumbnails combined in a sprite image only

Installation

npm install --save @youon/videojs-sprite-thumbnails

Usage

To include videojs-sprite-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-sprite-thumbnails.min.js"></script>
<script>
  var player = videojs('my-video');
 
  // setup 160x90 thumbnails in sprite.jpg, 1 per second
  player.spriteThumbnails({
    url: 'https://example.com/sprite.jpg',
    width: 160,
    height: 90
  });
</script> 

Browserify/CommonJS

When using with Browserify, install videojs-sprite-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-sprite-thumbnails');
 
var player = videojs('my-other-video');
 
player.spriteThumbnails({
  interval: 3,
  url: 'https://example.com/another-sprite.jpg',
  width: 120,
  height: 90
});

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-sprite-thumbnails'], function(videojs) {
  var player = videojs('my-video');
 
  player.spriteThumbnails({
    url: 'https://example.com/sprite.jpg',
    width: 160,
    height: 90
  });
});

CDN

Select a version of videojs-sprite-thumbnails from the CDN.

Configuration

option type mandatory default description
url String Sprite image location.
width Integer Width of a thumbnail in pixels.
height Integer Height of a thumbnail in pixels.
interval Number 1 Interval between thumbnail frames in seconds.
responsive Integer 600 Width of player in pixels below which thumbnails are reponsive. Set to 0 to disable.

License

MIT. Copyright (c) Christian Ebert <blacktrash@gmx.net>

Install

npm i @youon/videojs-sprite-thumbnails

DownloadsWeekly Downloads

2

Version

1.0.2

License

MIT

Unpacked Size

68.4 kB

Total Files

16

Last publish

Collaborators

  • avatar
  • avatar