Obsługuje strumienie dynamicznego wstawiania reklam. Ta klasa zarządza interakcjami z serwerami DAI, obsługuje pingi śledzenia oraz emituje zdarzenia strumienia i reklamy.
| Zespoły | |
|---|---|
constructor
|
|
| Metody | |
|---|---|
add
|
Dodaje detektor dla danego typu zdarzenia. |
content
|
Zwraca czas trwania treści bez reklam dla danego czasu strumienia. |
focus
|
Ustawia fokus na przycisku pomijania, jeśli jest on dostępny. |
get
|
Zwraca wartość
true, jeśli użytkownik może pominąć bieżącą reklamę. |
load
|
Wysyła do pakietu SDK DAI żądanie wczytania metadanych reklamy i emituje zdarzenie
LOADED stream.
|
on
|
Przekazuje słownik przetworzonych metadanych. |
previous
|
Zwraca poprzedni punkt sygnałowy dla danego czasu strumienia. |
process
|
Przetwarza metadane czasowe strumieni. |
remove
|
Usuwa detektor dla danego typu zdarzenia StreamEvent.
|
replace
|
Zastępuje wszystkie parametry tagu reklamy używane w żądaniach nadchodzących reklam w transmisji na żywo.
|
request
|
Wysyła żądanie strumienia do dynamicznego wstawiania reklam IMA, aby go wczytać przy użyciu podanych parametrów strumienia.
|
reset
|
Resetuje menedżera strumienia i usuwa ciągłe odpytywanie. |
stream
|
Zwraca łączny czas transmisji z reklamami dla danego czasu treści. |
Zespoły
constructor
new StreamManager(videoElement: HTMLVideoElement, adUiElement?: HTMLElement, uiSettings?: UiSettings): StreamManager
| Parametry | |
|---|---|
videoElement: HTMLVideoElement
|
Element wideo HTML, w którym odtwarzanie ma miejsce. |
|
Element, w którym renderuje się interfejs reklamy. |
|
Ustawienia interfejsu, które mają być używane w tej transmisji. |
| Zwroty | |
|---|---|
StreamManager
|
|
Metody
addEventListener
addEventListener(type: Type | Type[], listener: ((event: StreamEvent) => void)): void
Dodaje detektor dla danego typu zdarzenia.
| Parametry | |
|---|---|
type:
Type | Type[]
|
Typ zdarzenia reklamowego lub tablica typów zdarzeń. |
listener: ((event: StreamEvent) => void)
|
Funkcja wywołania zwrotnego dla odbiornika reklam. |
contentTimeForStreamTime
contentTimeForStreamTime(streamTime: number): number
Zwraca czas trwania treści bez reklam dla danego czasu strumienia. Zwraca podany czas transmisji na żywo.
| Parametry | |
|---|---|
streamTime: number
|
czas strumienia w sekundach, obejmujący treści i reklamy; |
| Zwroty | |
|---|---|
number
|
czas treści dla danego czasu strumienia, bez reklam. |
focus
focus(): void
Ustawia fokus na przycisku pomijania, jeśli jest on dostępny. Jeśli nie jest obecny, fokus jest przywracany do elementu interaktywnego.
getAdSkippableState
getAdSkippableState(): boolean
Zwraca wartość
true, jeśli użytkownik może pominąć bieżącą reklamę. Gdy ta wartość
się zmieni, klasa StreamManager wyemituje
zdarzenie strumienia SKIPPABLE_STATE_CHANGED.
| Zwroty | |
|---|---|
boolean
|
true – jeśli użytkownik może pominąć bieżącą reklamę,
false – w przeciwnym razie.
|
loadStreamMetadata
loadStreamMetadata(): void
Wysyła do pakietu SDK DAI żądanie wczytania metadanych reklamy i emituje
LOADED zdarzenie strumienia.
Wywołuj tę metodę ręcznie, gdy pobierzesz manifest strumienia z narzędzia do łączenia filmów innej firmy. Ta metoda jest przeznaczona tylko dla strumieni VOD z blokami reklamowymi wyświetlanymi w ramach DAI, które korzystają z narzędzia do łączenia filmów innej firmy.
onTimedMetadata
onTimedMetadata(metadata: {
[key: string]: string;
}): void
Przekazuje słownik przetworzonych metadanych. Słownik oczekuje dokładnego klucza
"TXXX" z ciągiem metadanych zdefiniowanym przez użytkownika jako wartością. Jeśli odtwarzacz udostępnia nieprzetworzone metadane, zamiast tego wywołaj metodę StreamManager.processMetadata.
| Parametry | |
|---|---|
metadata: {
|
Słownik metadanych. |
previousCuePointForStreamTime
previousCuePointForStreamTime(streamTime: number): CuePoint
Zwraca poprzedni punkt sygnałowy dla danego czasu strumienia. Jeśli nie ma poprzedniego punktu sygnałowego, zwraca wartość
null. Użyj tej metody, aby wdrożyć funkcje takie jak cofnięcie do przerwy na reklamę. Wywołaj ją, gdy użytkownik chce wrócić do przerwy na reklamę.
| Parametry | |
|---|---|
streamTime: number
|
czas strumienia, do którego użytkownik chce przejść. |
| Zwroty | |
|---|---|
CuePoint
|
poprzedni punkt sygnałowy dla danego czasu strumienia. |
processMetadata
processMetadata(type: string, data: string | Uint8Array, timestamp: number): void
Przetwarza metadane czasowe strumieni. Użyj tej metody, jeśli odtwarzacz wideo udostępnia nieprzetworzone metadane ze znacznikami czasu. W przeciwnym razie wywołaj StreamManager.onTimedMetadata.
| Parametry | |
|---|---|
type: string
|
Typ metadanych. Musi to być ciąg znaków 'ID3' w przypadku HLS lub identyfikator URI schematu wiadomości zdarzenia w przypadku DASH.
|
data: string | Uint8Array
|
Nieprzetworzone dane tagu. W przypadku ID3 muszą to być wszystkie nieprzetworzone dane tagu. W przypadku komunikatów o zdarzeniach DASH jest to ciąg danych komunikatu. |
timestamp: number
|
Czas w sekundach, w którym mają być przetwarzane dane. W przypadku DASH ten parametr to czas rozpoczęcia komunikatu o zdarzeniu. |
removeEventListener
removeEventListener(type: Type, listener: ((event: StreamEvent) => void)): void
Usuwa detektor dla danego typu zdarzenia StreamEvent. Aby usunąć odbiorcę, parametr odbiorcy przekazywany do tej metody musi być równy pod względem odwołania parametrowi przekazanemu wcześniej do metody
addEventListener.
| Parametry | |
|---|---|
type:
Type
|
Typ zdarzenia, dla którego chcesz usunąć odbiornik. |
listener: ((event: StreamEvent) => void)
|
Funkcja usuwania słuchacza. |
replaceAdTagParameters
replaceAdTagParameters(adTagParameters: {
[key:
string]: string;
}): void
Zastępuje wszystkie parametry tagu reklamy używane w żądaniach nadchodzących reklam w transmisji na żywo.
| Parametry | |
|---|---|
adTagParameters: {
|
Parametry tagu reklamy zastępczej. Musi mieć wartości w formie ciągów znaków. |
requestStream
requestStream(streamRequest: StreamRequest): void
Wysyła żądanie strumienia do dynamicznego wstawiania reklam IMA, aby go wczytać przy użyciu podanych parametrów strumienia.
| Parametry | |
|---|---|
streamRequest:
StreamRequest
|
zawiera parametry wczytywania metadanych strumienia. |
reset
reset(): void
Resetuje menedżera strumienia i usuwa ciągłe odpytywanie.
streamTimeForContentTime
streamTimeForContentTime(contentTime: number): number
Zwraca łączny czas transmisji z reklamami dla danego czasu treści. Zwraca podany czas treści w przypadku transmisji na żywo.
| Parametry | |
|---|---|
contentTime: number
|
czas trwania treści bez reklam w sekundach. |
| Zwroty | |
|---|---|
number
|
łączny czas transmisji odpowiadający danemu czasowi treści po wstawieniu reklam przez DAI. |