Ta strona została przetłumaczona przez Cloud Translation API.

IMA DAI SDK dla Roku

Class ima

Metody

disableLogging, getStreamManager, initSdk, requestStream

Funkcje globalne, które kontrolują pakiet IMA SDK.

`disableLogging()`

Wyłącza rejestrowanie pakietu SDK. Rejestrowanie jest domyślnie włączone.

`getStreamManager()`

Zwraca menedżera strumienia, jeśli jest dostępny. Jeśli menedżer strumienia nie jest jeszcze dostępny, zwracana jest wartość Nieprawidłowy. Jeśli podczas tworzenia menedżera strumienia wystąpił błąd, zwracany jest obiekt błędu.

Zwraca object: obiekt menedżera transmisji lub błąd.

`initSdk(settings)`

Inicjowanie pakietu SDK.

Parametr	Typ	Opis
`settings`	`object`	Opcjonalny obiekt ustawień IMA.

`requestStream(streamRequest)`

Rozpoczyna asynchroniczne żądanie transmisji. Po wywołaniu tej metody kontrola wraca natychmiast do odtwarzacza.

Zwraca object: błąd lub wartość nieprawidłowa, jeśli nie wystąpił błąd

Parametr	Typ	Opis
`streamRequest`	`object`

Nazwa	Typ	Opis
`adPosition`		Indeks reklamy w przerwie na reklamę. Wskaźnik `1` dotyczy reklam samodzielnych.
`duration`		Maksymalny czas trwania przerwy w sekundach lub `-1`, jeśli jest nieznany.
`podIndex`		W przypadku transmisji na żywo zwraca identyfikator przerwy jako indeks podsegmentu lub `0`w przypadku prerollu. W transmisjach na żywo nie ma reklam końcowych. Domyślna wartość to `-2`. W przypadku wideo na żądanie (VOD) zwraca indeks bloku reklamowego. W przypadku bloku reklamowego preroll zwraca wartość `0`. W przypadku reklam w trakcie filmu zwracane są wartości `1`, `2`, …, n. W przypadku podzbioru po reklamie zwraca n+1...n+x. Domyślnie jest to `0`, jeśli reklama nie należy do bloku reklamowego lub blok reklamowy nie należy do playlisty.
`timeOffset`		Pozycja bloku reklamowego w treści (w sekundach). Reklamy przed filmem zwracają wartość `0`, reklamy po filmie – `-1`, a reklamy w trakcie filmu – zaplanowany czas podgrupy reklam.
`totalAds`		Łączna liczba reklam zawartych w tej przerwie na reklamę. Wartość `1` dotyczy reklam samodzielnych.

Nazwa	Typ	Opis
`AD_PERIOD_ENDED`		Wywoływany za każdym razem, gdy transmisja przechodzi z reklamy lub planszy na treści. Jest ono wywoływane nawet wtedy, gdy reklama jest odtwarzana po raz drugi lub gdy użytkownik przewinie reklamę.
`AD_PERIOD_STARTED`		Wywoływany za każdym razem, gdy transmisja przechodzi z treści do reklamy lub planszy. Jest ono wywoływane nawet wtedy, gdy reklama jest odtwarzana po raz drugi lub gdy użytkownik przewinie reklamę.
`COMPLETE`		Uruchamiane po zakończeniu odtwarzania reklamy.
`ERROR`		Uruchamiane, gdy wystąpi błąd.
`FIRST_QUARTILE`		Uruchamiane, gdy element sterujący odtwarzania reklamy przekroczy pierwszy kwartyl.
`ICON_FALLBACK_IMAGE_CLOSED`		Wywoływane, gdy użytkownik zamknie okno obrazu zastępczego ikony.
`ICON_FALLBACK_IMAGE_SHOWN`		Wywoływane po wyświetleniu obrazu ikony zastępczego.
`MIDPOINT`		Uruchamiane, gdy suwak odtwarzania reklamy przekroczy punkt środkowy.
`PROGRESS`		Uruchamiane, gdy nastąpiła zmiana w postępie wyświetlania reklamy.
`SKIPPABLE_STATE_CHANGED`		Uruchamiane, gdy stan możliwości pominięcia reklamy się zmienia.
`SKIPPED`		Uruchamiane, gdy użytkownik pominie reklamę.
`START`		Uruchamiane, gdy reklama zacznie się odtwarzać.
`THIRD_QUARTILE`		Uruchamiane, gdy nagłówek reklamy przekroczy trzeci kwartyl.

Nazwa	Typ	Opis
`adBreakInfo`		Informacje dotyczące całej przerwy, w której wyświetla się reklama.
`adDescription`		Opis reklamy.
`adId`		Identyfikator reklamy lub pusty ciąg znaków, jeśli jest nieznany.
`adSystem`		System reklamy dostarczający kreację.
`adTitle`		Tytuł reklamy.
`advertiserName`		Nazwa reklamodawcy określona przez stronę wyświetlającą.
`companions`		Reklamy towarzyszące określone w odpowiedzi VAST.
`creativeAdId`		Kod ISCI (Industry Standard Commercial Identifier) reklamy. Jest to identyfikator reklamy wybranej kreacji w odpowiedzi VAST.
`creativeId`		Identyfikator wybranej kreacji reklamy.
`currentTime`		Bieżący czas w reklamie (w sekundach) lub -1, jeśli jest nieznany.
`dealId`		Zwraca pierwszy identyfikator umowy obecny w łańcuchu opakowania dla bieżącej reklamy, zaczynając od góry.
`duration`		Czas trwania tej pojedynczej reklamy w sekundach lub -1, jeśli jest nieznany.
`skipOffset`		Czas potrzebny do tego, aby reklama stała się możliwa do pominięcia lub -1, jeśli jest to nieznane.
`universalAdIDRegistry`		Ciąg znaków służący do identyfikacji adresu URL witryny rejestru, w której katalogowany jest uniwersalny identyfikator reklamy wybranej kreacji.
`universalAdIDValue`		Uniwersalny identyfikator reklamy wybranej kreacji reklamy.
`wrappers`		Tablica obiektów ima.WrapperInfo z informacjami o wrapperze dla tej reklamy. Kolejność będzie od opakowania zewnętrznego do wewnętrznego.

Nazwa	Typ	Opis
`apiFramework`		Interfejs API wymagany do wyświetlenia tej reklamy lub „Nieprawidłowy”, jeśli interfejs API jest niedostępny.
`creativeType`		Reprezentuje typ kreacji, zwykle mimetype.
`height`		Wysokość elementu towarzyszącego w pikselach. 0, jeśli jest niedostępna.
`trackingEvents`		Mapa zdarzeń śledzonych, w której kluczem jest zdarzenie, a wartością jest lista adresów URL, do których wysyłane są pingi po wystąpieniu danego zdarzenia.
`url`		Adres URL zasobu statycznego tego filmu.
`width`		Szerokość elementu towarzyszącego w pikselach. 0, jeśli jest niedostępna.

Nazwa	Typ	Opis
`end`		Czas zakończenia punktu wstawienia podany w sekundach. Odpowiada przerwie na reklamę.
`hasPlayed`		Wartość logiczna wskazująca, że punkt cuepoint został już odtworzony.
`start`		Czas rozpoczęcia punktu cue w sekundach. Odpowiada przerwie na reklamę.

Nazwa	Typ	Opis
`id`		Identyfikator błędu. Lista kodów błędów znajduje się w konstancie ErrorEvent.
`info`		dodatkowe informacje o błędzie;
`type`		Zawsze ustawiaj na błąd, aby wskazać typ tego obiektu.

Nazwa	Typ	Opis
`BAD_STREAM_REQUEST`		Żądanie strumienia nie zostało prawidłowo wypełnione.
`COULD_NOT_LOAD_STREAM`		Nie udało się wczytać strumienia.
`ERROR`		Nieznany błąd.
`INVALID_RESPONSE`		Odpowiedź serwera była nieprawidłowa.
`STREAM_API_KEY_NOT_VALID`		Podany klucz interfejsu API nie został zaakceptowany przez serwer.

Nazwa	Typ	Opis
`format`		Format filmu: hls lub dash. Zdefiniowany w ima.StreamFormat.
`manifest`		Adres URL strumienia.
`streamId`		Unikalny identyfikator strumienia.
`streamType`		Typ filmu: na żywo lub na żądanie. Zdefiniowany w ima.StreamType.
`subtitles`		napisy (jeśli są dostępne); Nieprawidłowe.

Parametr	Typ	Opis
`streamRequest`	`ima.StreamRequest`
`streamInitResponse`	`ima.StreamInitResponse`

Parametr	Typ	Opis
`streamManifest`	`string`	Adres URL manifestu strumienia z wstawionymi reklamami.
`streamSubtitle`	`ifArray>\|Invalid`	Napisy są powiązane z strumieniem lub `Invalid`, jeśli nie ma żadnych napisów.

Nazwa	Typ	Opis
`adTagParameters`		Opcjonalnie: W żądaniu strumienia możesz zastąpić ograniczony zestaw parametrów tagu reklamy. Więcej informacji znajdziesz w artykule Dodawanie parametrów kierowania do strumienia. Do ustawienia preferencji dotyczącej wariantu strumienia możesz też użyć parametrów dai-ot i dai-ov. Więcej informacji znajdziesz w artykule Zastępowanie parametrów wersji strumienia.
`adUiNode`		Węzeł grafu sceny, w którym wyświetla się interfejs reklamy. Podczas wyświetlania reklam IMA umieszcza na tym elemencie przyciski takie jak Dlaczego ta reklama i Pomiń. Element musi nakładać się na cały element wideo.
`apiKey`		Opcjonalnie: Można ich używać do uwierzytelniania żądań strumieni. Klucze uwierzytelniania DAI należy skonfigurować w interfejsie DFP.
`assetKey`		Wymagany w przypadku transmisji na żywo. Służy do określenia, który strumień powinien być odtwarzany. Klucz zasobu transmisji na żywo to identyfikator, który można znaleźć w interfejsie DFP.
`authToken`		Token autoryzacji żądania strumienia. Używany zamiast klucza API w celu uzyskania bardziej rygorystycznej autoryzacji treści. Wydawca może kontrolować uprawnienia do poszczególnych strumieni treści na podstawie tego tokena.
`contentSourceId`		Wymagane w przypadku strumieniowania na żądanie. Parametr cmsid pochodzi ze źródła treści wideo DFP w interfejsie DFP.
`customAssetKey`		Klucz zasobu niestandardowego służy do określenia, który strumień powinien być odtwarzany. Niestandardowe klucze plików są wymagane do obsługi żądań strumienia podrzędnego.
`format`		Format strumienia. Domyślna wartość to `ima.StreamFormat.HLS`.
`networkCode`		Kod sieci wydawcy przesyłającego żądanie strumienia. Kody sieci są wymagane w przypadku żądań strumienia do wyświetlania bloków reklamowych przesłanych za pomocą metod createPodLiveStreamRequest lub createPodVodStreamRequest. Te kody są również wymagane w przypadku żądań strumienia łączenia w chmurze wykonanych za pomocą metod createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest lub createVideoStitcherVodStreamRequestWithVodConfig. Te kody są opcjonalne i zalecane w przypadku żądań strumieniowania z pełną obsługą usługi utworzonych za pomocą createLiveStreamRequest lub createVodStreamRequest. Dodanie kodu sieci powoduje zastosowanie ustawień wybranych w interfejsie Ad Managera, np. włączenia reklamy ograniczonej w ramach automatyzacji. W przypadku wyświetlania bloków reklamowych i łączenia w chmurze dodanie kodu sieciowego umożliwia odnalezienie i odtworzenie strumienia. Aby znaleźć kod sieci, zapoznaj się z tym artykułem.
`player`		Implementacja interfejsu odtwarzacza.
`ppid`		Rola wycofana. Użyj parametru adTagParameters. Opcjonalnie: Identyfikator podany przez wydawcę w grupie odbiorców DFP.
`streamActivityMonitorId`		Identyfikator służący do debugowania strumienia za pomocą narzędzia do monitorowania aktywności strumienia. Dzięki temu wydawcy mogą wygodnie znajdować dziennik transmisji w narzędziu do monitorowania aktywności w transmisji.
`videoId`		Wymagane w przypadku strumieniowania na żądanie. Identyfikator źródła treści wideo.
`videoObject`		Obiekt wideo (np. obiekt roSGNode wideo) odpowiedzialny za odtwarzanie filmu w aplikacji klienta. Ten obiekt będzie sondowany pod kątem różnych danych, które będą wykorzystywane do prawidłowego określania czasu zdarzeń HLS ID3 na żywo.
`videoStitcherSessionOptions`		Opcje sesji służą do ustawiania parametrów charakterystycznych dla nalepki wideo w przypadku żądań strumienia VideoStitcher.

Parametr	Typ	Opis
`assetKey`	`string`
`apiKey`	`string`	Parametr przypisany do zwracanej właściwości `ima.StreamRequest` `ima.StreamRequest.apiKey`. Jeśli klucz API nie istnieje, prześlij pusty ciąg.
`networkCode`	`string`	Kod sieci wydawcy przesyłającego żądanie strumienia. Podanie kodu sieci jest opcjonalne, ale zalecane.

Parametr	Typ	Opis
`contentSourceId`	`string`
`videoId`	`string`
`apiKey`	`string`	Parametr przypisany do zwracanej właściwości `ima.StreamRequest` `ima.StreamRequest.apiKey`. Jeśli klucz API nie istnieje, prześlij pusty ciąg.
`networkCode`	`string`	Kod sieci wydawcy przesyłającego żądanie strumienia. Podanie kodu sieci jest opcjonalne, ale zalecane.

Nazwa	Typ	Opis
`LIVE`		Film został opublikowany.
`VOD`		Film jest dostępny na żądanie.

Parametr	Typ	Opis
`adTagUrl`	`string`
`networkCode`	`string`
`contentSourceUrl`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

Parametr	Typ	Opis
`vodConfigId`	`string`
`networkCode`	`string`
`region`	`string`
`projectNumber`	`string`
`oAuthToken`	`string`

IMA DAI SDK dla Roku

Class ima

disableLogging()

getStreamManager()

initSdk(settings)

requestStream(streamRequest)

Klasa: ima.AdBreakInfo

Właściwości

createAdBreakInfo()

Klasa: ima.AdEvent

Właściwości

Klasa ima.AdInfo

Właściwości

createAdInfo()

Class ima.Companion

Właściwości

createCompanion()

Klasa ima.CuePoint

Właściwości

createCuePoint()

Klasa: ima.Error

Właściwości

createError()

Class ima.ErrorEvent

Właściwości

Klasa: ima.Player

adBreakEnded(adBreakInfo)

adBreakStarted(adBreakInfo)

allVideoComplete()

createPlayer()

loadUrl(streamInfo)

Klasa: ima.StreamFormat

Właściwości

Klasa: ima.StreamInfo

Właściwości

createStreamInfo()

Klasa ima.StreamManager

addEventListener(event, callback)

createStreamManager(streamRequest, streamInitResponse)

enableInteractiveAds()

getContentTime(streamTime)

getCuePoints()

getPreviousCuePoint(time)

getStreamTime(contentTime)

loadThirdPartyStream(streamManifest, streamSubtitle)

onMessage(msg)

replaceAdTagParameters(adTagParameters)

start()

Klasa: ima.StreamRequest

Właściwości

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)

Klasa: ima.StreamType

Właściwości

Klasa: ima.WrapperInfo

Właściwości

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()`