[go: nahoru, domu]

Kelas: StreamManager

StreamManager

class

Menangani streaming penyisipan iklan dinamis. Layanan ini mengelola interaksi dengan backend DAI dan menangani ping pelacakan serta meneruskan streaming dan peristiwa iklan kepada penayang. Pengelola ini tidak mewarisi dari BaseAdsManager karena bukan pengelola untuk iklan tertentu, tetapi satu untuk seluruh streaming

Konstruktor

StreamManager

baru StreamManager(videoElement, adUiElement, uiSettings)

Parameter

videoElement

Elemen video HTML tempat pemutaran akan dilakukan.

Nilai tidak boleh nol.

adUiElement

Opsional

Elemen HTML yang akan digunakan untuk menyimpan elemen UI iklan. Elemen ini harus memiliki tinggi dan lebar yang sama dengan pemutaran video, dan harus langsung ditempatkan di atas elemen tersebut. Jika tidak diberikan, tidak ada UI yang akan ditampilkan, dan iklan yang memerlukan UI, seperti iklan yang dapat dilewati, yang akan diminta.

Nilai tidak boleh nol.

uiSettings

Opsional

Setelan UI yang akan digunakan untuk streaming ini.

Nilai tidak boleh nol.
Menampilkan

saat parameter input tidak memenuhi persyaratan.

Metode

contentTimeForStreamTime

contentTimeForStreamTime(streamTime) menampilkan angka

Menampilkan waktu konten tanpa iklan untuk waktu streaming tertentu. Menampilkan waktu streaming tertentu untuk live stream.

Parameter

streamTime

number

waktu streaming dengan iklan yang disisipkan (dalam detik).
Hasil

number waktu konten yang sesuai dengan waktu streaming tertentu setelah iklan dihapus.

focus

focus()

Menempatkan fokus pada tombol lewati, jika ada. Jika tidak ada, fokus diberikan pada elemen interaktif, termasuk ikon atau materi iklan interaktif.

getAdSkippableState

getAdSkipState() menampilkan boolean

Menampilkan true (benar) jika iklan dapat dilewati saat ini. Saat nilai ini berubah, StreamManager akan mengaktifkan peristiwa StreamEvent.SKIPPABLE_STATE_CHANGED.

Hasil

boolean Benar jika iklan saat ini dapat dilewati, salah (false) jika tidak.

loadStreamMetadata

loadStreamMetadata()

Meminta SDK untuk memuat metadata iklan, lalu menyiarkan StreamEvent.LOADED. Tindakan ini harus dipicu secara manual setelah manifes streaming diambil dari penggabung video pihak ketiga. Ini hanya digunakan untuk Pod yang Menayangkan VOD dengan penggabung video pihak ketiga, dan tidak beroperasi untuk permintaan streaming lainnya.

onTimedMetadata

onTimedMetadata(metadata)

Meneruskan kamus metadata yang diproses. Kamus ini mengharapkan kunci 'TXXX' dengan string metadata buatan pengguna sebagai nilai. Jika pemain menyediakan metadata mentah, panggil StreamManager.processMetadata.

Parameter

metadata

Objek

Kamus {i>metadata<i}.

Nilai tidak boleh nol.

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) menampilkan CuePoint

Menampilkan titik tanda sebelumnya untuk waktu streaming yang ditentukan. Menampilkan null jika tidak ada titik tanda tersebut. Ini digunakan untuk mengimplementasikan fitur seperti snap back, dan dipanggil saat penayang mendeteksi bahwa pengguna mencari untuk mengembalikan pengguna ke jeda iklan.

Parameter

streamTime

number

waktu streaming yang dicari.
Hasil

nullable CuePoint titik tanda sebelumnya untuk waktu streaming tertentu.

processMetadata

processMetadata(type, data, timestamp)

Memproses metadata dengan waktu untuk live stream. Gunakan jika pemutar video Anda menyediakan metadata yang tidak diurai beserta stempel waktu. Jika tidak, panggil StreamManager.onTimedMetadata.

Parameter

tipe

string

Jenis untuk metadata. Harus berupa 'ID3' untuk HLS, atau URI ID skema pesan peristiwa untuk DASH.

data

(Uint8Array atau string bukan null)

Data tag mentah. Untuk ID3, harus berupa data tag mentah secara keseluruhan. Untuk pesan peristiwa DASH, ini adalah string data pesan.

timestamp

number

Waktu dalam detik saat data harus diproses. Untuk DASH, ini adalah waktu mulai pesan peristiwa.

replaceAdTagParameters

replaceAdTagParameters(adTagParameters)

Menggantikan semua parameter tag iklan yang digunakan untuk permintaan iklan berikutnya untuk live stream.

Parameter

adTagParameters

Objek dengan properti string

Parameter tag iklan baru. Harus memiliki nilai string.

Nilai tidak boleh nol.

requestStream

requestStream(streamRequest)

Meminta streaming dimuat menggunakan parameter streaming yang disediakan.

Parameter

streamRequest

StreamRequest

berisi parameter untuk memuat metadata streaming.

Nilai tidak boleh nol.

reset

reset()

Mereset pengelola streaming dan menghapus polling berkelanjutan.

setClickElement

setClickElement(clickElement)

Menetapkan elemen klik-tayang iklan. Elemen ini digunakan sebagai penerima klik atau ketuk saat iklan diputar dan dapat mengakibatkan navigasi keluar dari halaman saat ini. API ini sekarang tidak digunakan lagi, dan adUiElement harus diteruskan ke StreamManager. Jika adUiElement diberikan ke konstruktor StreamManager, metode ini tidak akan dioperasikan.

Parameter

clickElement

Elemen

Elemen yang digunakan sebagai klik tayang iklan.

Nilai mungkin null.
Tidak digunakan lagi
Sebagai gantinya, berikan adUiElement ke konstruktor StreamManager.

streamTimeForContentTime

streamTimeForContentTime(contentTime) menampilkan angka

Menampilkan waktu streaming dengan iklan untuk waktu konten tertentu. Menampilkan waktu konten yang ditentukan untuk live stream.

Parameter

contentTime

number

waktu konten tanpa iklan (dalam detik).
Hasil

number waktu streaming yang sesuai dengan waktu konten yang ditentukan setelah iklan disisipkan.