Klasse: StreamManager

StreamManager

class   public

Verwaltet Streams mit dynamischer Anzeigenbereitstellung. Er verwaltet die Interaktionen mit dem DAI-Backend und verarbeitet Tracking-Pings sowie die Weiterleitung von Stream- und Anzeigenereignissen an den Publisher. Dieser Manager wird nicht von BaseAdsManager übernommen, da es sich nicht um einen Manager für eine bestimmte Anzeige, sondern um einen Manager für den gesamten Stream handelt.

Konstruktor

StreamManager

new StreamManager(videoElement, adUiElement, uiSettings)

Konstruktor.

Parameter
videoElement	Das HTML-Videoelement, in dem die Wiedergabe erfolgt. Der Wert darf nicht null sein.
adUiElement	Optional Das HTML-Element, das die UI-Elemente der Anzeige enthält. Dieses Element sollte dieselbe Höhe und Breite wie die Videowiedergabe haben und direkt darüber liegen. Andernfalls wird keine Benutzeroberfläche angezeigt und es werden keine Anzeigen angefordert, für die eine Benutzeroberfläche erforderlich ist, z. B. überspringbare Anzeigen.
uiSettings	Optional Die UI-Einstellungen, die für diesen Stream verwendet werden sollen. Der Wert darf nicht null sein.

Löst

wenn die Eingabeparameter nicht den Anforderungen entsprechen.

Attribute

clickElement

Nicht null-wertiges HTMLElement

clickElement

Nicht null-wertiges HTMLElement

streamMonitor

nicht nuller PodServingStreamMonitor

Methoden

addEventListener

addEventListener(type, listener) gibt void zurück

Fügt einen Listener für den angegebenen Ereignistyp hinzu.

Parameter
Typ	String Die Art des Ereignisses, das erfasst werden soll.
Listener	function(non-null StreamEvent) Eine Funktion, die jedes Mal aufgerufen wird, wenn ein Ereignis dieses Typs eintritt.

Ausgabe

void 

contentTimeForStreamTime

contentTimeForStreamTime(streamTime) gibt eine Zahl zurück

Gibt die Zeitspanne des Inhalts ohne Anzeigen für eine bestimmte Streamzeit zurück. Gibt die angegebene Streamzeit für Livestreams zurück.

Parameter
streamTime	Zahl die Wiedergabezeit mit eingefügten Anzeigen (in Sekunden).

Ausgabe

number die Zeitspanne des Inhalts, die der angegebenen Streamzeit entspricht, nachdem Anzeigen entfernt wurden.

Fokus

focus() gibt nichts zurück

Der Fokus wird auf die Schaltfläche „Überspringen“ gelegt, falls vorhanden. Andernfalls liegt der Fokus auf interaktiven Elementen wie Symbolen oder interaktiven Creatives.

Ausgabe

void 

getAdSkippableState

getAdSkippableState() gibt einen booleschen Wert zurück

Gibt „true“ zurück, wenn die Anzeige derzeit übersprungen werden kann. Wenn sich dieser Wert ändert, löst StreamManager das Ereignis StreamEvent.SKIPPABLE_STATE_CHANGED aus.

Ausgabe

boolean „True“, wenn die Anzeige derzeit übersprungen werden kann, andernfalls „false“.

loadStreamMetadata

loadStreamMetadata() gibt nichts zurück

Das SDK wird aufgefordert, Anzeigenmetadaten zu laden, und sendet dann StreamEvent.LOADED. Dieser Vorgang sollte manuell ausgelöst werden, sobald das Stream-Manifest vom Video-Stitcher eines Drittanbieters abgerufen wurde. Diese Option wird nur für die VOD-Bereitstellung von Pods mit einem Video-Stitcher von Drittanbietern verwendet und hat bei anderen Streamanfragen keine Auswirkungen.

Ausgabe

void 

onTimedMetadata

onTimedMetadata(metadata) gibt „void“ zurück

Ein Dictionary mit verarbeiteten Metadaten wird übergeben. Das Dictionary erwartet den Schlüssel „TXXX“ mit dem benutzerdefinierten Metadatenstring als Wert. Wenn dein Player Rohmetadaten bereitstellt, rufe stattdessen StreamManager.processMetadata auf.

Parameter
Metadaten	(Null- oder Nicht-Null-Objekt mit Stringeigenschaften) Das Wörterbuch mit Metadaten.

Ausgabe

void 

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) returns (null or CuePoint)

Gibt den vorherigen Cue-Punkt für die angegebene Streamzeit zurück. Gibt „null“ zurück, wenn kein solcher Cue-Punkt vorhanden ist. Dieser Parameter wird verwendet, um Funktionen wie „Zurückspringen“ zu implementieren. Er wird aufgerufen, wenn der Publisher erkennt, dass der Nutzer vorwärtsgesprungen ist, um ihn zu einer Werbeunterbrechung zurückzusenden.

Parameter
streamTime	Zahl die Streamzeit, zu der gesprungen wurde.

Ausgabe

(null or non-null CuePoint) der vorherige Cue-Punkt für die angegebene Streamzeit.

processMetadata

processMetadata(type, data, timestamp) gibt nichts zurück

Verarbeitet zeitbezogene Metadaten für Livestreams. Verwende diese Funktion, wenn dein Videoplayer unformatierte Metadaten zusammen mit Zeitstempeln bereitstellt. Andernfalls rufe StreamManager.onTimedMetadata auf.

Parameter
Typ	String Typ für Metadaten. Muss „ID3“ für HLS oder die Ereignisnachrichten-Schema-ID-URI für DASH sein.
Daten	(String oder nicht null-wertiges Uint8Array) Rohe Tag-Daten Bei ID3-Tags müssen es die vollständigen Roh-Tag-Daten sein. Bei DASH-Ereignisnachrichten ist dies der Nachrichtendatenstring.
timestamp	Zahl Zeit in Sekunden, zu der die Daten verarbeitet werden sollen. Bei DASH ist dies die Startzeit der Ereignisnachricht.

Ausgabe

void 

removeEventListener

removeEventListener(type, listener) gibt void zurück

Entfernt einen Listener für den angegebenen Ereignistyp. Die Listenerfunktion muss mit der Funktion übereinstimmen, die zuvor an addEventListener übergeben wurde.

Parameter
Typ	String Der Ereignistyp, für den der Listener entfernt werden soll.
Listener	function(non-null StreamEvent) Die Funktion, die als Listener entfernt werden soll.

Ausgabe

void 

replaceAdTagParameters

replaceAdTagParameters(adTagParameters) gibt „void“ zurück

Ersetzt alle Anzeigen-Tag-Parameter eines Livestreams, die für anstehende Anzeigenanfragen verwendet werden.

Parameter
adTagParameters	Objekt mit Stringeigenschaften Die neuen Parameter für Anzeigen-Tags. Muss Stringwerte haben. Der Wert darf nicht null sein.

Ausgabe

void 

requestStream

requestStream(streamRequest) gibt nichts zurück

Hiermit wird ein Stream mit den angegebenen Streamparametern geladen.

Parameter
streamRequest	StreamRequest enthält Parameter zum Laden der Stream-Metadaten. Der Wert darf nicht null sein.

Ausgabe

void 

Zurücksetzen

reset() gibt void zurück

Der Streammanager wird zurückgesetzt und kontinuierliche Abfragen werden entfernt.

Ausgabe

void 

setClickElement

setClickElement(clickElement) gibt „void“ zurück

Hier wird das Element für die Weiterleitung nach dem Klick auf die Anzeige festgelegt. Dieses Element wird als Klick- oder Tippempfänger verwendet, während eine Anzeige wiedergegeben wird. Dies kann dazu führen, dass die aktuelle Seite verlassen wird. Diese Funktion ist jetzt eingestellt. Stattdessen sollte ein „adUiElement“ an den StreamManager übergeben werden. Wenn dem StreamManager-Konstruktor ein adUiElement übergeben wird, wird diese Methode nicht ausgeführt.

Parameter
clickElement	(null oder nicht null-Element) Das Element, das als Klick-Element für die Anzeige verwendet wird.

Verworfen

Gib stattdessen ein „adUiElement“ für den StreamManager-Konstruktor an.

Ausgabe

void 

streamTimeForContentTime

streamTimeForContentTime(contentTime) gibt eine Zahl zurück

Gibt die Streamzeit mit Anzeigen für eine bestimmte Contentdauer zurück. Gibt die angegebene Zeit für den Inhalt von Livestreams zurück.

Parameter
contentTime	Zahl die Dauer des Inhalts ohne Werbeunterbrechungen (in Sekunden).

Ausgabe

number die Streamzeit, die der angegebenen Contentzeit entspricht, nachdem Anzeigen eingefügt wurden.