Sınıf: StreamRequest

Marka

StreamRequest

yeni StreamRequest()

Akış isteğinin özelliklerini belirtmek için kullanılır.

Özellikler

adTagParameters

static

Dize

İsteğe bağlıdır. Akış isteğinizde sınırlı sayıda reklam etiketi parametresini geçersiz kılabilirsiniz. Akışınıza hedefleme parametreleri sağlayın daha fazla bilgi sağlar. Akış varyantı tercihi için dai-ot ve dai-ov parametrelerini de kullanabilirsiniz. Daha fazla bilgi için Akış değişkeni parametrelerini geçersiz kılma konusuna bakın.

adUiNode

static

roSGNode

Reklam kullanıcı arayüzünün görüntülendiği sahne grafiği düğümü. IMA, reklamlar sırasında bu öğeye Bu Reklam Neden? ve Atla düğmeleri gibi öğeler yerleştirir. Öğe, video öğesinin tamamını kaplamalıdır.

apiKey

static

Dize

İsteğe bağlıdır. Bu anahtarlar akış isteklerini doğrulamak için kullanılabilir. DAI kimlik doğrulama anahtarları DFP kullanıcı arayüzünde ayarlanmalıdır.

assetKey

static

Dize

Canlı yayınlar için gereklidir. Hangi akışın oynatılacağını belirlemek için kullanılır. Canlı yayın isteği varlık anahtarı, DFP kullanıcı arayüzünde bulunabilen bir tanımlayıcıdır.

authToken

static

Dize

Akış isteği yetkilendirme belirteci. Daha katı içerik yetkilendirmesi için API anahtarı yerine kullanılır. Yayıncı, bu token'a dayalı olarak bireysel içerik akışlarının yetkilendirmelerini kontrol edebilir.

contentSourceId

static

Dize

İsteğe bağlı yayınlar için gereklidir. cmsid değeri, DFP kullanıcı arayüzündeki DFP video içeriği kaynağından alınır.

customAssetKey

static

Dize

Özel varlık anahtarı hangi akışın oynatılacağını belirlemek için kullanılır. Pod hizmet akışı istekleri için özel varlık anahtarları gereklidir.

biçim

static

ima.StreamFormat

Yayının formatı. Varsayılan olarak ima.StreamFormat.HLS.

networkCode

static

Dize

Yayın isteğinde bulunan yayıncının ağ kodu. createPodLiveStreamRequest veya createPodVodStreamRequest ile yapılan pod yayınlama akışı istekleri için ağ kodları gerekir. Bu kodlar, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest veya createVideoStitcherVodStreamRequestWithVodConfig ile yapılan Cloud birleştirme akışı istekleri için de gereklidir. Bu kodlar isteğe bağlıdır ve createLiveStreamRequest veya createVodStreamRequest ile yapılan tam hizmet akışı istekleri için önerilir. Ağ kodunun eklenmesi, Ad Manager kullanıcı arayüzünde seçilen ayarları (ör. programatik sınırlı reklamların etkinleştirilmesi) uygular. Pod yayını ve Cloud stitching için ağ kodunun eklenmesi, akışı bulup oynatır. Ağ kodunu bulmak için bu makaleyi inceleyin.

oynatıcı

static

(ima.Player veya Geçersiz)

Oynatıcı arayüzünün bir uygulaması.

ppid

static

Dize

Kullanımdan kaldırıldı. adTagParameters'ı kullanın. İsteğe bağlıdır. DFP Audience yayıncı tarafından sağlanan tanımlayıcısı.

streamActivityMonitorId

static

Dize

Akış etkinliği izleyicisi ile akışı hata ayıklamak için kullanılacak kimlik. Bu, yayıncıların akış etkinliği izleme aracında bir akış günlüğünü bulmalarına olanak tanıyan kullanışlı bir yol sağlamak için kullanılır.

videoId

static

Dize

İsteğe bağlı yayınlar için gereklidir. Video içerik kaynağının tanımlayıcısı.

videoObject

static

(roVideo veya Geçersiz)

İstemci uygulamasında video oynatmaktan sorumlu video nesnesi (örneğin, Video roSGNode). Bu nesne, Canlı HLS ID3 olaylarının doğru zamanlamasını sağlamak için kullanılacak çeşitli veriler için sorgulanacaktır.

videoStitcherSessionOptions

static

V dizisi

Oturum seçenekleri, VideoStitcher streamRequests için video sticher'a özgü parametreleri ayarlamak için kullanılır.

Yöntemler

createLiveStreamRequest

static

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

Bir Live'ın StreamRequest gerekli özelliklerini başlatır. Bu API'nin kullanılması, StreamType'ya özgü diğer tüm özelliklerin yoksayılmasına neden olur. Zorunlu parametrelerden herhangi biri boş dizeyse hata günlüğü oluşturulur ve API, yoksayılan özellikler olmadan genel bir StreamRequest döndürür.

Parametre

assetKey

dize

apiKey

dize

Döndürülen ima.StreamRequest'nin ima.StreamRequest.apiKey özelliğine atanan parametre. Eğer API anahtarı yoksa boş bir dize geçirin.

networkCode

dize

Yayıncının yayın isteğinde bulunduğu ağ kodu. Ağ kodunu eklemek isteğe bağlıdır ancak önerilir.

İadeler

Zorunlu Canlı özelliklere sahip ima.StreamRequest ima.StreamRequest nesnesi.

createPodLiveStreamRequest

static

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey) StreamRequest döndürür

Bir Pod Live ima.StreamRequest için gerekli özellikleri başlatır. Bu API'nin kullanılması, ima.StreamType'ya özgü diğer tüm özelliklerin yoksayılmasına neden olur. Zorunlu parametrelerden herhangi biri boş dizeyse hata günlüğü oluşturulur ve API, yoksayılan özellikler olmadan genel bir StreamRequest döndürür.

Parametre

customAssetKey

dize

networkCode

dize

apiKey

dize

Döndürülen ima.StreamRequest'nin ima.StreamRequest.apiKey özelliğine atanan isteğe bağlı parametre; varsayılan olarak boş dizedir.

İadeler

Gerekli PodLive özelliklerine sahip StreamRequest ima.StreamRequest nesnesi.

createPodVodStreamRequest

static

createPodVodStreamRequest(networkCode) returns StreamRequest

Üçüncü taraf bir video birleştiriciyle DAI Pod hizmeti kullanıldığında bir VOD akışını kaydetmek için ima.StreamRequest'nin gerekli özelliklerini başlatır. Bu işlev, istek türünü ima.StreamType.POD_VOD olarak ayarlar ve eksik veriler için gerekli tüm özellikleri doğrular. Başarısız doğrulamalar hata ayıklama konsolunda bir hata kaydına neden olur.

Parametre

networkCode

dize

Google Reklam Yöneticisi ağ kodu

İadeler

StreamRequest bir ima.StreamRequest nesnesi. Gerekli tüm özellikler belirtilirse, istek türü ima.StreamType.POD_VOD olarak ayarlanır.

createStreamRequest

static

createStreamRequest() ima.StreamRequest değerini döndürür

İadeler

ima.StreamRequest Boş bir ima.StreamRequest nesnesi.

createVideoStitcherLiveStreamRequest

static

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken) ima.StreamRequest değerini döndürür

Video Stitcher Live StreamRequest'ın gerekli özelliklerini başlatır. Bu API'nin kullanılması, StreamType'a özgü diğer tüm özelliklerin yok sayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dizelerse, hata kaydı oluşur ve API, hiçbir özelliğin göz ardı edilmediği genel bir StreamRequest döndürür.

Parametre

customAssetKey

dize

networkCode

dize

liveConfigId

dize

bölge

dize

projectNumber

dize

oAuthToken

dize

İadeler

Gerekli VideoStitcherLive özelliklerine sahip ima.StreamRequest ima.StreamRequest nesnesi.

createVideoStitcherVodStreamRequest

static

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken) ima.StreamRequest değerini döndürür

Video Stitcher VOD StreamRequest'un gerekli özelliklerini başlatır. Bu API'nin kullanılması, StreamType'a özgü diğer tüm özelliklerin yok sayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dizelerse, hata kaydı oluşur ve API, hiçbir özelliğin göz ardı edilmediği genel bir StreamRequest döndürür.

Parametre

adTagUrl

dize

networkCode

dize

contentSourceUrl

dize

bölge

dize

projectNumber

dize

oAuthToken

dize

İadeler

Gerekli VideoStitcherVod özelliklerine sahip ima.StreamRequest ima.StreamRequest nesnesi.

createVideoStitcherVodStreamRequestWithVodConfig

static

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken) ima.StreamRequest değerini döndürür

Bulut video birleştiricisinden oluşturulan vodConfigId kullanılarak bir Video Birleştirici VOD StreamRequest'nin gerekli özellikleri başlatılır. Bu API'nin kullanılması, StreamType'a özgü diğer tüm özelliklerin yok sayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dizelerse, hata kaydı oluşur ve API, hiçbir özelliğin göz ardı edilmediği genel bir StreamRequest döndürür.

Parametre

vodConfigId

dize

networkCode

dize

bölge

dize

projectNumber

dize

oAuthToken

dize

İadeler

Gerekli VideoStitcherVod özelliklerine sahip ima.StreamRequest ima.StreamRequest nesnesi.

createVodStreamRequest

static

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

VOD ima.StreamRequest'un gerekli özelliklerini başlatır. Bu API'nin kullanılması, ima.StreamType'a özgü diğer tüm özelliklerin yok sayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dizelerse, hata kaydı oluşur ve API, hiçbir özelliğin göz ardı edilmediği genel bir StreamRequest döndürür.

Parametre

contentSourceId

dize

videoId

dize

apiKey

dize

Döndürülen ima.StreamRequest'nin ima.StreamRequest.apiKey özelliğine atanan parametre. Eğer API anahtarı yoksa boş bir dize geçirin.

networkCode

dize

Yayıncının yayın isteğinde bulunduğu ağ kodu. Ağ kodunu eklemek isteğe bağlıdır ancak önerilir.

İadeler

Gerekli VOD özelliklerine sahip ima.StreamRequest ima.StreamRequest nesnesi.