videojs-slides

Plugin to show slides according to the time, author name and resources list

Table of Contents

Installation

npm install --save videojs-slides

Usage

To include videojs-slides 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-slides.min.js"></script>
<script>
  var player = videojs('my-video');
  slides = [{url:'image url',time:9}]
  player.slides(slide);
</script>

Browserify

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

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

player.slides();

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

  player.slides();
});

Options

slides: [
  {
    url:'path', time:'seconds'
  }
]
resources: [
  {
    url:'path',name:'string',icon:'iconclass',cta:'string'
  }
]
links: [
  {
    name:'string', url:'path'
  }
]
logo: [
  {
    url:'path',link:'string'
  }
]
author: [
  {
    name:'string',image:'path'
  }
]

Example:

player.slides({slides, author, resources, links, logo});

License

MIT. Copyright (c) Jairo Campos Vargas