Kelas: StreamManager

StreamManager

class   public

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

Konstruktor

StreamManager

new StreamManager(videoElement, adUiElement, uiSettings)

Konstruktor.

Parameter

videoElement

Elemen video HTML tempat pemutaran akan terjadi.

Nilai tidak boleh null.

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 menempatkannya. Jika tidak disediakan, tidak ada UI yang akan ditampilkan, dan tidak ada iklan yang memerlukan UI, seperti iklan yang dapat dilewati, yang akan diminta.

uiSettings

Opsional

Setelan UI yang akan digunakan untuk streaming ini.

Nilai tidak boleh null.
Menampilkan

jika parameter input tidak memenuhi persyaratan.

Properti

clickElement

HTMLElement non-null

clickElement

HTMLElement non-null

streamMonitor

PodServingStreamMonitor non-null

Metode

addEventListener

addEventListener(type, listener) menampilkan void

Menambahkan pemroses untuk jenis peristiwa yang diberikan.

Parameter

jenis

string

Jenis peristiwa yang akan diproses.

pemroses

function(non-null StreamEvent)

Fungsi yang dipanggil setiap kali peristiwa jenis ini terjadi.
Hasil

void 

contentTimeForStreamTime

contentTimeForStreamTime(streamTime) menampilkan angka

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

Parameter

streamTime

angka

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

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

fokus

focus() menampilkan void

Memfokuskan pada tombol lewati, jika ada. Jika tidak ada, fokus akan ditempatkan pada elemen interaktif, termasuk ikon atau materi iklan interaktif.

Hasil

void 

getAdSkippableState

getAdSkippableState() menampilkan boolean

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

Hasil

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

loadStreamMetadata

loadStreamMetadata() menampilkan void

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

Hasil

void 

onTimedMetadata

onTimedMetadata(metadata) menampilkan void

Meneruskan kamus metadata yang diproses. Kamus mengharapkan kunci 'TXXX' dengan string metadata yang ditentukan pengguna sebagai nilai. Jika pemutar Anda menyediakan metadata mentah, panggil StreamManager.processMetadata.

Parameter

metadata

(Objek null atau non-null dengan properti string)

Kamus metadata.
Hasil

void 

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) returns (null or CuePoint)

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

Parameter

streamTime

angka

waktu streaming yang dicari.
Hasil

(null or non-null CuePoint) titik tanda sebelumnya untuk waktu streaming yang diberikan.

processMetadata

processMetadata(type, data, timestamp) menampilkan void

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

Parameter

jenis

string

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

data

(string atau Uint8Array non-null)

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

timestamp

angka

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

void 

removeEventListener

removeEventListener(type, listener) menampilkan void

Menghapus pemroses untuk jenis peristiwa yang ditentukan. Fungsi pemroses harus sama dengan referensi ke fungsi yang sebelumnya diteruskan ke addEventListener.

Parameter

jenis

string

Jenis peristiwa yang pemrosesnya akan dihapus.

pemroses

function(non-null StreamEvent)

Fungsi yang akan dihapus sebagai pemroses.
Hasil

void 

replaceAdTagParameters

replaceAdTagParameters(adTagParameters) menampilkan void

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

Parameter

adTagParameters

Objek dengan properti string

Parameter tag iklan baru. Harus memiliki nilai string.

Nilai tidak boleh null.
Hasil

void 

requestStream

requestStream(streamRequest) menampilkan void

Meminta streaming untuk dimuat menggunakan parameter streaming yang disediakan.

Parameter

streamRequest

StreamRequest

berisi parameter untuk memuat metadata streaming.

Nilai tidak boleh null.
Hasil

void 

reset

reset() menampilkan void

Mereset pengelola streaming dan menghapus polling berkelanjutan.

Hasil

void 

setClickElement

setClickElement(clickElement) menampilkan void

Menetapkan elemen klik-tayang iklan. Elemen ini digunakan sebagai penerima klik atau ketukan saat iklan diputar dan dapat menyebabkan navigasi keluar dari halaman saat ini. Ini sekarang tidak digunakan lagi, dan adUiElement harus diteruskan ke StreamManager. Jika adUiElement diberikan ke konstruktor StreamManager, metode ini menjadi tidak berfungsi.

Parameter

clickElement

(Elemen null atau non-null)

Elemen yang digunakan sebagai klik-tayang iklan.
Tidak digunakan lagi
Berikan adUiElement ke konstruktor StreamManager.
Hasil

void 

streamTimeForContentTime

streamTimeForContentTime(contentTime) menampilkan angka

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

Parameter

contentTime

angka

waktu konten tanpa iklan (dalam detik).
Hasil

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