Roku için IMA DAI SDK'sı

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

Yöntemler

disableLogging, getStreamManager, initSdk, requestStream

IMA SDK'sını kontrol eden genel işlevler.

disableLogging()

SDK günlük kaydını devre dışı bırakır. Günlüğe kaydetme özelliği varsayılan olarak açıktır.

getStreamManager()

Varsa bir akış yöneticisi döndürür. Akış yöneticisi henüz kullanılamıyorsa geçersiz değeri döndürülür. Akış yöneticisi oluşturulurken hata oluştuysa bir hata nesnesi döndürülür.

object döndürür: Yayın yöneticisi veya hata nesnesi.

initSdk(settings)

SDK'yı başlatır.

Parametre	Tür	Açıklama
settings	object	İsteğe bağlı IMA ayarları nesnesi.

requestStream(streamRequest)

Asenkron bir yayın isteği başlatır. Bu yöntem çağrıldıktan sonra kontrol hemen oynatıcıya geri döner.

object döndürür: Hata varsa hata, hata yoksa geçersiz

Parametre	Tür	Açıklama
streamRequest	object

Başa dön

Sınıf ima.AdBreakInfo

Alanlar

adPosition, süre, podIndex, timeOffset, totalAds

Yöntemler

createAdBreakInfo

Reklam arası hakkında bilgi içerir. SDK tarafından etkinlik geri çağırma işlevlerine iletilir.

Özellikler

Ad	Tür	Açıklama
adPosition		Reklam arasının reklamı. Bağımsız reklamlar için dizin 1'tür.
duration		Aranın saniye cinsinden maksimum süresi veya bilinmiyorsa -1.
podIndex		Canlı yayınlar için pod dizini olarak ara kimliğini döndürür. Reklam öncesi için 0 döndürür. Canlı yayınlarda son reklamlar gösterilmez. Varsayılan olarak -2 değerine ayarlanır. Seç-izle video (VOD) için reklam kapsülünün dizini döndürülür. Reklam öncesi kapsül için 0 döndürülür. Videonun ortasında gösterilen reklamlar için 1, 2, ..., n değerlerini döndürür. Sonraki reklam kapsülü için n+1...n+x döndürülür. Bu reklam bir kapsülün parçası değilse veya bu kapsül bir oynatma listesinin parçası değilse varsayılan değeri 0 olur.
timeOffset		Kapsülün içerikteki konumu (saniye cinsinden). Videodan önce gösterilen reklamlar 0, videodan sonra gösterilen reklamlar -1 ve videonun ortasında gösterilen reklamlar kapsülün planlanan zamanını döndürür.
totalAds		Bu reklam arasının içerdiği toplam reklam sayısı. Bağımsız reklamlar için değer 1 olur.

createAdBreakInfo()

ima.AdBreakInfo döndürür:

Başa dön

Sınıf ima.AdEvent

Alanlar

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

Reklam yöneticisi tarafından tetiklenen etkinlikler.

Özellikler

Ad	Tür	Açıklama
AD_PERIOD_ENDED		Yayın reklamdan veya seçenek listesinden içeriğe her geçiş yaptığında tetiklenir. Bu etkinlik, bir reklam ikinci kez oynatıldığında veya bir reklama atlandığında bile tetiklenir.
AD_PERIOD_STARTED		Yayın içerikten reklama veya seçenek listesine her geçiş yaptığında tetiklenir. Bu etkinlik, bir reklam ikinci kez oynatıldığında veya bir reklama atlandığında bile tetiklenir.
COMPLETE		Reklamın oynatılması tamamlandığında tetiklenir.
ERROR		Bir hata oluştuğunda tetiklenir.
FIRST_QUARTILE		Reklam oynatma çubuğu ilk çeyreği geçtiğinde tetiklenir.
ICON_FALLBACK_IMAGE_CLOSED		Kullanıcı simge yedek resim iletişim kutusunu kapattığında tetiklenir.
ICON_FALLBACK_IMAGE_SHOWN		Simge yedek resmi gösterildiğinde tetiklenir.
MIDPOINT		Reklam oynatma yer imleci orta noktayı geçtiğinde tetiklenir.
PROGRESS		Bir reklamın ilerleme durumunda güncelleme olduğunda tetiklenir.
SKIPPABLE_STATE_CHANGED		Bir reklamın atlanabilir durumu değiştiğinde tetiklenir.
SKIPPED		Bir reklam atlandığında tetiklenir.
START		Bir reklam oynatılmaya başladığında tetiklenir.
THIRD_QUARTILE		Reklam oynatma çubuğu üçüncü çeyreği geçtiğinde tetiklenir.

Başa dön

Sınıf ima.AdInfo

Alanlar

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

Yöntemler

createAdInfo

Reklamla ilgili bilgileri içerir. SDK tarafından etkinlik geri çağırma işlevlerine iletilir.

Özellikler

Ad	Tür	Açıklama
adBreakInfo		Bu reklamın yer aldığı aranın tamamıyla ilgili bilgiler.
adDescription		Reklamın açıklaması.
adId		Reklamın kimliği veya bilinmiyorsa boş bir dize.
adSystem		Reklam öğesini sağlayan reklam sistemi.
adTitle		Reklamın başlığı.
advertiserName		Yayınlayan taraf tarafından tanımlanan reklamveren adı.
companions		VAST yanıtında belirtilen tamamlayıcı reklamlar.
creativeAdId		Bir reklamın ISCI (Endüstri Standardı Ticari Tanımlayıcı) kodu. Bu, VAST yanıtında seçilen reklam öğesinin reklam kimliğidir.
creativeId		Reklam için seçilen reklam öğesinin kimliği.
currentTime		Bir reklamdaki mevcut süre (saniye cinsinden) veya bilinmiyorsa -1.
dealId		Mevcut reklamın sarmalayıcı zincirinde en üstten başlayarak bulunan ilk anlaşma kimliğini döndürür.
duration		Bu tek reklamın süresi saniye cinsinden veya bilinmiyorsa -1.
skipOffset		Reklamın atlanabilir hale gelmesi için geçen süre veya bilinmiyorsa -1.
universalAdIDRegistry		Seçilen reklam öğesinin Evrensel Reklam Kimliği'nin kataloglandığı sicil dairesi web sitesinin URL'sini tanımlamak için kullanılan bir dize.
universalAdIDValue		Reklam için seçilen reklam öğesinin Evrensel Reklam Kimliği.
wrappers		Bu reklamın sarmalayıcı bilgilerini içeren bir ima.WrapperInfo dizisi. Sıralama, dış sarmalayıcıdan içe doğru olacaktır.

createAdInfo()

ima.AdInfo döndürür:

Başa dön

Sınıf ima.Companion

Alanlar

apiFramework, creativeType, height, trackingEvents, url, width

Yöntemler

createCompanion

Bir reklamın tamamlayıcıları hakkında bilgi içerir.

Özellikler

Ad	Tür	Açıklama
apiFramework		Bu reklamın yürütülmesi için gereken API veya kullanılamıyorsa geçersiz.
creativeType		Reklam öğesi türünü (genellikle mime türü) temsil eder.
height		Tamamlayıcı öğenin piksel cinsinden yüksekliği. Kullanılamıyorsa 0 değerini alır.
trackingEvents		Anahtarın etkinlik, değerin ise bu etkinlikte ping'lenecek URL'lerin listesi olduğu izleme etkinliklerinin haritası.
url		Bu tamamlayıcının statik kaynağının URL'si.
width		Tamamlayıcı öğenin piksel cinsinden genişliği. Kullanılamıyorsa 0 değerini alır.

createCompanion()

ima.Companion döndürür:

Başa dön

Sınıf ima.CuePoint

Alanlar

end, hasPlayed, start

Yöntemler

createCuePoint

İşaret noktasıyla ilgili bilgileri içerir.

Özellikler

Ad	Tür	Açıklama
end		Saniye cinsinden bir işaret noktasının bitiş zamanı. Bu, bir reklam arasını gösterir.
hasPlayed		İşaretçi noktasının daha önce oynatıldığını belirten bir boole değeri.
start		Saniye cinsinden bir işaret noktasının başlangıç zamanı. Bu, bir reklam arasını gösterir.

createCuePoint()

ima.CuePoint döndürür:

Başa dön

Sınıf ima.Error

Alanlar

id, info, type

Yöntemler

createError

Hata varsa hata işleyiciye iletilen nesne.

Özellikler

Ad	Tür	Açıklama
id		Hatanın kimliği. Hata kodlarının listesi için ErrorEvent sabit değerine bakın.
info		Hatayla ilgili ek bilgiler.
type		Bu nesnenin türünü belirtmek için her zaman hata olarak ayarlanır.

createError()

ima.Error döndürür:

Başa dön

Sınıf ima.ErrorEvent

Alanlar

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

SDK'nın geri gönderebileceği tüm hatalar.

Özellikler

Ad	Tür	Açıklama
BAD_STREAM_REQUEST		Akış isteği doğru şekilde doldurulmamış.
COULD_NOT_LOAD_STREAM		Yayın yüklenemedi.
ERROR		Bilinmeyen bir hata.
INVALID_RESPONSE		Sunucu yanıtı geçerli değildi.
STREAM_API_KEY_NOT_VALID		Sağlanan API anahtarı sunucu tarafından kabul edilmedi.

Başa dön

Sınıf ima.Player

Yöntemler

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl

adBreakEnded(adBreakInfo)

İsteğe bağlı. Bir reklam arası sona erdiğinde çağrılır.

Parametre	Tür	Açıklama
adBreakInfo	ima.AdBreakInfo	Reklam arası hakkında bilgi içerir.

adBreakStarted(adBreakInfo)

İsteğe bağlı. Reklam arası başladığında çağrılır.

Parametre	Tür	Açıklama
adBreakInfo	ima.AdBreakInfo	Reklam arası hakkında bilgi içerir.

allVideoComplete()

İsteğe bağlı. Tüm video tamamlandığında çağrılır.

createPlayer()

Boş bir IMA Player nesnesi oluşturur. Reklam oynatmak için loadUrl işlevini uygulamanız gerekir. Diğer işlevler isteğe bağlıdır.

ima.Player döndürür:

loadUrl(streamInfo)

Oynatıcı bir URL'yi oynatmaya başlaması gerektiğinde çağrılır. Akış yüklemek için bu yöntemi uygulamanız gerekir.

Parametre	Tür	Açıklama
streamInfo	ima.StreamInfo	İçerik oynatmak için gereken bilgileri içerir.

Başa dön

Class ima.StreamFormat

Alanlar

DASH, HLS

Akış biçimini tanımlar.

Özellikler

Ad	Tür	Açıklama
DASH
HLS

Başa dön

Sınıf ima.StreamInfo

Alanlar

format, manifest, streamId, streamType, subtitles

Yöntemler

createStreamInfo

SDK'dan oynatıcıya yayınla ilgili iletilen bilgiler.

Özellikler

Ad	Tür	Açıklama
format		Videonun biçimi: hls veya dash. ima.StreamFormat içinde tanımlanır.
manifest		Yayının URL'si.
streamId		Akış için benzersiz bir kimlik.
streamType		Videonun türü: canlı veya seç-izle. ima.StreamType içinde tanımlanır.
subtitles		Altyazılar (varsa). Aksi takdirde geçersizdir.

createStreamInfo()

ima.StreamInfo döndürür:

Başa dön

Sınıf ima.StreamManager

Yöntemler

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

Akış oynatmayı yönetmek için kullanılan nesne.

addEventListener(event, callback)

Belirtilen etkinlik için bir dinleyici ekler. Desteklenen etkinlikler için AdEvents sabit değerine bakın.

Parametre	Tür	Açıklama
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

ima.StreamManager döndürür:

Parametre	Tür	Açıklama
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

Desteklenmiyor. Bunun yerine, tamamlayıcı reklamdaki verileri doğrudan RAF'a aktarın. Bu işlem artık yapılamaz.

getContentTime(streamTime)

VOD akışı için milisaniye cinsinden bir zaman alır. Bu zaman, reklamsız içeriğin süresini temsil eder. Daha fazla bilgi için SSS bölümünü inceleyin. Geçerli yayın zamanı için içerik süresini almak üzere -1 değerini iletin.

Integer döndürür: Belirtilen yayın süresine karşılık gelen içerik süresi.

Parametre	Tür	Açıklama
streamTime	Integer	Yayındaki saat.

getCuePoints()

Tüm reklam aralarına karşılık gelen tüm işaret noktalarını döndürür. Bu, yalnızca tüm reklam aralarının önceden bilindiği seç-izle video içerikleri için geçerlidir. Tüm süreler, saniye cinsinden aktarma süresini gösterir. Cloud Stitching API akışlarında her ima.CuePoint öğesinin hasPlayed özelliği her zaman false olur.

Object döndürür: Tüm işaret noktalarını içeren bir dizi.

getPreviousCuePoint(time)

Bu zamandan önceki işaret noktasını döndürür. İşaretçi noktası, reklam arasını gösterir. Tüm süreler, saniye cinsinden aktarma süresini gösterir.

ima.CuePoint döndürür: start, end ve hasPlayed özelliklerini içeren bir nesne. İşaretçi noktası yoksa geçersiz değerini döndürür.

Parametre	Tür	Açıklama
time	Float	Kontrol edilecek zaman. -1, mevcut zamanı gösterir ve diğer tüm akışlar için Invalid değerini döndürür.

getStreamTime(contentTime)

VOD içeriği süresinden milisaniye cinsinden yayın süresini alır. Daha fazla bilgi için SSS bölümünü inceleyin.

Integer döndürür: Belirtilen içerik süresine karşılık gelen yayın süresi.

Parametre	Tür	Açıklama
contentTime	Integer	İçeriğin yayınlanma zamanı.

loadThirdPartyStream(streamManifest, streamSubtitle)

Reklam meta verilerini yükler ve sağlanan streamManifestUrl ve streamSubtitle verileriyle loadUrl işlevini çağırır. Bu işlev yalnızca akış isteği türü ima.StreamType.POD_VOD olduğunda çalışır.

Parametre	Tür	Açıklama
streamManifest	string	Reklamların birleştirildiği yayın manifesti URL'si.
streamSubtitle	ifArray>|Invalid	Yayınla ilişkili altyazılar veya yoksa Invalid.

onMessage(msg)

Video nesnesinden gelen tüm iletileri işler. roMessagePort'ta alınan her mesaj için çağrılmalıdır.

Parametre	Tür	Açıklama
msg	object	roVideo bağlantı noktasından gelen mesaj.

replaceAdTagParameters(adTagParameters)

Bir canlı yayının incelenecek reklam istekleri için kullanılacak tüm reklam etiketi parametrelerinin yerini alır. Bu çağrının seç-izle yayınları için işlevsiz olduğunu unutmayın.

Parametre	Tür	Açıklama
adTagParameters	string	Yeni reklam etiketi parametreleri.

start()

Aktarmanın oynatılmasını başlatır.

Başa dön

Sınıf ima.StreamRequest

Alanlar

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

Yöntemler

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

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

Özellikler

Ad	Tür	Açıklama
adTagParameters		İsteğe bağlı. Akış isteğinizde sınırlı sayıda reklam etiketi parametresini geçersiz kılabilirsiniz. Akışınıza hedefleme parametreleri sağlama bölümünde daha fazla bilgi bulabilirsiniz. Akış varyantı tercihi için dai-ot ve dai-ov parametrelerini de kullanabilirsiniz. Daha fazla bilgi için Akış varyantı parametrelerini geçersiz kılma başlıklı makaleyi inceleyin.
adUiNode		Reklam kullanıcı arayüzünün gösterildiği bir sahne grafiği düğümü. IMA, reklamlar sırasında bu öğeye Neden Bu Reklam? ve Atla düğmeleri gibi öğeler yerleştirir. Öğe, video öğesinin tamamını kaplamalıdır.
apiKey		İsteğe bağlı. Bu anahtarlar, akış isteklerinin kimliğini doğrulamak için kullanılabilir. DAI kimlik doğrulama anahtarları, DFP kullanıcı arayüzünde ayarlanmalıdır.
assetKey		Canlı yayınlar için gereklidir. Bu, hangi yayının oynatılacağını belirlemek için kullanılır. Canlı yayın isteği öğe anahtarı, DFP kullanıcı arayüzünde bulunabilen bir tanımlayıcıdır.
authToken		Akış isteği yetkilendirme jetonu. Daha sıkı içerik yetkilendirmesi için API anahtarı yerine kullanılır. Yayıncı, bu jetona dayalı olarak ayrı içerik akışlarının yetkilendirmelerini kontrol edebilir.
contentSourceId		İsteğe bağlı yayınlar için gereklidir. cmsid, DFP kullanıcı arayüzündeki DFP Video İçerik Kaynaklarından gelir.
customAssetKey		Özel öğe anahtarı, hangi yayının oynatılması gerektiğini belirlemek için kullanılır. Kapsül yayın istekleri için özel öğe anahtarları gereklidir.
format		Akış biçimi. Varsayılan olarak ima.StreamFormat.HLS değerine ayarlanır.
networkCode		Akış isteği gönderen yayıncının ağ kodu. createPodLiveStreamRequest veya createPodVodStreamRequest ile yapılan kapsül yayınlama akış istekleri için ağ kodları gerekir. Bu kodlar, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest veya createVideoStitcherVodStreamRequestWithVodConfig ile yapılan Cloud dikiş 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ğ kodu eklendiğinde, Ad Manager kullanıcı arayüzünde seçilen ayarlar (ör. programatik sınırlı reklam etkinleştirme) uygulanır. Pod yayınlama ve Cloud dikiş için ağ kodu eklendiğinde akış bulunur ve oynatılır. Ağ kodunu bulmak için bu makaleyi inceleyin.
player		Oynatıcı arayüzünün bir uygulaması.
ppid		Kullanımdan kaldırıldı. adTagParameters parametresini kullanın. İsteğe bağlı. DFP Kitlesi yayıncı tarafından sağlanan tanımlayıcı.
streamActivityMonitorId		Akış etkinliği izleyiciyle akışta hata ayıklama yapmak için kullanılacak kimlik. Bu, yayıncıların akış etkinliği izleyici aracında akış günlüğünü kolayca bulmasına olanak tanımak için kullanılır.
videoId		İsteğe bağlı yayınlar için gereklidir. Video içeriği kaynağının tanımlayıcısıdır.
videoObject		İstemci uygulamasında video oynatmaktan sorumlu video nesnesi (ör. Video roSGNode). Bu nesne, canlı HLS ID3 etkinliklerini doğru şekilde zamanlamak için kullanılacak çeşitli veriler için ankete tabi tutulur.
videoStitcherSessionOptions		Oturum seçenekleri, VideoStitcher streamRequests için video dikişçiye özgü parametreleri ayarlamak amacıyla kullanılır.

createLiveStreamRequest(assetKey, apiKey, networkCode)

Canlı StreamRequest'ın zorunlu özelliklerini başlatır. Bu API'nin kullanılması, StreamType'ye özgü diğer özelliklerin yoksayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dize ise hata günlüğü oluşturulur ve API, hiçbir özelliğin yoksayılmadığı genel bir StreamRequest döndürür.

ima.StreamRequest döndürür: Zorunlu Canlı özellikleri içeren ima.StreamRequest nesnesi.

Parametre	Tür	Açıklama
assetKey	string
apiKey	string	Döndürülen ima.StreamRequest'ın ima.StreamRequest.apiKey özelliğine atanan parametre. API anahtarı yoksa boş bir dize gönderin.
networkCode	string	Akış isteği gönderen yayıncının ağ kodu. Ağ kodunu eklemek isteğe bağlıdır ancak önerilir.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Pod Live ima.StreamRequest'ın zorunlu özelliklerini başlatır. Bu API'nin kullanılması, ima.StreamType'ye özgü diğer özelliklerin yoksayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dize ise hata günlüğü oluşturulur ve API, hiçbir özelliğin yoksayılmadığı genel bir StreamRequest döndürür.

StreamRequest döndürür: Gerekli PodLive özelliklerine sahip ima.StreamRequest nesnesi.

Parametre	Tür	Açıklama
customAssetKey	string
networkCode	string
apiKey	string	Döndürülen ima.StreamRequest'ın ima.StreamRequest.apiKey mülküne atanan isteğe bağlı parametre; varsayılan olarak boş dizedir.

createPodVodStreamRequest(networkCode)

Üçüncü taraf bir video birleştirme aracıyla DAI kapsül yayını kullanılırken VOD akışı 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 gereken tüm özellikleri doğrular. Başarısız doğrulamalar, hata ayıklama konsoluna kaydedilir.

StreamRequest döndürür: ima.StreamRequest nesnesi. Gerekli tüm özellikler belirtilirse istek türü ima.StreamType.POD_VOD olarak ayarlanır.

Parametre	Tür	Açıklama
networkCode	string	Google Ad Manager ağ kodu

createStreamRequest()

ima.StreamRequest döndürür: Boş bir ima.StreamRequest nesnesi.

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

Video Birleştiricisi Canlı StreamRequest özelliğinin gerekli özelliklerini başlatır. Bu API'nin kullanılması, StreamType'ye özgü diğer özelliklerin yoksayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dize ise hata günlüğü oluşturulur ve API, hiçbir özelliğin yoksayılmadığı genel bir StreamRequest döndürür.

ima.StreamRequest döndürür: Gerekli VideoStitcherLive özellikleriyle ima.StreamRequest nesnesi.

Parametre	Tür	Açıklama
customAssetKey	string
networkCode	string
liveConfigId	string
region	string
projectNumber	string
oAuthToken	string

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

Video Stitcher VOD'un gerekli özelliklerini başlatırStreamRequest. Bu API'nin kullanılması, StreamType'ye özgü diğer özelliklerin yoksayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dize ise hata günlüğü oluşturulur ve API, hiçbir özelliğin yoksayılmadığı genel bir StreamRequest döndürür.

ima.StreamRequest döndürür: Gerekli VideoStitcherVod özelliklerine sahip ima.StreamRequest nesnesi.

Parametre	Tür	Açıklama
adTagUrl	string
networkCode	string
contentSourceUrl	string
region	string
projectNumber	string
oAuthToken	string

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

Cloud Video Birleştirici'de oluşturulan vodConfigId'yi kullanarak Video Birleştirici VOD StreamRequest'ün gerekli özelliklerini başlatır. Bu API'nin kullanılması, StreamType'ye özgü diğer özelliklerin yoksayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dize ise hata günlüğü oluşturulur ve API, hiçbir özelliğin yoksayılmadığı genel bir StreamRequest döndürür.

ima.StreamRequest döndürür: Gerekli VideoStitcherVod özelliklerine sahip ima.StreamRequest nesnesi.

Parametre	Tür	Açıklama
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

VOD'un ima.StreamRequest zorunlu özelliklerini başlatır. Bu API'nin kullanılması, ima.StreamType'ye özgü diğer özelliklerin yoksayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dize ise hata günlüğü oluşturulur ve API, hiçbir özelliğin yoksayılmadığı genel bir StreamRequest döndürür.

ima.StreamRequest döndürür: Zorunlu VOD özelliklerine sahip ima.StreamRequest nesnesi.

Parametre	Tür	Açıklama
contentSourceId	string
videoId	string
apiKey	string	Döndürülen ima.StreamRequest'ın ima.StreamRequest.apiKey özelliğine atanan parametre. API anahtarı yoksa boş bir dize gönderin.
networkCode	string	Akış isteği gönderen yayıncının ağ kodu. Ağ kodunu eklemek isteğe bağlıdır ancak önerilir.

Başa dön

Sınıf ima.StreamType

Alanlar

CANLI, Seç-izle

Oynatıcıdan oynatması istenen yayının türünü tanımlar. Ön reklamlar ve seç-izle içerikler yayının başından itibaren oynatılmalıdır.

Özellikler

Ad	Tür	Açıklama
LIVE		Video yayında.
VOD		Video, seç-izle olarak yayınlanıyor.

Başa dön

Sınıf ima.WrapperInfo

Alanlar

adId, adSystem, creativeAdId, creativeId, dealId

Yöntemler

createWrapperInfo

Sarmalayıcıyla ilgili bilgileri içerir.

Özellikler

Ad	Tür	Açıklama
adId		Reklamın kimliği veya bilinmiyorsa boş bir dize.
adSystem		Reklam sisteminin bildirilen adı veya bilinmiyorsa boş dize.
creativeAdId		Reklam öğesindeki reklam kimliği veya bilinmiyorsa boş bir dize.
creativeId		Reklam öğesinin kimliği veya bilinmiyorsa boş bir dize.
dealId		Anlaşma kimliği veya bilinmiyorsa boş dize.

createWrapperInfo()

ima.WrapperInfo döndürür:

Başa dön