Parse ein VMAP XML Dokument in ein Javascript Objekt. Entspricht der VMAP 1.0.1 Spezifikation.

Installation

Installation mit npm

npm install vmap

Verwendung

Übergeben Sie dem VMAP Konstruktor ein XML, um eine geparste Version davon zu erhalten.

Zugriff auf VMAP Eigenschaften mit den unten dokumentierten APIs.

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

Eigenschaften

• version: Die VMAP Version (sollte 1.0 sein).
• adBreaks: Ein Array von VMAPAdBreak Objekten.
• extensions: Ein Array von Object mit
  • children: Object mit allen Kindern dieser Erweiterung und ihrem Namen als Schlüssel
  • attribute: Object mit allen Attributen dieser Erweiterung und deren Namen als Schlüssel
  • value: Object geparst aus CDATA oder als Fallback alle Textknoten dieser Erweiterung verkettet

VMAPAdBreak

Liefert Informationen über eine Werbeunterbrechung.

Eigenschaften

• timeOffset: Stellt den Zeitpunkt des Anzeigenwechsels dar.
• breakType: Gibt an, ob der Anzeigenwechsel „lineare“, „nichtlineare“ oder „Display“-Anzeigen zulässt.
• breakId: Ein optionaler String-Bezeichner für den Anzeigenwechsel.
• repeatAfter: Eine Option, die verwendet wird, um Anzeigenunterbrechungen in gleichem Abstand zueinander entlang einer linearen Zeitleiste zu verteilen.
• adSource: Ein VMAPAdSource Objekt.
• trackingEvents: Ein Array von Object mit Tracking-URLs
  • event: Der Name des zu verfolgenden Ereignisses für das Element. Kann einer von breakStart, breakEnd oder error sein.
  • uri: Die URI des Trackers.
• extensions: Ein Array von Object mit
  • children: Object mit allen Kindern dieser Erweiterung und ihrem Namen als Schlüssel
  • attribute: Object mit allen Attributen dieser Erweiterung und deren Namen als Schlüssel
  • value: Object geparst aus CDATA oder als Fallback alle Textknoten dieser Erweiterung konkateniert

Methoden

• track(event, errorCode): Ruft die Tracker für das angegebene Ereignis mit einem optionalen Fehlercodeparameter für error Ereignisse auf.

VMAPAdSource

Stellt dem Player entweder eine Inline-Anzeigenantwort oder einen Verweis auf eine Anzeigenantwort zur Verfügung.

Eigenschaften

• id: Anzeigenkennung für die Anzeigenquelle.
• allowMultipleAds: Gibt an, ob ein VAST-Anzeigenpod oder mehrere Anzeigenbuffets in einem Anzeigenwechsel bereitgestellt werden können.
• followRedirects: Gibt an, ob der Videoplayer die Weiterleitungen innerhalb einer Anzeigenantwort berücksichtigen soll.
• vastAdData: Enthält eine eingebettete VAST-Antwort.
• adTagURI: Enthält einen URI zum VAST.
• customData: Enthält benutzerdefinierte Anzeigendaten.

Unterstützung und Kompatibilität

Die Bibliothek ist zu 100% in JavaScript geschrieben und der Quellcode verwendet moderne Features wie modules, classes, ecc… . Stellen Sie sicher, dass Ihre Umgebung diese Features unterstützt, oder transpilieren Sie die Bibliothek, wenn Sie Ihr Projekt bündeln.

Vorgefertigte Versionen

Wir bieten mehrere vorgefertigte Versionen der Bibliothek an (siehe dist Verzeichnis)

Browser

Eine vorgefertigte Version von VMAP-jsis verfügbar: vmap-js.js.

Sie können das Skript direkt in Ihre Seite einfügen und über den VMAP Konstruktor auf die Bibliothek zugreifen.

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

var vmap = new VMAP(vmapXML);

Node

Eine vorgebündelte Version für Node ist ebenfalls verfügbar: vmap-js-node.js.

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

Build und Tests

Abhängigkeiten installieren mit:

npm install

Das Projekt wird mit Rollup gebündelt. Erstellen mit:

npm run-script build

Tests ausführen mit:

npm test