Clase StreamManager


Controla las transmisiones de inserción de anuncios dinámicos. Esta clase administra las interacciones con los servidores de DAI, controla los pings de seguimiento y emite eventos de transmisión y de anuncios.
Constructores
constructor
Métodos
addEventListener
Agrega un objeto de escucha para el tipo de evento determinado.
contentTimeForStreamTime
Devuelve el tiempo de contenido sin anuncios para un tiempo de transmisión determinado.
focus
Enfoca el botón de omitir, si está presente.
getAdSkippableState
Devuelve un valor true si el usuario puede omitir el anuncio actual.
loadStreamMetadata
Solicita al SDK de DAI que cargue los metadatos del anuncio y emite un evento de transmisión LOADED.
onTimedMetadata
Pasa un diccionario de metadatos procesados.
previousCuePointForStreamTime
Devuelve el punto de referencia anterior para el tiempo de transmisión determinado.
processMetadata
Procesa los metadatos cronometrados para las transmisiones.
removeEventListener
Quita un objeto de escucha para el tipo de evento StreamEvent determinado.
replaceAdTagParameters
Reemplaza todos los parámetros de etiquetas de anuncios que se usan para las próximas solicitudes de anuncios de una transmisión en vivo.
requestStream
Solicita que se cargue una transmisión para la DAI de IMA con los parámetros de transmisión proporcionados.
reset
Restablece el administrador de transmisiones y quita cualquier sondeo continuo.
streamTimeForContentTime
Devuelve el tiempo total de transmisión con anuncios para un tiempo de contenido determinado.

Constructores


constructor

new StreamManager(videoElement: HTMLVideoElement, adUiElement?: HTMLElement, uiSettings?: UiSettings): StreamManager
Parámetros
videoElement: HTMLVideoElement Es el elemento de video HTML en el que se produce la reproducción.
Optional adUiElement: HTMLElement Es el elemento en el que se renderiza la IU del anuncio.
Optional uiSettings: UiSettings Es la configuración de la IU que se usará para esta transmisión.
Muestra
StreamManager

Métodos


addEventListener

addEventListener(type: Type | Type[], listener: ((event: StreamEvent) => void)): void
Agrega un objeto de escucha para el tipo de evento determinado.
Parámetros
type: Type | Type[] Es el tipo de evento de anuncio o un array de tipos de eventos.
listener: ((event: StreamEvent) => void) Es una función de devolución de llamada para el objeto de escucha de anuncios.

contentTimeForStreamTime

contentTimeForStreamTime(streamTime: number): number
Devuelve el tiempo de contenido sin anuncios para un tiempo de transmisión determinado. Devuelve el tiempo de transmisión determinado para las transmisiones en vivo.
Parámetros
streamTime: number Es el tiempo de transmisión en segundos, que combina el contenido y los anuncios.
Muestra
number Es el tiempo de contenido para el tiempo de transmisión determinado, sin incluir los anuncios.

focus

focus(): void
Enfoca el botón de omitir, si está presente. Si no está presente, el foco vuelve al elemento interactivo.

getAdSkippableState

getAdSkippableState(): boolean
Devuelve un valor true si el usuario puede omitir el anuncio actual. Cuando este valor cambia, la clase StreamManager emite un evento de transmisión SKIPPABLE_STATE_CHANGED.
Muestra
boolean true si el usuario puede omitir el anuncio actual; de lo contrario, false.

loadStreamMetadata

loadStreamMetadata(): void
Solicita al SDK de DAI que cargue los metadatos del anuncio y emite un evento de transmisión LOADED. Llama a este método de forma manual cuando recuperes el manifiesto de transmisión de tu unificador de video de terceros. Este método solo se aplica a las transmisiones de VOD de publicación de Pod con un concatenador de video de terceros.

onTimedMetadata

onTimedMetadata(metadata: {
  [key: string]: string;
}): void
Pasa un diccionario de metadatos procesados. El diccionario espera la clave exacta "TXXX" con la cadena de metadatos definidos por el usuario como valor. Si tu reproductor proporciona metadatos sin procesar, llama al método StreamManager.processMetadata.
Parámetros
metadata: {
  [key: string]: string;
}
Es el diccionario de metadatos.

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime: number): CuePoint
Devuelve el punto de referencia anterior para el tiempo de transmisión determinado. Si no existe un punto de referencia anterior, se devuelve null. Usa este método para implementar funciones como el restablecimiento automático llamándolo cuando el usuario intente volver a una pausa publicitaria.
Parámetros
streamTime: number Es el tiempo de transmisión al que el usuario busca acceder.
Muestra
CuePoint Es el punto de referencia anterior para el tiempo de transmisión determinado.

processMetadata

processMetadata(type: string, data: string | Uint8Array, timestamp: number): void
Procesa los metadatos cronometrados para las transmisiones. Usa este método si tu reproductor de video proporciona metadatos sin analizar con marcas de tiempo. De lo contrario, llama a StreamManager.onTimedMetadata.
Parámetros
type: string Es el tipo de metadatos. Debe ser la cadena 'ID3' para HLS o el URI del ID del esquema del mensaje de evento para DASH.
data: string | Uint8Array Son los datos de etiquetas sin procesar. En el caso de ID3, debe ser la totalidad de los datos sin procesar de la etiqueta. Para los mensajes de eventos de DASH, esta es la cadena de datos del mensaje.
timestamp: number Es el momento en segundos en el que se procesarán los datos. En el caso de DASH, este parámetro es la hora de inicio del mensaje del evento.

removeEventListener

removeEventListener(type: Type, listener: ((event: StreamEvent) => void)): void
Quita un objeto de escucha para el tipo de evento StreamEvent determinado. Para quitar correctamente un objeto de escucha, el parámetro de objeto de escucha que pasas a este método debe ser igual por referencia al que se pasó anteriormente al método addEventListener.
Parámetros
type: Type Es el tipo de evento para el que se quitará el objeto de escucha.
listener: ((event: StreamEvent) => void) Es la función que se quitará como objeto de escucha.

replaceAdTagParameters

replaceAdTagParameters(adTagParameters: {
  [key: string]: string;
}): void
Reemplaza todos los parámetros de etiquetas de anuncios que se usan para las próximas solicitudes de anuncios de una transmisión en vivo.
Parámetros
adTagParameters: {
  [key: string]: string;
}
Son los parámetros de la etiqueta de anuncio de reemplazo. Debe tener valores de cadena.

requestStream

requestStream(streamRequest: StreamRequest): void
Solicita que se cargue una transmisión para la DAI de IMA con los parámetros de transmisión proporcionados.
Parámetros
streamRequest: StreamRequest Contiene parámetros para cargar los metadatos de la transmisión.

reset

reset(): void
Restablece el administrador de transmisiones y quita cualquier sondeo continuo.

streamTimeForContentTime

streamTimeForContentTime(contentTime: number): number
Devuelve el tiempo total de transmisión con anuncios para un tiempo de contenido determinado. Devuelve el tiempo de contenido determinado para las transmisiones en vivo.
Parámetros
contentTime: number Es el tiempo de contenido sin anuncios en segundos.
Muestra
number Es el tiempo total de transmisión que corresponde al tiempo de contenido determinado después de que la DAI inserta anuncios.