Класс StreamManager

Этот класс обрабатывает динамические потоки вставки рекламы. Он управляет взаимодействием с серверами DAI, обрабатывает запросы отслеживания и генерирует события потока и рекламы.
Строители
constructor
Методы
add Event Listener
Добавляет обработчик для заданного типа события.
content Time For Stream Time
Возвращает время просмотра контента без рекламы для заданного времени трансляции.
focus
Перемещает фокус на кнопку пропуска, если она присутствует.
get Ad Skippable State
Возвращает значение true , если пользователь может пропустить текущую рекламу.
load Stream Metadata
Запрашивает у SDK DAI загрузку метаданных рекламы и генерирует событие LOADED stream.
on Timed Metadata
Передает словарь обработанных метаданных.
previous Cue Point For Stream Time
Возвращает предыдущую точку отсчета для заданного времени потока.
process Metadata
Обрабатывает метаданные с заданным временем для потоков.
remove Event Listener
Удаляет обработчик события для заданного типа StreamEvent .
replace Ad Tag Parameters
Заменяет все параметры рекламных тегов, используемые для будущих запросов рекламы на прямую трансляцию.
request Stream
Запрашивает поток для загрузки в IMA DAI, используя предоставленные параметры потока.
reset
Перезагружает менеджер потоков и отключает непрерывный опрос.
stream Time For Content Time
Возвращает общее время просмотра с рекламой для заданного времени контента.

Строители

конструктор

new StreamManager ( videoElement : HTMLVideoElement , adUiElement ?: HTMLElement , uiSettings ?: UiSettings ) : StreamManager
Параметры
videoElement : HTMLVideoElement HTML-элемент для видео, в котором происходит воспроизведение.
Optional adUiElement : HTMLElement Элемент, где отображается рекламный интерфейс.
Optional uiSettings : UiSettings Настройки пользовательского интерфейса для этой трансляции.
Возвраты
StreamManager

Методы

addEventListener

addEventListener ( type : Type | Type [] , listener : ( ( event : StreamEvent ) => void ) ) : void
Добавляет обработчик для заданного типа события.
Параметры
type : Type | Type [] Тип рекламного события или массив типов событий.
listener : ( ( event : StreamEvent ) => void ) Функция обратного вызова для прослушивателя рекламы.

contentTimeForStreamTime

contentTimeForStreamTime ( streamTime : number ) : number
Возвращает время просмотра контента без рекламы для заданного времени трансляции. Возвращает заданное время трансляции для прямых эфиров.
Параметры
streamTime : number Время трансляции в секундах, включающее контент и рекламу.
Возвраты
number Время показа контента для данного потока, не включая рекламу.

фокус

focus ( ) : void
Если кнопка пропуска присутствует, фокус переключается на неё. Если кнопка отсутствует, фокус возвращается к интерактивному элементу.

getAdSkippableState

getAdSkippableState ( ) : boolean
Возвращает значение true , если пользователь может пропустить текущую рекламу. При изменении этого значения класс StreamManager генерирует событие потока SKIPPABLE_STATE_CHANGED .
Возвраты
boolean true if the user can skip the current ad, false otherwise.

loadStreamMetadata

loadStreamMetadata ( ) : void
Этот метод запрашивает у SDK DAI загрузку метаданных рекламы и генерирует событие LOADED stream. Вызывайте этот метод вручную при получении манифеста потока от стороннего видеоредактора. Этот метод предназначен только для потоков VOD, обслуживаемых Pod Serving с помощью стороннего видеоредактора.

onTimedMetadata

onTimedMetadata ( metadata : {
  [ key : string ] : string ;
} ) : void
Передает словарь обработанных метаданных. Словарь ожидает точный ключ "TXXX" со значением в виде строки метаданных, заданной пользователем. Если ваш проигрыватель предоставляет необработанные метаданные, вызовите вместо этого метод StreamManager.processMetadata .
Параметры
metadata : {
  [ key : string ] : string ;
}		 Словарь метаданных.

previousCuePointForStreamTime

previousCuePointForStreamTime ( streamTime : number ) : CuePoint
Возвращает предыдущую точку воспроизведения для заданного времени трансляции. Если предыдущая точка воспроизведения отсутствует, возвращает null . Используйте этот метод для реализации таких функций, как возврат к предыдущей точке воспроизведения, вызывая метод при попытке пользователя вернуться к рекламной паузе.
Параметры
streamTime : number Время трансляции, которое запрашивает пользователь.
Возвраты
CuePoint Предыдущая контрольная точка для заданного времени потока.

процессМетаданные

processMetadata ( type : string , data : string | Uint8Array , timestamp : number ) : void
Обрабатывает временные метаданные для потоков. Используйте этот метод, если ваш видеоплеер предоставляет неразобранные метаданные с временными метками. В противном случае вызовите StreamManager.onTimedMetadata .
Параметры
type : string Тип для метаданных. Для HLS это должна быть строка 'ID3' , а для DASH — URI идентификатора схемы сообщения события.
data : string | Uint8Array Исходные данные тега. Для ID3 это должны быть все исходные данные тега. Для сообщений событий DASH это строка данных сообщения.
timestamp : number Время в секундах, когда следует обрабатывать данные. Для DASH этот параметр представляет собой время начала сообщения о событии.

removeEventListener

removeEventListener ( type : Type , listener : ( ( event : StreamEvent ) => void ) ) : void
Удаляет обработчик события для заданного типа события StreamEvent . Для успешного удаления обработчика параметр listener, передаваемый этому методу, должен быть равен по ссылке параметру listener, ранее переданному методу addEventListener .
Параметры
type : Type Тип события, при котором следует удалить слушателя.
listener : ( ( event : StreamEvent ) => void ) Функция, которую следует удалить в качестве слушателя.

replaceAdTagParameters

replaceAdTagParameters ( adTagParameters : {
  [ key : string ] : string ;
} ) : void
Заменяет все параметры рекламных тегов, используемые для будущих запросов рекламы на прямую трансляцию.
Параметры
adTagParameters : {
  [ key : string ] : string ;
}		 Параметры тега замены рекламы. Должны быть строковыми значениями.

requestStream

requestStream ( streamRequest : StreamRequest ) : void
Запрашивает поток для загрузки в IMA DAI, используя предоставленные параметры потока.
Параметры
streamRequest : StreamRequest Содержит параметры для загрузки метаданных потока.

перезагрузить

reset ( ) : void
Перезагружает менеджер потоков и отключает непрерывный опрос.

streamTimeForContentTime

streamTimeForContentTime ( contentTime : number ) : number
Возвращает общее время трансляции с рекламой для заданного времени контента. Возвращает заданное время контента для прямых трансляций.
Параметры
contentTime : number Время просмотра контента без рекламы в секундах.
Возвраты
number Общее время просмотра, соответствующее заданному времени контента после вставки рекламы компанией DAI.