Klasa: StreamManager

StreamManager

class   public

Obsługuje strumienie dynamicznego wstawiania reklam. Zarządza interakcjami z systemem backendowym DAI i obsługuje pingi śledzenia oraz przekierowywanie zdarzeń strumienia i reklam do wydawcy. Ten menedżer nie dziedziczy z BaseAdsManager, ponieważ nie jest menedżerem konkretnej reklamy, ale całego strumienia

Zespół

StreamManager

new StreamManager(videoElement, adUiElement, uiSettings)

Konstruktor.

Parametr

videoElement

Element wideo HTML, w którym nastąpi odtwarzanie.

Wartość nie może być pusta.

adUiElement

Opcjonalny

Element HTML służący do przechowywania elementów interfejsu reklamy. Element ten powinien mieć taką samą wysokość i szerokość jak odtwarzane wideo i powinien być nałożony bezpośrednio na ten film. Jeśli nie podasz tego parametru, nie będzie wyświetlany interfejs użytkownika, a reklamy, które wymagają interfejsu, np. reklamy możliwe do pominięcia, nie będą wyświetlane.

uiSettings

Opcjonalny

Ustawienia interfejsu użytkownika stosowane w przypadku tego strumienia.

Wartość nie może być pusta.
Rzuty

gdy parametry wejściowe nie spełniają wymagań.

Właściwości

clickElement

niepusty HTMLElement

clickElement

niepusty HTMLElement

streamMonitor

niepusty PodServingStreamMonitor

Metody

addEventListener

addEventListener(type, listener) zwraca void

Dodaje odbiornik dla danego typu zdarzenia.

Parametr

typ

ciąg znaków

Typ zdarzenia, na które ma być nasłuchiwany.

detektor

function(non-null StreamEvent)

Funkcja wywoływana za każdym razem, gdy wystąpi zdarzenie tego typu.
Zwroty

void 

contentTimeForStreamTime

contentTimeForStreamTime(streamTime) zwraca liczbę

Zwraca czas trwania treści bez reklam w danym strumieniu. Zwraca podany czas transmisji na żywo.

Parametr

streamTime

liczba

czas strumienia z wstawionych reklam (w sekundach).
Zwroty

number czas trwania treści odpowiadający danemu czasowi transmisji po usunięciu reklam.

ostrość

focus() zwraca void

Ostrość jest ustawiana na przycisku pominięcia (jeśli jest dostępny). Jeśli nie ma takich elementów, użytkownik skupia się na elementach interaktywnych, w tym na ikonach lub interaktywnych kreacjach.

Zwroty

void 

getAdSkippableState

Metoda getAdSkippableState() zwraca wartość logiczną

Zwraca wartość „prawda”, jeśli reklamę można obecnie pominąć. Gdy ta wartość się zmieni, tag StreamManager uruchomi zdarzenie StreamEvent.SKIPPABLE_STATE_CHANGED.

Zwroty

boolean Wartość true (prawda), jeśli reklamę można obecnie pominąć, w przeciwnym razie ma wartość false (fałsz).

loadStreamMetadata

loadStreamMetadata() zwraca void

Wysyła żądanie do pakietu SDK, aby wczytać metadane reklamy, a potem wysyła zdarzenie StreamEvent.LOADED. Należy to ręcznie uruchomić po pobraniu pliku manifestu strumienia z zewnętrznego łączenia filmów. Jest on używany tylko do wyświetlania VOD w blokach za pomocą zewnętrznego łączenia wideo. Nie jest on używany do innych żądań strumieni.

Zwroty

void 

onTimedMetadata

Funkcja onTimedMetadata(metadata) zwraca void

Przekazuje słownik przetworzonych metadanych. Słownik oczekuje klucza „TXXX” z ciągiem znaków metadanych zdefiniowanym przez użytkownika jako wartość. Jeśli Twój odtwarzacz udostępnia metadane w postaci surowych danych, wywołaj zamiast tego funkcję StreamManager.processMetadata.

Parametr

metadane

(obiekt null lub inny obiekt z właściwościami ciągu znaków)

słownik metadanych,
Zwroty

void 

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) returns (null or CuePoint)

Zwraca poprzedni punkt cuepoint dla danego czasu strumienia. Zwraca wartość null, jeśli nie ma takiego punktu cue. Jest ona używana do implementowania funkcji takich jak snap back i wywoływana, gdy wydawca wykryje, że użytkownik przewinął film, aby wrócić do przerwy na reklamę.

Parametr

streamTime

liczba

czas przesunięcia strumienia.
Zwroty

(null or non-null CuePoint) poprzedni punkt cue w danym czasie transmisji.

processMetadata

processMetadata(type, data, timestamp) zwraca void

Przetwarza zsynchronizowane z czasem metadane w przypadku transmisji na żywo. Użyj, jeśli odtwarzacz wideo udostępnia nieprzetworzone metadane wraz z sygnaturą czasową. W przeciwnym razie wywołaj funkcję StreamManager.onTimedMetadata.

Parametr

typ

ciąg znaków

Typ metadanych. W przypadku HLS musi to być „ID3”, a w przypadku DASH – identyfikator URI schematu wiadomości o zdarzeniu.

dane

(ciąg znaków lub niepusty tablica Uint8)

Nieprzetworzone dane tagów. W przypadku ID3 muszą to być wszystkie dane tagu w formacie nieprzetworzonym. W przypadku wiadomości zdarzeń DASH jest to ciąg danych wiadomości.

sygnatura czasowa

liczba

Czas w sekundach, w którym dane mają zostać przetworzone. W przypadku DASH jest to czas rozpoczęcia wiadomości o zdarzeniu.
Zwroty

void 

removeEventListener

removeEventListener(type, listener) zwraca void

Usuwa detektor dla danego typu zdarzenia. Funkcja listener musi być równa funkcji przekazanej wcześniej do funkcji addEventListener.

Parametr

typ

ciąg znaków

Typ zdarzenia, dla którego chcesz usunąć odbiornik.

detektor

function(non-null StreamEvent)

Funkcja do usunięcia jako listener.
Zwroty

void 

replaceAdTagParameters

replaceAdTagParameters(adTagParameters) zwraca wartość pustą

Zastępuje wszystkie parametry tagu reklamy używane w żądaniach nadchodzących reklam w transmisji na żywo.

Parametr

adTagParameters

Obiekt z właściwościami typu string

Nowe parametry tagu reklamy. Musi zawierać ciągi znaków.

Wartość nie może być pusta.
Zwroty

void 

requestStream

requestStream(streamRequest) zwraca void

Żądanie załadowania strumienia za pomocą podanych parametrów strumienia.

Parametr

streamRequest

StreamRequest

zawiera parametry do wczytania metadanych strumienia.

Wartość nie może być pusta.
Zwroty

void 

zresetuj

Funkcja reset() zwraca void

Resetuje menedżera strumienia i usuwa wszystkie ciągłe sondy.

Zwroty

void 

setClickElement

setClickElement(clickElement) zwraca void

Ustawia element kliknięcia reklamy. Ten element służy jako odbiornik kliknięcia lub dotknięcia podczas wyświetlania reklamy i może spowodować przejście na inną stronę. Ta metoda została wycofana. Zamiast niej należy przekazać do StreamManagera obiekt adUiElement. Jeśli konstruktor StreamManager otrzymuje element adUiElement, ta metoda nie wykonuje żadnej operacji.

Parametr

clickElement

(null lub nienullowy element)

Element używany jako kliknięcie reklamy.
Wycofano
Zamiast tego prześlij parametr adUiElement do konstruktora StreamManager.
Zwroty

void 

streamTimeForContentTime

streamTimeForContentTime(contentTime) zwraca liczbę

Zwraca czas trwania strumienia z reklamami dla danego czasu trwania treści. Wyświetla czas trwania danego materiału w przypadku transmisji na żywo.

Parametr

contentTime

liczba

czas trwania treści bez reklam (w sekundach).
Zwroty

number czas transmisji odpowiadający danemu czasowi trwania treści po wstawieniu reklam.