IMA DAI SDK dla Roku

1. 1. ima
   2. ima.AdBreakInfo
   3. ima.AdEvent
   4. ima.AdInfo
   5. ima.Companion
   6. ima.CuePoint
   7. ima.Error
   8. ima.ErrorEvent
   9. ima.Player
   10. ima.StreamFormat
   11. ima.StreamInfo
   12. ima.StreamManager
   13. ima.StreamRequest
   14. ima.StreamType
   15. ima.WrapperInfo

Klasa ima

Metody

disableLogging, getStreamManager, initSdk, requestStream

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

disableLogging()

Wyłącza logowanie pakietu SDK. Logowanie będzie 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łowa. Jeśli podczas tworzenia menedżera strumienia wystąpił błąd, zwracany jest obiekt błędu.

Zwraca object: menedżer strumienia lub obiekt błędu.

initSdk(settings)

Inicjuje pakiet SDK.

Parametr	Typ	Opis
settings	object	Opcjonalny obiekt ustawień IMA.

requestStream(streamRequest)

Uruchamia żądanie strumienia asynchronicznego Kontrola powraca do odtwarzacza natychmiast po wywołaniu tej metody.

Zwraca wartość object: błąd lub wartość nieprawidłowa, jeśli nie ma błędu

Parametr	Typ	Opis
streamRequest	object

Powrót do góry

Klasa ima.AdBreakInfo

Pola

adPosition, duration, podIndex, timeOffset, totalAds

Metody

createAdBreakInfo

Zawiera informacje o przerwie na reklamę. Przekazywana do wywołań zwrotnych zdarzenia przez pakiet SDK.

Właściwości

Nazwa	Typ	Opis
adPosition		Indeks reklamy w przerwie na reklamę. Będzie 1 dla samodzielnych reklam.
duration		Maksymalny czas trwania przerwy w sekundach. Jeśli nie jest znany, wartość wynosi -1.
podIndex		W przypadku transmisji na żywo zawsze zwraca wartość -1. W przypadku wideo na żądanie (VOD) zwraca indeks bloku reklamowego. W przypadku bloku reklamowego przed filmem zwraca wartość 0. W przypadku reklam w trakcie filmu zwraca 1, 2, ..., n. W przypadku bloku reklamowego po filmie zwraca n+1...n+x. Wartość domyślna to 0, jeśli ta reklama nie jest częścią bloku reklamowego lub ten blok nie jest częścią playlisty.
timeOffset		Pozycja bloku reklamowego w treści wyrażona w sekundach. Reklama przed filmem zwraca wartość 0, reklamy po filmie zwracają wartość -1, a reklamy w trakcie filmu zwracają zaplanowany czas bloku reklamowego.
totalAds		Łączna liczba reklam zawartych w tej przerwie na reklamę. Będzie 1 dla samodzielnych reklam.

createAdBreakInfo()

Zwraca ima.AdBreakInfo:

Powrót do góry

Klasa ima.AdEvent

Pola

AD_PERIOD_ENDED, AD_PERIOD_STARTED, COMPLETE, ERROR, FIRST_QUARTILE, ICON_FALLBACK_IMAGE_CLOSED, ICON_FALLBACK_IMAGE_SHOWN, MID_CHANGE7},{STATE_CHANGE}, SKIPPABLE_STATE_CHANGEDTHIRD_QUARTILE

Zdarzenia wywoływane przez menedżera reklam.

Właściwości

Nazwa	Typ	Opis
AD_PERIOD_ENDED		Uruchamiane za każdym razem, gdy transmisja z reklam lub planszy zostanie zastąpiona treścią. Reklama zostanie uruchomiona nawet wtedy, gdy reklama zostanie odtworzona po raz drugi lub przejdziesz do reklamy.
AD_PERIOD_STARTED		Uruchamiane za każdym razem, gdy transmisja zostanie przełączona z treści na reklamę lub plansze. Reklama zostanie uruchomiona nawet wtedy, gdy reklama zostanie odtworzona po raz drugi lub przejdziesz do reklamy.
COMPLETE		Uruchamiane po zakończeniu odtwarzania reklamy.
ERROR		Uruchamiane po wystąpieniu błędu.
FIRST_QUARTILE		Uruchamiane, gdy suwak odtwarzania reklamy przekroczy pierwszy kwartyl.
ICON_FALLBACK_IMAGE_CLOSED		Uruchamiane, gdy użytkownik zamknie okno obrazu zastępczego ikony.
ICON_FALLBACK_IMAGE_SHOWN		Uruchamiane po wyświetleniu obrazu zastępczego ikony.
MIDPOINT		Uruchamiane, gdy suwak odtwarzania reklamy przekroczy wartość środkową.
PROGRESS		Uruchamiane, gdy trwa aktualizacja postępu reklamy.
SKIPPABLE_STATE_CHANGED		Uruchamiane, gdy zmieni się stan reklamy możliwej do pominięcia.
SKIPPED		Uruchamiane, gdy reklama zostanie pominięta.
START		Uruchamiane po rozpoczęciu odtwarzania reklamy.
THIRD_QUARTILE		Uruchamiane, gdy suwak odtwarzania reklamy przekroczy trzeci kwartyl.

Powrót do góry

Klasa ima.AdInfo

Pola

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, identyfikatory towarzyszące, currentTime, duration, universalValues2}AdRewrap2} skipOffset, universalAdIDRegistryuniversalAdIDValue

Metody

createAdInfo

Zawiera informacje o reklamie. Przekazywana do wywołań zwrotnych zdarzenia przez pakiet SDK.

Właściwości

Nazwa	Typ	Opis
adBreakInfo		Informacje dotyczące całej przerwy, w której znajduje się ta reklama.
adDescription		Tekst reklamy.
adId		Identyfikator reklamy lub pusty ciąg znaków, jeśli jest nieznany.
adSystem		System reklamowy dostarczający kreację.
adTitle		Tytuł reklamy.
advertiserName		Nazwa reklamodawcy zdefiniowana przez stronę wyświetlającą reklamy.
companions		Reklamy towarzyszące określone w odpowiedzi VAST.
currentTime		Bieżący czas w reklamie podany w sekundach lub -1, jeśli jest nieznany.
duration		Czas trwania tej pojedynczej reklamy w sekundach lub -1, jeśli jest nieznany.
skipOffset		Czas, po upływie którego reklama stanie się możliwa do pominięcia, lub -1, jeśli jest nieznana.
universalAdIDRegistry		Ciąg znaków identyfikujący adres URL witryny rejestru, w której jest katalogowany uniwersalny identyfikator reklamy wybranej kreacji.
universalAdIDValue		Uniwersalny identyfikator reklamy wybranej dla reklamy.
wrappers		Tablica ima.WrapperInfo z informacjami o kodzie reklamy. Zamówienie będzie przebiegać z zewnętrznego korpusu na wewnętrzny.

createAdInfo()

Zwraca ima.AdInfo:

Powrót do góry

Klasa ima.Companion

Pola

apiFramework, creativeType, height, trackingEvents, url, width

Metody

createCompanion

Zawiera informacje o elementach towarzyszących reklamy.

Właściwości

Nazwa	Typ	Opis
apiFramework		Interfejs API potrzebny do uruchomienia tej reklamy lub wartość Nieprawidłowa, jeśli jest niedostępna.
creativeType		Reprezentuje typ kreacji, zwykle jest to typ MIME.
height		Wysokość reklamy towarzyszącej w pikselach. Wartość 0, jeśli jest niedostępna.
trackingEvents		Mapa zdarzeń śledzenia, w której klucz to zdarzenie, a wartością jest lista adresów URL, do których należy wysłać ping po tym zdarzeniu.
url		Adres URL statycznego zasobu danej reklamy towarzyszącej.
width		Szerokość reklamy towarzyszącej w pikselach. Wartość 0, jeśli jest niedostępna.

createCompanion()

Zwraca ima.Companion:

Powrót do góry

Klasa ima.CuePoint

Pola

end, hasPlayed, start

Metody

createCuePoint

Zawiera informacje o punkcie wstawienia.

Właściwości

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

createCuePoint()

Zwraca ima.CuePoint:

Powrót do góry

Klasa ima.Error

Pola

id, info, type

Metody

createError

Obiekt przekazywany do modułu obsługi błędu w przypadku wystąpienia błędu.

Właściwości

Nazwa	Typ	Opis
id		Identyfikator błędu. Lista kodów błędów znajduje się w stałej ErrorEvent.
info		Dodatkowe informacje o błędzie.
type		Zawsze ustawiaj na error (błąd), aby wskazać typ tego obiektu.

createError()

Zwraca ima.Error:

Powrót do góry

Klasa ima.ErrorEvent

Pola

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

Wszystkie błędy, które pakiet SDK może odesłać.

Właściwości

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.

Powrót do góry

Klasa ima.Player

Metody

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl

adBreakEnded(adBreakInfo)

Opcjonalnie. Wywoływane po zakończeniu przerwy na reklamę.

Parametr	Typ	Opis
adBreakInfo	ima.AdBreakInfo	który zawiera informacje o przerwie na reklamę.

adBreakStarted(adBreakInfo)

Opcjonalnie. Wywoływane po rozpoczęciu przerwy na reklamę.

Parametr	Typ	Opis
adBreakInfo	ima.AdBreakInfo	który zawiera informacje o przerwie na reklamę.

allVideoComplete()

Opcjonalnie. Wywoływane po zakończeniu odtwarzania wszystkich filmów.

createPlayer()

Tworzy pusty obiekt IMA Player. Aby wyświetlać reklamy, musisz zaimplementować funkcję loadUrl. Pozostałe funkcje są opcjonalne.

Zwraca ima.Player:

loadUrl(streamInfo)

Wywoływane, gdy odtwarzacz powinien rozpocząć odtwarzanie adresu URL. Musisz zaimplementować tę metodę, aby wczytać strumień.

Parametr	Typ	Opis
streamInfo	ima.StreamInfo	Zawiera informacje potrzebne do odtworzenia treści.

Powrót do góry

Klasa ima.StreamFormat

Pola

DASH i HLS

Określa format strumienia.

Właściwości

Nazwa	Typ	Opis
DASH
HLS

Powrót do góry

Klasa ima.StreamInfo

Pola

format, manifest, streamId, streamType, napisy

Metody

createStreamInfo

Informacje na temat strumienia przekazywane z pakietu SDK do odtwarzacza.

Właściwości

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łowa wartość, jeśli nie.

createStreamInfo()

Zwraca ima.StreamInfo:

Powrót do góry

Klasa ima.StreamManager

Metody

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, loadThirdPartyStream, onMessage, onMessage28}replaceAdTagParameters

Obiekt do zarządzania odtwarzaniem w strumieniu.

addEventListener(event, callback)

Dodaje detektor określonego zdarzenia. Aby sprawdzić obsługiwane zdarzenia, zobacz stałą AdEvents.

Parametr	Typ	Opis
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

Zwraca ima.StreamManager:

Parametr	Typ	Opis
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

Nieobsługiwane. Zamiast tego przekazują dane z reklamy towarzyszącej bezpośrednio do RAF. Nie jest to teraz możliwe.

getContentTime(streamTime)

Oblicza czas (w milisekundach) dla strumienia VOD, który reprezentuje czas w treści bez reklam. Zobacz: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq Aby sprawdzić czas treści dla bieżącej transmisji w przedziale czasu -1.

Zwraca Integer: czas treści odpowiadający podanemu czasowi transmisji.

Parametr	Typ	Opis
streamTime	Integer	Czas w strumieniu.

getCuePoints()

Zwraca wszystkie punkty wstawienia reklamy odpowiadające wszystkim przerwom na reklamę. Dotyczy to tylko treści wideo na żądanie, w których wszystkie przerwy na reklamę są znane z wyprzedzeniem. Wszystkie czasy oznaczają czas trwania transmisji w sekundach.

Zwraca wartość Object: tablica ze wszystkimi punktami wstawienia reklamy.

getPreviousCuePoint(time)

Zwraca punkt wstawienia reklamy poprzedzający ten czas. Punkt wstawienia reklamy wskazuje przerwę na reklamę. Wszystkie czasy oznaczają czas trwania transmisji w sekundach.

Zwraca ima.CuePoint: obiekt z początkiem, końcem i hasPlayed. Zwraca nieprawidłową wartość, jeśli nie ma dostępnego punktu wstawienia.

Parametr	Typ	Opis
time	Float	Czas do wyszukania. -1 oznacza bieżący czas.

getStreamTime(contentTime)

W przypadku VOD pobiera w milisekundach czas trwania transmisji z czasu treści. Patrz: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq

Zwraca wartość Integer: czas strumienia odpowiadający podanemu czasowi treści.

Parametr	Typ	Opis
contentTime	Integer	Czas zamieszczenia treści.

loadThirdPartyStream(streamManifest, streamSubtitle)

Wczytuje metadane reklamy i wywołuje funkcję loadUrl z podanymi danymi streamManifestUrl i streamSubtitle. Ta funkcja działa tylko wtedy, gdy typ żądania strumienia to ima.StreamType.POD_VOD.

Parametr	Typ	Opis
streamManifest	string	Adres URL pliku manifestu strumienia z połączonymi reklamami.
streamSubtitle	ifArray>|Invalid	Napisy powiązane ze strumieniem lub Invalid, jeśli nie ma ich wcale.

onMessage(msg)

Obsługuje wszystkie komunikaty pochodzące z obiektu Video. Musi być wywoływane w przypadku każdej wiadomości odebranej w roMessagePort.

Parametr	Typ	Opis
msg	object	Komunikat z portu roVideo.

replaceAdTagParameters(adTagParameters)

Zastępuje wszystkie parametry tagu reklamy, które mają być używane w żądaniach nadchodzących reklam w przypadku transmisji na żywo. Pamiętaj, że to połączenie nie dotyczy strumieni VOD.

Parametr	Typ	Opis
adTagParameters	string	Nowe parametry tagu reklamy.

start()

Rozpoczyna odtwarzanie transmisji.

Powrót do góry

Klasa ima.StreamRequest

Pola

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, format, networkCode, networkCode, odtwarzacz,ActivityId, ppidstreamActivityMonitorIdvideoIdvideoObjectvideoStitcherSessionOptions

Metody

createLiveStreamRequest, createPodLiveStreamRequest, createPodVodStreamRequest, createStreamRequest, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, CreateVideoStitcherVodStreamRequestWithVodConfig, createVodStreamRequest

Służy do określania właściwości żądania strumienia.

Właściwości

Nazwa	Typ	Opis
adTagParameters		Opcjonalnie. W żądaniu strumienia możesz zastąpić ograniczony zestaw parametrów tagu reklamy. Opcja Podaj parametry kierowania do strumienia zawiera więcej informacji. Do preferencji wersji strumienia możesz też używać parametrów dai-ot i dai-ov. Więcej informacji znajdziesz w sekcji Zastępowanie parametrów wersji strumienia.
adUiNode		Węzeł wykresu sceny, w którym wyświetla się interfejs reklamy. IMA umieszcza w reklamach te elementy, np. Dlaczego ta reklama? i Pomiń. Element musi nakładać się na cały element wideo.
apiKey		Opcjonalnie. Tych kluczy można używać do uwierzytelniania żądań strumieni. Klucze uwierzytelniania DAI należy skonfigurować w interfejsie DFP.
assetKey		Wymagany w przypadku transmisji na żywo. Ta wartość określa, który strumień odtworzyć. Klucz zasobu żądania 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 bardziej rygorystycznej autoryzacji treści. Wydawca może kontrolować autoryzacje poszczególnych strumieni treści na podstawie tego tokena.
contentSourceId		Wymagany w przypadku strumieni na żądanie. Identyfikator cmsid pochodzi ze źródła treści wideo w usłudze DFP w interfejsie użytkownika.
customAssetKey		Niestandardowy klucz pliku służy do określenia, którą transmisję należy odtworzyć. W przypadku żądań strumieni wyświetlania bloków reklamowych wymagane są niestandardowe klucze zasobów.
format		Format strumienia. Domyślna wartość to ima.StreamFormat.HLS.
networkCode		Kod sieci wydawcy wysyłającego żądanie strumienia. Żądania strumienia obsługującego pody wymagają kodów sieci.
player		Implementacja interfejsu odtwarzacza.
ppid		Rola wycofana. Należy użyć parametru adTagParameters. Opcjonalnie. Identyfikator podawany przez wydawcę z funkcji Odbiorcy DFP.
streamActivityMonitorId		Identyfikator używany do debugowania strumienia za pomocą narzędzia do monitorowania aktywności strumienia. Pozwala to w wygodny sposób umożliwić wydawcom znalezienie logu strumienia w narzędziu do monitorowania aktywności strumienia.
videoId		Wymagany w przypadku strumieni na żądanie. Identyfikator źródła treści wideo.
videoObject		Obiekt wideo (np. Video roSGNode) odpowiedzialny za odtwarzanie filmu w aplikacji klienckiej. Ten obiekt będzie sondowany w poszukiwaniu różnych danych do użycia we właściwym czasie zdarzeń HLS ID3 w czasie rzeczywistym.
videoStitcherSessionOptions		Opcje sesji służą do ustawiania konkretnych parametrów tagu wideo w żądaniach VideoStitcher streamRequest.

createLiveStreamRequest(assetKey, apiKey)

Inicjuje wymagane właściwości aktywnego StreamRequest. Użycie tego interfejsu API powoduje ignorowanie wszystkich pozostałych właściwości typowych dla właściwości StreamType. Jeśli którekolwiek z wymaganych parametrów są pustymi ciągami znaków, logowanie błędów jest rejestrowane i interfejs API zwraca ogólny atrybut StreamRequest, który nie jest ignorowany.

Zwraca obiekt ima.StreamRequest: ima.StreamRequest z wymaganymi właściwościami Live.

Parametr	Typ	Opis
assetKey	string
apiKey	string	Parametr opcjonalny, który zostanie przypisany do zwróconej właściwości apiKey elementu StreamRequest. Domyślnie jest to pusty ciąg znaków.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Inicjuje wymagane właściwości aktywnego poda ima.StreamRequest. Użycie tego interfejsu API powoduje zignorowanie pozostałych właściwości ima.StreamType. Jeśli którekolwiek z wymaganych parametrów są pustymi ciągami znaków, logowanie błędów jest rejestrowane i interfejs API zwraca ogólny atrybut StreamRequest, który nie jest ignorowany.

Zwraca obiekt StreamRequest: ima.StreamRequest z wymaganymi właściwościami PodLive.

Parametr	Typ	Opis
customAssetKey	string
networkCode	string
apiKey	string	Parametr opcjonalny, który zostanie przypisany do zwróconej właściwości ima.StreamRequest.apiKey elementu ima.StreamRequest. Domyślnie jest to pusty ciąg znaków.

createPodVodStreamRequest(networkCode)

Inicjuje wymagane właściwości ima.StreamRequest do zarejestrowania strumienia VOD, gdy pod DAI jest wyświetlany za pomocą narzędzia do łączenia filmów innej firmy. Ta funkcja ustawia typ żądania na ima.StreamType.POD_VOD i weryfikuje wszystkie wymagane właściwości w przypadku brakujących danych. Nieudana weryfikacja spowoduje zarejestrowanie błędu w konsoli debugowania.

Zwraca StreamRequest: obiekt ima.StreamRequest. Jeśli określone są wszystkie wymagane właściwości, typ żądania jest ustawiony na ima.StreamType.POD_VOD.

Parametr	Typ	Opis
networkCode	string	kod sieci Google Ad Managera,

createStreamRequest()

Zwraca ima.StreamRequest: pusty obiekt ima.StreamRequest.

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

Inicjuje wymagane właściwości narzędzia Video Stitcher Live StreamRequest. Użycie tego interfejsu API powoduje zignorowanie innych właściwości typowych dla właściwości StreamType. Jeśli którekolwiek z wymaganych parametrów są pustymi ciągami znaków, logowanie błędów jest rejestrowane i interfejs API zwraca ogólny atrybut StreamRequest, który nie jest ignorowany.

Zwraca obiekt ima.StreamRequest: ima.StreamRequest z wymaganymi właściwościami VideoStitcherLive.

Parametr	Typ	Opis
customAssetKey	string
networkCode	string
liveConfigId	string
region	string
projectNumber	string
oAuthToken	string

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

Inicjuje wymagane właściwości VOD narzędzia Video Stitcher StreamRequest. Użycie tego interfejsu API powoduje zignorowanie innych właściwości typowych dla właściwości StreamType. Jeśli którekolwiek z wymaganych parametrów są pustymi ciągami znaków, logowanie błędów jest rejestrowane i interfejs API zwraca ogólny atrybut StreamRequest, który nie jest ignorowany.

Zwraca obiekt ima.StreamRequest: ima.StreamRequest z wymaganymi właściwościami VideoStitcherVod.

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

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

Inicjuje wymagane właściwości narzędzia VOD narzędzia Video Stitcher StreamRequest za pomocą pola vodConfigId utworzonego za pomocą narzędzia do łączenia treści wideo w chmurze. Użycie tego interfejsu API powoduje, że pozostałe właściwości typowe dla klasy StreamType są ignorowane. Jeśli którekolwiek z wymaganych parametrów są pustymi ciągami znaków, logowanie błędów jest rejestrowane i interfejs API zwraca ogólny atrybut StreamRequest, który nie jest ignorowany.

Zwraca obiekt ima.StreamRequest: ima.StreamRequest z wymaganymi właściwościami VideoStitcherVod.

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

createVodStreamRequest(contentSourceId, videoId, apiKey)

Inicjuje wymagane właściwości elementu ima.StreamRequest VOD. Użycie tego interfejsu API powoduje, że pozostałe właściwości typowe dla klasy ima.StreamType są ignorowane. Jeśli którekolwiek z wymaganych parametrów są pustymi ciągami znaków, logowanie błędów jest rejestrowane i interfejs API zwraca ogólny atrybut StreamRequest, który nie jest ignorowany.

Zwraca obiekt ima.StreamRequest: ima.StreamRequest z wymaganymi właściwościami VOD.

Parametr	Typ	Opis
contentSourceId	string
videoId	string
apiKey	string	Parametr opcjonalny, który zostanie przypisany do zwróconej właściwości ima.StreamRequest.apiKey elementu ima.StreamRequest. Domyślnie jest to pusty ciąg znaków.

Powrót do góry

Klasa ima.StreamType

Pola

LIVE, VOD

Definiuje typ strumienia, o który prosi odtwarzacz. Reklamy przed filmem i filmy na żądanie powinny być odtwarzane od początku transmisji.

Właściwości

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

Powrót do góry

Klasa ima.WrapperInfo

Pola

adId, adSystem, creativeAdId, creativeId, dealId

Metody

createWrapperInfo

Zawiera informacje o opakowaniu.

Właściwości

Nazwa	Typ	Opis
adId		Identyfikator reklamy lub pusty ciąg znaków, jeśli jest nieznany.
adSystem		Zadeklarowana nazwa systemu reklam lub pusty ciąg znaków, jeśli nie jest znany.
creativeAdId		Identyfikator reklamy w kreacji lub pusty ciąg znaków, jeśli jest nieznany.
creativeId		Identyfikator kreacji lub pusty ciąg znaków, jeśli jest nieznany.
dealId		Identyfikator umowy lub pusty ciąg znaków, jeśli jest nieznany.

createWrapperInfo()

Zwraca ima.WrapperInfo:

Powrót do góry