Videos anzeigen

Die Integration oxomi.videos rendert eine Liste von Videos in den angegebenen DOM-Container. Dabei wird das Vorschau-Bild des Videos sowie dessen Name angezeigt. Die Integration bietet verschiedene Filter-, Sortier- und Gruppiermöglichkeiten, mit denen Sie die Ergebnisse einschränken und anpassen können. Darüber hinaus kann ein Gruppenfilter angezeigt werden.

Die gerenderte Liste von Videos enthält bis zu 50 Einträge. Falls mehr Videos gefunden wurden, so wird eine Karte mit dem Label „Weitere anzeigen“ dargestellt. Durch einen Klick auf diese Karte werden jedes Mal bis zu 15 weitere Videos nachgeladen.

Die Integration bietet verschiedene CSS -cust Klassen an, um das Aussehen oder den Funktionsumfang der Integration zu beeinflussen. Weitere Informationen hierzu finden Sie im Artikel Individuelle CSS Regeln.

Der Aufruf der Integration liefert ein Promise zurück, welches Ihnen die Möglichkeit gibt, entsprechend auf den Abschluss des Aufrufs zu reagieren. Hierfür können Sie die then und catch Methoden des Promise Objekts verwenden. Der nachfolgende JavaScript-Code zeigt ein Beispiel, wie Sie auf den Abschluss des Aufrufs reagieren können.

oxomi.videos({
    target: "#output",
    showActions: true,
    showGroupFilter: true,
    groupBy: "brand",
    supplierNumbers: "L10190"
}).then((result) => {
    console.log("success");
}).catch((error) => {
    console.log("failed");
});

Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.

Parameter Parametertyp Beschreibung
target string

Gibt das Ziel-Element an, in welches die gerenderte Liste von Videos eingefügt wird.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird #oxomi-videos als Default-Wert verwendet.
supplierNumbers string

Gibt die Lieferantennummern der Partner an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Sie können Ihre eigenen Lieferantennummern verwenden, wenn Sie diese in der Partnerschaft zum Lieferanten gepflegt haben (siehe: Lieferantennummern).
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
excludedSupplierNumbers string

Gibt die Lieferantennummern der Partner an, deren Inhalte von den Ergebnissen ausgeschlossen werden sollen.

Hinweis:

  • Sie können Ihre eigenen Lieferantennummern verwenden, wenn Sie diese in der Partnerschaft zum Lieferanten gepflegt haben (siehe: Lieferantennummern).
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
brandIds string

Gibt die IDs der Marken an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
  • Die ID der Marke eines Inhalts kann in der jeweiligen Detailansicht innerhalb der Portalinhalte eingesehen werden.
brands string

Gibt die Namen der Marken an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Dieser Parameter sollte nach Möglichkeit nicht verwendet werden, da der Name einer Marke nicht eindeutig ist und geändert werden kann. Verwenden Sie stattdessen den Parameter brandIds.
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die Groß- und Kleinschreibung wird bei der Angabe der Werte berücksichtigt.
seriesIds string

Gibt die IDs der Serien an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
  • Die ID der Serie eines Inhalts kann in der jeweiligen Detailansicht innerhalb der Portalinhalte eingesehen werden.
tags string

Gibt die Tags an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die Groß- und Kleinschreibung wird bei der Angabe der Werte berücksichtigt.
categoryIds string

Gibt die IDs der Kategorien an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
  • Die ID der Kategorie eines Inhalts kann in der jeweiligen Detailansicht innerhalb der Portalinhalte eingesehen werden.
categories string

Gibt die Namen der Kategorien an, auf welche die Ergebnisse eingeschränkt werden sollen.

Hinweis:

  • Dieser Parameter sollte nach Möglichkeit nicht verwendet werden, da der Name einer Kategorie nicht eindeutig ist und geändert werden kann. Verwenden Sie stattdessen den Parameter categoryIds.
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die Groß- und Kleinschreibung wird bei der Angabe der Werte berücksichtigt.
types string

Gibt die Video-Typen an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: Videotypen

Hinweis:

  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
filterLanguages string

Gibt die Sprachen als 2-buchstabige ISO-Codes an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: ISO-Sprachcodes

Hinweis:

  • Dieser Parameter steht nur für PRO Portale zur Verfügung. Zu den Preisen & Bestellmöglichkeiten
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
filterCountries string

Gibt die Länder als 2-buchstabige ISO-Codes an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: ISO-Ländercodes

Hinweis:

  • Dieser Parameter steht nur für PRO Portale zur Verfügung. Zu den Preisen & Bestellmöglichkeiten
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
own boolean

Gibt an, ob nur eigene Videos oder nur Videos von anderen Anbietern angezeigt werden sollen.

Hinweis:

  • Dieser Parameter bezieht sich dabei ausschließlich auf die eigene Standardmarke.
  • Wird dieser Parameter auf true gesetzt, so werden ausschließlich eigene Videos angezeigt.
  • Wird dieser Parameter auf false gesetzt, so werden ausschließlich Videos von anderen Anbietern angezeigt.
  • Wird dieser Parameter nicht angegeben, so werden sowohl eigene als auch Videos von anderen Anbietern angezeigt, sofern diese über eine Partnerschaft verfügbar sind.
includeOutdated boolean

Gibt an, ob auch archivierte Videos in den Ergebnissen angezeigt werden sollen.

Hinweis:

  • Wird dieser Parameter auf true gesetzt, so werden auch archivierte Videos angezeigt.
  • Wird dieser Parameter auf false gesetzt, so werden ausschließlich aktuelle Videos angezeigt.
  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Dieser Parameter wird nur angewendet, wenn in den Portaleinstellungen im Abschnitt „Standard“ die Option „Archiv aktivieren“ mit einem Wert größer 0 eingestellt ist.
onlyOutdated boolean

Gibt an, ob ausschließlich archivierte Videos in den Ergebnissen angezeigt werden sollen.

Hinweis:

  • Wird dieser Parameter auf true gesetzt, so werden ausschließlich archivierte Videos in den Ergebnissen angezeigt.
  • Sollte der Parameter auf true gesetzt sein, hat er Vorrang vor dem Parameter includeOutdated. Bei Einstellung auf false verhält sich der Parameter so, als wäre er nicht angegeben worden.
  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Dieser Parameter wird nur angewendet, wenn in den Portaleinstellungen im Abschnitt „Standard“ die Option „Archiv aktivieren“ mit einem Wert größer 0 eingestellt ist.
sortBy string

Gibt die Sortierung der Ergebnisse vor. Die nachfolgenden Werte stehen hier zur Verfügung:

Wert Beschreibung
priority Sortierung nach Marken-Priorität & Marken-Namen. Bei gleicher Marke werden die Dokumente alphanumerisch nach dem Dokumentnamen sortiert. Dies ist der verwendete Standard-Wert.
name Sortiert alphanumerisch nach dem Namen. Keine Markensortierung.
date Sortierung nach Datum, neuste Objekte werden zuerst gezeigt.
random Das Ergebnis ist zufällig gemischt.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird priority als Default-Wert verwendet.
showGroupFilter boolean

Gibt an, ob ein Gruppenfilter angezeigt werden soll. Wird dieser Parameter auf true gesetzt, werden über dem Ergebnis Schaltflächen zur Filterung durch den Nutzer auf einzelne Gruppen angezeigt.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Der Gruppenfilter wird nur angezeigt, wenn der Parameter groupBy mit einem gültigen Wert angegeben wurde.
groupBy string

Gibt an ob und wie das Ergebnis gruppiert werden soll. Die nachfolgenden Werte stehen hier zur Verfügung:

Wert Beschreibung
category Gruppiert nach Kategorie
brand Gruppiert nach Marke
type Gruppiert nach Typ
tag Gruppiert nach Tags
series Gruppiert nach Serie

Hinweis:

  • Wenn der Parameter angegeben wird, so verändert sich die Struktur der gerenderten Ansicht. Die Videos werden dann in Gruppen angezeigt, welche durch eine Überschrift gekennzeichnet sind.
  • In jeder Gruppe werden dann maximal 15 Videos angezeigt. Falls mehr Videos in einer Gruppe vorhanden sind, so wird eine Karte mit dem Label „Weitere Videos“ angezeigt. Durch einen Klick auf diese Karte werden jedes Mal bis zu 15 weitere Videos nachgeladen.
  • Videos die nicht in eine Gruppe eingeordnet werden können, werden in dieser Ansicht nicht angezeigt.
limit integer

Gibt die maximale Anzahl an Videos an, welche initial angezeigt werden sollen.

Hinweis:

  • Der maximal zulässige Wert für den Parameter beträgt 50.
  • Sind mehr Videos vorhanden, so ist es über eine entsprechend angezeigte Kachel möglich, weitere Videos nachzuladen.
  • Wird dieser Parameter nicht angegeben, so werden bei gruppierter Ansicht (siehe groupBy) bis zu 15 Videos pro Gruppe angezeigt. Andernfalls werden maximal 50 Videos angezeigt.
Videos anzeigen - Showcase

Initialisierungsparameter
(portal)
Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
(user) Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
(roles) Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.
(accessToken) Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Hauptparameter
(supplierNumbers) Gibt die Lieferantennummern der Partner an, auf welche die Ergebnisse eingeschränkt werden sollen.
(excludedSupplierNumbers) Gibt die Lieferantennummern der Partner an, dessen Inhalte von den Ergebnissen ausgeschlossen werden sollen.
(brandIds) Gibt die IDs der Marken an, auf welche die Ergebnisse eingeschränkt werden sollen.
(seriesIds) Gibt die IDs der Serien an, auf welche die Ergebnisse eingeschränkt werden sollen.
(categoryIds) Gibt die IDs der Kategorien an, auf welche die Ergebnisse eingeschränkt werden sollen.
(tags) Gibt die Tags an, auf welche die Ergebnisse eingeschränkt werden sollen.
(types)
Gibt die Video-Typen an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: Videotypen
(groupBy)
Gibt an ob und wie das Ergebnis gruppiert werden soll.
(showGroupFilter) Gibt an, ob ein Gruppenfilter angezeigt werden soll. Wird dieser Parameter auf Ja (true) gesetzt, werden über dem Ergebnis Schaltflächen zur Filterung durch den Nutzer auf einzelne Gruppen angezeigt. Dieser Parameter wird nur angewandt, wenn der Parameter Gruppierung mit einem gültigen Wert angegeben wurde.
(includeOutdated) Gibt an, ob auch archivierte Videos in den Ergebnissen angezeigt werden sollen. Dieser Parameter wird nur angewandt, wenn der Parameter Nur archivierte Videos anzeigen mit einem anderen Wert als Ja (true) angegeben wurde.
(onlyOutdated) Gibt an, ob ausschließlich archivierte Videos in den Ergebnissen angezeigt werden sollen. Wenn dieser Parameter auf Ja (true) gesetzt wird, werden nur archivierte Videos in den Ergebnissen angezeigt. Außerdem hat der Parameter dann Vorrang vor dem Parameter Archivierte Videos anzeigen.
(own)
Gibt an, ob nur eigene Videos oder nur Videos von anderen Anbietern angezeigt werden sollen.
(filterLanguages)
Gibt die Sprachen als 2-buchstabige ISO-Codes an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: ISO-Sprachcodes
(filterCountries)
Gibt die Länder als 2-buchstabige ISO-Codes an, auf welche die Ergebnisse eingeschränkt werden sollen. Die verfügbaren Werte können hier eingesehen werden: ISO-Ländercodes
(limit) Gibt die maximale Anzahl an Videos an, welche initial angezeigt werden sollen.

Ausgabebereich

Video einbetten

Die Integration oxomi.embedVideo rendert entweder das Cover-Bild eines einzelnen angegebenen Videos (sowie dessen Name) oder das Video direkt in den angegebenen DOM-Container. Für die direkte Einbettung des Videos stehen zwei verschiedene Arten zur Verfügung, welche mithilfe des mode Parameters festgelegt werden können.

Die Integration bietet zudem verschiedene CSS -cust Klassen an um das Aussehen oder den Funktionsumfang der Integration zu beeinflussen. Weitere Informationen hierzu finden Sie im Artikel Individuelle CSS Regeln.

Der Aufruf der Integration liefert ein Promise zurück, welches Ihnen die Möglichkeit gibt, entsprechend auf den Abschluss des Aufrufs zu reagieren. Hierfür können Sie die then und catch Methoden des Promise Objekts verwenden. Der nachfolgende JavaScript-Code zeigt ein Beispiel, wie Sie auf den Abschluss des Aufrufs reagieren können.

oxomi.embedVideo({
    target: "#output",
    video: "131",
    mode: "overlay",
    autoplay: true,
    showName: true
}).then((result) => {
    console.log("success");
}).catch((error) => {
    console.log("failed");
});

Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.

Parameter Parametertyp Beschreibung
video string

Gibt die ID oder den Code des Videos an.

Hinweis:

  • Wird ein Code angegeben, für den mehrere Videos existieren, so wird das aktuellste verwendet.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
target string

Gibt das Ziel-Element an, in welches das gerenderte Video eingefügt wird.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird #oxomi-video als Default-Wert verwendet.
mode string

Gibt den Modus der Einbettung an. Die nachfolgenden Werte stehen hier zur Verfügung:

Wert Beschreibung
overlay

Es wird ein Vorschaubild eingebettet. Wird dies angeklickt, so wird der Video-Player in einem Overlay geöffnet. Dies hat den Vorteil, dass kleinere Bilder verwendet werden können, nachher aber ein großer Video-Player zur Verfügung steht. Weiterhin werden die Ressourcen (Video-Player und Film) erst geladen, wenn ein Video abgespielt wird.

in-place

Es wird ein Vorschaubild eingebettet. Wird dies angeklickt, wird der Video-Player an der Stelle des Vorschaubildes geöffnet. Dies vereinfacht die Benutzerführung. Weiterhin werden die Ressourcen (Video-Player und Film) erst geladen, wenn ein Video abgespielt wird.

embed

Es wird direkt ein Video-Player an der gewünschten Stelle eingebunden, welcher das Video abspielt. Dies hat den Vorteil, dass alle Ressourcen geladen sind und das Video sofort abspielt. Der Nachteil ist, dass die Ressourcen auch dann geladen werden, wenn kein Video abgespielt werden soll.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird overlay als Default-Wert verwendet.
autoplay boolean

Gibt an, ob das Video nach dem Laden sofort abgespielt werden soll.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
  • Wird dieser Parameter auf true gesetzt, so wird das Video nach dem Laden sofort abgespielt.
  • Wird dieser Parameter auf false gesetzt, so wird das Video nach dem Laden pausiert.
  • In Chromium-basierten Browsern wird dieser Parameter ignoriert, da diese das automatische Abspielen von Videos grundsätzlich blockieren.
showName boolean

Gibt an, ob der Name des Videos angezeigt werden soll.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird true als Default-Wert verwendet.
  • Wird dieser Parameter auf true gesetzt, so wird der Name des Videos angezeigt.
  • Wird dieser Parameter auf false gesetzt, so wird der Name des Videos nicht angezeigt.
Video einbetten - Showcase

Initialisierungsparameter
(portal)
Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
(user) Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
(roles) Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.
(accessToken) Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Hauptparameter
(video) Geben Sie hier entweder ID (aus der URL der Detailseite) oder Code eines Videos an. Werden mehrere Inhalte mit demselben Code gefunden, so wird das aktuellste Element verwendet.
(mode)
(autoplay) Die automatische Wiedergabe des Videos funktioniert nur, wenn der Modus auf Player direkt einbinden steht. Außerdem wird dieser Parameter in Chromium-basierten Browsern ignoriert, da diese das automatische Abspielen von Videos grundsätzlich blockieren.
(showName) Gib an, ob der Name des Videos angezeigt werden soll.

Ausgabebereich

Video öffnen

Mit der Integration oxomi.openVideo kann ein Video in einem Overlay geöffnet werden. So können Sie beispielsweise ein Video aus einer Videoliste oder aus einem anderen Kontext heraus anzeigen.

Der Aufruf der Integration liefert ein Promise zurück, welches Ihnen die Möglichkeit gibt, entsprechend auf den Abschluss des Aufrufs zu reagieren. Hierfür können Sie die then und catch Methoden des Promise Objekts verwenden. Der nachfolgende JavaScript-Code zeigt ein Beispiel, wie Sie auf den Abschluss des Aufrufs reagieren können.

oxomi.openVideo({
    video: "131",
    startTime: 3.0,
    autoplay: false
}).then((result) => {
    console.log("success");
}).catch((error) => {
    console.log("failed");
});

Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.

Parameter Parametertyp Beschreibung
video string

Gibt die ID oder den Code des Videos an.

Hinweis:

  • Wird ein Code angegeben, für den mehrere Videos existieren, so wird das aktuellste verwendet.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
startTime number

Gibt die Zeit in Sekunden an, an welcher Stelle das Video geöffnet werden soll.

autoplay boolean

Gibt an, ob das Video nach dem Laden sofort abgespielt werden soll.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird true als Default-Wert verwendet.
  • Wird dieser Parameter auf true gesetzt, so wird das Video nach dem Laden sofort abgespielt.
  • Wird dieser Parameter auf false gesetzt, so wird das Video nach dem Laden pausiert.
  • In Chromium-basierten Browsern wird dieser Parameter ignoriert, da diese das automatische Abspielen von Videos grundsätzlich blockieren.
Interaktives Code-Beispiel
Video öffnen - Showcase

Initialisierungsparameter
(portal)
Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
(user) Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
(roles) Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.
(accessToken) Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Hauptparameter
(video) Geben Sie hier entweder ID (aus der URL der Detailseite) oder Code eines Videos an. Werden mehrere Inhalte mit demselben Code gefunden, so wird das aktuellste Element verwendet.
(autoplay) Gibt an, ob das Video nach dem Öffnen sofort abgespielt werden soll.

Ausgabebereich

Video-Playlist einbetten

Die Integration oxomi.videoPlaylist rendert einen Video-Player direkt in das angegebene Ziel-Element. Der Player ist anschließend in der Lage, eine Playlist von Videos abzuspielen. Die in der Liste angegebenen Videos werden in der Reihenfolge abgespielt, in der sie angegeben wurden. Außerdem werden die Videos in der Playlist automatisch abgespielt, sobald das erste Video gestartet wurde.

Der Aufruf der Integration liefert ein Promise zurück, welches Ihnen die Möglichkeit gibt, entsprechend auf den Abschluss des Aufrufs zu reagieren. Hierfür können Sie die then und catch Methoden des Promise Objekts verwenden. Der nachfolgende JavaScript-Code zeigt ein Beispiel, wie Sie auf den Abschluss des Aufrufs reagieren können.

oxomi.videoPlaylist({
    target: "#output",
    videos: "131,133,142"
}).then((result) => {
    console.log("success");
}).catch((error) => {
    console.log("failed");
});

Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.

Parameter Parametertyp Beschreibung
videos string

Gibt die ID oder den Code der Videos an, welche in der Playlist angezeigt werden sollen.

Hinweis:

  • Wird ein Code angegeben, für den mehrere Videos existieren, so wird das aktuellste verwendet.
  • Die Angabe von mehreren Werten erfolgt durch die Verwendung von , (Komma) oder | (Pipe) als Trennzeichen. Es dürfen keine Leerzeichen enthalten sein.
  • Die ID kann in der Detailansicht gefunden werden. Hierzu muss unten rechts auf das Info-Icon geklickt werden. Anschließend kann die ID (Entity-ID) mit einem Klick auf das Kopieren-Icon kopiert werden.
target string

Gibt das Ziel-Element an, in welches die gerenderte Video-Playlist eingefügt wird.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird #oxomi-video als Default-Wert verwendet.
Video-Playlist einbetten - Showcase

Initialisierungsparameter
(portal)
Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
(user) Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
(roles) Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.
(accessToken) Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Hauptparameter
(videos) Gibt die ID oder den Code der Videos an, welche in der Playlist angezeigt werden sollen.

Ausgabebereich

Siehe auch
Enthält die Grundlagen zum Thema Javascript Integration.