Класс: Стримрекуест

има . StreamRequest

класс статический

Конструктор

StreamRequest

новый StreamRequest()

Используется для указания свойств потокового запроса.

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

adTagParameters

статический

Нить

Необязательно. Вы можете переопределить ограниченный набор параметров тега рекламы в запросе потока. Укажите параметры таргетинга для потока, чтобы получить дополнительную информацию. Вы также можете использовать параметры dai-ot и dai-ov для настройки вариантов потока. Подробнее см. в разделе «Переопределение параметров вариантов потока» .

adUiNode

статический

roSGNode

Узел графа сцены, где отображается пользовательский интерфейс рекламы. IMA размещает на этом элементе такие элементы, как «Почему эта реклама» и «Пропустить » во время рекламы. Элемент должен перекрывать весь видеоэлемент.

API-ключ

статический

Нить

Необязательно. Эти ключи можно использовать для аутентификации запросов потоковой передачи. Ключи аутентификации DAI необходимо настроить в пользовательском интерфейсе DFP.

assetKey

статический

Нить

Требуется для прямых трансляций. Используется для определения потока, который следует воспроизводить. Ключ ресурса запроса прямой трансляции — это идентификатор, который можно найти в пользовательском интерфейсе DFP.

authToken

статический

Нить

Токен авторизации запроса потока. Используется вместо ключа API для более строгой авторизации контента. Издатель может контролировать авторизацию отдельных потоков контента на основе этого токена.

contentSourceId

статический

Нить

Требуется для потоковой передачи по запросу. CMSID берётся из источника видеоконтента DFP в пользовательском интерфейсе DFP.

customAssetKey

статический

Нить

Пользовательский ключ ресурса используется для определения потока, который следует воспроизводить. Пользовательские ключи ресурсов требуются для обслуживания потоковой передачи pod.

формат

статический

ima.StreamFormat

Формат потока. По умолчанию ima.StreamFormat.HLS .

networkCode

статический

Нить

Сетевой код издателя, выполняющего запрос на поток. Сетевые коды требуются для запросов на поток, обслуживаемых Pod, с помощью createPodLiveStreamRequest или createPodVodStreamRequest. Эти коды также требуются для запросов на поток, объединяемых в облако, с помощью createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest или createVideoStitcherVodStreamRequestWithVodConfig. Эти коды необязательны и рекомендуются для запросов на поток, обслуживаемых Full Service, с помощью createLiveStreamRequest или createVodStreamRequest. Добавление сетевого кода применяет настройки, выбранные в пользовательском интерфейсе Менеджера рекламы, такие как программная ограниченная поддержка рекламы. Для обслуживания Pod и объединения в облако добавление сетевого кода позволяет найти и воспроизвести поток. Чтобы найти сетевой код, см. эту статью .

игрок

статический

( ima.Player или Invalid)

Реализация интерфейса плеера.

ppid

статический

Нить

Устарело. Используйте adTagParameters. Необязательно. Идентификатор предоставлен издателем DFP Audience.

streamActivityMonitorId

статический

Нить

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

videoId

статический

Нить

Требуется для потоковой передачи по запросу. Идентификатор источника видеоконтента.

видеоОбъект

статический

(roVideo или недействительно)

Видеообъект (например, Video roSGNode), отвечающий за воспроизведение видео в клиентском приложении. Этот объект будет опрашиваться на предмет различных данных, которые будут использоваться для правильного определения времени событий Live HLS ID3.

videoStitcherSessionOptions

статический

Массив V

Параметры сеанса используются для настройки специфических параметров видеостичера для VideoStitcher streamRequests.

Методы

createLiveStreamRequest

статический

createLiveStreamRequest(assetKey, apiKey, networkCode) возвращает ima.StreamRequest

Инициализирует обязательные свойства запроса Live StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает универсальный StreamRequest , без игнорирования каких-либо свойств.

Параметр
assetKey	нить
API-ключ	нить Параметр, назначенный свойству ima.StreamRequest возвращаемого объекта ima.StreamRequest.apiKey . Если ключ API отсутствует, передайте пустую строку.
networkCode	нить Сетевой код издателя, отправляющего запрос на трансляцию. Указывать сетевой код необязательно, но рекомендуется.

Возврат

ima.StreamRequest Объект ima.StreamRequest с требуемыми свойствами Live.

createPodLiveStreamRequest

статический

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) возвращает StreamRequest

Инициализирует обязательные свойства Pod Live ima.StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных для ima.StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает универсальный StreamRequest , без игнорирования каких-либо свойств.

Параметр
customAssetKey	нить
networkCode	нить
API-ключ	нить Необязательный параметр ima.StreamRequest.apiKey ima.StreamRequest по умолчанию — пустая строка.

Возврат

Объект StreamRequest ima.StreamRequest с требуемыми свойствами PodLive.

createPodVodStreamRequest

статический

createPodVodStreamRequest(networkCode) возвращает StreamRequest

Инициализирует требуемые свойства запроса ima.StreamRequest для регистрации потока VOD при использовании DAI Pod для обслуживания со сторонним видеосшивателем. Эта функция устанавливает тип запроса ima.StreamType.POD_VOD и проверяет все требуемые свойства на наличие отсутствующих данных. В случае неудачной проверки в консоли отладки регистрируется ошибка.

Параметр
networkCode	нить сетевой код Google Ad Manager

Возврат

StreamRequest объект ima.StreamRequest . Если указаны все обязательные свойства, тип запроса устанавливается как ima.StreamType.POD_VOD .

createStreamRequest

статический

createStreamRequest() возвращает ima.StreamRequest

Возврат

ima.StreamRequest Пустой объект ima.StreamRequest .

createVideoStitcherLiveStreamRequest

статический

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) возвращает ima.StreamRequest

Инициализирует обязательные свойства запроса Video Stitcher Live StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает универсальный StreamRequest без игнорирования каких-либо свойств.

Параметр
customAssetKey	нить
networkCode	нить
liveConfigId	нить
область	нить
Номер проекта	нить
oAuthToken	нить

Возврат

Объект ima.StreamRequest с требуемыми свойствами ima.StreamRequest .

createVideoStitcherVodStreamRequest

статический

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) возвращает ima.StreamRequest

Инициализирует обязательные свойства запроса Video Stitcher VOD StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает универсальный StreamRequest , без игнорирования каких-либо свойств.

Параметр
adTagUrl	нить
networkCode	нить
contentSourceUrl	нить
область	нить
Номер проекта	нить
oAuthToken	нить

Возврат

ima.StreamRequest Объект ima.StreamRequest с требуемыми свойствами VideoStitcherVod.

createVideoStitcherVodStreamRequestWithVodConfig

статический

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) возвращает ima.StreamRequest

Инициализирует обязательные свойства запроса VOD StreamRequest от Video Stitcher, используя vodConfigId , созданный в Cloud Video Stitcher. Использование этого API приводит к игнорированию любых других свойств, специфичных StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает общий StreamRequest без игнорирования каких-либо свойств.

Параметр
vodConfigId	нить
networkCode	нить
область	нить
Номер проекта	нить
oAuthToken	нить

Возврат

ima.StreamRequest Объект ima.StreamRequest с требуемыми свойствами VideoStitcherVod.

createVodStreamRequest

статический

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode) возвращает ima.StreamRequest

Инициализирует обязательные свойства VOD ima.StreamRequest . Использование этого API приводит к игнорированию любых других свойств, специфичных для ima.StreamType . Если какие-либо обязательные параметры представляют собой пустые строки, происходит регистрация ошибок, и API возвращает универсальный StreamRequest , без игнорирования каких-либо свойств.

Параметр
contentSourceId	нить
videoId	нить
API-ключ	нить Параметр, назначенный свойству ima.StreamRequest возвращаемого объекта ima.StreamRequest.apiKey . Если ключ API отсутствует, передайте пустую строку.
networkCode	нить Сетевой код издателя, отправляющего запрос на трансляцию. Указывать сетевой код необязательно, но рекомендуется.

Возврат

ima.StreamRequest Объект ima.StreamRequest с требуемыми свойствами VOD.