Pars een VMAP XML-document naar een Javascript-object. Voldoet aan de VMAP 1.0.1 spec.

Installatie

Installeer met npm

npm install vmap

Gebruik

Voeg de VMAP constructor een XML in om er een geparseerde versie van te krijgen.

Toegang tot VMAP-eigenschappen met behulp van de hieronder gedocumenteerde API’s.

import VMAP from 'vmap';// Fetch VMAP as XMLconst xhr = new XMLHttpRequest();xhr.open('GET', vmapURL);xhr.send();xhr.onreadystatechange = function() { if (xhr.readyState === xhr.DONE) { if (xhr.status === 200) { // Get a parsed VMAP object const vmap = new VMAP(xhr.responseXML); } }};

API

VMAP

Eigenschappen

• version: De VMAP versie (moet 1.0 zijn).
• adBreaks: Een array van VMAPAdBreak objecten.
• extensions: Een array van Object met
  • children: Object met al deze uitbreidingskinderen en hun naam als sleutel
  • attribute: Object met alle attributen van deze extensie en hun naam als sleutel
  • value: Object geparsed uit CDATA of als fallback alle tekstknooppunten van deze extensie aaneengeschakeld

VMAPAdBreak

Levert informatie over een advertentiepauze.

Eigenschappen

• timeOffset: Geeft de timing van de advertentie onderbreking weer.
• breakType: Geeft aan of de advertentie onderbreking “lineaire”, “niet-lineaire” of “weergave” advertenties toestaat.
• breakId: Een optionele string-identifier voor de ad break.
• repeatAfter: Een optie die wordt gebruikt om advertentie-einden op gelijke afstand van elkaar te verdelen langs een lineaire tijdlijn.
• adSource: Een VMAPAdSource object.
• trackingEvents: Een array van Object met tracking URL’s
  • event: De naam van de gebeurtenis die voor het element moet worden gevolgd. Kan een van breakStart, breakEnd of error zijn.
  • uri: De URI van de tracker.
• extensions: Een array van Object met
  • children: Object met al deze uitbreidingskinderen en hun naam als sleutel
  • attribute: Object met daarin alle attributen van deze extensie en hun naam als sleutel
  • value: Object geparsed uit CDATA of als fallback alle tekstknooppunten van deze extensie samengevoegd

Methoden

• track(event, errorCode): Roept de trackers voor de gegeven gebeurtenis op met een optionele foutcodeparameter voor error-gebeurtenissen.

VMAPAdSource

Voorziet de speler van ofwel een inline advertentie-respons of een verwijzing naar een advertentie-respons.

Eigenschappen

• id: Ad-identifier voor de advertentiebron.
• allowMultipleAds: Geeft aan of een VAST-advertentiepod of een meervoudig buffet van advertenties kan worden geserveerd in een advertentiepauze.
• followRedirects: Geeft aan of de videospeler de omleidingen binnen een advertentierespons moet honoreren.
• vastAdData: Bevat een ingesloten VAST-respons.
• adTagURI: Bevat een URI naar de VAST.
• customData: Bevat aangepaste advertentiegegevens.

Ondersteuning en compatibiliteit

De bibliotheek is 100% geschreven in JavaScript en de broncode maakt gebruik van moderne functies zoals modules, classes, ecc… . Zorg ervoor dat uw omgeving deze functies ondersteunt, of transpileer de bibliotheek bij het bundelen van uw project.

Voorgebundelde versies

We bieden verschillende voorgebundelde versies van de bibliotheek (zie dist directory)

Browser

Een voorgebundelde versie van VMAP-jsis beschikbaar: vmap-js.js.

U kunt het script direct aan uw pagina toevoegen en de bibliotheek benaderen via de VMAP constructor.

<script src="dist/vmap-js.js"></script>

var vmap = new VMAP(vmapXML);

Node

Een pre-bundled versie voor node is ook beschikbaar: vmap-js-node.js.

const VMAP = require('vmap')const vmap = new VMAP(vmapXML);

Bouw en test

Installeer afhankelijkheden met:

npm install

Het project is gebundeld met behulp van Rollup. Bouwen met:

npm run-script build

Testen uitvoeren met:

npm test