IMA DAI SDK untuk 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

Metode

disableLogging, getStreamManager, initSdk, requestStream

Fungsi global yang mengontrol IMA SDK.

disableLogging()

Menonaktifkan logging SDK. Logging akan aktif secara default.

getStreamManager()

Menampilkan pengelola streaming jika tersedia. Jika pengelola streaming belum tersedia, Invalid akan ditampilkan. Jika terjadi error saat membuat pengelola streaming, objek error akan ditampilkan.

Menampilkan object: Pengelola streaming atau objek error.

initSdk(settings)

Menginisialisasi SDK.

Parameter	Jenis	Deskripsi
settings	object	Objek setelan IMA opsional.

requestStream(streamRequest)

Memulai permintaan streaming asinkron Kontrol segera kembali ke pemain setelah memanggil metode ini.

Menampilkan object: error atau tidak valid jika tidak ada error

Parameter	Jenis	Deskripsi
streamRequest	object

Kembali ke atas

Class ima.AdBreakInfo

Kolom

adPosition, duration, podIndex, timeOffset, totalAds

Metode

createAdBreakInfo

Berisi info tentang jeda iklan. Diteruskan ke callback peristiwa oleh SDK.

Properti

Nama	Jenis	Deskripsi
adPosition		Indeks iklan dalam jeda iklan. Indeksnya adalah 1 untuk iklan mandiri.
duration		Durasi maksimum jeda dalam detik, atau -1 jika tidak diketahui.
podIndex		Untuk live stream, menampilkan ID jeda sebagai indeks pod, atau 0 untuk preroll. Tidak ada postroll dalam live stream. Nilai defaultnya adalah -2. Untuk video on demand (VOD), menampilkan indeks pod iklan. Untuk pod pra-putar, menampilkan 0. Untuk mid-roll, menampilkan 1, 2, ..., n. Untuk pod postroll, menampilkan n+1...n+x. Nilai defaultnya adalah 0 jika iklan ini bukan bagian dari pod, atau pod ini bukan bagian dari playlist.
timeOffset		Posisi pod dalam konten dalam hitungan detik. Pre-roll menampilkan 0, post-roll menampilkan -1, dan mid-roll menampilkan waktu terjadwal pod.
totalAds		Jumlah total iklan yang ada dalam jeda iklan ini. Nilainya adalah 1 untuk iklan mandiri.

createAdBreakInfo()

Hasil ima.AdBreakInfo:

Kembali ke atas

Class ima.AdEvent

Kolom

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

Peristiwa yang diaktifkan oleh pengelola iklan.

Properti

Nama	Jenis	Deskripsi
AD_PERIOD_ENDED		Diaktifkan setiap kali streaming beralih dari iklan atau slate ke konten. Peristiwa ini akan diaktifkan meskipun iklan diputar untuk kedua kalinya atau saat mencari ke dalam iklan.
AD_PERIOD_STARTED		Diaktifkan setiap kali streaming beralih dari konten ke iklan atau slate. Peristiwa ini akan diaktifkan meskipun iklan diputar untuk kedua kalinya atau saat mencari ke dalam iklan.
COMPLETE		Diaktifkan saat iklan selesai diputar.
ERROR		Diaktifkan saat terjadi error.
FIRST_QUARTILE		Diaktifkan saat penunjuk waktu iklan melewati kuartil pertama.
ICON_FALLBACK_IMAGE_CLOSED		Diaktifkan saat pengguna menutup dialog gambar pengganti ikon.
ICON_FALLBACK_IMAGE_SHOWN		Diaktifkan saat gambar penggantian ikon ditampilkan.
MIDPOINT		Diaktifkan saat penunjuk pemutaran iklan melewati titik tengah.
PROGRESS		Diaktifkan saat ada pembaruan pada progres iklan.
SKIPPABLE_STATE_CHANGED		Diaktifkan saat status dapat dilewati iklan berubah.
SKIPPED		Diaktifkan saat iklan dilewati.
START		Diaktifkan saat iklan mulai diputar.
THIRD_QUARTILE		Diaktifkan saat penunjuk pemutaran iklan melewati kuartil ketiga.

Kembali ke atas

Class ima.AdInfo

Kolom

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

Metode

createAdInfo

Berisi info tentang iklan. Diteruskan ke callback peristiwa oleh SDK.

Properti

Nama	Jenis	Deskripsi
adBreakInfo		Info terkait seluruh jeda iklan tempat iklan ini berada.
adDescription		Deskripsi iklan.
adId		ID iklan atau string kosong jika tidak diketahui.
adSystem		Sistem iklan yang menyediakan materi iklan.
adTitle		Judul iklan.
advertiserName		Nama pengiklan sebagaimana ditentukan oleh pihak penayangan.
companions		Iklan pengiring yang ditentukan dalam respons VAST.
creativeAdId		Kode ISCI (Industry Standard Commercial Identifier) untuk iklan. Ini adalah Ad-ID materi iklan yang dipilih dalam respons VAST.
creativeId		ID materi iklan yang dipilih untuk iklan.
currentTime		Waktu saat ini dalam iklan dalam detik atau -1 jika tidak diketahui.
dealId		Menampilkan ID kesepakatan pertama yang ada di rantai wrapper untuk iklan saat ini, dimulai dari atas.
duration		Durasi satu iklan ini dalam detik atau -1 jika tidak diketahui.
skipOffset		Waktu yang diperlukan agar iklan dapat dilewati atau -1 jika tidak diketahui.
universalAdIDRegistry		String yang digunakan untuk mengidentifikasi URL situs pendaftaran tempat ID Iklan Universal materi iklan yang dipilih dikatalogkan.
universalAdIDValue		ID Iklan Universal materi iklan yang dipilih untuk iklan.
wrappers		Array ima.WrapperInfo dengan informasi wrapper untuk iklan ini. Urutannya adalah dari wrapper luar ke dalam.

createAdInfo()

Hasil ima.AdInfo:

Kembali ke atas

Class ima.Companion

Kolom

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

Metode

createCompanion

Berisi informasi tentang pengiring iklan.

Properti

Nama	Jenis	Deskripsi
adSlotId		ID slot iklan pengiring. Kosong jika tidak tersedia.
apiFramework		API yang diperlukan untuk mengeksekusi iklan ini, atau Tidak valid jika tidak tersedia.
companionClickThrough		URL klik-tayang pendamping.
creativeType		Mewakili creativetype, biasanya mimetype.
height		Tinggi pengiring dalam piksel. 0 jika tidak tersedia.
trackingEvents		Peta peristiwa pelacakan dengan kunci adalah peristiwa dan nilai adalah daftar URL yang akan diping saat peristiwa tersebut terjadi.
url		URL untuk resource statis pendamping ini.
width		Lebar pengiring dalam piksel. 0 jika tidak tersedia.

createCompanion()

Hasil ima.Companion:

Kembali ke atas

Class ima.CuePoint

Kolom

end, hasPlayed, start

Metode

createCuePoint

Berisi info tentang titik tanda.

Properti

Nama	Jenis	Deskripsi
end		Waktu akhir titik cue dalam detik. Ini sesuai dengan jeda iklan.
hasPlayed		Boolean yang menunjukkan bahwa titik isyarat sudah diputar.
start		Waktu mulai untuk titik cue dalam detik. Ini sesuai dengan jeda iklan.

createCuePoint()

Hasil ima.CuePoint:

Kembali ke atas

Class ima.Error

Kolom

id, info, type

Metode

createError

Objek yang diteruskan ke pengendali error jika ada error.

Properti

Nama	Jenis	Deskripsi
id		ID error. Lihat konstanta ErrorEvent untuk mengetahui daftar kode error.
info		Informasi tambahan tentang error.
type		Selalu disetel ke error untuk menunjukkan jenis objek ini.

createError()

Hasil ima.Error:

Kembali ke atas

Class ima.ErrorEvent

Kolom

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

Semua error yang mungkin dikirim kembali oleh SDK.

Properti

Nama	Jenis	Deskripsi
BAD_STREAM_REQUEST		Permintaan streaming tidak diisi dengan benar.
COULD_NOT_LOAD_STREAM		Aliran data tidak dapat dimuat.
ERROR		Error tidak diketahui.
INVALID_RESPONSE		Respons server tidak valid.
STREAM_API_KEY_NOT_VALID		Kunci API yang diberikan tidak diterima oleh server.

Kembali ke atas

Class ima.Player

Metode

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl, streamInitialized

adBreakEnded(adBreakInfo)

Opsional. Dipanggil saat jeda iklan telah berakhir.

Parameter	Jenis	Deskripsi
adBreakInfo	ima.AdBreakInfo	Berisi informasi tentang jeda iklan.

adBreakStarted(adBreakInfo)

Opsional. Dipanggil saat jeda iklan telah dimulai.

Parameter	Jenis	Deskripsi
adBreakInfo	ima.AdBreakInfo	Berisi informasi tentang jeda iklan.

allVideoComplete()

Opsional. Dipanggil saat semua video selesai.

createPlayer()

Membuat objek IMA Player kosong. Anda harus menerapkan fungsi loadUrl untuk memutar iklan. Fungsi lainnya bersifat opsional.

Hasil ima.Player:

loadUrl(streamInfo)

Dipanggil saat pemutar harus mulai memutar URL. Anda harus mengimplementasikan metode ini untuk memuat streaming.

Parameter	Jenis	Deskripsi
streamInfo	ima.StreamInfo	Berisi informasi yang diperlukan untuk memutar konten.

streamInitialized(streamInfo)

Dipanggil saat aliran telah diinisialisasi.

Parameter	Jenis	Deskripsi
streamInfo	ima.StreamInfo	Berisi informasi yang diperlukan untuk memutar konten.

Kembali ke atas

Class ima.StreamFormat

Kolom

DASH, HLS

Menentukan format aliran.

Properti

Nama	Jenis	Deskripsi
DASH
HLS

Kembali ke atas

Class ima.StreamInfo

Kolom

format, manifest, streamId, streamType, subtitles

Metode

createStreamInfo

Informasi yang diteruskan dari SDK ke pemutar tentang streaming.

Properti

Nama	Jenis	Deskripsi
format		Format video: hls atau dash. Ditentukan dalam ima.StreamFormat.
manifest		URL untuk streaming.
streamId		ID unik untuk streaming.
streamType		Jenis video: live atau on demand. Ditentukan dalam ima.StreamType.
subtitles		Subtitel, jika tersedia. Tidak valid jika tidak.

createStreamInfo()

Hasil ima.StreamInfo:

Kembali ke atas

Class ima.StreamManager

Metode

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

Objek untuk mengelola pemutaran streaming.

addEventListener(event, callback)

Menambahkan pemroses untuk peristiwa yang ditentukan. Lihat konstanta AdEvents untuk peristiwa yang didukung.

Parameter	Jenis	Deskripsi
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

Hasil ima.StreamManager:

Parameter	Jenis	Deskripsi
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

Tidak didukung. Sebagai gantinya, teruskan data dari iklan pengiring ke RAF secara langsung. Sekarang tidak ada operasi.

getContentTime(streamTime)

Mendapatkan waktu dalam milidetik untuk streaming VOD, yang merepresentasikan waktu dalam konten tanpa iklan. Untuk mengetahui detail selengkapnya, lihat FAQ. Untuk mendapatkan waktu konten untuk waktu streaming saat ini, teruskan -1.

Menampilkan Integer: Waktu konten yang sesuai dengan waktu streaming yang diberikan.

Parameter	Jenis	Deskripsi
streamTime	Integer	Waktu dalam streaming.

getCuePoints()

Menampilkan semua titik cuplikan yang sesuai dengan semua jeda iklan. Hal ini hanya valid untuk konten video on demand yang semua jeda iklannya diketahui sebelumnya. Semua waktu mewakili waktu streaming dalam detik. Untuk streaming Cloud Stitching API, properti hasPlayed dari setiap ima.CuePoint selalu salah (false).

Menampilkan Object: Array dengan semua titik isyarat.

getPreviousCuePoint(time)

Menampilkan titik cue yang mendahului waktu ini. Titik cue menunjukkan jeda iklan. Semua waktu mewakili waktu streaming dalam detik.

Mengembalikan ima.CuePoint: Objek dengan start, end, dan hasPlayed. Menampilkan Tidak Valid jika tidak ada titik tanda yang tersedia.

Parameter	Jenis	Deskripsi
time	Float	Waktu untuk mencari, -1 menunjukkan waktu saat ini, dan menampilkan Invalid untuk semua streaming lainnya.

getStreamTime(contentTime)

Mendapatkan waktu untuk streaming dari waktu konten untuk VOD dalam milidetik. Untuk mengetahui detail selengkapnya, lihat FAQ.

Menampilkan Integer: Waktu streaming yang sesuai dengan waktu konten yang diberikan.

Parameter	Jenis	Deskripsi
contentTime	Integer	Waktu konten.

loadThirdPartyStream(streamManifest, streamSubtitle)

Memuat metadata iklan dan memanggil fungsi loadUrl dengan data streamManifestUrl dan streamSubtitle yang diberikan. Fungsi ini hanya berfungsi jika jenis permintaan streaming adalah ima.StreamType.POD_VOD.

Parameter	Jenis	Deskripsi
streamManifest	string	URL manifes streaming dengan iklan yang digabungkan.
streamSubtitle	ifArray>|Invalid	Subtitel yang terkait dengan streaming, atau Invalid jika tidak ada.

onMessage(msg)

Menangani semua pesan yang berasal dari objek Video. Harus dipanggil untuk setiap pesan yang diterima di roMessagePort.

Parameter	Jenis	Deskripsi
msg	object	Pesan dari port roVideo.

replaceAdTagParameters(adTagParameters)

Mengganti semua parameter tag iklan yang akan digunakan untuk permintaan iklan berikutnya di live stream. Perhatikan bahwa panggilan ini tidak beroperasi untuk streaming VOD.

Parameter	Jenis	Deskripsi
adTagParameters	string	Parameter tag iklan baru.

start()

Memulai pemutaran streaming.

Kembali ke atas

Class ima.StreamRequest

Kolom

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

Metode

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

Digunakan untuk menentukan properti permintaan streaming.

Properti

Nama	Jenis	Deskripsi
adTagParameters		Opsional. Anda dapat mengganti serangkaian parameter tag iklan terbatas pada permintaan streaming. Menyediakan parameter penargetan ke streaming Anda memberikan informasi selengkapnya. Anda juga dapat menggunakan parameter dai-ot dan dai-ov untuk preferensi varian streaming. Lihat Mengganti parameter varian streaming untuk mengetahui informasi selengkapnya.
adUiNode		Node grafik adegan tempat UI iklan ditampilkan. IMA menempatkan elemen seperti tombol Mengapa Iklan Ini dan Lewati pada elemen ini selama iklan. Elemen harus menutupi seluruh elemen video.
apiKey		Opsional. Kunci ini dapat digunakan untuk mengautentikasi permintaan streaming. Kunci autentikasi DAI harus disiapkan di UI DFP.
assetKey		Diperlukan untuk live stream. Ini digunakan untuk menentukan aliran mana yang harus diputar. Kunci aset permintaan live stream adalah ID yang dapat ditemukan di UI DFP.
authToken		Token otorisasi permintaan streaming. Digunakan sebagai pengganti kunci API untuk otorisasi konten yang lebih ketat. Penerbit dapat mengontrol otorisasi setiap aliran konten berdasarkan token ini.
contentSourceId		Diperlukan untuk streaming on-demand. cmsid berasal dari Sumber Konten Video DFP di UI DFP.
customAssetKey		Kunci aset kustom digunakan untuk menentukan streaming mana yang harus diputar. Kunci aset kustom diperlukan untuk permintaan streaming penayangan pod.
format		Format streaming. Default-nya adalah ima.StreamFormat.HLS.
networkCode		Kode jaringan untuk penayang yang membuat permintaan streaming. Kode jaringan diperlukan untuk permintaan streaming penayangan Pod yang dibuat dengan createPodLiveStreamRequest atau createPodVodStreamRequest. Kode ini juga diperlukan untuk permintaan streaming penyambungan Cloud yang dibuat dengan createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, atau createVideoStitcherVodStreamRequestWithVodConfig. Kode ini bersifat opsional dan direkomendasikan untuk permintaan streaming layanan Penuh yang dibuat dengan createLiveStreamRequest atau createVodStreamRequest. Menambahkan kode jaringan menerapkan setelan yang dipilih di UI Ad Manager, seperti pengaktifan iklan terbatas terprogram. Untuk penayangan Pod dan penyambungan Cloud, penambahan kode jaringan akan menemukan dan memutar streaming. Untuk menemukan kode jaringan, lihat artikel ini.
player		Implementasi antarmuka pemutar.
ppid		Tidak digunakan lagi. Gunakan adTagParameters. Opsional. Audiens DFP ID yang diberikan penayang.
streamActivityMonitorId		ID yang akan digunakan untuk men-debug streaming dengan pemantau aktivitas streaming. ID ini digunakan untuk memberikan cara mudah bagi penayang untuk menemukan log streaming di alat pemantau aktivitas streaming.
videoId		Diperlukan untuk streaming on-demand. ID untuk sumber konten video.
videoObject		Objek video (seperti Video roSGNode) yang bertanggung jawab atas pemutaran video di aplikasi klien. Objek ini akan di-polling untuk berbagai data yang akan digunakan dalam menentukan waktu yang tepat untuk peristiwa ID3 HLS Live.
videoStitcherSessionOptions		Opsi sesi digunakan untuk menyetel parameter khusus penggabung video untuk streamRequest VideoStitcher.

createLiveStreamRequest(assetKey, apiKey, networkCode)

Melakukan inisialisasi properti yang diperlukan dari StreamRequest Live. Menggunakan API ini akan menyebabkan properti khusus StreamType lainnya diabaikan. Jika ada parameter wajib yang berupa string kosong, error akan dicatat dan API akan menampilkan StreamRequest umum, tanpa properti yang diabaikan.

Menampilkan ima.StreamRequest: Objek ima.StreamRequest dengan properti Live yang diperlukan.

Parameter	Jenis	Deskripsi
assetKey	string
apiKey	string	Parameter ditetapkan ke properti ima.StreamRequest.apiKey ima.StreamRequest yang ditampilkan. Jika tidak ada kunci API, teruskan string kosong.
networkCode	string	Kode jaringan untuk penayang yang membuat permintaan streaming. Pencantuman kode jaringan bersifat opsional, tetapi direkomendasikan.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Menginisialisasi properti yang diperlukan dari Pod Live ima.StreamRequest. Penggunaan API ini menyebabkan properti khusus ima.StreamType lainnya diabaikan. Jika ada parameter wajib yang berupa string kosong, error akan dicatat dan API akan menampilkan StreamRequest umum, tanpa properti yang diabaikan.

Menampilkan StreamRequest: Objek ima.StreamRequest dengan properti PodLive yang diperlukan.

Parameter	Jenis	Deskripsi
customAssetKey	string
networkCode	string
apiKey	string	Parameter opsional yang ditetapkan ke properti ima.StreamRequest.apiKey ima.StreamRequest yang ditampilkan; defaultnya adalah string kosong.

createPodVodStreamRequest(networkCode)

Menginisialisasi properti ima.StreamRequest yang diperlukan untuk mendaftarkan streaming VOD saat menggunakan penayangan Pod DAI dengan penyambung video pihak ketiga. Fungsi ini menetapkan jenis permintaan ke ima.StreamType.POD_VOD dan memvalidasi semua properti yang diperlukan untuk data yang tidak ada. Validasi yang gagal akan mencatat error di konsol debug.

Menampilkan StreamRequest: objek ima.StreamRequest. Jika semua properti wajib ditentukan, jenis permintaan ditetapkan ke ima.StreamType.POD_VOD.

Parameter	Jenis	Deskripsi
networkCode	string	kode jaringan Google Ad Manager

createStreamRequest()

Mengembalikan ima.StreamRequest: Objek ima.StreamRequest kosong.

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

Menginisialisasi properti yang diperlukan dari Video Stitcher Live StreamRequest. Penggunaan API ini menyebabkan properti khusus StreamType lainnya diabaikan. Jika ada parameter wajib yang berupa string kosong, error akan dicatat dan API akan menampilkan StreamRequest umum, tanpa properti yang diabaikan.

Menampilkan ima.StreamRequest: Objek ima.StreamRequest dengan properti VideoStitcherLive yang diperlukan.

Parameter	Jenis	Deskripsi
customAssetKey	string
networkCode	string
liveConfigId	string
region	string
projectNumber	string
oAuthToken	string

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

Menginisialisasi properti yang diperlukan dari Video Stitcher VOD StreamRequest. Penggunaan API ini menyebabkan properti khusus StreamType lainnya diabaikan. Jika ada parameter wajib yang berupa string kosong, error akan dicatat dan API akan menampilkan StreamRequest umum, tanpa properti yang diabaikan.

Menampilkan ima.StreamRequest: Objek ima.StreamRequest dengan properti VideoStitcherVod yang diperlukan.

Parameter	Jenis	Deskripsi
adTagUrl	string
networkCode	string
contentSourceUrl	string
region	string
projectNumber	string
oAuthToken	string

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

Menginisialisasi properti yang diperlukan dari VOD Video Stitcher StreamRequest menggunakan vodConfigId yang dibuat dari penggabung video cloud. Penggunaan API ini menyebabkan properti khusus StreamType lainnya diabaikan. Jika ada parameter wajib yang berupa string kosong, error akan dicatat dan API akan menampilkan StreamRequest umum, tanpa properti yang diabaikan.

Menampilkan ima.StreamRequest: Objek ima.StreamRequest dengan properti VideoStitcherVod yang diperlukan.

Parameter	Jenis	Deskripsi
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Melakukan inisialisasi properti yang diperlukan dari ima.StreamRequest VOD. Menggunakan API ini akan menyebabkan properti khusus ima.StreamType lainnya diabaikan. Jika ada parameter wajib yang berupa string kosong, error akan dicatat dan API akan menampilkan StreamRequest umum, tanpa properti yang diabaikan.

Menampilkan ima.StreamRequest: Objek ima.StreamRequest dengan properti VOD yang diperlukan.

Parameter	Jenis	Deskripsi
contentSourceId	string
videoId	string
apiKey	string	Parameter ditetapkan ke properti ima.StreamRequest.apiKey ima.StreamRequest yang ditampilkan. Jika tidak ada kunci API, teruskan string kosong.
networkCode	string	Kode jaringan untuk penayang yang membuat permintaan streaming. Pencantuman kode jaringan bersifat opsional, tetapi direkomendasikan.

Kembali ke atas

Class ima.StreamType

Kolom

LIVE, VOD

Mendefinisikan jenis streaming yang diminta untuk diputar oleh pemutar. Preroll dan VOD harus diputar dari awal streaming.

Properti

Nama	Jenis	Deskripsi
LIVE		Video ditayangkan.
VOD		Video tersedia sesuai permintaan.

Kembali ke atas

Class ima.WrapperInfo

Kolom

adId, adSystem, creativeAdId, creativeId, dealId

Metode

createWrapperInfo

Berisi informasi tentang wrapper.

Properti

Nama	Jenis	Deskripsi
adId		ID iklan atau string kosong jika tidak diketahui.
adSystem		Nama sistem iklan yang dinyatakan atau string kosong jika tidak diketahui.
creativeAdId		ID iklan pada materi iklan atau string kosong jika tidak diketahui.
creativeId		ID materi iklan atau string kosong jika tidak diketahui.
dealId		ID promo atau string kosong jika tidak diketahui.

createWrapperInfo()

Hasil ima.WrapperInfo:

Kembali ke atas