StreamManager
Diese Funktion verarbeitet Streams zur dynamischen Anzeigenbereitstellung. Er verwaltet Interaktionen mit dem Back-End für die dynamische Anzeigenbereitstellung, verarbeitet Tracking-Pings sowie die Weiterleitung von Streams und Anzeigenereignissen an den Publisher. Dieses Verwaltungskonto wird nicht aus dem BaseAdsManager übernommen, da es kein Verwaltungskonto für eine bestimmte Anzeige ist, sondern eines für den gesamten Stream
Konstruktor
StreamManager
neu StreamManager(videoElement, adUiElement, uiSettings)
Parameter |
|
|---|---|
|
videoElement |
Das HTML-Videoelement, in dem die Wiedergabe erfolgen soll Der Wert darf nicht null sein. |
|
adUiElement |
Optional Das HTML-Element, in dem die UI-Elemente der Anzeige enthalten sind. Dieses Element sollte dieselbe Höhe und Breite wie die Videowiedergabe haben und es direkt überlagern. Wenn nicht angegeben, wird keine UI angezeigt und keine Anzeigen, die eine UI erfordern, z. B. überspringbare Anzeigen, werden angefordert. Der Wert darf nicht null sein. |
|
uiSettings |
Optional Die UI-Einstellungen, die für diesen Stream verwendet werden sollen. Der Wert darf nicht null sein. |
- Löst aus
-
wenn Eingabeparameter die Anforderungen nicht erfüllen.
Methoden
contentTimeForStreamTime
„contentTimeForStreamTime(streamTime)“ gibt eine Zahl zurück.
Gibt die Content-Zeit ohne Anzeigen für eine bestimmte Stream-Zeit zurück. Gibt die angegebene Streamzeit für Livestreams zurück.
Parameter |
|
|---|---|
|
streamTime |
number Streamzeit mit eingefügten Anzeigen (in Sekunden) |
- Rückgabe
-
numberist die Contentzeit, die der jeweiligen Streamzeit entspricht, nachdem die Anzeigen entfernt wurden.
Konzentration
Fokus()
Setzt den Fokus auf die Schaltfläche „Überspringen“ (falls vorhanden). Falls nicht vorhanden, liegt der Fokus auf interaktiven Elementen wie Symbolen oder interaktiven Creatives.
getAdSkippableState
getAdOverlayState() 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 ein StreamEvent.SKIPPABLE_STATE_CHANGED-Ereignis aus.
- Rückgabe
-
boolean„true“, wenn die Anzeige derzeit übersprungen werden kann, andernfalls „false“.
loadStreamMetadata
loadStreamMetadata()
Fordert das SDK an, Anzeigenmetadaten zu laden, und überträgt dann StreamEvent.LOADED. Diese Aktion sollte manuell ausgelöst werden, sobald das Streammanifest vom Video Stitcher eines Drittanbieters abgerufen wurde. Dies wird nur für die Pod-Auslieferung mit Video-Stitching-Tools von Drittanbietern verwendet und ist bei anderen Streamanfragen kein Vorgang.
onTimedMetadata
onTimedMetadata(metadata)
Die Tickets werden in einem Wörterbuch der verarbeiteten Metadaten übergeben. Das Wörterbuch erwartet den Schlüssel „TXXX“ mit dem benutzerdefinierten Metadatenstring als Wert. Wenn dein Player Rohmetadaten bereitstellt, rufe stattdessen StreamManager.processMetadata auf.
Parameter |
|
|---|---|
|
Metadaten |
Objekt Das Wörterbuch der Metadaten. Der Wert darf nicht null sein. |
previousCuePointForStreamTime
beforeCuePointForStreamTime(streamTime) gibt CuePoint zurück.
Gibt den vorherigen Cue-Punkt für die angegebene Streamzeit zurück. Gibt null zurück, wenn kein solcher Cue-Punkt vorhanden ist. Er wird verwendet, um Funktionen wie die Funktion „Zurückspringen“ zu implementieren, und wird aufgerufen, wenn der Publisher erkennt, dass der Nutzer eine Suche durchgeführt hat, um den Nutzer zu einer Werbeunterbrechung zurückzukehren.
Parameter |
|
|---|---|
|
streamTime |
number die gewünschte Streamzeit ist. |
- Rückgabe
-
nullable CuePoint: Der vorherige Cue-Punkt für die angegebene Streamzeit
processMetadata
processMetadata(type, data, timestamp)
Verarbeitet zeitgesteuerte Metadaten für Livestreams. Verwende diese Option, wenn dein Videoplayer nicht geparste Metadaten zusammen mit Zeitstempeln bereitstellt. Rufe andernfalls StreamManager.onTimedMetadata auf.
Parameter |
|
|---|---|
|
Typ |
String Typ für Metadaten. Muss bei HLS „ID3“ oder für DASH der URI des Ereignisnachrichtenschemas sein. |
|
data |
(Uint8Array ungleich null oder String) Tag-Rohdaten Für ID3 müssen die gesamten Tag-Rohdaten angegeben werden. Bei DASH-Ereignisnachrichten ist dies der Nachrichtendatenstring. |
|
timestamp |
number Zeit in Sekunden, in der Daten verarbeitet werden sollen. Bei DASH ist dies der Beginn der Ereignisnachricht. |
replaceAdTagParameters
replaceAdTagParameters(adTagParameters)
Ersetzt alle Anzeigen-Tag-Parameter, die für anstehende Anzeigenanfragen für einen Livestream verwendet werden.
Parameter |
|
|---|---|
|
adTagParameters |
Objekt mit Stringattributen Die neuen Anzeigen-Tag-Parameter. Muss Stringwerte enthalten. Der Wert darf nicht null sein. |
requestStream
requestStream(streamRequest)
Fordert an, dass ein Stream mithilfe der angegebenen Streamparameter geladen wird.
Parameter |
|
|---|---|
|
streamRequest |
enthält Parameter zum Laden der Streammetadaten. Der Wert darf nicht null sein. |
Zurücksetzen
Zurücksetzen()
Setzt den Stream-Manager zurück und entfernt kontinuierliche Abfragen.
setClickElement
setClickElement(clickElement)
Legt das Click-through-Element der Anzeigen fest. 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 wurde eingestellt. Stattdessen sollte ein adUiElement an StreamManager übergeben werden. Wenn dem StreamManager-Konstruktor ein adUiElement übergeben wird, wird diese Methode zu einer Nulloperation.
Parameter |
|
|---|---|
|
clickElement |
Element Das Element, das für den Klick auf die Anzeige verwendet wird. Der Wert kann null sein. |
- Eingestellte Funktionen
- Stellen Sie dem StreamManager-Konstruktor stattdessen ein adUiElement bereit.
streamTimeForContentTime
streamTimeForContentTime(contentTime) gibt eine Zahl zurück
Gibt die Streamzeit mit Anzeigen für einen bestimmten Contentzeitpunkt zurück. Gibt die angegebene Inhaltszeit für Livestreams zurück.
Parameter |
|
|---|---|
|
contentTime |
number Content-Zeit ohne Anzeigen (in Sekunden) |
- Rückgabe
-
numberist die Streamzeit, die der angegebenen Contentzeit entspricht, nachdem die Anzeigen eingefügt wurden.