Corso: StreamManager

StreamManager

class   public

Gestisce gli stream di inserzione di annunci dinamici. Gestisce le interazioni con il backend DAI e gestisce i ping di monitoraggio, nonché l'inoltro di eventi di stream e annunci al publisher. Questo gestore non eredita da BaseAdsManager poiché non è un gestore per un annuncio specifico, ma per l'intero stream

Costruttore

StreamManager

new StreamManager(videoElement, adUiElement, uiSettings)

Costruttore.

Parametro
videoElement	L'elemento video HTML in cui verrà eseguita la riproduzione. Il valore non deve essere null.
adUiElement	Facoltativo L'elemento HTML da utilizzare per contenere gli elementi dell'interfaccia utente dell'annuncio. Questo elemento deve avere le stesse dimensioni della riproduzione video e sovrapporsi direttamente al video. Se non viene fornita, non verrà visualizzata alcuna interfaccia utente e non verranno richiesti annunci che richiedono un'interfaccia utente, come gli annunci ignorabili.
uiSettings	Facoltativo Le impostazioni dell'interfaccia utente da utilizzare per questo stream. Il valore non deve essere null.

Lanci

quando i parametri di input non soddisfano i requisiti.

Proprietà

clickElement

HTMLElement non nullo

clickElement

HTMLElement non nullo

streamMonitor

PodServingStreamMonitor non nullo

Metodi

addEventListener

addEventListener(type, listener) restituisce void

Aggiunge un listener per il tipo di evento specificato.

Parametro
tipo	stringa Il tipo di evento da tenere in considerazione.
listener	function(non-null StreamEvent) Una funzione chiamata ogni volta che si verifica un evento di questo tipo.

Resi

void 

contentTimeForStreamTime

contentTimeForStreamTime(streamTime) restituisce un numero

Restituisce il tempo dei contenuti senza annunci per un determinato momento dello stream. Restituisce l'ora indicata dello stream per i live streaming.

Parametro
streamTime	numero il tempo dello stream con gli annunci inseriti (in secondi).

Resi

number l'ora dei contenuti corrispondente all'ora dello stream indicata una volta rimossi gli annunci.

obiettivo

focus() restituisce void

Imposta lo stato attivo sul pulsante Salta, se presente. In caso contrario, l'attenzione viene rivolta agli elementi interattivi, tra cui icone o creatività interattive.

Resi

void 

getAdSkippableState

getAdSkippableState() restituisce un valore booleano

Restituisce true se l'annuncio può essere saltato al momento. Quando questo valore cambia, StreamManager attiva un evento StreamEvent.SKIPPABLE_STATE_CHANGED.

Resi

boolean True se l'annuncio può essere saltato al momento, false in caso contrario.

loadStreamMetadata

loadStreamMetadata() restituisce void

Chiede all'SDK di caricare i metadati dell'annuncio e poi trasmette StreamEvent.LOADED. Questo deve essere attivato manualmente dopo aver recuperato il manifest dello stream dallo stitcher video di terze parti. Viene utilizzato solo per la pubblicazione di VOD con il servizio Pod con un editor video di terze parti ed è un'operazione non valida per altre richieste di stream.

Resi

void 

onTimedMetadata

onTimedMetadata(metadata) restituisce void

Passa un dizionario di metadati elaborati. Il dizionario si aspetta la chiave "TXXX" con la stringa dei metadati definiti dall'utente come valore. Se il tuo player fornisce metadati non elaborati, chiama StreamManager.processMetadata.

Parametro
metadati	(oggetto null o non null con proprietà stringa) Il dizionario dei metadati.

Resi

void 

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) returns (null or CuePoint)

Restituisce il cue point precedente per il tempo dello stream specificato. Restituisce null se non esiste un cue point di questo tipo. Viene utilizzato per implementare funzionalità come lo snap back e viene chiamato quando il publisher rileva che l'utente ha cercato di tornare a una interruzione pubblicitaria.

Parametro
streamTime	numero l'ora dello stream a cui è stato eseguito il seek.

Resi

(null or non-null CuePoint) il cue point precedente per l'ora dello stream specificata.

processMetadata

processMetadata(type, data, timestamp) restituisce void

Elabora i metadati con temporizzazione per i live streaming. Da utilizzare se il tuo video player fornisce metadati non analizzati insieme ai timestamp, altrimenti chiama StreamManager.onTimedMetadata.

Parametro
tipo	stringa Digita i metadati. Deve essere "ID3" per HLS o l'URI ID dello schema del messaggio evento per DASH.
dati	(stringa o Uint8Array non nullo) Dati non elaborati dei tag. Per ID3, devono essere presenti tutti i dati non elaborati del tag. Per i messaggi di evento DASH, si tratta della stringa di dati del messaggio.
timestamp	numero Tempo in secondi in cui i dati devono essere elaborati. Per DASH, si tratta dell'ora di inizio del messaggio dell'evento.

Resi

void 

removeEventListener

removeEventListener(type, listener) restituisce void

Rimuove un listener per il tipo di evento specificato. La funzione di listener deve essere uguale per riferimento a quella passata in precedenza a addEventListener.

Parametro
tipo	stringa Il tipo di evento per cui rimuovere l'ascoltatore.
listener	function(non-null StreamEvent) La funzione da rimuovere come ascoltatore.

Resi

void 

replaceAdTagParameters

replaceAdTagParameters(adTagParameters) restituisce void

Sostituisce tutti i parametri dei tag annuncio utilizzati per le richieste di annunci imminenti per un live streaming.

Parametro
adTagParameters	Oggetto con proprietà di stringa I nuovi parametri dei tag annuncio. Deve avere valori di stringa. Il valore non deve essere null.

Resi

void 

requestStream

requestStream(streamRequest) restituisce void

Richiede il caricamento di uno stream utilizzando i parametri dello stream forniti.

Parametro
streamRequest	StreamRequest contiene i parametri per caricare i metadati dello stream. Il valore non deve essere null.

Resi

void 

reimposta

reset() restituisce void

Reimposta il gestore dello stream e rimuove eventuali polling continui.

Resi

void 

setClickElement

setClickElement(clickElement) restituisce void

Imposta l'elemento di clickthrough degli annunci. Questo elemento viene utilizzato come destinatario dei clic o dei tocchi durante la riproduzione di un annuncio e può comportare l'uscita dalla pagina corrente. Questo valore è stato ritirato e al suo posto deve essere passato un adUiElement allo StreamManager. Se un adUiElement viene fornito al costruttore StreamManager, questo metodo diventa un'operazione non valida.

Parametro
clickElement	(Elemento null o non null) L'elemento utilizzato come clic sull'annuncio.

Deprecato

Fornisci invece un adUiElement al costruttore StreamManager.

Resi

void 

streamTimeForContentTime

streamTimeForContentTime(contentTime) restituisce un numero

Restituisce il tempo dello stream con gli annunci per un determinato momento dei contenuti. Restituisce il tempo dei contenuti specificati per i live streaming.

Parametro
contentTime	numero La durata dei contenuti senza annunci (in secondi).

Resi

number l'ora dello stream che corrisponde all'ora dei contenuti specificata una volta inseriti gli annunci.