Sınıf: StreamManager

Marka

StreamManager

new StreamManager(videoElement, adUiElement, uiSettings)

Oluşturucu.

Parametre

videoElement

Oynatma işleminin gerçekleşeceği HTML video öğesi.

Değer boş olamaz.

adUiElement

İsteğe bağlı

Reklam kullanıcı arayüzü öğelerini tutmak için kullanılacak HTML öğesi. Bu öğe, video oynatma ile aynı yükseklik ve genişlikte olmalı ve videonun üzerine doğrudan yerleştirilmelidir. Sağlanmazsa kullanıcı arayüzü gösterilmez ve atlanabilir reklamlar gibi kullanıcı arayüzü gerektiren reklamlar istenmez.

uiSettings

İsteğe bağlı

Bu yayın için kullanılacak kullanıcı arayüzü ayarları.

Değer boş olamaz.

Atışlar

Giriş parametreleri koşulları karşılamıyorsa

Özellikler

clickElement

null olmayan HTMLElement

clickElement

null olmayan HTMLElement

streamMonitor

null olmayan PodServingStreamMonitor

Yöntemler

addEventListener

addEventListener(type, listener) işlevi void döndürür.

Belirtilen etkinlik türü için bir dinleyici ekler.

Parametre

tür

dize

Dinlenecek etkinlik türü.

işleyici

function(non-null StreamEvent)

Bu tür bir etkinlik her gerçekleştiğinde çağrılan bir işlev.

İadeler

void 

contentTimeForStreamTime

contentTimeForStreamTime(streamTime) sayı döndürür

Belirli bir yayın süresi için reklamsız içerik süresini döndürür. Canlı yayınlar için belirli yayın süresini döndürür.

Parametre

streamTime

sayı

Eklenmiş reklamlarla yayın süresi (saniye cinsinden).

İadeler

number reklamlar kaldırıldıktan sonra belirli bir yayın süresine karşılık gelen içerik süresi.

odak

focus(), void döndürür

Odağı, varsa atlama düğmesine ayarlar. Bu öğeler yoksa odak, simgeler veya etkileşimli reklam öğeleri dahil olmak üzere etkileşimli öğelere verilir.

İadeler

void 

getAdSkippableState

getAdSkippableState() boole döndürür

Reklam şu anda atlanabilir durumdaysa doğru değerini döndürür. Bu değer değiştiğinde StreamManager, StreamEvent.SKIPPABLE_STATE_CHANGED etkinliğini tetikler.

İadeler

boolean Reklam şu anda atlanabilir durumdaysa doğru, aksi takdirde yanlış değerini döndürür.

loadStreamMetadata

loadStreamMetadata() işlevi void döndürür

SDK'dan reklam meta verilerini yüklemesini ister ve ardından StreamEvent.LOADED'ı yayınlar. Bu işlem, üçüncü taraf video birleştirme aracından yayın manifesti alındıktan sonra manuel olarak tetiklenmelidir. Bu, yalnızca üçüncü taraf video dikişleyiciyle kapsül yayınlama VOD için kullanılır ve diğer akış istekleri için işlem yapmaz.

İadeler

void 

onTimedMetadata

onTimedMetadata(metadata) işlevi void döndürüyor

İşlenen meta verilerin sözlüğünü iletir. Sözlük, değer olarak kullanıcı tanımlı meta veri dizesini içeren anahtar "TXXX" bekler. Oynatıcınız ham meta veriler sağlıyorsa bunun yerine StreamManager.processMetadata işlevini çağırın.

Parametre

meta veri

(dize özellikleri olan null veya null olmayan nesne)

Meta veri sözlüğü.

İadeler

void 

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) returns (null or CuePoint)

Belirtilen yayın zamanı için önceki işaret noktasını döndürür. Böyle bir işaret noktası yoksa null değerini döndürür. Bu yöntem, geri sarma gibi özellikleri uygulamak için kullanılır ve yayıncı, kullanıcıyı reklam arasına döndürmek için kullanıcının ilerlediğini algıladığında çağrılır.

Parametre

streamTime

sayı

akışta istenilen zaman.

İadeler

(null or non-null CuePoint) Belirli bir yayın zamanı için önceki işaret noktası.

processMetadata

processMetadata(type, data, timestamp) işlevi void döndürür

Canlı yayınlar için zamanlanmış meta verileri işler. Video oynatıcınız zaman damgaları ile birlikte ayrıştırılmamış meta veriler sağlıyorsa kullanın. Aksi takdirde StreamManager.onTimedMetadata işlevini çağırın.

Parametre

tür

dize

Meta veri türü. HLS için "ID3" veya DASH için etkinlik mesajı şeması kimliği URI'si olmalıdır.

aktarma

(dize veya null olmayan Uint8Array)

Ham etiket verileri. ID3 için ham etiket verilerinin tamamı olmalıdır. DASH etkinlik mesajları için bu, mesaj veri dizesidir.

timestamp

sayı

Verilerin işlenmesi gereken süre (saniye cinsinden). DASH için bu, etkinlik mesajının başlangıç zamanıdır.

İadeler

void 

removeEventListener

removeEventListener(type, listener) işlevi void değerini döndürür.

Belirtilen etkinlik türü için bir dinleyiciyi kaldırır. İşleyici işlevi, daha önce addEventListener işlevine iletilen işleve referans olarak eşit olmalıdır.

Parametre

tür

dize

İşleyicinin kaldırılacağı etkinlik türü.

işleyici

function(non-null StreamEvent)

Dinleyici olarak kaldırılacak işlev.

İadeler

void 

replaceAdTagParameters

replaceAdTagParameters(adTagParameters) işlevi void döndürür

Bir canlı yayının incelenecek reklam istekleri için kullanılan reklam etiketi parametrelerinin tümünü değiştirir.

Parametre

adTagParameters

Dize özelliklerine sahip nesne

Yeni reklam etiketi parametreleri. Dize değerlerine sahip olmalıdır.

Değer boş olamaz.

İadeler

void 

requestStream

requestStream(streamRequest) işlevi void döndürür

Sağlanan akış parametreleri kullanılarak bir yayının yüklenmesini ister.

Parametre

streamRequest

StreamRequest

akış meta verilerini yükleme parametrelerini içerir.

Değer boş olamaz.

İadeler

void 

reset

reset(), void döndürür

Akış yöneticisini sıfırlar ve sürekli anketleri kaldırır.

İadeler

void 

setClickElement

setClickElement(clickElement) işlevi void döndürür

Reklam tıklama öğesini ayarlar. Bu öğe, reklam oynatılırken tıklama veya dokunma alıcısı olarak kullanılır ve geçerli sayfadan başka bir sayfaya yönlendirmeyle sonuçlanabilir. Bu yöntemin desteği sonlandırıldı. Bunun yerine StreamManager'a bir adUiElement gönderilmelidir. StreamManager oluşturucusuna bir adUiElement verilirse bu yöntem işlem yapmaz.

Parametre

clickElement

(null veya null olmayan öğe)

Reklam tıklaması olarak kullanılan öğe.

Kullanımdan kaldırıldı
Bunun yerine StreamManager kurucusuna bir adUiElement sağlayın.
İadeler

void 

streamTimeForContentTime

streamTimeForContentTime(contentTime) sayı döndürür

Belirli bir içerik süresi için reklamlarla birlikte yayın süresini döndürür. Canlı yayınlarda belirli bir içerik süresini döndürür.

Parametre

contentTime

sayı

Reklamsız içerik süresi (saniye cinsinden).

İadeler

number reklamlar eklendikten sonra belirli bir içerik süresine karşılık gelen yayın süresi.