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

Class ima

Metody

disableLogging, getStreamManager, initSdk, requestStream

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

disableLogging()

Wyłącza logowanie w pakiecie SDK. Rejestrowanie będzie domyślnie włączone.

getStreamManager()

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

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

initSdk(settings)

Inicjuje pakiet SDK.

Parametr	Typ	Opis
settings	object	Opcjonalny obiekt ustawień IMA.

requestStream(streamRequest)

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

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

Parametr	Typ	Opis
streamRequest	object

Powrót do góry

Class ima.AdBreakInfo

Pola

adPosition, duration, podIndex, timeOffset, totalAds

Metody

createAdBreakInfo

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

Właściwości

Nazwa	Typ	Opis
adPosition		Indeks reklamy w przerwie na reklamę. Wskaźnik ten dotyczy 1 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 zasobnika lub 0w przypadku reklamy przed filmem. W transmisjach na żywo nie ma reklam wyświetlanych po zakończeniu filmu. Domyślna wartość to -2. 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 zwroty1, 2, ..., n. W przypadku bloku reklamowego po filmie zwraca n+1...n+x. Domyślnie 0, jeśli ta reklama nie jest częścią bloku reklamowego lub ten blok reklamowy nie jest częścią listy odtwarzania.
timeOffset		Pozycja bloku reklamowego w treści w sekundach. Reklamy przed filmem zwracają 0, reklamy po filmie zwracają -1, a reklamy w trakcie filmu zwracają zaplanowany czas bloku reklamowego.
totalAds		Łączna liczba reklam w tej przerwie na reklamę. W przypadku reklam samodzielnych wartość wynosi 1.

createAdBreakInfo()

Zwrotyima.AdBreakInfo:

Powrót do góry

Class ima.AdEvent

Pola

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

Zdarzenia wywoływane przez menedżera reklam.

Właściwości

Nazwa	Typ	Opis
AD_PERIOD_ENDED		Wywoływane za każdym razem, gdy strumień przełącza się z reklamy lub planszy na treść. To zdarzenie zostanie uruchomione nawet wtedy, gdy reklama zostanie odtworzona po raz drugi lub gdy użytkownik przewinie reklamę.
AD_PERIOD_STARTED		Wywoływane za każdym razem, gdy strumień przełącza się z treści na reklamę lub planszę. To zdarzenie zostanie uruchomione nawet wtedy, gdy reklama zostanie odtworzona 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 głowica odtwarzania reklamy przekroczy pierwszy kwartyl.
ICON_FALLBACK_IMAGE_CLOSED		Uruchamiane, gdy użytkownik zamknie okno obrazu zastępczego ikony.
ICON_FALLBACK_IMAGE_SHOWN		Uruchamiane, gdy wyświetlany jest obraz zastępczy ikony.
MIDPOINT		Uruchamiane, gdy suwak odtwarzania reklamy przekroczy punkt środkowy.
PROGRESS		Uruchamiane, gdy nastąpi zmiana postępu reklamy.
SKIPPABLE_STATE_CHANGED		Uruchamiane, gdy zmienia się stan reklamy, którą można pominąć.
SKIPPED		Uruchamiane, gdy reklama zostanie pominięta.
START		Uruchamiane, gdy reklama zacznie się odtwarzać.
THIRD_QUARTILE		Uruchamiane, gdy głowica odtwarzania reklamy przekroczy trzeci kwartyl.

Powrót do góry

Class ima.AdInfo

Pola

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, companions, creativeAdId, creativeId, currentTime, dealId, duration, skipOffset, universalAdIDRegistry, universalAdIDValue, wrappers

Metody

createAdInfo

Zawiera informacje o reklamie. Przekazywane do wywołań zwrotnych zdarzeń przez pakiet SDK.

Właściwości

Nazwa	Typ	Opis
adBreakInfo		Informacje dotyczące całej przerwy, w której wyświetla się ta reklama.
adDescription		Opis 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 podmiot wyświetlający reklamy.
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 transakcji w łańcuchu opakowania bieżącej reklamy, zaczynając od góry.
duration		Czas trwania tej pojedynczej reklamy w sekundach lub -1, jeśli jest nieznany.
skipOffset		Czas, po którym reklamę można pominąć, lub -1, jeśli jest nieznany.
universalAdIDRegistry		Ciąg znaków używany do identyfikowania adresu URL witryny rejestru, w której katalogowany jest uniwersalny identyfikator reklamy wybranej kreacji.
universalAdIDValue		Uniwersalny identyfikator reklamy wybranej kreacji w reklamie.
wrappers		Tablica obiektów ima.WrapperInfo zawierająca informacje o otoczce tej reklamy. Kolejność będzie od zewnętrznego do wewnętrznego kodu towarzyszącego.

createAdInfo()

Zwrotyima.AdInfo:

Powrót do góry

Class ima.Companion

Pola

adSlotId, apiFramework, companionClickThrough, creativeType, height, trackingEvents, url, width

Metody

createCompanion

Zawiera informacje o kreacjach towarzyszących reklamy.

Właściwości

Nazwa	Typ	Opis
adSlotId		Identyfikator boksu reklamowego reklamy towarzyszącej. Puste, jeśli niedostępne.
apiFramework		Interfejs API potrzebny do wyświetlenia tej reklamy lub „Invalid”, jeśli jest niedostępny.
companionClickThrough		Docelowy URL komponentu towarzyszącego.
creativeType		Reprezentuje typ kreacji, zwykle typ MIME.
height		Wysokość reklamy towarzyszącej w pikselach. 0, jeśli jest niedostępna.
trackingEvents		Mapa zdarzeń śledzenia, w której kluczem jest zdarzenie, a wartością lista adresów URL, na które należy wysłać ping po wystąpieniu tego zdarzenia.
url		Adres URL zasobu statycznego tego elementu towarzyszącego.
width		Szerokość reklamy towarzyszącej w pikselach. 0, jeśli jest niedostępna.

createCompanion()

Zwrotyima.Companion:

Powrót do góry

Class ima.CuePoint

Pola

end, hasPlayed, start

Metody

createCuePoint

Zawiera informacje o punkcie wstawienia reklamy.

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, czy punkt sygnałowy został już odtworzony.
start		Czas rozpoczęcia punktu sygnałowego w sekundach. Odpowiada to przerwie na reklamę.

createCuePoint()

Zwrotyima.CuePoint:

Powrót do góry

Class ima.Error

Pola

id, info, type

Metody

createError

Obiekt przekazywany do modułu obsługi błędów, jeśli wystąpi błąd.

Właściwości

Nazwa	Typ	Opis
id		Identyfikator błędu. Listę kodów błędów znajdziesz w stałej ErrorEvent.
info		Dodatkowe informacje o błędzie.
type		Zawsze ustawiaj wartość „error”, aby wskazać typ tego obiektu.

createError()

Zwrotyima.Error:

Powrót do góry

Class ima.ErrorEvent

Pola

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

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

Właściwości

Nazwa	Typ	Opis
BAD_STREAM_REQUEST		Żądanie transmisji nie zostało poprawnie wypełnione.
COULD_NOT_LOAD_STREAM		Nie udało się wczytać transmisji.
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

Class ima.Player

Metody

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl, streamInitialized

adBreakEnded(adBreakInfo)

Opcjonalnie. Wywoływana po zakończeniu bloku reklamowego.

Parametr	Typ	Opis
adBreakInfo	ima.AdBreakInfo	Zawiera informacje o bloku reklamowym.

adBreakStarted(adBreakInfo)

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

Parametr	Typ	Opis
adBreakInfo	ima.AdBreakInfo	Zawiera informacje o bloku reklamowym.

allVideoComplete()

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

createPlayer()

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

Zwrotyima.Player:

loadUrl(streamInfo)

Wywoływana, gdy odtwarzacz powinien rozpocząć odtwarzanie adresu URL. Aby wczytać strumień, musisz zaimplementować tę metodę.

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

streamInitialized(streamInfo)

Wywoływana po zainicjowaniu strumienia.

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

Powrót do góry

Class ima.StreamFormat

Pola

DASH, HLS

Określa format strumienia.

Właściwości

Nazwa	Typ	Opis
DASH
HLS

Powrót do góry

Class ima.StreamInfo

Pola

format, manifest, streamId, streamType, subtitles

Metody

createStreamInfo

Informacje o strumieniu 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; Jeśli nie, jest nieprawidłowy.

createStreamInfo()

Zwrotyima.StreamInfo:

Powrót do góry

Class ima.StreamManager

Metody

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, loadThirdPartyStream, onMessage, replaceAdTagParameters, start

Obiekt do zarządzania odtwarzaniem strumienia.

addEventListener(event, callback)

Dodaje detektor określonego zdarzenia. Listę obsługiwanych zdarzeń znajdziesz w stałej AdEvents.

Parametr	Typ	Opis
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

Zwrotyima.StreamManager:

Parametr	Typ	Opis
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

Nieobsługiwane. Zamiast tego przesyłaj dane z reklamy towarzyszącej bezpośrednio do RAF. Ta funkcja nie jest już dostępna.

getContentTime(streamTime)

Pobiera czas w milisekundach dla strumienia VOD, który reprezentuje czas w treści bez reklam. Więcej informacji znajdziesz w najczęstszych pytaniach. Aby uzyskać czas treści dla bieżącego karnetu czasowego strumienia w -1.

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

Parametr	Typ	Opis
streamTime	Integer	Czas w strumieniu.

getCuePoints()

Zwraca wszystkie punkty sygnałowe odpowiadające wszystkim przerwom na reklamę. Dotyczy to tylko treści wideo na żądanie, w przypadku których wszystkie przerwy na reklamę są znane z wyprzedzeniem. Wszystkie czasy oznaczają czas transmisji w sekundach. W przypadku strumieni interfejsu Cloud Stitching API właściwość hasPlayed każdego kroku ima.CuePoint jest zawsze fałszywa.

Zwraca Object: tablicę ze wszystkimi punktami wskazującymi.

getPreviousCuePoint(time)

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

Zwraca ima.CuePoint: obiekt z właściwościami start, end i hasPlayed. Zwraca Nieprawidłowa, jeśli nie ma punktu wskazującego.

Parametr	Typ	Opis
time	Float	Czas, w którym należy spojrzeć w górę, -1 wskazuje bieżący czas, a w przypadku wszystkich innych transmisji zwraca Invalid.

getStreamTime(contentTime)

Pobiera czas transmisji z czasu treści VOD w milisekundach. Więcej informacji znajdziesz w najczęstszych pytaniach.

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

Parametr	Typ	Opis
contentTime	Integer	Czas 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 manifestu strumienia z wstawionymi reklamami.
streamSubtitle	ifArray>|Invalid	Napisy są powiązane ze strumieniem lub Invalid, jeśli nie ma napisów.

onMessage(msg)

Obsługuje wszystkie wiadomości pochodzące z obiektu Video. Musi być wywoływana dla każdej wiadomości odebranej na porcie roMessagePort.

Parametr	Typ	Opis
msg	object	Wiadomość z portu roVideo.

replaceAdTagParameters(adTagParameters)

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

Parametr	Typ	Opis
adTagParameters	string	Nowe parametry tagu reklamy.

start()

Rozpoczyna odtwarzanie transmisji.

Powrót do góry

Class ima.StreamRequest

Pola

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, format, networkCode, player, ppid, streamActivityMonitorId, videoId, videoObject, videoStitcherSessionOptions

Metody

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

Używane 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. Więcej informacji znajdziesz w artykule Dodawanie parametrów kierowania do strumienia. Możesz też używać parametrów dai-ot i dai-ov do określania preferencji dotyczących wariantu strumienia. Więcej informacji znajdziesz w artykule Zastępowanie parametrów wersji strumienia.
adUiNode		Węzeł wykresu sceny, w którym wyświetla się interfejs reklamy. Podczas wyświetlania reklam pakiet IMA SDK umieszcza w tym elemencie przyciski takie jak Dlaczego ta reklama? i Pomiń. Element musi zakrywać cały element wideo.
apiKey		Opcjonalnie. Klucze te mogą służyć do uwierzytelniania żądań strumieni. Klucze uwierzytelniania DAI muszą być skonfigurowane w interfejsie DFP.
assetKey		Wymagane w przypadku transmisji na żywo. Służy do określania, który strumień ma być odtwarzany. Żądanie transmisji na żywo klucz zasobu to identyfikator, który można znaleźć w interfejsie DFP.
authToken		Token autoryzacji żądania strumienia. Używany zamiast klucza interfejsu API do bardziej rygorystycznej autoryzacji treści. Wydawca może kontrolować autoryzacje poszczególnych strumieni treści na podstawie tego tokena.
contentSourceId		Wymagane w przypadku strumieni na żądanie. Parametr cmsid pochodzi ze źródła treści wideo DFP w interfejsie DFP.
customAssetKey		Niestandardowy klucz zasobu służy do określania, który strumień ma być odtwarzany. W przypadku żądań strumieniowania w ramach wyświetlania bloków reklamowych wymagane są niestandardowe klucze plików.
format		Format strumienia. Domyślna wartość to ima.StreamFormat.HLS.
networkCode		Kod sieci wydawcy, który wysyła żądanie strumienia. Kody sieci są wymagane w przypadku żądań strumieni bloków reklamowych wysyłanych za pomocą funkcji createPodLiveStreamRequest lub createPodVodStreamRequest. Te kody są też wymagane w przypadku żądań strumieni scalania w chmurze wysyłanych za pomocą funkcji createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest lub createVideoStitcherVodStreamRequestWithVodConfig. Te kody są opcjonalne i zalecane w przypadku żądań strumienia usługi pełnej wysyłanych za pomocą funkcji createLiveStreamRequest lub createVodStreamRequest. Dodanie kodu sieci powoduje zastosowanie ustawień wybranych w interfejsie Ad Managera, takich jak włączenie automatyzacji ograniczonego wyświetlania reklam. W przypadku wstawiania reklam w podcastach i łączenia w chmurze dodanie kodu sieciowego lokalizuje i odtwarza strumień. Aby znaleźć kod sieci, zapoznaj się z tym artykułem.
player		Implementacja interfejsu odtwarzacza.
ppid		Rola wycofana. Używaj parametru adTagParameters. Opcjonalnie. Odbiorcy DFP identyfikator podawany przez wydawcę.
streamActivityMonitorId		Identyfikator do debugowania strumienia za pomocą narzędzia do monitorowania aktywności w transmisji na żywo. Umożliwia to wydawcom łatwe znajdowanie dziennika strumienia w narzędziu do monitorowania aktywności w transmisji na żywo.
videoId		Wymagane w przypadku strumieni na żądanie. Identyfikator źródła treści wideo.
videoObject		Obiekt wideo (np. Video roSGNode) odpowiedzialny za odtwarzanie wideo w aplikacji klienta. Ten obiekt będzie odpytywany o różne dane, które będą używane do prawidłowego określania czasu zdarzeń ID3 w transmisji na żywo przez protokół HLS.
videoStitcherSessionOptions		Opcje sesji służą do ustawiania parametrów specyficznych dla narzędzia do łączenia filmów w przypadku żądań strumieni VideoStitcher.

createLiveStreamRequest(assetKey, apiKey, networkCode)

Inicjuje wymagane właściwości obiektu Live StreamRequest. Użycie tego interfejsu API powoduje zignorowanie wszystkich innych właściwości związanych z StreamType. Jeśli którykolwiek z wymaganych parametrów jest pustym ciągiem znaków, następuje rejestrowanie błędów, a interfejs API zwraca ogólny obiekt StreamRequest bez ignorowania właściwości.

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

Parametr	Typ	Opis
assetKey	string
apiKey	string	Parametr przypisany do zwróconej właściwości ima.StreamRequestima.StreamRequest.apiKey. Jeśli klucz interfejsu API nie istnieje, przekaż pusty ciąg.
networkCode	string	Kod sieci wydawcy, który wysyła żądanie strumienia. Dodanie kodu sieci jest opcjonalne, ale zalecane.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Inicjuje wymagane właściwości obiektu Pod Live ima.StreamRequest. Użycie tego interfejsu API powoduje zignorowanie wszystkich innych właściwości związanych z ima.StreamType. Jeśli którykolwiek z wymaganych parametrów jest pustym ciągiem znaków, następuje rejestrowanie błędów, a interfejs API zwraca ogólny obiekt StreamRequest bez ignorowania właściwości.

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

Parametr	Typ	Opis
customAssetKey	string
networkCode	string
apiKey	string	Parametr opcjonalny przypisany do właściwości ima.StreamRequest zwróconych obiektów ima.StreamRequest.apiKey; domyślnie jest to pusty ciąg znaków.

createPodVodStreamRequest(networkCode)

Inicjuje wymagane właściwości obiektu ima.StreamRequest, aby zarejestrować strumień VOD podczas korzystania z wyświetlania bloków reklamowych w ramach DAI z zewnętrznym narzędziem do łączenia filmów. Ta funkcja ustawia typ żądania na ima.StreamType.POD_VOD i sprawdza, czy wszystkie wymagane właściwości zawierają dane. W przypadku nieudanej weryfikacji w konsoli debugowania zostanie zarejestrowany błąd.

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

Parametr	Typ	Opis
networkCode	string	kod sieci Google Ad Managera;

createStreamRequest()

Zwracaima.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 spowoduje zignorowanie wszystkich innych właściwości związanych z StreamType. Jeśli którykolwiek z wymaganych parametrów jest pustym ciągiem znaków, następuje rejestrowanie błędów, a interfejs API zwraca ogólny obiekt StreamRequest bez ignorowania właściwości.

Zwraca:ima.StreamRequest ima.StreamRequest obiekt 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 sesji VOD narzędzia Video StitcherStreamRequest. Użycie tego interfejsu API spowoduje zignorowanie wszystkich innych właściwości związanych z StreamType. Jeśli którykolwiek z wymaganych parametrów jest pustym ciągiem znaków, następuje rejestrowanie błędów, a interfejs API zwraca ogólny obiekt StreamRequest bez ignorowania właściwości.

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

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 sesji VOD narzędzia Video StitcherStreamRequest za pomocą vodConfigId utworzonego w narzędziu Video Stitcher w chmurze. Użycie tego interfejsu API spowoduje zignorowanie wszystkich innych właściwości specyficznych dla StreamType. Jeśli którykolwiek z wymaganych parametrów jest pustym ciągiem znaków, następuje rejestrowanie błędów, a interfejs API zwraca ogólny obiekt StreamRequest bez ignorowania właściwości.

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

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

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Inicjuje wymagane właściwości obiektu ima.StreamRequest VOD. Użycie tego interfejsu API powoduje zignorowanie wszystkich innych właściwości specyficznych dla ima.StreamType. Jeśli którykolwiek z wymaganych parametrów jest pustym ciągiem znaków, następuje rejestrowanie błędów, a interfejs API zwraca ogólny obiekt StreamRequest bez ignorowania właściwości.

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

Parametr	Typ	Opis
contentSourceId	string
videoId	string
apiKey	string	Parametr przypisany do zwróconej właściwości ima.StreamRequestima.StreamRequest.apiKey. Jeśli klucz interfejsu API nie istnieje, przekaż pusty ciąg.
networkCode	string	Kod sieci wydawcy, który wysyła żądanie strumienia. Dodanie kodu sieci jest opcjonalne, ale zalecane.

Powrót do góry

Class ima.StreamType

Pola

NA ŻYWO, VOD

Określa typ strumienia, który ma odtwarzać odtwarzacz. Reklamy przed filmem i treści VOD powinny być odtwarzane od początku strumienia.

Właściwości

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

Powrót do góry

Class ima.WrapperInfo

Pola

adId, adSystem, creativeAdId, creativeId, dealId

Metody

createWrapperInfo

Zawiera informacje o otoczce.

Właściwości

Nazwa	Typ	Opis
adId		Identyfikator reklamy lub pusty ciąg znaków, jeśli jest nieznany.
adSystem		Zadeklarowana nazwa systemu reklamowego lub pusty ciąg znaków, jeśli jest nieznana.
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()

Zwrotyima.WrapperInfo:

Powrót do góry