Класс: StreamManager

StreamManager

Классная публика

Обрабатывает потоки динамической вставки рекламы. Он управляет взаимодействием с серверной частью DAI и отслеживает пинги, а также пересылает потоковые и рекламные события издателю. Этот менеджер не наследуется от BaseAdsManager, поскольку он является менеджером не для конкретного объявления, а для всего потока.

Конструктор

StreamManager

новый StreamManager (videoElement, adUiElement, uiSettings)

Конструктор.

Параметр
видеоЭлемент	HTML-элемент видео, в котором будет происходить воспроизведение. Значение не должно быть нулевым.
адУиЭлемент	Необязательный HTML-элемент, используемый для хранения элементов пользовательского интерфейса объявления. Этот элемент должен иметь ту же высоту и ширину, что и воспроизводимое видео, и должен непосредственно накладываться на него. Если этот параметр не указан, пользовательский интерфейс отображаться не будет, а реклама, для которой требуется пользовательский интерфейс, например объявления с возможностью пропуска, запрашиваться не будет.
Настройки пользовательского интерфейса	Необязательный Настройки пользовательского интерфейса, которые будут использоваться для этого потока. Значение не должно быть нулевым.

Броски

когда входные параметры не соответствуют требованиям.

Характеристики

кликЭлемент

ненулевой HTMLElement

кликЭлемент

ненулевой HTMLElement

потокМонитор

ненулевой PodServingStreamMonitor

Методы

контенттимефорстримтиме

contentTimeForStreamTime(streamTime) возвращает число

Возвращает время контента без рекламы для заданного времени трансляции. Возвращает заданное время трансляции для прямых трансляций.

Параметр
StreamTime	число время трансляции со вставленной рекламой (в секундах).

Возврат

number время контента, которое соответствует заданному времени трансляции после удаления рекламы.

сосредоточиться

focus() возвращает void

Перемещает фокус на кнопку пропуска, если она имеется. Если их нет, основное внимание уделяется интерактивным элементам, включая значки или интерактивные креативы.

Возврат

void

getAdSkippableState

getAdSkippableState() возвращает логическое значение

Возвращает true, если объявление в данный момент можно пропустить. Когда это значение изменяется, StreamManager запускает событие StreamEvent.SKIPPABLE_STATE_CHANGED .

Возврат

boolean True, если рекламу можно пропустить в данный момент, в противном случае — false.

loadStreamMetadata

loadStreamMetadata() возвращает void

Запрашивает SDK для загрузки метаданных объявления, а затем передает StreamEvent.LOADED. Это следует активировать вручную после получения манифеста потока из стороннего средства объединения видео. Это используется только для Pod Serving VOD со сторонним сшивателем видео и не используется для других запросов потока.

Возврат

void

onTimedMetadata

onTimedMetadata (метаданные) возвращает void

Передает словарь обработанных метаданных. Словарь ожидает ключ «TXXX» со строкой метаданных, определенной пользователем, в качестве значения. Если ваш проигрыватель предоставляет необработанные метаданные, вместо этого вызовите StreamManager.processMetadata.

Параметр
метаданные	(нулевой или ненулевой объект со строковыми свойствами) Словарь метаданных.

Возврат

void

предыдущийCuePointForStreamTime

previousCuePointForStreamTime(streamTime) возвращает (null или CuePoint )

Возвращает предыдущую точку разметки для данного времени потока. Возвращает значение null, если такой точки разметки не существует. Это используется для реализации таких функций, как возврат назад, и вызывается, когда издатель обнаруживает, что пользователь искал, чтобы вернуть пользователя к рекламной паузе.

Параметр
StreamTime	число время потока, к которому стремились.

Возврат

(null or non-null CuePoint ) предыдущая точка метки для данного времени потока.

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

ProcessMetadata (тип, данные, метка времени) возвращает void

Обрабатывает синхронизированные метаданные для прямых трансляций. Используйте, если ваш видеопроигрыватель предоставляет неанализированные метаданные вместе с метками времени, в противном случае вызовите StreamManager.onTimedMetadata.

Параметр
тип	нить Введите метаданные. Должен быть «ID3» для HLS или URI идентификатора схемы сообщения о событии для DASH.
данные	(строка или ненулевой Uint8Array) Необработанные данные тега. Для ID3 это должны быть все необработанные данные тега. Для сообщений о событиях DASH это строка данных сообщения.
временная метка	число Время в секундах, когда данные должны быть обработаны. Для DASH это время начала сообщения о событии.

Возврат

void

заменитьAdTagParameters

replaceAdTagParameters(adTagParameters) возвращает void

Заменяет все параметры тега объявления, используемые для предстоящих запросов объявлений для прямой трансляции.

Параметр
adTagParameters	Объект со строковыми свойствами Новые параметры тега объявления. Должны иметь строковые значения. Значение не должно быть нулевым.

Возврат

void

запросПоток

requestStream(streamRequest) возвращает void

Запрашивает загрузку потока, используя предоставленные параметры потока.

Параметр
потокЗапрос	Стримреквест содержит параметры для загрузки метаданных потока. Значение не должно быть нулевым.

Возврат

void

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

сброс() возвращает пустоту

Сбрасывает менеджер потоков и удаляет все непрерывные опросы.

Возврат

void

УстановитьКликЭлемент

setClickElement(clickElement) возвращает void

Устанавливает элемент кликабельности объявлений. Этот элемент используется в качестве приемника кликов или касаний во время воспроизведения рекламы и может привести к переходу с текущей страницы. Сейчас это устарело, и вместо этого в StreamManager следует передать adUiElement. Если конструктору StreamManager передается adUiElement, этот метод становится пустым.

Параметр
кликЭлемент	(нулевой или ненулевой элемент) Элемент, используемый для перехода по объявлению.

Устарело

Вместо этого предоставьте adUiElement конструктору StreamManager.

Возврат

void

потоктимефорконтенттиме

streamTimeForContentTime(contentTime) возвращает число

Возвращает время трансляции с рекламой для заданного времени контента. Возвращает заданное время контента для прямых трансляций.

Параметр
контентвремя	число время контента без рекламы (в секундах).

Возврат

number время потока, которое соответствует заданному времени контента после вставки рекламы.

,

StreamManager

Классная публика

Обрабатывает потоки динамической вставки рекламы. Он управляет взаимодействием с серверной частью DAI и отслеживает пинги, а также пересылает потоковые и рекламные события издателю. Этот менеджер не наследуется от BaseAdsManager, поскольку он является менеджером не для конкретного объявления, а для всего потока.

Конструктор

StreamManager

новый StreamManager (videoElement, adUiElement, uiSettings)

Конструктор.

Параметр
видеоЭлемент	HTML-элемент видео, в котором будет происходить воспроизведение. Значение не должно быть нулевым.
адУиЭлемент	Необязательный HTML-элемент, используемый для хранения элементов пользовательского интерфейса объявления. Этот элемент должен иметь ту же высоту и ширину, что и воспроизводимое видео, и должен непосредственно накладываться на него. Если этот параметр не указан, пользовательский интерфейс отображаться не будет, а реклама, для которой требуется пользовательский интерфейс, например объявления с возможностью пропуска, запрашиваться не будет.
Настройки пользовательского интерфейса	Необязательный Настройки пользовательского интерфейса, которые будут использоваться для этого потока. Значение не должно быть нулевым.

Броски

когда входные параметры не соответствуют требованиям.

Характеристики

кликЭлемент

ненулевой HTMLElement

кликЭлемент

ненулевой HTMLElement

потокМонитор

ненулевой PodServingStreamMonitor

Методы

контенттимефорстримтиме

contentTimeForStreamTime(streamTime) возвращает число

Возвращает время контента без рекламы для заданного времени трансляции. Возвращает заданное время трансляции для прямых трансляций.

Параметр
StreamTime	число время трансляции со вставленной рекламой (в секундах).

Возврат

number время контента, которое соответствует заданному времени трансляции после удаления рекламы.

сосредоточиться

focus() возвращает void

Перемещает фокус на кнопку пропуска, если она имеется. Если его нет, основное внимание уделяется интерактивным элементам, включая значки или интерактивные креативы.

Возврат

void

getAdSkippableState

getAdSkippableState() возвращает логическое значение

Возвращает true, если объявление в данный момент можно пропустить. Когда это значение изменяется, StreamManager запускает событие StreamEvent.SKIPPABLE_STATE_CHANGED .

Возврат

boolean True, если рекламу в данный момент можно пропустить, в противном случае — false.

loadStreamMetadata

loadStreamMetadata() возвращает void

Запрашивает SDK для загрузки метаданных объявления, а затем передает StreamEvent.LOADED. Это следует активировать вручную после получения манифеста потока из стороннего средства объединения видео. Это используется только для Pod Serving VOD со сторонним сшивателем видео и не используется для других запросов потока.

Возврат

void

onTimedMetadata

onTimedMetadata (метаданные) возвращает void

Передает словарь обработанных метаданных. Словарь ожидает ключ «TXXX» со строкой метаданных, определенной пользователем, в качестве значения. Если ваш проигрыватель предоставляет необработанные метаданные, вместо этого вызовите StreamManager.processMetadata.

Параметр
метаданные	(нулевой или ненулевой объект со строковыми свойствами) Словарь метаданных.

Возврат

void

предыдущийCuePointForStreamTime

previousCuePointForStreamTime(streamTime) возвращает (null или CuePoint )

Возвращает предыдущую точку разметки для данного времени потока. Возвращает значение null, если такой точки разметки не существует. Это используется для реализации таких функций, как возврат назад, и вызывается, когда издатель обнаруживает, что пользователь искал, чтобы вернуть пользователя к рекламной паузе.

Параметр
StreamTime	число время потока, к которому стремились.

Возврат

(null or non-null CuePoint ) предыдущая точка метки для данного времени потока.

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

ProcessMetadata (тип, данные, метка времени) возвращает void

Обрабатывает синхронизированные метаданные для прямых трансляций. Используйте, если ваш видеопроигрыватель предоставляет неанализированные метаданные вместе с метками времени, в противном случае вызовите StreamManager.onTimedMetadata.

Параметр
тип	нить Введите метаданные. Должен быть «ID3» для HLS или URI идентификатора схемы сообщения о событии для DASH.
данные	(строка или ненулевой Uint8Array) Необработанные данные тега. Для ID3 это должны быть все необработанные данные тега. Для сообщений о событиях DASH это строка данных сообщения.
временная метка	число Время в секундах, когда данные должны быть обработаны. Для DASH это время начала сообщения о событии.

Возврат

void

заменитьAdTagParameters

replaceAdTagParameters(adTagParameters) возвращает void

Заменяет все параметры тега объявления, используемые для предстоящих запросов объявлений для прямой трансляции.

Параметр
adTagParameters	Объект со строковыми свойствами Новые параметры тега объявления. Должны иметь строковые значения. Значение не должно быть нулевым.

Возврат

void

запросПоток

requestStream(streamRequest) возвращает void

Запрашивает загрузку потока, используя предоставленные параметры потока.

Параметр
потокЗапрос	Стримреквест содержит параметры для загрузки метаданных потока. Значение не должно быть нулевым.

Возврат

void

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

сброс() возвращает пустоту

Сбрасывает менеджер потоков и удаляет все непрерывные опросы.

Возврат

void

УстановитьКликЭлемент

setClickElement(clickElement) возвращает void

Устанавливает элемент кликабельности объявлений. Этот элемент используется в качестве приемника кликов или касаний во время воспроизведения рекламы и может привести к переходу с текущей страницы. Сейчас это устарело, и вместо этого в StreamManager следует передать adUiElement. Если конструктору StreamManager передается adUiElement, этот метод становится пустым.

Параметр
кликЭлемент	(нулевой или ненулевой элемент) Элемент, используемый для перехода по объявлению.

Устарело

Вместо этого предоставьте adUiElement конструктору StreamManager.

Возврат

void

потоктимефорконтенттиме

streamTimeForContentTime(contentTime) возвращает число

Возвращает время трансляции с рекламой для заданного времени контента. Возвращает заданное время контента для прямых трансляций.

Параметр
контентвремя	число время контента без рекламы (в секундах).

Возврат

number время потока, которое соответствует заданному времени контента после вставки рекламы.

,

StreamManager

Классная публика

Обрабатывает потоки динамической вставки рекламы. Он управляет взаимодействием с серверной частью DAI и отслеживает пинги, а также пересылает потоковые и рекламные события издателю. Этот менеджер не наследуется от BaseAdsManager, поскольку он является менеджером не для конкретного объявления, а для всего потока.

Конструктор

StreamManager

новый StreamManager (videoElement, adUiElement, uiSettings)

Конструктор.

Параметр
видеоЭлемент	HTML-элемент видео, в котором будет происходить воспроизведение. Значение не должно быть нулевым.
адУиЭлемент	Необязательный HTML-элемент, используемый для хранения элементов пользовательского интерфейса объявления. Этот элемент должен иметь ту же высоту и ширину, что и воспроизводимое видео, и должен непосредственно накладываться на него. Если этот параметр не указан, пользовательский интерфейс отображаться не будет, а реклама, для которой требуется пользовательский интерфейс, например объявления с возможностью пропуска, запрашиваться не будет.
Настройки пользовательского интерфейса	Необязательный Настройки пользовательского интерфейса, которые будут использоваться для этого потока. Значение не должно быть нулевым.

Броски

когда входные параметры не соответствуют требованиям.

Характеристики

кликЭлемент

ненулевой HTMLElement

кликЭлемент

ненулевой HTMLElement

потокМонитор

ненулевой PodServingStreamMonitor

Методы

контенттимефорстримтиме

contentTimeForStreamTime(streamTime) возвращает число

Возвращает время контента без рекламы для заданного времени трансляции. Возвращает заданное время трансляции для прямых трансляций.

Параметр
StreamTime	число время трансляции со вставленной рекламой (в секундах).

Возврат

number время контента, которое соответствует заданному времени трансляции после удаления рекламы.

сосредоточиться

focus() возвращает void

Перемещает фокус на кнопку пропуска, если она имеется. Если их нет, основное внимание уделяется интерактивным элементам, включая значки или интерактивные креативы.

Возврат

void

getAdSkippableState

getAdSkippableState() возвращает логическое значение

Возвращает true, если объявление в данный момент можно пропустить. Когда это значение изменяется, StreamManager запускает событие StreamEvent.SKIPPABLE_STATE_CHANGED .

Возврат

boolean True, если рекламу в данный момент можно пропустить, в противном случае — false.

loadStreamMetadata

loadStreamMetadata() возвращает void

Запрашивает SDK для загрузки метаданных объявления, а затем передает StreamEvent.LOADED. Это следует активировать вручную после получения манифеста потока из стороннего средства объединения видео. Это используется только для Pod Serving VOD со сторонним видеосшивателем и не используется для других запросов потока.

Возврат

void

onTimedMetadata

onTimedMetadata (метаданные) возвращает void

Передает словарь обработанных метаданных. Словарь ожидает ключ «TXXX» со строкой метаданных, определенной пользователем, в качестве значения. Если ваш проигрыватель предоставляет необработанные метаданные, вместо этого вызовите StreamManager.processMetadata.

Параметр
метаданные	(нулевой или ненулевой объект со строковыми свойствами) Словарь метаданных.

Возврат

void

предыдущийCuePointForStreamTime

previousCuePointForStreamTime(streamTime) возвращает (null или CuePoint )

Возвращает предыдущую точку разметки для данного времени потока. Возвращает значение null, если такой точки разметки не существует. Это используется для реализации таких функций, как возврат назад, и вызывается, когда издатель обнаруживает, что пользователь искал, чтобы вернуть пользователя к рекламной паузе.

Параметр
поток времени	число время потока, к которому стремились.

Возврат

(null or non-null CuePoint ) предыдущая точка метки для данного времени потока.

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

ProcessMetadata (тип, данные, метка времени) возвращает void

Обрабатывает синхронизированные метаданные для прямых трансляций. Используйте, если ваш видеопроигрыватель предоставляет неанализированные метаданные вместе с метками времени, в противном случае вызовите StreamManager.onTimedMetadata.

Параметр
тип	нить Введите метаданные. Должен быть «ID3» для HLS или URI идентификатора схемы сообщения о событии для DASH.
данные	(строка или ненулевой Uint8Array) Необработанные данные тега. Для ID3 это должны быть все необработанные данные тега. Для сообщений о событиях DASH это строка данных сообщения.
временная метка	число Время в секундах, когда данные должны быть обработаны. Для DASH это время начала сообщения о событии.

Возврат

void

заменитьAdTagParameters

replaceAdTagParameters(adTagParameters) возвращает void

Заменяет все параметры тега объявления, используемые для предстоящих запросов объявлений для прямой трансляции.

Параметр
adTagParameters	Объект со строковыми свойствами Новые параметры тега объявления. Должны иметь строковые значения. Значение не должно быть нулевым.

Возврат

void

запросПоток

requestStream(streamRequest) возвращает void

Запрашивает загрузку потока, используя предоставленные параметры потока.

Параметр
потокЗапрос	Стримреквест содержит параметры для загрузки метаданных потока. Значение не должно быть нулевым.

Возврат

void

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

сброс() возвращает пустоту

Сбрасывает менеджер потоков и удаляет все непрерывные опросы.

Возврат

void

УстановитьКликЭлемент

setClickElement(clickElement) возвращает void

Устанавливает элемент кликабельности объявлений. Этот элемент используется в качестве приемника кликов или касаний во время воспроизведения рекламы и может привести к переходу с текущей страницы. Сейчас это устарело, и вместо этого в StreamManager следует передать adUiElement. Если конструктору StreamManager передается adUiElement, этот метод становится пустым.

Параметр
кликЭлемент	(нулевой или ненулевой элемент) Элемент, используемый для перехода по объявлению.

Устарело

Вместо этого предоставьте adUiElement конструктору StreamManager.

Возврат

void

потоктимефорконтенттиме

streamTimeForContentTime(contentTime) возвращает число

Возвращает время трансляции с рекламой для заданного времени контента. Возвращает заданное время контента для прямых трансляций.

Параметр
контентвремя	число время контента без рекламы (в секундах).

Возврат

number время потока, которое соответствует заданному времени контента после вставки рекламы.