videojs-ssa

server-side ads integration

Table of Contents

Installation

• Installation
• Usage
  • <script> Tag
  • Browserify/CommonJS
  • RequireJS/AMD
  • Options
• License

Installation

npm install --save @youon/videojs-ssa

Usage

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

  player.ssa({
    debug : false,
    inventoryUrl : 'url/to/server/inventory'
  });
</script>

Browserify/CommonJS

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

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

player.ssa({
    debug : false,
    inventoryUrl : 'url/to/server/inventory'
  });

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

  player.ssa({
    debug : false,
    inventoryUrl : 'url/to/server/inventory',
  });

});

Options

You can set options to the plugin

  player.ssa({ 
    debug: boolean (default: false)
    inventoryUrl: string (mandatory)
    thumbnail : boolean, (default: true)
    skip : boolean, (this is set by each ad)
    skipAfter : number, (this is set by each ad)
    waitForSkip : boolean, (default: true)
    textWaitForSkip : string (default: "skip after" (translates to PT and EN))
    displayTimetoSkip : boolean,  (default: true)
    textCanSkip : string (default: "skip to video" (translates to PT and EN))
    controlBar : {
      fullscreen : boolean, (default: false)
      muteToggle : boolean, (default: false)
      remainingTime : boolean, (default: true)
      text : string (default: "advertisement" (translates to PT and EN)),
      hidden : boolean (default: false)
    }
  });
});

License

MIT. Copyright (c) YouOn <youongroup.com>