A VideoJS plugin for VAST
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib Update videojs-contrib-ads to 0.4.0 Sep 28, 2014
spec
.gitignore
.jshintrc
.travis.yml
Gruntfile.js
LICENSE
README.md
bower.json
example.html
karma.conf.js Updates for testing Oct 30, 2014
package.json
videojs.vast.css
videojs.vast.js

README.md

videojs-vast-plugin Build Status Coverage Status

This plugin reads a VAST file, grabs the first video it can, and plays it as pre-roll advertisement before your video. It will also click through to whatever url the advertiser designates, track any clicks, and fire all of the correct pixel trackers at the right times.

Usage

Include the plugin and it's dependencies:

<script src="http://vjs.zencdn.net/4.4.3/video.js"></script>
<script src="vast-client.js"></script>
<script src="video.ads.js"></script>
<script src="videojs.vast.js"></script>

Add "ads" and "vast" to the plugins object, and pass a url:

plugins: {
    ads: {},
    vast: {
        url: 'http://url.to.your/vast/file.xml'
    }
}

And when you play that video, a pre-roll ad should play beforehand.

If you click on the ad, an adclick event will trigger.

Check out the demo for a more detailed example.

This plugin is technically an integration for video.js's ads plugin. For more information on the various states in the preroll process, please refer to the videojs-contrib-ads documentation.

Options

  • url: a URL to the xml file.
  • skip: how long until the user can skip the ad. Defaults to 5, and a negative number will disable it.

Credit

This plugin uses dailymotion's vast client to read and parse the VAST files, and video.js's ads plugin for switching from pre-roll to content.