VASTmanka
VASTmanka makes it easy to playback linear VAST creatives in the browser. It currently supports VPAID 1.0/2.0 (JavaScript and Flash) and HTML5 <MediaFile>
s. The library has the following responsibilites:
- Requesting VAST ad tags
- Resolving VAST wrapper tags
- Choosing a
<MediaFile>
based on the browser environment - Loading/initializing a
<MediaFile>
(including VPAID creatives) - Firing VAST tracking pixels/impressions at the correct time
- Opening VAST
<VideoClicks>
when appropriate
Adding to Project
- Install as a dependency
$ yarn add vastmanka
- Use the module
; const vastmanka = document;vastmanka;
API
main exports
Node
, [config]:Object
) extends
EventEmitter
VASTmanka(container:- Parameters
- container:
Node
: A DOM node into which the ad will be inserted. The ad will take up 100% of the width and height of the container. - optional config:
Object
: The following properties are supported- config.vast:
Object
: Configuration for fetching VAST ad tags- config.vast.resolveWrappers:
Boolean
:true
if VAST<Wrapper>
s should be fetched automatically. Defaults totrue
. - config.vast.maxRedirects:
Number
: The number of VAST<Wrapper>
s that are allowed to be fetched. Defaults to5
.
- config.vast.resolveWrappers:
- config.tracking:
Object
: Configuration for firing tracking pixels- config.tracking.mapper:
Function
: ThisFunction
can be used to transform the URIs of VAST tracking pixels. TheFunction
will be invoked every time a tracking pixel is fired, with the URI of the pixel as the only argument. The returnedString
URI will be fired. Deaults to an identityFunction
.
- config.tracking.mapper:
- config.vast:
- container:
- Methods
- load(uri:
String
) =>Promise
: Fetches a VAST ad tag and loads one of its<MediaFile>
s into the container. The returnedPromise
will be resolved when it is safe to start playback viastartAd()
. - startAd() =>
Promise
: Starts playback of the ad. This method may only be called once. The returnedPromise
will be fulfilled when the ad starts playing. This method cannot be called until thePromise
returned byload()
is fulfilled. - stopAd() =>
Promise
: Stops playback of the ad and cleans-up its resources. Once this method has been called, the ad cannot be started again viastartAd()
. The returnedPromise
will be fulfilled when the ad's resources are cleaned-up. This method cannot be called until thePromise
returned byload()
is fulfilled. - pauseAd() =>
Promise
: Pauses ad playback. The returnedPromise
will be fulfilled when the ad pauses. This method cannot be called until thePromise
returned bystartAd()
is fulfilled. - resumeAd() =>
Promise
: Resumes ad playback. The returnedPromise
will be fulfilled when ad playback resumes. This method cannot be called until thePromise
returned bypauseAd()
is fulfilled.
- load(uri:
- Properties
- container:
Node
: The supplied container. - config:
Object
: The supplied configuration, with defaults applied. - vast:
VAST
: A vastacularVAST
instance representing the fetched ad tag. - ready:
Boolean
: Indicates if the ad is ready for playback. - adRemainingTime:
Number
: The amount of time (in seconds) left in the linear ad. Accessing this property before the ad is loaded will throw anError
. - adDuration:
Number
: The total duration of the ad (in seconds.) Accessing this property before the ad is loaded will throw anError
. - adVolume:
Number
: Gets/sets the volume of the ad with0
being completely silent and1
being as loud as possible. Accessing (or setting) this property before the ad is loaded will throw anError
.
- container:
- Events: All VPAID 2.0 events are supported. A subset of these events are supported for non-VPAID
<MediaFile>
s as well. In addition, the following events are emitted:- ready: Fired when
startAd()
may be called and theready
property becomestrue
. - error: Fired when an error occurs with ad loading/playback.
- ready: Fired when
String
VASTmanka.vpaidSWFLocation:The location of the SWF needed for Flash VPAID playback. The defaults to a location on the jsDelivr CDN. Only override this property if you want to use a version of the SWF you have uploaded yourself.