Klasa: StreamRequest

ima.StreamRequest

class   static

Zespół

StreamRequest

nowy StreamRequest()

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

Właściwości

adTagParameters

static

Ciąg znaków

Opcjonalnie: Możesz zastąpić ograniczony zestaw parametrów tagu reklamy w żądaniu strumienia. Więcej informacji znajdziesz w sekcji Podaj parametry docelowe strumienia. Można również użyć parametrów dai-ot i dai-ov w celu określenia preferencji wariantu strumienia. Więcej informacji znajdziesz w sekcji Zastępowanie parametrów wariantów strumienia.

adUiNode

static

roSGNode

Węzeł grafu sceny, w którym wyświetlany jest interfejs użytkownika reklamy. IMA umieszcza w tym elemencie podczas reklam elementy takie jak przyciski Dlaczego ta reklama? i Pomiń. Element musi nakładać się na cały element wideo.

apiKey

static

Ciąg znaków

Opcjonalnie: Klucze te można wykorzystać do uwierzytelniania żądań przesyłania strumieniowego. Klucze uwierzytelniania DAI muszą zostać skonfigurowane w interfejsie użytkownika DFP.

assetKey

static

Ciąg znaków

Wymagane w przypadku transmisji na żywo. Służy do określenia, który strumień ma zostać odtworzony. Klucz zasobu żądania transmisji na żywo to identyfikator, który można znaleźć w interfejsie użytkownika DFP.

authToken

static

Ciąg znaków

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

static

Ciąg znaków

Wymagane w przypadku strumieni na żądanie. Parametr cmsid pochodzi ze źródła treści wideo DFP w interfejsie DFP.

customAssetKey

static

Ciąg znaków

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.

reklamy

static

ima.StreamFormat

Format strumienia. Domyślnie: ima.StreamFormat.HLS.

networkCode

static

Ciąg znaków

Kod sieciowy wydawcy wysyłającego żądanie strumienia. Kody sieciowe są wymagane do żądania strumieniowania w ramach usługi Pod za pomocą polecenia createPodLiveStreamRequest lub createPodVodStreamRequest. Kody te są również wymagane w przypadku żądań strumieniowania w chmurze składanych za pomocą polecenia createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest lub createVideoStitcherVodStreamRequestWithVodConfig. Kody te są opcjonalne i zalecane w przypadku żądań pełnego strumieniowania składanych za pomocą createLiveStreamRequest lub createVodStreamRequest. Dodanie kodu sieciowego powoduje zastosowanie ustawień wybranych w interfejsie użytkownika Menedżera reklam, takich jak włączanie ograniczonych reklam programowych. W przypadku udostępniania Podów i łączenia chmur dodanie kodu sieciowego lokalizuje i odtwarza strumień. Aby znaleźć kod sieciowy, zapoznaj się z tym artykułem.

zawodnik

static

(ima.Player lub nieprawidłowy)

Implementacja interfejsu gracza.

ppid

static

Ciąg znaków

Rola wycofana. Używaj parametru adTagParameters. Opcjonalnie: Odbiorcy DFP identyfikator podawany przez wydawcę.

streamActivityMonitorId

static

Ciąg znaków

Identyfikator, który należy wykorzystać do debugowania strumienia za pomocą monitora aktywności strumienia. Umożliwia to wydawcom wygodne znalezienie dziennika transmisji strumieniowej w narzędziu do monitorowania aktywności transmisji strumieniowej.

videoId

static

Ciąg znaków

Wymagane w przypadku strumieni na żądanie. Identyfikator źródła treści wideo.

videoObject

static

(roVideo lub Invalid)

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

static

Tablica V

Opcje sesji służą do ustawiania parametrów specyficznych dla narzędzia do łączenia filmów w przypadku żądań strumieni VideoStitcher.

Metody

createLiveStreamRequest

static

createLiveStreamRequest(assetKey, apiKey, networkCode) returns ima.StreamRequest

Inicjuje wymagane właściwości obiektu Live StreamRequest. Użycie tego interfejsu API powoduje ignorowanie 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 i interfejs API zwraca ogólny StreamRequest, bez ignorowania żadnych właściwości.

Parametr
assetKey	ciąg znaków
apiKey	ciąg znaków Parametr przypisany do zwróconej właściwości ima.StreamRequest.apiKey obiektu ima.StreamRequest. Jeśli klucz API nie istnieje, przekaż pusty ciąg.
networkCode	ciąg znaków Kod sieciowy dla wydawcy wysyłającego żądanie transmisji strumieniowej. Podanie kodu sieciowego jest opcjonalne, ale zalecane.

Zwroty

Obiekt ima.StreamRequest ima.StreamRequest z wymaganymi właściwościami Live.

createPodLiveStreamRequest

static

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) zwraca StreamRequest

Inicjuje wymagane właściwości Pod Live ima.StreamRequest. Użycie tego interfejsu API powoduje ignorowanie 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 i interfejs API zwraca ogólny StreamRequest, bez ignorowania żadnych właściwości.

Parametr
customAssetKey	ciąg znaków
networkCode	ciąg znaków
apiKey	ciąg znaków Opcjonalny parametr przypisany do właściwości ima.StreamRequest.apiKey zwracanego ima.StreamRequest; domyślnie jest to pusty ciąg.

Zwroty

Obiekt StreamRequest ima.StreamRequest z wymaganymi właściwościami PodLive.

createPodVodStreamRequest

static

createPodVodStreamRequest(networkCode) zwraca StreamRequest

Inicjuje wymagane właściwości ima.StreamRequest w celu zarejestrowania strumienia VOD podczas korzystania z obsługi DAI Pod z zewnętrznym programem do łączenia wideo. Ta funkcja ustawia typ żądania na ima.StreamType.POD_VOD i sprawdza, czy wszystkie wymagane właściwości nie zawierają brakujących danych. Nieudane walidacje spowodują zarejestrowanie błędu w konsoli debugowania.

Parametr
networkCode	ciąg znaków kod sieciowy Menedżera reklam Google

Zwroty

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

createStreamRequest

static

createStreamRequest() zwraca ima.StreamRequest

Zwroty

ima.StreamRequest Pusty obiekt ima.StreamRequest.

createVideoStitcherLiveStreamRequest

static

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) zwraca ima.StreamRequest

Inicjuje wymagane właściwości Video Stitcher Live StreamRequest. Użycie tego interfejsu API powoduje ignorowanie 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 i interfejs API zwraca ogólny StreamRequest, bez ignorowania żadnych właściwości.

Parametr
customAssetKey	ciąg znaków
networkCode	ciąg znaków
liveConfigId	ciąg znaków
region	ciąg znaków
projectNumber	ciąg znaków
oAuthToken	ciąg znaków

Zwroty

Obiekt ima.StreamRequest ima.StreamRequest z wymaganymi właściwościami VideoStitcherLive.

createVideoStitcherVodStreamRequest

static

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) returns ima.StreamRequest

Inicjuje wymagane właściwości Video Stitcher VOD StreamRequest. Użycie tego interfejsu API powoduje ignorowanie 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 i interfejs API zwraca ogólny StreamRequest, bez ignorowania żadnych właściwości.

Parametr
adTagUrl	ciąg znaków
networkCode	ciąg znaków
contentSourceUrl	ciąg znaków
region	ciąg znaków
projectNumber	ciąg znaków
oAuthToken	ciąg znaków

Zwroty

Obiekt ima.StreamRequest ima.StreamRequest z wymaganymi właściwościami VideoStitcherVod.

createVideoStitcherVodStreamRequestWithVodConfig

static

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) zwraca ima.StreamRequest

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 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 błąd StreamRequest bez ignorowania właściwości.

Parametr
vodConfigId	ciąg znaków
networkCode	ciąg znaków
region	ciąg znaków
projectNumber	ciąg znaków
oAuthToken	ciąg znaków

Zwroty

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

createVodStreamRequest

static

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode) zwraca ima.StreamRequest

Inicjuje wymagane właściwości VOD ima.StreamRequest. Użycie tego interfejsu API powoduje ignorowanie 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 i interfejs API zwraca ogólny StreamRequest, bez ignorowania żadnych właściwości.

Parametr
contentSourceId	ciąg znaków
videoId	ciąg znaków
apiKey	ciąg znaków Parametr przypisany do zwróconej właściwości ima.StreamRequest.apiKey obiektu ima.StreamRequest. Jeśli klucz API nie istnieje, przekaż pusty ciąg.
networkCode	ciąg znaków Kod sieciowy dla wydawcy wysyłającego żądanie transmisji strumieniowej. Podanie kodu sieciowego jest opcjonalne, ale zalecane.

Zwroty

Obiekt ima.StreamRequest ima.StreamRequest z wymaganymi właściwościami VOD.