Eventos del kit de desarrollo de software de reproductor web TD

módulo: kit de desarrollo de software global

Evento: Player-Ready

Devolución de llamada cuando el kit de desarrollo de software de reproductor web TD está listo. Todos los módulos están cargados.

módulo: reproductor multimedia

Evento: Stream-Start

La reproducción del stream comenzó.

módulo: reproductor multimedia

Evento: Stream-Stop

La reproducción del stream se detuvo.

módulo: reproductor multimedia

Evento: Stream-Select
Se seleccionó un punto de montaje de stream.

módulo: reproductor multimedia

Evento: stream-config-ready
La configuración del stream en vivo está lista.

módulo: reproductor multimedia

Evento: stream-config-error
El análisis de la configuración del stream en vivo devuelve un error.

módulo: reproductor multimedia

Evento: stream-config-load-error
La carga de la configuración del stream en vivo devuelve un error.

módulo: reproductor multimedia

Evento: Stream-Fail

La conexión al stream falló.

módulo: reproductor multimedia

Evento: Stream-Error

Ocurrió un error en el stream

propiedades del evento:

texto (Secuencia) El texto del error.

módulo: reproductor multimedia

Evento: Stream-Status

Información del estado del stream.

propiedades del evento:

• status (cadena) El mensaje de texto de estado "No se permite la reproducción de medios en el contexto o situación actual." Disponible en inglés, francés, español y portugués (dependiendo del idioma del sistema operativo).
• code (Código de estado de cadena, consulte la lista a continuación).
• message (cadena). Campo para agregar mensaje de error u otro evento.

Aquí le ofrecemos la lista de los mensajes de estado y sus códigos asociados.

El código puede usarse para mostrar un mensaje que no sea el predeterminado proporcionado en la propiedad "estado".

Nota: cuando un stream en vivo está bloqueado geográficamente, LIVE_FAILED se recibe. Cuando un stream HLS está bloqueado geográficamente, HLS_STREAM_GEOBLOCKED se reciba.

módulo: reproductor multimedia

Evento: track-cue-point

Se recibió un nuevo punto de referencia de pista en el stream.

propiedades de los datos de evento:

• cuePoint (Objeto) - Las propiedades del objeto cuePoint son:
  • cueTitle (cadena) - El título de la canción
  • artistName (cadena): el nombre del artista
  • albumName (cadena) - El nombre del álbum
• parameters (Object) - La lista de parámetros original enviada por el punto de referencia.

Ejemplo (JavaScript):

/** Attach an addEventListener to the TD Web Player SDK instance **/
player.addEventListener( 'track-cue-point', onTrackCuePoint );
 
function onTrackCuePoint( event )
{
   var cueTitle = event data.cuePoint.cueTitle;
}

módulo: reproductor multimedia

Evento: Custom-Cue-Point

Se recibió un nuevo punto de referencia personalizado en el stream.

propiedades de los datos de evento:

• cuePoint (objeto) que contiene las propiedades personalizadas.
• parameters (Object) - La lista de parámetros original enviada por el punto de referencia.

módulo: reproductor multimedia

Evento: Speech-cue-point

Se recibió un nuevo punto de referencia de discurso en el stream.

propiedades de los datos de evento:

• cuePoint (Objeto) - Las propiedades del objeto cuePoint son:
  • cueTitle (cadena) - El título de la canción
  • artistName (cadena) - El nombre del artista de la canción
• parameters (Object) - La lista de parámetros original enviada por el punto de referencia.

Para ver otros parámetros disponibles dentro de este punto de referencia, consulte el Diccionario de metadatos STWCue.

módulo: reproductor multimedia

Evento: HLS-Cue-Point

Se ha recibido un nuevo punto de referencia HLS en el stream (solo iOS).

propiedades de los datos de evento:

• cuePoint (Objeto) - Las propiedades del objeto cuePoint son:
  •  hls_track_id (cadena): ID de pista del siguiente segmento.
  •  hls_segment_id (cadena): ID de segmento del siguiente segmento.

módulo: reproductor multimedia

Evento: Timeout-Alert

Alerta de expiración de la conexión: el stream se detendrá en 30 segundos.

Consulte la documentación de la función play() (parámetro connectionTimeOut) .

módulo: reproductor multimedia

Evento: Timeout-Reach

La conexión expiró (el usuario no hizo clic en el mensaje anterior de alerta de expiración de conexión).

En este momento, el kit de desarrollo de software del reproductor detuvo el stream automáticamente.

módulo: reproductor multimedia

Evento: TargetSpot-Cue-Point

Se recibió un nuevo punto de referencia TargetSpot en el stream.

propiedades del evento:

duración: duración del corte publicitario TargetSpot, en milisegundos

módulo: reproductor multimedia

Evento: timeshift-info

Proporciona información general sobre el stream HLS. Inserte el fragmento de código descripto en Event Listener para suscribirse a la información.

propiedades del evento:

totalDuration: duración de la sesión Timeshift, en milisegundos

módulo: reproductor multimedia

Evento: ad-break-cue-point

Se recibió un nuevo punto de referencia de corte publicitario en el stream.

propiedades del evento:

• adBreakData (objeto): las propiedades del objeto adBreakData son:
  •  url (cadena): la URL del banner sincronizado
  • duration (Integer) - La duración del corte publicitario
  • cueTitle (cadena): el título del corte publicitario
  • adVast (cadena) - Respuesta VAST del anuncio.
  • vastUrl (cadena) - URL para obtener el VAST.
  • duration (cadena) - duración del anuncio

módulo: reproductor multimedia

Evento: Ad-break-cue-point-complete

El corte publicitario actual terminó.

módulo: reproductor multimedia

Evento: Ad-playback-start

Reproducción de anuncio: cada vez que comienza la reproducción de un anuncio de audio/video, se activa este evento.

propiedades del evento:

type (String) - El tipo de servidor de anuncios (es decir, vastAd cuando se utilizó VAST Ad Server).

módulo: reproductor multimedia

Evento: Ad-blocker-detected

Se activa este evento cuando el cliente tiene habilitado un bloqueador de anuncios.

propiedades del evento:

message (cadena): el mensaje del bloqueador de anuncios.

módulo: reproductor multimedia

Evento: Ad-playback-complete

Reproducción de anuncio: cada vez que una reproducción de anuncio de audio/video está completa, se activa este evento. Aquí es donde debe llamar a la función play() para reproducir la transmisión en vivo.

propiedades del evento:

type (String) - El tipo de servidor de anuncios (es decir, vastAd cuando se utilizó VAST Ad Server).

módulo: reproductor multimedia

Evento: Ad-playback-error

Reproducción de anuncio: cada vez que una reproducción de anuncio de audio/video devuelve un error (es decir, el anuncio no se pudo reproducir), se activa este evento. Aquí es donde debe llamar a la función play() para reproducir la transmisión en vivo.

módulo: reproductor multimedia

Evento: Ad-Countdown

Ad CountDown: el evento es activado cuando se está reproduciendo un anuncio de audio/video, lo cual le permite mostrar un mensaje de cuenta regresiva (por ejemplo: Publicidad: el stream comenzará en xx segundos)

propiedades del evento:

• countDown (Integer): el valor en segundos antes de que finalice el anuncio.

módulo: reproductor multimedia

Evento: Ad-quartile

Ad Quartile. Se acciona el evento en cada cuartil, cuando se está reproduciendo un anuncio de audio/video.

propiedades del evento:

• type (Cadena): los valores posibles para el tipo son:
  • Inicio (inicio de la reproducción del anuncio = 0 %)
  • primeroCuartil (25 %)
  • Punto medio (50 %)
  • terceroCuartil (75 %)
  • Completo (100%)

módulo: reproductor multimedia

Evento: vpaid-ad-companions

Campaña VPAID: cuando una campaña VPAID contiene complementos de anuncios, se activa este evento. Escuche este evento para mostrar los complementos de anuncios VPAIS en la página.

propiedades del evento:

• companions (Array) - Variedad de anuncios complementarios de VAST

módulo: reproductor multimedia

Evento: error de configuración

Error de configuración - Se acciona un error del evento porque el objeto de datos JSON que se envió a la biblioteca es inválido.
Verifique si el objeto de datos JSON es correcto.

módulo: reproductor multimedia

Evento: stream-geo-blocked

El stream tiene bloqueo geográfico. Se activa el evento cuando la llamada al servidor de aprovisionamiento devuelve un estado "Stream Geo Blocked".
La conexión al stream no será posible. Se debería mostrar un mensaje al usuario, como por ejemplo: "Sorry, the stream is not available in your area"("Lo sentimos, el stream no está disponible en su área").

módulo: reproductor multimedia

Evento: Video-mid-roll-playback-start

Reproducción de anuncio durante podcast de video: cada vez que se comienza a reproducir un anuncio durante podcast de video, se activa este evento.

módulo: reproductor multimedia

Evento: Video-mid-roll-playback-complete

Reproducción de anuncio durante podcast de video: cada vez que un anuncio durante podcast de video está completo, se activa este evento.

módulo: SyncBanners

Evento: Ad-break-Synced-Element

Un banner de corte publicitario está disponible en el punto de referencia de corte publicitario y se cargará y mostrará automáticamente en su elemento div HTML en la página.

propiedades del evento:

• type (String): tipo de banner sincronizado. Posibles valores: legacy o VAST.
• id (cadena) - El ID del banner HTML, tal como se define en la propiedad "elements" del módulo SyncBanners.
• data (Object) - Se define sólo si el tipo es VAST. Contiene la propiedad del objeto VAST del banner.
•  url (cadena): se define solo si el tipo es heredado. Contiene el URL del banner sincronizado.

módulo: NowPlayingApi

Evento: lista cargada

Historial de reproducción en curso cargado. Se activa el evento cuando los datos del historial de reproducción en curso ha sido cargado y está disponible.

propiedades del evento:

• data (objeto) - Lista de datos de reproducción en curso (pista, anuncio, voz)

/** Attach an addEventListener to the TD Web Player SDK instance **/
player.addEventListener( 'list-loaded', onListLoaded );
 
function onListLoaded( e )
{
    console.log( 'tdplayer::onListLoaded' );
    console.log( e.data );
    $.each( e.data.list, function(index, item){
       console.log('Artist : ' + item.artistName );
       console.log('Title : ' + item.cueTitle );
       console.log('Time : ' + item.cueTimeStart );
    } );
}

módulo: NowPlayingApi

Evento: lista vacía

El historial de reproducción en curso está vacío (no hay datos). Se activa el evento cuando los datos del historial de reproducción en curso ha sido cargado y está vacío.

/** TD Web Player SDK instance **/
var player = new TDSdk( tdPlayerConfig );
 
/** Attach an addEventListener to the TD Player SDK instance **/
player.addEventListener( 'list-empty', onListEmpty);
 
function onListEmpty( e )
{
    console.log( 'tdplayer::onListEmpty' );
}

módulo: NowPlayingApi

Evento: NowPlaying-API-Error

Error de API de reproducción en curso - Se activa el evento cuando no fue posible recuperar los datos del historial de reproducción en curso debido a un error.

/** TD Player SDK instance **/
var player = new TDSdk( tdPlayerConfig );
 
/** Attach an addEventListener to the TD Player SDK instance **/
player.addEventListener( 'nowplaying-api-error', onNowPlayingApiError);
 
function onNowPlayingApiError( e )
{
    console.log( 'tdplayer::onNowPlayingApiError' + e );
}