Clase: StreamManager

StreamManager

class   public

Controla las transmisiones de inserción de anuncios dinámicos. Administra las interacciones con el backend de la DAI y controla los pings de seguimiento, así como la transmisión y los eventos de anuncios de reenvío al publicador. Este administrador no hereda de BaseAdsManager, ya que no es un administrador de un anuncio específico, sino de todo el flujo.

Constructor

StreamManager

new StreamManager(videoElement, adUiElement, uiSettings)

Constructor.

Parámetro
videoElement	Es el elemento de video HTML en el que se realizará la reproducción. El valor no debe ser nulo.
adUiElement	Opcional Es el elemento HTML que se usará para contener los elementos de la IU del anuncio. Este elemento debe tener la misma altura y el mismo ancho que la reproducción de video y debe superponerse directamente. Si no se proporciona, no se mostrará ninguna IU ni se solicitarán anuncios que la requieran, como los anuncios que se pueden omitir.
uiSettings	Opcional Es la configuración de la IU que se usará para esta transmisión. El valor no debe ser nulo.

Arroja

cuando los parámetros de entrada no cumplen con los requisitos.

Propiedades

clickElement

HTMLElement no nulo

clickElement

HTMLElement no nulo

streamMonitor

PodServingStreamMonitor no nulo

Métodos

addEventListener

addEventListener(type, listener) devuelve void.

Agrega un objeto de escucha para el tipo de evento determinado.

Parámetro
tipo	string El tipo de evento que se debe escuchar;
objeto de escucha	function(non-null StreamEvent) Es una función a la que se llama cada vez que ocurre un evento de este tipo.

Muestra

void 

contentTimeForStreamTime

contentTimeForStreamTime(streamTime) devuelve un número.

Muestra la duración del contenido sin anuncios para una hora de transmisión determinada. Muestra la hora de transmisión determinada para las transmisiones en vivo.

Parámetro
streamTime	número el tiempo de transmisión con anuncios insertados (en segundos).

Muestra

number es la duración del contenido que corresponde con la duración de la transmisión determinada una vez que se quitan los anuncios.

enfoque

focus() devuelve un valor nulo.

Enfoca el botón Omitir, si está presente. Si no está presente, el enfoque se centra en los elementos interactivos, incluidos los íconos o las creatividades interactivas.

Muestra

void 

getAdSkippableState

getAdSkippableState() muestra un valor booleano.

Muestra verdadero si el anuncio se puede omitir en este momento. Cuando cambia este valor, StreamManager activa un evento StreamEvent.SKIPPABLE_STATE_CHANGED.

Muestra

boolean Es verdadero si actualmente se puede omitir el anuncio; de lo contrario, es falso.

loadStreamMetadata

loadStreamMetadata() devuelve un valor nulo.

Solicita al SDK que cargue los metadatos del anuncio y, luego, transmite StreamEvent.LOADED. Se debe activar de forma manual una vez que se haya recuperado el manifiesto de la transmisión desde el compilador de videos de terceros. Esto solo se usa para la publicación de VOD de Pod con un editor de videos de terceros y no se realiza ninguna acción para otras solicitudes de transmisión.

Muestra

void 

onTimedMetadata

onTimedMetadata(metadata) devuelve un valor nulo.

Pasa un diccionario de metadatos procesados. El diccionario espera la clave “TXXX” con la cadena de metadatos definida por el usuario como valor. Si tu reproductor proporciona metadatos sin procesar, llama a StreamManager.processMetadata.

Parámetro
metadatos	(objeto nulo o no nulo con propiedades de cadena) El diccionario de metadatos.

Muestra

void 

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) returns (null or CuePoint)

Devuelve el punto de inserción anterior para la hora de transmisión determinada. Muestra un valor nulo si no existe un punto de inserción de ese tipo. Se usa para implementar funciones como el retroceso, y se lo llama cuando el publicador detecta que el usuario realizó un salto para regresar a una pausa publicitaria.

Parámetro
streamTime	número la hora de la transmisión a la que se avanzó

Muestra

(null or non-null CuePoint): Es el punto de inserción anterior para la hora de transmisión determinada.

processMetadata

processMetadata(type, data, timestamp) devuelve void

Procesa metadatos sincronizados para las transmisiones en vivo. Úsalo si tu reproductor de video proporciona metadatos sin analizar junto con marcas de tiempo. De lo contrario, llama a StreamManager.onTimedMetadata.

Parámetro
tipo	string Es el tipo de metadatos. Debe ser "ID3" para HLS o el URI del ID del esquema de mensaje de evento para DASH.
datos	(cadena o Uint8Array no nulo) Datos de etiquetas sin procesar. Para ID3, deben ser todos los datos de la etiqueta sin procesar. En el caso de los mensajes de eventos de DASH, esta es la cadena de datos del mensaje.
timestamp	número Es el tiempo en segundos en el que se deben procesar los datos. Para DASH, esta es la hora de inicio del mensaje del evento.

Muestra

void 

removeEventListener

removeEventListener(type, listener) devuelve void.

Quita un objeto de escucha para el tipo de evento determinado. La función del objeto de escucha debe ser igual en función de la que se pasó anteriormente a addEventListener.

Parámetro
tipo	string Es el tipo de evento para el que se quitará el objeto de escucha.
objeto de escucha	function(non-null StreamEvent) Es la función que se quitará como objeto de escucha.

Muestra

void 

replaceAdTagParameters

replaceAdTagParameters(adTagParameters) devuelve un valor nulo.

Reemplaza todos los parámetros de la etiqueta de anuncio que se usan para las próximas solicitudes de anuncios de una transmisión en vivo.

Parámetro
adTagParameters	Objeto con propiedades de cadena Los nuevos parámetros de la etiqueta de anuncio Debe tener valores de cadena. El valor no debe ser nulo.

Muestra

void 

requestStream

requestStream(streamRequest) devuelve void

Solicita que se cargue una transmisión con los parámetros de transmisión proporcionados.

Parámetro
streamRequest	StreamRequest contiene parámetros para cargar los metadatos de la transmisión. El valor no debe ser nulo.

Muestra

void 

restablecer

reset() devuelve un valor nulo.

Restablece el administrador de transmisiones y quita cualquier sondeo continuo.

Muestra

void 

setClickElement

setClickElement(clickElement) devuelve un valor nulo.

Establece el elemento de clics de los anuncios. Este elemento se usa como receptor de clics o presiones mientras se reproduce un anuncio y puede provocar que se abandone la página actual. Esta función dejó de estar disponible y, en su lugar, se debe pasar un adUiElement a StreamManager. Si se proporciona un adUiElement al constructor de StreamManager, este método se convierte en una operación no realizada.

Parámetro
clickElement	(Elemento nulo o no nulo) Es el elemento que se usa como clic en el anuncio.

Obsoleto

Proporciona un adUiElement al constructor de StreamManager.

Muestra

void 

streamTimeForContentTime

streamTimeForContentTime(contentTime) muestra un número.

Muestra la duración de la transmisión con anuncios para un tiempo de contenido determinado. Muestra la hora de contenido determinada para las transmisiones en vivo.

Parámetro
contentTime	número el tiempo de contenido sin anuncios (en segundos).

Muestra

number es la hora de transmisión que corresponde a la hora del contenido determinada una vez que se insertan los anuncios.