Klasse StreamManager

Verarbeitet Streams für die dynamische Anzeigenbereitstellung. Diese Klasse verwaltet Interaktionen mit DAI-Servern, verarbeitet Tracking-Pings und gibt Stream- und Anzeigenereignisse aus.
Konstruktoren
constructor
Methoden
addEventListener
Fügt einen Listener für den angegebenen Ereignistyp hinzu.
contentTimeForStreamTime
Gibt die Contentzeit ohne Anzeigen für eine bestimmte Streamzeit zurück.
focus
Legt den Fokus auf die Schaltfläche zum Überspringen, sofern vorhanden.
getAdSkippableState
Gibt einen true-Wert zurück, wenn der Nutzer die aktuelle Anzeige überspringen kann.
loadStreamMetadata
Fordert das DAI SDK auf, Anzeigenmetadaten zu laden, und gibt ein LOADED-Streamereignis aus.
onTimedMetadata
Übergibt ein Dictionary mit verarbeiteten Metadaten.
previousCuePointForStreamTime
Gibt den vorherigen Cuepoint für die angegebene Streamzeit zurück.
processMetadata
Verarbeitet zeitgesteuerte Metadaten für Streams.
removeEventListener
Entfernt einen Listener für den angegebenen StreamEvent-Ereignistyp.
replaceAdTagParameters
Ersetzt alle Anzeigen-Tag-Parameter eines Livestreams, die für anstehende Anzeigenanfragen verwendet werden.
requestStream
Fordert einen Stream für die dynamische Anzeigenbereitstellung mit dem IMA SDK an, der mit den angegebenen Stream-Parametern geladen werden soll.
reset
Setzt den Stream-Manager zurück und entfernt alle kontinuierlichen Abfragen.
streamTimeForContentTime
Gibt die Gesamtstreamzeit mit Anzeigen für eine bestimmte Contentzeit zurück.

Konstruktoren

constructor

new StreamManager(videoElement: HTMLVideoElement, adUiElement?: HTMLElement, uiSettings?: UiSettings): StreamManager
Parameter
videoElement: HTMLVideoElement Das HTML-Videoelement, in dem die Wiedergabe erfolgt.
Optional adUiElement: HTMLElement Das Element, in dem die Benutzeroberfläche der Anzeige gerendert wird.
Optional uiSettings: UiSettings Die UI-Einstellungen, die für diesen Stream verwendet werden sollen.
Ausgabe
StreamManager

Methoden

addEventListener

addEventListener(type: Type | Type[], listener: ((event: StreamEvent) => void)): void
Fügt einen Listener für den angegebenen Ereignistyp hinzu.
Parameter
type: Type | Type[] Der Anzeigenereignistyp oder ein Array von Ereignistypen.
listener: ((event: StreamEvent) => void) Eine Callback-Funktion für den Anzeigen-Listener.

contentTimeForStreamTime

contentTimeForStreamTime(streamTime: number): number
Gibt die Contentzeit ohne Anzeigen für eine bestimmte Streamzeit zurück. Gibt die angegebene Streamzeit für Livestreams zurück.
Parameter
streamTime: number Die Streamzeit in Sekunden, einschließlich Content und Anzeigen.
Ausgabe
number Die Contentzeit für die angegebene Streamzeit, ohne Anzeigen.

Fokus

focus(): void
Legt den Fokus auf die Schaltfläche zum Überspringen, sofern vorhanden. Wenn nicht vorhanden, wird der Fokus wieder auf das interaktive Element gelegt.

getAdSkippableState

getAdSkippableState(): boolean
Gibt einen true-Wert zurück, wenn der Nutzer die aktuelle Anzeige überspringen kann. Wenn sich dieser Wert ändert, gibt die Klasse StreamManager ein Streamereignis SKIPPABLE_STATE_CHANGED aus.
Ausgabe
boolean true, wenn der Nutzer die aktuelle Anzeige überspringen kann, false andernfalls.

loadStreamMetadata

loadStreamMetadata(): void
Fordert das DAI SDK auf, Anzeigenmetadaten zu laden, und gibt ein LOADED-Streamereignis aus. Rufen Sie diese Methode manuell auf, wenn Sie das Streammanifest von Ihrem Drittanbieter-Videostitching-Tool abrufen. Diese Methode ist nur für VOD-Streams mit Pod-Auslieferung und einem Video-Stitching-Tool von Drittanbietern vorgesehen.

onTimedMetadata

onTimedMetadata(metadata: {
  [key: string]: string;
}): void
Übergibt ein Dictionary mit verarbeiteten Metadaten. Das Dictionary erwartet den genauen Schlüssel "TXXX" mit dem benutzerdefinierten Metadatenstring als Wert. Wenn Ihr Player Rohmetadaten bereitstellt, rufen Sie stattdessen die Methode StreamManager.processMetadata auf.
Parameter
metadata: {
  [key: string]: string;
} 		Das Dictionary mit Metadaten.

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime: number): CuePoint
Gibt den vorherigen Cuepoint für die angegebene Streamzeit zurück. Wenn kein vorheriger Cuepoint vorhanden ist, wird null zurückgegeben. Verwenden Sie diese Methode, um Funktionen wie „Zurückspringen“ zu implementieren. Rufen Sie die Methode auf, wenn der Nutzer zu einer Werbeunterbrechung zurückkehren möchte.
Parameter
streamTime: number Die Streamzeit, zu der der Nutzer springen möchte.
Ausgabe
CuePoint Der vorherige Cuepoint für die angegebene Streamzeit.

processMetadata

processMetadata(type: string, data: string | Uint8Array, timestamp: number): void
Verarbeitet zeitgesteuerte Metadaten für Streams. Verwenden Sie diese Methode, wenn Ihr Videoplayer ungeparste Metadaten mit Zeitstempeln bereitstellt. Rufen Sie andernfalls StreamManager.onTimedMetadata auf.
Parameter
type: string Typ für Metadaten. Muss der 'ID3'-String für HLS oder die URI der Ereignisnachrichtenschema-ID für DASH sein.
data: string | Uint8Array Rohe Tag-Daten Bei ID3 müssen es die gesamten Roh-Tag-Daten sein. Bei DASH-Ereignismeldungen ist dies der Nachrichtendatenstring.
timestamp: number Zeit in Sekunden, zu der Daten verarbeitet werden sollen. Bei DASH ist dieser Parameter die Startzeit der Ereignisnachricht.

removeEventListener

removeEventListener(type: Type, listener: ((event: StreamEvent) => void)): void
Entfernt einen Listener für den angegebenen StreamEvent-Ereignistyp. Damit ein Listener erfolgreich entfernt werden kann, muss der Listener-Parameter, den Sie an diese Methode übergeben, per Referenz mit dem Parameter übereinstimmen, der zuvor an die Methode addEventListener übergeben wurde.
Parameter
type: Type Der Typ des Ereignisses, für das der Listener entfernt werden soll.
listener: ((event: StreamEvent) => void) Die Funktion, die als Listener entfernt werden soll.

replaceAdTagParameters

replaceAdTagParameters(adTagParameters: {
  [key: string]: string;
}): void
Ersetzt alle Anzeigen-Tag-Parameter eines Livestreams, die für anstehende Anzeigenanfragen verwendet werden.
Parameter
adTagParameters: {
  [key: string]: string;
} 		Die Parameter für das Ersatz-Anzeigen-Tag. Muss Stringwerte enthalten.

requestStream

requestStream(streamRequest: StreamRequest): void
Fordert einen Stream für die dynamische Anzeigenbereitstellung mit dem IMA SDK an, der mit den angegebenen Stream-Parametern geladen werden soll.
Parameter
streamRequest: StreamRequest Enthält Parameter zum Laden der Streammetadaten.

Zurücksetzen

reset(): void
Setzt den Stream-Manager zurück und entfernt alle kontinuierlichen Abfragen.

streamTimeForContentTime

streamTimeForContentTime(contentTime: number): number
Gibt die Gesamtstreamzeit mit Anzeigen für eine bestimmte Contentzeit zurück. Gibt die angegebene Inhaltszeit für Livestreams zurück.
Parameter
contentTime: number Die Contentdauer ohne Anzeigen in Sekunden.
Ausgabe
number Die Gesamtstreamzeit, die der angegebenen Contentzeit entspricht, nachdem durch die dynamische Anzeigenbereitstellung Anzeigen eingefügt wurden.