Эта страница переведена с помощью Cloud Translation API.

IMA DAI SDK для Roku, IMA DAI SDK для Roku

Класс има

Методы

DisableLogging , getStreamManager , initSdk , requestStream

Глобальные функции, управляющие IMA SDK.

`disableLogging()`

Отключает ведение журнала SDK. По умолчанию ведение журнала будет включено.

`getStreamManager()`

Возвращает менеджер потоков, если он доступен. Если менеджер потоков еще недоступен, возвращается Invalid. Если при создании диспетчера потоков произошла ошибка, возвращается объект ошибки.

Возвращаемый object : диспетчер потока или объект ошибки.

`initSdk(settings)`

Инициализирует SDK.

Параметр	Тип	Описание
`settings`	`object`	Необязательный объект настроек IMA.

`requestStream(streamRequest)`

Запускает запрос асинхронного потока. Управление немедленно возвращается проигрывателю после вызова этого метода.

Возвращает object : ошибка или недействительный, если ошибки нет.

Параметр	Тип	Описание
`streamRequest`	`object`

Имя	Тип	Описание
`adPosition`		Индекс объявления в рекламной паузе. Индекс равен `1` для отдельных объявлений.
`duration`		Максимальная продолжительность перерыва в секундах или `-1` , если неизвестна.
`podIndex`		Для прямых трансляций возвращает идентификатор перерыва в качестве индекса модуля или `0` для начала ролика. В прямых трансляциях нет построллов. По умолчанию `-2` . Для видео по запросу (VOD) возвращает индекс рекламного модуля. Для модуля предварительного просмотра возвращает `0` . Для рекламы в середине ролика возвращается `1` , `2` , ..., n. Для модуля построллинга возвращает n+1...n+x. По умолчанию установлено значение `0` , если это объявление не является частью модуля или этот модуль не является частью плейлиста.
`timeOffset`		Положение модуля в контенте в секундах. Pre-roll возвращает `0` , post-roll возвращает `-1` , а Mid-roll возвращает запланированное время пакета.
`totalAds`		Общее количество объявлений, содержащихся в этой рекламной паузе. Значение равно `1` для отдельных объявлений.

Имя	Тип	Описание
`AD_PERIOD_ENDED`		Запускается каждый раз, когда поток переключается с рекламы или рекламы на контент. Это будет активировано, даже если реклама воспроизводится во второй раз или при поиске рекламы.
`AD_PERIOD_STARTED`		Запускается каждый раз, когда поток переключается с контента на рекламу или презентацию. Это будет активировано, даже если реклама воспроизводится во второй раз или при поиске рекламы.
`COMPLETE`		Запускается, когда объявление завершает воспроизведение.
`ERROR`		Запускается при возникновении ошибки.
`FIRST_QUARTILE`		Запускается, когда курсор воспроизведения объявления пересекает первый квартиль.
`ICON_FALLBACK_IMAGE_CLOSED`		Вызывается, когда пользователь закрывает диалоговое окно резервного изображения значка.
`ICON_FALLBACK_IMAGE_SHOWN`		Вызывается, когда отображается резервное изображение значка.
`MIDPOINT`		Срабатывает, когда курсор воспроизведения объявления пересекает среднюю точку.
`PROGRESS`		Запускается при обновлении хода выполнения объявления.
`SKIPPABLE_STATE_CHANGED`		Запускается при изменении состояния пропуска объявления.
`SKIPPED`		Срабатывает, когда реклама пропускается.
`START`		Запускается, когда начинается воспроизведение рекламы.
`THIRD_QUARTILE`		Запускается, когда курсор воспроизведения объявления пересекает третий квартиль.

Имя	Тип	Описание
`adBreakInfo`		Информация, относящаяся ко всему перерыву, в котором находится это объявление.
`adDescription`		Описание объявления.
`adId`		Идентификатор объявления или пустая строка, если он неизвестен.
`adSystem`		Рекламная система, предоставляющая креатив.
`adTitle`		Название объявления.
`advertiserName`		Имя рекламодателя, определенное обслуживающей стороной.
`companions`		Сопутствующие объявления, указанные в ответе VAST.
`creativeAdId`		Код ISCI (отраслевой стандартный коммерческий идентификатор) для объявления. Это идентификатор объявления, выбранного в ответе VAST.
`creativeId`		Идентификатор выбранного креатива для объявления.
`currentTime`		Текущее время в объявлении в секундах или -1, если неизвестно.
`dealId`		Возвращает идентификатор первой сделки, присутствующей в цепочке-оболочке текущего объявления, начиная сверху.
`duration`		Продолжительность этого одиночного объявления в секундах или -1, если неизвестно.
`skipOffset`		Время, необходимое для того, чтобы объявление можно было пропустить, или -1, если оно неизвестно.
`universalAdIDRegistry`		Строка, используемая для идентификации URL-адреса веб-сайта реестра, на котором каталогизирован универсальный идентификатор объявления выбранного креатива.
`universalAdIDValue`		Универсальный рекламный идентификатор выбранного креатива для объявления.
`wrappers`		Массив ima.WrapperInfo с информацией об обертке для этого объявления. Порядок будет от внешней оболочки к внутренней.

Имя	Тип	Описание
`apiFramework`		API, необходимый для показа этого объявления, или недействительный, если он недоступен.
`creativeType`		Представляет креативный тип, обычно mimetype.
`height`		Высота компаньона в пикселях. 0, если недоступен.
`trackingEvents`		Карта отслеживания событий, где ключом является событие, а значением — список URL-адресов для проверки связи с этим событием.
`url`		URL-адрес статического ресурса этого сопутствующего баннера.
`width`		Ширина сопутствующего баннера в пикселях. 0, если недоступен.

Имя	Тип	Описание
`end`		Время окончания ключевой точки в секундах. Это соответствует рекламной паузе.
`hasPlayed`		Логическое значение, указывающее, что точка разметки уже воспроизведена.
`start`		Время начала ключевой точки в секундах. Это соответствует рекламной паузе.

Имя	Тип	Описание
`id`		Идентификатор ошибки. См. константу ErrorEvent для получения списка кодов ошибок.
`info`		Дополнительная информация об ошибке.
`type`		Всегда устанавливайте значение error, чтобы указать тип этого объекта.

Имя	Тип	Описание
`BAD_STREAM_REQUEST`		Запрос потока не был заполнен правильно.
`COULD_NOT_LOAD_STREAM`		Не удалось загрузить поток.
`ERROR`		Неизвестная ошибка.
`INVALID_RESPONSE`		Ответ сервера недействителен.
`STREAM_API_KEY_NOT_VALID`		Предоставленный ключ API не был принят сервером.

Имя	Тип	Описание
`format`		Формат видео: hls или тире. Определено в ima.StreamFormat.
`manifest`		URL-адрес потока.
`streamId`		Уникальный идентификатор потока.
`streamType`		Тип видео: прямой эфир или по запросу. Определено в ima.StreamType.
`subtitles`		Субтитры, если они есть. Недействительно, если нет.

Параметр	Тип	Описание
`streamRequest`	`ima.StreamRequest`
`streamInitResponse`	`ima.StreamInitResponse`

Параметр	Тип	Описание
`streamManifest`	`string`	URL-адрес манифеста потока со вшитыми объявлениями.
`streamSubtitle`	`ifArray >\|Invalid` `ifArray >\|Invalid`	Субтитры связаны с потоком или `Invalid` , если их нет.

Имя	Тип	Описание
`adTagParameters`		Необязательный. Вы можете переопределить ограниченный набор параметров рекламного тега в запросе трансляции. Добавьте параметры таргетинга в свой поток, чтобы получить больше информации. Вы также можете использовать параметры dai-ot и dai-ov для предпочтения варианта потока. Дополнительные сведения см. в разделе «Переопределить параметры варианта потока» .
`adUiNode`		Узел графа сцены, в котором отображается пользовательский интерфейс рекламы. IMA размещает на этом элементе такие элементы, как кнопки «Почему эта реклама» и «Пропустить» во время рекламы. Элемент должен перекрывать весь видеоэлемент.
`apiKey`		Необязательный. Эти ключи можно использовать для аутентификации запросов потока. Ключи аутентификации DAI необходимо настроить в пользовательском интерфейсе DFP.
`assetKey`		Требуется для прямых трансляций. Это используется для определения того, какой поток следует воспроизводить. Ключ объекта запроса прямой трансляции – это идентификатор, который можно найти в пользовательском интерфейсе DFP.
`authToken`		Токен авторизации запроса потока. Используется вместо ключа API для более строгой авторизации контента. Издатель может управлять авторизацией отдельных потоков контента на основе этого токена.
`contentSourceId`		Требуется для потоков по запросу. cmsid берется из источника видеоконтента DFP в пользовательском интерфейсе DFP.
`customAssetKey`		Пользовательский ключ ресурса используется для определения того, какой поток следует воспроизводить. Пользовательские ключи активов необходимы для запросов потоков, обслуживающих модуль.
`format`		Формат потока. По умолчанию — `ima.StreamFormat.HLS` .
`networkCode`		Сетевой код издателя, отправляющего запрос потока. Сетевые коды необходимы для обслуживания запросов потоков Pod, сделанных с помощью createPodLiveStreamRequest или createPodVodStreamRequest. Эти коды также необходимы для запросов потока сшивания облака, сделанных с помощью createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest или createVideoStitcherVodStreamRequestWithVodConfig. Эти коды являются необязательными и рекомендуются для запросов потока полного обслуживания, выполненных с помощью createLiveStreamRequest или createVodStreamRequest. При добавлении кода сети применяются настройки, выбранные в пользовательском интерфейсе Менеджера рекламы, например включение ограниченной алгоритмической рекламы. Для обслуживания модулей и объединения в облако добавление сетевого кода позволяет найти и воспроизвести поток. Чтобы узнать код сети, смотрите эту статью .
`player`		Реализация интерфейса плеера.
`ppid`		Устарело. Используйте adTagParameters. Необязательный. Издатель DFP Audience предоставил идентификатор .
`streamActivityMonitorId`		Идентификатор, который будет использоваться для отладки потока с помощью монитора активности потока. Это используется, чтобы предоставить издателям удобный способ найти журнал потока в инструменте мониторинга активности потока.
`videoId`		Требуется для потоков по запросу. Идентификатор источника видеоконтента.
`videoObject`		Видеообъект (например, Video roSGNode), отвечающий за воспроизведение видео в клиентском приложении. Этот объект будет опрашиваться на предмет различных данных, которые будут использоваться для правильной синхронизации событий Live HLS ID3.
`videoStitcherSessionOptions`		Параметры сеанса используются для установки конкретных параметров видеостикера для потоковых запросов VideoStitcher.

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

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

Имя	Тип	Описание
`LIVE`		Видео живое.
`VOD`		Видео по запросу.

Параметр	Тип	Описание
`adTagUrl`	`string`
`networkCode`	`string`
`contentSourceUrl`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

Параметр	Тип	Описание
`vodConfigId`	`string`
`networkCode`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

IMA DAI SDK для Roku, IMA DAI SDK для Roku

Класс има

disableLogging()

getStreamManager()

initSdk(settings)

requestStream(streamRequest)

Класс ima.AdBreakInfo

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

createAdBreakInfo()

Класс ima.AdEvent

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

Класс ima.AdInfo

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

createAdInfo()

Класс ima.Companion

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

createCompanion()

Класс ima.CuePoint

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

createCuePoint()

Класс ima.Error

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

createError()

Класс ima.ErrorEvent

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

Класс ima.Player

adBreakEnded(adBreakInfo)

adBreakStarted(adBreakInfo)

allVideoComplete()

createPlayer()

loadUrl(streamInfo)

Класс ima.StreamFormat

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

Класс ima.StreamInfo

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

createStreamInfo()

Класс ima.StreamManager

addEventListener(event, callback)

createStreamManager(streamRequest, streamInitResponse)

enableInteractiveAds()

getContentTime(streamTime)

getCuePoints()

getPreviousCuePoint(time)

getStreamTime(contentTime)

loadThirdPartyStream(streamManifest, streamSubtitle)

onMessage(msg)

replaceAdTagParameters(adTagParameters)

start()

Класс ima.StreamRequest

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

createLiveStreamRequest(assetKey, apiKey, networkCode)

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

createPodVodStreamRequest(networkCode)

createStreamRequest()

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Класс ima.StreamType

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

Класс ima.WrapperInfo

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

createWrapperInfo()

`disableLogging()`

`getStreamManager()`

`initSdk(settings)`

`requestStream(streamRequest)`

`createAdBreakInfo()`

`createAdInfo()`

`createCompanion()`

`createCuePoint()`

`createError()`

`adBreakEnded(adBreakInfo)`

`adBreakStarted(adBreakInfo)`

`allVideoComplete()`

`createPlayer()`

`loadUrl(streamInfo)`

`createStreamInfo()`

`addEventListener(event, callback)`

`createStreamManager(streamRequest, streamInitResponse)`

`enableInteractiveAds()`

`getContentTime(streamTime)`

`getCuePoints()`

`getPreviousCuePoint(time)`

`getStreamTime(contentTime)`

`loadThirdPartyStream(streamManifest, streamSubtitle)`

`onMessage(msg)`

`replaceAdTagParameters(adTagParameters)`

`start()`

`createLiveStreamRequest(assetKey, apiKey, networkCode)`

`createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)`

`createPodVodStreamRequest(networkCode)`

`createStreamRequest()`

`createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)`

`createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)`

`createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)`

`createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)`

`createWrapperInfo()`