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'yı 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 etkindir.

getStreamManager()

Kullanılabiliyorsa bir akış yöneticisi döndürür. Akış yöneticisi henüz kullanıma sunulmadıysa Invalid (Geçersiz) değeri döndürülür. Akış yöneticisi oluşturulurken bir hata oluştuysa hata nesnesi döndürülür.

Döndürülen değer object: Akış 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 akış isteği başlatır. Bu yöntem çağrıldıktan sonra kontrol hemen oynatıcıya döner.

Döndürür object: hata yoksa hata veya geçersiz

Parametre	Tür	Açıklama
streamRequest	object

Başa dön

Class ima.AdBreakInfo

Alanlar

adPosition, duration, 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ındaki reklamın dizini. Dizin, bağımsız reklamlar için 1'dır.
duration		Aranın saniye cinsinden maksimum süresi veya bilinmiyorsa -1.
podIndex		Canlı yayınlarda, reklam arası kimliğini pod dizini olarak veya 0 ön rulo için döndürür. Canlı yayınlarda yayın sonrası reklamlar yoktur. Varsayılan olarak -2 değerine ayarlanır. Seç-izle video (VOD) için reklam kapsülünün dizinini döndürür. Bir yayın öncesi reklam kapsülü için 0 değerini döndürür. Videonun ortasında gösterilen reklamlar için dönüşler 1, 2, ..., n. Bir yayın sonrası kapsül için n+1...n+x değerlerini döndürür. Bu reklam bir kapsülün parçası değilse veya bu kapsül bir oynatma listesinin parçası değilse varsayılan olarak 0 kullanılır.
timeOffset		Kapsülün içerikteki saniye cinsinden konumu. Videodan önce gösterilen reklamlar 0, videodan sonra gösterilen reklamlar -1 ve videonun ortasında gösterilen reklamlar, yayınlanacak içeriğin planlanan saatini döndürür.
totalAds		Bu reklam arasında yer alan reklamların toplam sayısı. Bağımsız reklamlar için değer 1'dır.

createAdBreakInfo()

İadeler ima.AdBreakInfo:

Başa dön

Class 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, reklam veya seçenek listesinden içeriğe her geçtiğinde tetiklenir. Bu etkinlik, bir reklam ikinci kez oynatıldığında veya reklamda arama yapıldığında bile tetiklenir.
AD_PERIOD_STARTED		Yayın, içerikten reklama veya seçeneğe her geçtiğinde tetiklenir. Bu etkinlik, bir reklam ikinci kez oynatıldığında veya reklamda arama yapıldığında bile tetiklenir.
COMPLETE		Reklamın oynatılması tamamlandığında tetiklenir.
ERROR		Bir hata oluştuğunda tetiklenir.
FIRST_QUARTILE		Reklam oynatma başlığı 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örüntülendiğinde tetiklenir.
MIDPOINT		Reklam video yer imleci orta noktayı geçtiğinde tetiklenir.
PROGRESS		Reklamın ilerleme durumunda güncelleme olduğunda tetiklenir.
SKIPPABLE_STATE_CHANGED		Atlanabilir reklam durumu değiştiğinde tetiklenir.
SKIPPED		Bir reklam atlandığında tetiklenir.
START		Reklam oynatılmaya başladığında tetiklenir.
THIRD_QUARTILE		Reklam oynatma başlığı üçüncü çeyreği geçtiğinde tetiklenir.

Başa dön

Class ima.AdInfo

Alanlar

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

Yöntemler

createAdInfo

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

Özellikler

Ad	Tür	Açıklama
adBreakInfo		Bu reklamın bulunduğu 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		Reklam sunan taraf tarafından tanımlanan reklamveren adı.
companions		VAST yanıtında belirtilen tamamlayıcı reklamlar.
creativeAdId		Bir reklamın ISCI (Industry Standard Commercial Identifier) kodu. Bu, VAST yanıtında seçilen reklam öğesinin Ad-ID'sidir.
creativeId		Reklam için seçilen reklam öğesinin kimliği.
currentTime		Reklamdaki geçerli süre (saniye cinsinden) veya bilinmiyorsa -1.
dealId		Geçerli reklam için sarmalayıcı zincirinde en üstten başlayarak bulunan ilk fırsat 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 gereken süre veya bilinmiyorsa -1.
universalAdIDRegistry		Seçilen reklam öğesinin evrensel reklam kimliğinin kataloglandığı kayıt defteri web sitesinin URL'sini tanımlamak için kullanılan dize.
universalAdIDValue		Reklam için seçilen reklam öğesinin Evrensel Reklam Kimliği.
wrappers		Bu reklamla ilgili sarmalayıcı bilgilerini içeren bir ima.WrapperInfo dizisi. Sıra, dış sarmalayıcıdan iç sarmalayıcıya doğru olacaktır.

createAdInfo()

İadeler ima.AdInfo:

Başa dön

Class ima.Companion

Alanlar

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

Yöntemler

createCompanion

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

Özellikler

Ad	Tür	Açıklama
adSlotId		Tamamlayıcı reklamın reklam alanı kimliği. Kullanılamıyorsa boş bırakılır.
apiFramework		Bu reklamı yürütmek için gereken API veya kullanılamıyorsa Geçersiz.
companionClickThrough		Tamamlayıcının tıklama URL'si.
creativeType		Genellikle bir MIME türü olan reklam öğesi türünü gösterir.
height		Tamamlayıcı öğenin piksel cinsinden yüksekliği. Kullanılamıyorsa 0.
trackingEvents		Anahtarın etkinlik, değerin ise bu etkinlikte ping gönderilecek URL'lerin listesi olduğu bir izleme etkinlikleri haritası.
url		Bu arkadaşın statik kaynağının URL'si.
width		Tamamlayıcı öğenin piksel cinsinden genişliği. Kullanılamıyorsa 0.

createCompanion()

İadeler ima.Companion:

Başa dön

Class ima.CuePoint

Alanlar

end, hasPlayed, start

Yöntemler

createCuePoint

İşaret noktası hakkında bilgi içerir.

Özellikler

Ad	Tür	Açıklama
end		Bir işaret noktasının bitiş zamanı (saniye cinsinden). Bu, bir reklam arasına karşılık gelir.
hasPlayed		İşaret noktasının zaten oynatılıp oynatılmadığını belirten bir boole değeri.
start		Bir işaret noktasının başlangıç zamanı (saniye). Bu, bir reklam arasına karşılık gelir.

createCuePoint()

İadeler ima.CuePoint:

Başa dön

Class 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 sabitine bakın.
info		Hatayla ilgili ek bilgiler.
type		Bu nesnenin türünü belirtmek için her zaman hata olarak ayarlayın.

createError()

İadeler ima.Error:

Başa dön

Class 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		Yayın isteği doğru şekilde doldurulmamış.
COULD_NOT_LOAD_STREAM		Akış 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

Class ima.Player

Yöntemler

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl, streamInitialized

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ıyla ilgili bilgileri içerir.

adBreakStarted(adBreakInfo)

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

Parametre	Tür	Açıklama
adBreakInfo	ima.AdBreakInfo	Reklam arasıyla ilgili bilgileri içerir.

allVideoComplete()

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

createPlayer()

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

İadeler ima.Player:

loadUrl(streamInfo)

Oynatıcının 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.

streamInitialized(streamInfo)

Bir yayın başlatıldığında çağrılır.

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ışın biçimini tanımlar.

Özellikler

Ad	Tür	Açıklama
DASH
HLS

Başa dön

Class ima.StreamInfo

Alanlar

format, manifest, streamId, streamType, subtitles

Yöntemler

createStreamInfo

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

Özellikler

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

createStreamInfo()

İadeler ima.StreamInfo:

Başa dön

Class 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 işleyici ekler. Desteklenen etkinlikler için AdEvents sabitine bakın.

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

createStreamManager(streamRequest, streamInitResponse)

İadeler ima.StreamManager:

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

enableInteractiveAds()

Desteklenmiyor. Bunun yerine, tamamlayıcı reklamdan gelen verileri doğrudan RAF'ye iletin. Bu artık bir işlem değildir.

getContentTime(streamTime)

VOD akışı için milisaniye cinsinden bir süre alır. Bu süre, içerikteki reklamsız süreyi temsil eder. Daha fazla bilgi için SSS bölümüne bakın. -1 içinde geçerli akış zamanı kartının içerik süresini almak için.

Döndürülen değer Integer: Belirtilen akış zamanına karşılık gelen içerik zamanı.

Parametre	Tür	Açıklama
streamTime	Integer	Akıştaki zaman.

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 zamanlar, saniye cinsinden yayın süresini gösterir. Cloud Stitching API akışlarında her ima.CuePoint öğesinin hasPlayed özelliği her zaman false olur.

Döndürülen değer Object: Tüm işaret noktalarını içeren bir dizi.

getPreviousCuePoint(time)

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

Döndürür ima.CuePoint: Başlangıç, bitiş ve hasPlayed özelliklerine sahip bir nesne. İşaret noktası yoksa geçersiz değerini döndürür.

Parametre	Tür	Açıklama
time	Float	Arama zamanı, -1 ile gösterilir ve diğer tüm yayınlar için Invalid döndürülür.

getStreamTime(contentTime)

Yayın için süreyi, VOD'deki içerik süresinden milisaniye cinsinden alır. Daha fazla bilgi için SSS bölümüne bakın.

Döndürülen değer Integer: Belirtilen içerik zamanına karşılık gelen yayın zamanı.

Parametre	Tür	Açıklama
contentTime	Integer	İçeriğin 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 manifestosu 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 yaklaşan reklam isteklerinde kullanılacak tüm reklam etiketi parametrelerinin yerini alır. Bu çağrının VOD yayınları için işlem yapmadığını unutmayın.

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

start()

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

Başa dön

Class 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ı bir reklam etiketi parametreleri grubunu geçersiz kılabilirsiniz. Akışınıza hedefleme parametreleri sağlama başlıklı makalede daha fazla bilgi verilmektedir. 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örüntülendiğ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 akışı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 katı içerik yetkilendirmesi için API anahtarı yerine kullanılır. Yayıncı, bu jetona göre her bir içerik akışı yetkisini kontrol edebilir.
contentSourceId		İsteğe bağlı yayınlar için gereklidir. cmsid, DFP kullanıcı arayüzündeki DFP Video İçeriği Kaynağı'ndan gelir.
customAssetKey		Hangi akışın oynatılacağını belirlemek için özel öğe anahtarı kullanılır. Pod yayınlama akışı istekleri için özel öğe anahtarları gereklidir.
format		Akışın biçimi. Varsayılan olarak ima.StreamFormat.HLS değerine ayarlanır.
networkCode		Yayın isteğinde bulunan 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 Stitching 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.
player		Oynatıcı arayüzünün bir uygulaması.
ppid		Kullanımdan kaldırıldı. adTagParameters'ı kullanın. İsteğe bağlı. DFP Audience yayıncı tarafından sağlanan tanımlayıcısı.
streamActivityMonitorId		Akışın akış etkinliği izleyicisiyle hata ayıklaması için kullanılacak kimlik. Bu parametre, yayıncıların akış etkinliği izleme aracında akış günlüğü bulmasını kolaylaştırmak 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ı.
videoObject		İstemci uygulamasında video oynatmaktan sorumlu video nesnesi (ör. Video roSGNode). Bu nesne, Canlı HLS ID3 etkinliklerinin doğru zamanlanmasında kullanılacak çeşitli veriler için yoklanır.
videoStitcherSessionOptions		Oturum seçenekleri, VideoStitcher streamRequest'leri için VideoStitcher'a özgü parametreleri ayarlamak üzere kullanılır.

createLiveStreamRequest(assetKey, apiKey, networkCode)

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

Döndürülen değer ima.StreamRequest: Gerekli Canlı özelliklere sahip ima.StreamRequest nesnesi.

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

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

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

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

Parametre	Tür	Açıklama
customAssetKey	string
networkCode	string
apiKey	string	İsteğe bağlı parametre, döndürülen ima.StreamRequest'nın ima.StreamRequest.apiKey özelliğine atanır. Varsayılan olarak boş dize kullanılır.

createPodVodStreamRequest(networkCode)

Üçüncü taraf video birleştiriciyle DAI kapsül yayınlama kullanılırken bir VOD akışını kaydetmek için ima.StreamRequest öğesinin 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ğrulama işlemleri, hata ayıklama konsoluna bir hata kaydeder.

Döndürür StreamRequest: ima.StreamRequest nesnesi. Gerekli tüm özellikler belirtilmişse istek türü ima.StreamType.POD_VOD olarak ayarlanır.

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

createStreamRequest()

Döndürülen değer ima.StreamRequest: Boş bir ima.StreamRequest nesnesi.

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

Video Birleştiricisi Canlı Oturumu'nun gerekli özelliklerini başlatır. StreamRequest Bu API'nin kullanılması, diğer tüm StreamType'ye özgü özelliklerin yoksayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dizeyse hata günlüğü oluşturulur ve API, yoksayılan özellikler olmadan genel bir StreamRequest döndürür.

Döndürür ima.StreamRequest: ima.StreamRequest gerekli VideoStitcherLive özelliklerine sahip nesne.

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ır StreamRequest. Bu API'nin kullanılması, diğer tüm StreamType'ye özgü özelliklerin yoksayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dizeyse hata günlüğü oluşturulur ve API, yoksayılan özellikler olmadan genel bir StreamRequest döndürür.

Döndürür ima.StreamRequest: ima.StreamRequest gerekli VideoStitcherVod özelliklerine sahip nesne.

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

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

Buluttan oluşturulan StreamRequest kullanılarak Video Stitcher VOD'un gerekli özelliklerini başlatır. video stitcher.vodConfigId Bu API'nin kullanılması, StreamType'ya özgü diğer tüm özelliklerin yoksayılmasına neden olur. Gerekli parametrelerden herhangi biri boş dizeyse hata günlüğü oluşturulur ve API, yoksayılan özellikler olmadan genel bir StreamRequest döndürür.

Döndürür ima.StreamRequest: ima.StreamRequest gerekli VideoStitcherVod özelliklerine sahip nesne.

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

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

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

Döndürülen ima.StreamRequest: Gerekli VOD özelliklerine sahip ima.StreamRequest nesnesi.

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

Başa dön

Class ima.StreamType

Alanlar

LIVE, VOD

Oynatıcıdan oynatması istenen yayın türünü tanımlar. Yayın öncesi reklamlar ve VOD, akışın başından itibaren oynatılmalıdır.

Özellikler

Ad	Tür	Açıklama
LIVE		Video yayında.
VOD		Video, seç-izle içerik olarak sunuluyor.

Başa dön

Class ima.WrapperInfo

Alanlar

adId, adSystem, creativeAdId, creativeId, dealId

Yöntemler

createWrapperInfo

Sarmalayıcı hakkında bilgi içerir.

Özellikler

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

createWrapperInfo()

İadeler ima.WrapperInfo:

Başa dön