cast. framework. jeda. BreakManager
Kelas untuk mengelola jeda.
Metode
addBreak
addBreak(breakData, breakClips, broadbandCastMediaStatus) menampilkan boolean
Menambahkan klip jeda dan jeda yang dinamis. Klip jeda akan dikaitkan dengan jeda tersebut (break.breakClipIds dan break.duration akan diperbarui sesuai dengan klip).
Parameter |
|
---|---|
breakData |
Nilai tidak boleh nol. |
breakClips |
Array cast.framework.messages.BreakClip non-null Nilai tidak boleh nol. |
broadCastMediaStatus |
Opsional boolean Apakah CAF harus memeriksa apakah status jeda iklan saat ini telah berubah. Hal ini mungkin tidak diinginkan sebelum pemutaran dimulai, karena penerima mungkin masih perlu menambahkan lebih banyak jeda (misalnya, selama pemuatan selesai). |
- Hasil
-
boolean
Benar jika jeda berhasil ditambahkan.
getBreakById
getBreakById(id) menampilkan cast.framework.messages.Break
Mendapatkan jeda media saat ini menurut ID.
Parameter |
|
---|---|
id |
string ID jeda. |
- Hasil
-
nullable cast.framework.messages.Break
getBreakClipById
getBreakClipById(id) returns cast.framework.messages.BreakClip
Mendapatkan klip jeda media saat ini menurut ID.
Parameter |
|
---|---|
id |
string ID klip. |
- Hasil
-
nullable cast.framework.messages.BreakClip
getBreakClipCurrentTimeSec
getBreakClipCurrentTimeSec() menampilkan angka
Menampilkan waktu saat ini dalam detik dalam klip jeda iklan yang sedang diputar.
- Hasil
-
nullable number
Waktu saat ini dalam detik dalam klip jeda saat ini. Null, jika pemutar tidak memutar klip jeda iklan.
getBreakClipDurationSec
getBreakClipDurationSec() menampilkan angka
Menampilkan durasi dalam detik dari klip jeda yang sedang diputar.
- Hasil
-
nullable number
Durasi klip jeda saat ini. Null, jika pemutar tidak memutar klip jeda iklan.
getBreakClips
getBreakClips() menampilkan Array cast.framework.messages.BreakClip non-null
Mendapatkan klip jeda media saat ini.
- Hasil
-
non-null Array of non-null cast.framework.messages.BreakClip
getBreaks
getBreaks() menampilkan Array non-null cast.framework.messages.Break
Mendapatkan jeda media saat ini.
- Hasil
-
non-null Array of non-null cast.framework.messages.Break
getCreativeInfoByClipId
getCreativeInfoByClipId(breakClipId) menampilkan cast.framework.breaks.CreativeInformation
Mendapatkan informasi materi iklan yang terkait dengan breakclip menurut ID.
Parameter |
|
---|---|
breakClipId |
string ID klip. |
- Hasil
getPlayWatchedBreak
getPlayWatchedBreak() menampilkan boolean
Menampilkan true jika jeda yang ditonton harus diputar.
- Hasil
-
boolean
removeBreakById
removeBreakById(breakId) menampilkan boolean
Menghapus jeda dan klip jeda terkait.
Parameter |
|
---|---|
breakId |
string ID jeda |
- Hasil
-
boolean
Benar jika jeda berhasil dihapus.
setBreakClipLoadInterceptor
setBreakClipLoadInterceptor(interceptor)
Menyediakan interseptor untuk memungkinkan developer menyisipkan lebih banyak klip jeda iklan atau mengubah klip jeda iklan saat ini sebelum jeda dimulai.
Jika interseptor bernilai null, intersep akan mereset interseptor ke nilai default. Secara default, pengambilan dan penguraian logika VAST di interseptor default. Jadi, jika interseptor yang disesuaikan disetel oleh developer, logika VAST akan diganti dan developer harus menerapkan logika pengambilan dan penguraian VAST mereka sendiri pada interseptor yang disediakan.
Parameter |
|
---|---|
interseptor |
function(non-null cast.framework.messages.BreakClip, optional non-null cast.framework.breaks.BreakClipLoadInterceptorContext) Interseptor pemuatan klip jeda default akan menampilkan klip jeda yang sama dengan input. Nilai boleh nol. |
setBreakSeekInterceptor
setBreakSeekInterceptor(seekInterceptor)
Menyediakan interseptor bagi developer untuk menentukan jeda yang ingin diputar setelah pencarian.
Parameter |
|
---|---|
seekInterceptor |
function(non-null cast.framework.breaks.BreakSeekData) Interseptor atau null jika developer ingin meresetnya ke default. Interseptor pencari jeda default akan menampilkan jeda terdekat dari nilai LookerTo. Nilai boleh nol. |
setPlayWatchedBreak
setPlayWatchedBreak(playWatchedBreak)
Menetapkan tanda untuk mengontrol apakah jeda penggabungan klien yang ditonton harus diputar.
Parameter |
|
---|---|
playWatchedBreak |
boolean |
setVastTrackingInterceptor
setVastTrackingInterceptor(interceptor)
Memberikan interseptor untuk mengubah URL pelacakan VAST sebelum dikirim ke server. Input interseptor adalah string URL pelacakan. Interseptor dapat menampilkan string URL yang dimodifikasi atau Promise untuk string URL yang dimodifikasi. Interseptor juga dapat menampilkan null jika ingin mengirim URL pelacakan dengan kode Anda sendiri, bukan dengan CAF.
Parameter |
|
---|---|
interseptor |
fungsi(string) Interseptor yang mengubah URL sebelum dikirim. Nilai boleh nol. |