Ima class
Metode
Fungsi global yang mengontrol IMA SDK.
disableLogging()
Menonaktifkan logging SDK. Logging akan diaktifkan secara default.
getStreamManager()
Menampilkan pengelola streaming jika tersedia.
Jika pengelola streaming belum tersedia, kolom Tidak Valid 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
Control akan langsung ditampilkan ke pemutar setelah memanggil metode ini.
Menampilkan object
: error atau tidak valid jika tidak ada error
Parameter | Jenis | Deskripsi |
---|---|---|
streamRequest |
object |
Class ima.AdBreakInfo
Kolom
Metode
Berisi info tentang jeda iklan. Diteruskan ke callback peristiwa oleh SDK.
Properti
Nama | Jenis | Deskripsi |
---|---|---|
adPosition |
|
Indeks iklan dalam jeda iklan. Akan menjadi 1 untuk iklan yang berdiri sendiri. |
duration |
|
Durasi jeda maksimum dalam detik, atau -1 jika tidak diketahui. |
podIndex |
|
Untuk live stream, selalu menghasilkan -1. Untuk video on-demand (VOD), menampilkan indeks pod iklan. Untuk pod preroll, menampilkan 0. Untuk mid-roll, menampilkan 1, 2, ..., n. Untuk pod post-roll, menampilkan n+1...n+x. Defaultnya adalah 0 jika iklan ini bukan bagian dari pod, atau pod ini bukan bagian dari playlist. |
timeOffset |
|
Posisi pod di dalam konten dalam hitungan detik. Pre-roll menampilkan 0, post-roll menampilkan -1, dan mid-roll menampilkan waktu pod yang dijadwalkan. |
totalAds |
|
Jumlah total iklan yang ada dalam jeda iklan ini. Akan menjadi 1 untuk iklan yang berdiri sendiri. |
createAdBreakInfo()
Menampilkan ima.AdBreakInfo
:
Class ima.AdEvent
Kolom
Peristiwa yang diaktifkan oleh pengelola iklan.
Properti
Nama | Jenis | Deskripsi |
---|---|---|
AD_PERIOD_ENDED |
|
Diaktifkan setiap kali streaming beralih dari iklan atau slate ke konten. Hal ini akan diaktifkan meskipun iklan diputar untuk kedua kalinya atau saat mencari iklan. |
AD_PERIOD_STARTED |
|
Diaktifkan setiap kali streaming beralih dari konten ke iklan atau slate (layar pemblokir). Hal ini akan diaktifkan meskipun iklan diputar untuk kedua kalinya atau saat mencari iklan. |
COMPLETE |
|
Diaktifkan saat iklan selesai diputar. |
ERROR |
|
Diaktifkan saat terjadi error. |
FIRST_QUARTILE |
|
Diaktifkan saat titik pemutaran iklan melewati kuartil pertama. |
MIDPOINT |
|
Diaktifkan saat titik pemutaran iklan melewati titik tengah. |
PROGRESS |
|
Diaktifkan saat ada pembaruan pada progres iklan. |
SKIPPABLE_STATE_CHANGED |
|
Diaktifkan saat status iklan yang dapat dilewati berubah. |
SKIPPED |
|
Diaktifkan saat iklan dilewati. |
START |
|
Diaktifkan saat iklan mulai diputar. |
THIRD_QUARTILE |
|
Diaktifkan saat titik pemutaran iklan melewati kuartil ketiga. |
Class ima.AdInfo
Kolom
Metode
Berisi info tentang iklan. Diteruskan ke callback peristiwa oleh SDK.
Properti
Nama | Jenis | Deskripsi |
---|---|---|
adBreakInfo |
|
Info terkait seluruh jeda iklan ini. |
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 seperti yang ditentukan oleh pihak yang menayangkan iklan. |
companions |
|
Iklan pengiring yang ditentukan dalam respons VAST. |
currentTime |
|
Waktu saat ini dalam iklan dalam detik atau -1 jika tidak diketahui. |
duration |
|
Durasi satu iklan ini dalam detik atau -1 jika tidak diketahui. |
universalAdIDRegistry |
|
String yang digunakan untuk mengidentifikasi URL situs registry tempat ID Iklan Universal materi iklan yang dipilih dicatat dalam katalog. |
universalAdIDValue |
|
ID Iklan Universal materi iklan yang dipilih untuk iklan. |
wrappers |
|
Array ima.WrapperInfo dengan informasi wrapper untuk iklan ini. Urutan akan berasal dari wrapper luar ke dalam. |
createAdInfo()
Menampilkan ima.AdInfo
:
Class ima.Companion
Kolom
Metode
Berisi informasi tentang pengiring iklan.
Properti
Nama | Jenis | Deskripsi |
---|---|---|
apiFramework |
|
API yang diperlukan untuk menjalankan iklan ini, atau Tidak valid jika tidak tersedia. |
creativeType |
|
Merepresentasikan creativetype, yang biasanya merupakan mimetype. |
height |
|
Tinggi pengiring dalam piksel. 0 jika tidak tersedia. |
trackingEvents |
|
Peta peristiwa pelacakan dengan kuncinya adalah peristiwa dan nilainya adalah daftar URL yang akan di-ping pada peristiwa tersebut. |
url |
|
URL untuk resource statis pengiring ini. |
width |
|
Lebar pengiring dalam piksel. 0 jika tidak tersedia. |
createCompanion()
Menampilkan ima.Companion
:
Class ima.CuePoint
Kolom
Metode
Berisi info tentang titik tanda.
Properti
Nama | Jenis | Deskripsi |
---|---|---|
end |
|
Waktu berakhir untuk titik tanda dalam detik. Hal ini sesuai dengan jeda iklan. |
hasPlayed |
|
Boolean yang menunjukkan titik tanda telah diputar. |
start |
|
Waktu mulai untuk titik tanda dalam detik. Hal ini sesuai dengan jeda iklan. |
createCuePoint()
Menampilkan ima.CuePoint
:
Class ima.Error
Kolom
Metode
Objek yang diteruskan ke pengendali error jika terjadi error.
Properti
Nama | Jenis | Deskripsi |
---|---|---|
id |
|
ID error. Lihat konstanta ErrorEvent untuk melihat daftar kode error. |
info |
|
Informasi tambahan tentang error. |
type |
|
Selalu setel ke error untuk menunjukkan jenis objek ini. |
createError()
Menampilkan ima.Error
:
Class ima.ErrorEvent
Kolom
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 |
|
Streaming tidak dapat dimuat. |
ERROR |
|
Kesalahan yang tidak diketahui. |
INVALID_RESPONSE |
|
Tanggapan server tidak valid. |
STREAM_API_KEY_NOT_VALID |
|
Kunci API yang diberikan tidak diterima oleh server. |
Class ima.Player
Metode
adBreakEnded(adBreakInfo)
Opsional. Dipanggil saat jeda iklan berakhir.
Parameter | Jenis | Deskripsi |
---|---|---|
adBreakInfo |
ima.AdBreakInfo |
Berisi informasi tentang jeda iklan. |
adBreakStarted(adBreakInfo)
Opsional. Dipanggil saat jeda iklan dimulai.
Parameter | Jenis | Deskripsi |
---|---|---|
adBreakInfo |
ima.AdBreakInfo |
Berisi informasi tentang jeda iklan. |
allVideoComplete()
Opsional. Dipanggil saat semua video selesai.
createPlayer()
Membuat objek Player
IMA kosong. Anda harus mengimplementasikan
fungsi loadUrl
untuk memutar iklan. Fungsi lainnya bersifat opsional.
Menampilkan ima.Player
:
loadUrl(streamInfo)
Dipanggil saat pemutar harus mulai memutar URL. Anda harus mengimplementasikan
metode ini untuk memuat aliran data.
Parameter | Jenis | Deskripsi |
---|---|---|
streamInfo |
ima.StreamInfo |
Berisi informasi yang diperlukan untuk memutar konten. |
Class ima.StreamFormat
Kolom
Menentukan format streaming.
Properti
Nama | Jenis | Deskripsi |
---|---|---|
DASH |
|
|
HLS |
|
Class ima.StreamInfo
Kolom
Metode
Informasi yang diteruskan dari SDK ke pemutar tentang streaming.
Properti
Nama | Jenis | Deskripsi |
---|---|---|
format |
|
Format video: hls atau tanda hubung. 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()
Menampilkan ima.StreamInfo
:
Class ima.StreamManager
Metode
Objek untuk mengelola pemutaran streaming.
addEventListener(event, callback)
Menambahkan pemroses untuk peristiwa yang ditentukan. Melihat konstanta AdEvents untuk peristiwa yang didukung.
Parameter | Jenis | Deskripsi |
---|---|---|
event |
string |
|
callback |
function |
createStreamManager(streamRequest, streamInitResponse)
Menampilkan 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.
Ini sekarang tanpa pengoperasian.
getContentTime(streamTime)
Mendapatkan waktu dalam milidetik untuk streaming VOD, yang menampilkan waktu dalam konten tanpa iklan.
Lihat: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq
Untuk mendapatkan waktu konten untuk penerusan waktu streaming saat ini di -1.
Menampilkan Integer
: Waktu konten yang sesuai dengan waktu streaming tertentu.
Parameter | Jenis | Deskripsi |
---|---|---|
streamTime |
Integer |
Waktu dalam streaming. |
getCuePoints()
Menampilkan semua titik tanda yang sesuai dengan semua jeda iklan. Hal ini hanya
berlaku untuk konten video on demand yang semua jeda iklan diketahui
sebelumnya. Semua waktu mewakili waktu streaming dalam detik.
Menampilkan Object
: Array dengan semua titik tanda.
getPreviousCuePoint(time)
Menampilkan titik tanda sebelumnya. Titik tanda menunjukkan jeda
iklan. Semua waktu mewakili waktu streaming dalam detik.
Menampilkan 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. |
getStreamTime(contentTime)
Mendapatkan waktu streaming dari waktu konten untuk VOD dalam milidetik.
Lihat: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq
Menampilkan Integer
: Waktu streaming yang sesuai dengan waktu konten tertentu.
Parameter | Jenis | Deskripsi |
---|---|---|
contentTime |
Integer |
Waktu pembuatan konten. |
loadThirdPartyStream(streamManifest, streamSubtitle)
Memuat metadata iklan dan memanggil fungsi loadUrl
dengan
data streamManifestUrl
dan streamSubtitle
yang disediakan. 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 |
Subtitel
akan dikaitkan dengan streaming, atau |
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 mendatang untuk
live stream. Perlu diperhatikan bahwa panggilan ini adalah tanpa pengoperasian untuk streaming VOD.
Parameter | Jenis | Deskripsi |
---|---|---|
adTagParameters |
string |
Parameter tag iklan baru. |
start()
Memulai pemutaran streaming.
Class ima.StreamRequest
Kolom
Metode
Digunakan untuk menentukan properti permintaan streaming.
Properti
Nama | Jenis | Deskripsi |
---|---|---|
adTagParameters |
|
Opsional. Anda dapat mengganti sekumpulan parameter tag iklan terbatas pada permintaan streaming. Sediakan parameter penargetan ke streaming Anda akan memberikan informasi lebih lanjut. 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 scene tempat UI iklan ditampilkan. IMA menempatkan elemen seperti tombol Mengapa Iklan Ini dan Lewati pada elemen ini selama iklan. Elemen tersebut harus menempatkan seluruh elemen video. |
apiKey |
|
Opsional. Kunci ini dapat digunakan untuk mengautentikasi permintaan streaming. Kunci autentikasi DAI harus disiapkan di UI DFP. |
assetKey |
|
Wajib untuk live stream. Hal ini digunakan untuk menentukan streaming 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. Penayang dapat mengontrol otorisasi streaming konten individual berdasarkan token ini. |
contentSourceId |
|
Wajib 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 pod yang menayangkan permintaan streaming. |
format |
|
Format streaming. Default-nya adalah |
networkCode |
|
Kode jaringan untuk penayang yang membuat permintaan streaming. Kode jaringan diperlukan untuk pod yang menayangkan permintaan streaming. |
player |
|
Implementasi antarmuka pemutar. |
ppid |
|
Tidak digunakan lagi. Gunakan adTagParameters. Opsional. ID yang diberikan penayang Audiens DFP. |
streamActivityMonitorId |
|
ID yang akan digunakan untuk men-debug streaming dengan pemantauan aktivitas streaming. Hal ini digunakan untuk memberikan cara mudah bagi penayang dalam menemukan log streaming di alat pemantauan aktivitas streaming. |
videoId |
|
Wajib 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 mengetahui berbagai data yang akan digunakan dalam peristiwa ID3 Live HLS dengan benar. |
createLiveStreamRequest(assetKey, apiKey)
Melakukan inisialisasi properti yang diperlukan dari StreamRequest
Live. Jika API ini digunakan, properti khusus StreamType
lainnya akan diabaikan.
Jika parameter yang diperlukan adalah string kosong, logging error akan terjadi dan API
akan menampilkan StreamRequest
generik, tanpa properti yang diabaikan.
Menampilkan ima.StreamRequest
: objek ima.StreamRequest
dengan
properti Live yang diperlukan.
Parameter | Jenis | Deskripsi |
---|---|---|
assetKey |
string |
|
apiKey |
string |
Parameter opsional yang akan ditetapkan ke properti |
createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)
Menginisialisasi properti wajib pada ima.StreamRequest
Pod Live.
Jika API ini digunakan, properti khusus ima.StreamType
lainnya akan diabaikan.
Jika parameter yang diperlukan adalah string kosong, logging error akan terjadi dan API
akan menampilkan StreamRequest
generik, 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 akan ditetapkan ke properti |
createPodVodStreamRequest(networkCode)
Menginisialisasi properti ima.StreamRequest
yang diperlukan untuk mendaftarkan streaming VOD saat menggunakan Pod DAI yang ditayangkan dengan penggabung 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 telah ditentukan, jenis permintaan akan ditetapkan ke
ima.StreamType.POD_VOD
.
Parameter | Jenis | Deskripsi |
---|---|---|
networkCode |
string |
kode jaringan Google Ad Manager |
createStreamRequest()
Menampilkan ima.StreamRequest
: Objek ima.StreamRequest
kosong.
createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)
Menginisialisasi properti yang diperlukan dari StreamRequest
Video Stitcher Live. Menggunakan API ini akan menyebabkan
properti khusus StreamType
lainnya diabaikan.
Jika parameter yang diperlukan adalah string kosong, logging error akan terjadi dan API
akan menampilkan StreamRequest
generik, 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 wajib VOD Video Stitcher
StreamRequest
. Menggunakan API ini akan menyebabkan
properti khusus StreamType
lainnya diabaikan.
Jika parameter yang diperlukan adalah string kosong, logging error akan terjadi dan API
akan menampilkan StreamRequest
generik, 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 |
createVodStreamRequest(contentSourceId, videoId, apiKey)
Menginisialisasi properti VOD yang diperlukan untuk ima.StreamRequest
. Penggunaan
API ini menyebabkan properti khusus ima.StreamType
lainnya
diabaikan.
Jika parameter yang diperlukan adalah string kosong, logging error akan terjadi dan API
akan menampilkan StreamRequest
generik, tanpa properti yang diabaikan.
Menampilkan ima.StreamRequest
: Objek ima.StreamRequest
dengan
properti VOD yang diwajibkan.
Parameter | Jenis | Deskripsi |
---|---|---|
contentSourceId |
string |
|
videoId |
string |
|
apiKey |
string |
Parameter opsional yang akan ditetapkan ke properti |
Class ima.StreamType
Kolom
Menentukan jenis streaming yang diminta untuk diputar oleh pemutar. Pre-roll dan VOD akan diputar dari awal streaming.
Properti
Nama | Jenis | Deskripsi |
---|---|---|
LIVE |
|
Video ditayangkan. |
VOD |
|
Video tersebut dibuat secara on demand. |
Class ima.WrapperInfo
Kolom
Metode
Berisi informasi tentang wrapper.
Properti
Nama | Jenis | Deskripsi |
---|---|---|
adId |
|
ID iklan atau string kosong jika tidak diketahui. |
adSystem |
|
Nama sistem iklan yang dideklarasikan atau string kosong jika tidak diketahui. |
creativeAdId |
|
ID iklan di materi iklan atau string kosong jika tidak diketahui. |
creativeId |
|
ID materi iklan atau string kosong jika tidak diketahui. |
dealId |
|
ID transaksi atau string kosong jika tidak diketahui. |
createWrapperInfo()
Menampilkan ima.WrapperInfo
: