Referencia de kit de desarrollo de software de JavaScript

  • Actualizado el 17 de abr. de 2024
  • Publicado el May 25, 2023
  • 5 minuto(s) de lectura
Anterior Siguiente

Esta sección describe todos los métodos de JavaScript disponibles en el kit de desarrollo de software.

player.version

Devuelve la versión del kit de desarrollo de software de reproductor web de Triton Digital.

console.log(player.version)

player.play( params )

Comience la reproducción de un stream de audio/video en vivo.

La función de reproducción automática está deshabilitada en dispositivos móviles (iOS, Android) con HTML5. Para ver información relacionada, consulte Usar la reproducción automática.

Parámetros:

params (objeto). Requerido: Sí.

El objeto de configuración de la reproducción

Propiedades:

station (String) o mount (String). Requerido: Sí.

La estación en la plataforma de Triton Digital. Ejemplo: TRITONRADIOMUSIC

Montaje en la plataforma de Triton Digital. Ejemplo: TRITONRADIOMUSICAAC

connectionTimeOut (número). Requerido: No.

Duración de la conexión de stream en vivo antes de expirar (minutos) - el valor predeterminado 0 (desactivado). Cuando se define un valor de connectionTimeOut, después de los minutos de "connectionTimeOut ", el controlador envía un evento de "alerta de tiempo de espera" que indica que la transmisión se detendrá.

Cuando se recibe esa alerta, el desarrollador del sitio web (cliente) debe mostrar un mensaje al usuario, como por ejemplo: "Para mantener la conexión activa, haga clic aquí o de lo contrario el stream se detendrá".

El usuario puede continuar escuchando la transmisión en vivo haciendo clic en este mensaje: el desarrollador del sitio web (lado del cliente) debe llamar a la función restartConnectionTimeOut() (ver más abajo) y ocultar el mensaje. Si el usuario no hace clic en el mensaje, entonces 30 segundos después de mostrarse la alerta, el stream se detendrá automáticamente. El controlador envía un evento "timeout-reached". Si el usuario quiere escuchar de nuevo el stream, el desarrollador del sitio web (cliente) debe mostrar otro mensaje. Por ejemplo:

"El stream se detuvo (la conexión expiró). Para escuchar de nuevo el stream en vivo, haga clic aquí. Gracias". Cuando el usuario hace clic en este mensaje, el desarrollador del sitio web (cliente) debe llamar a la función play() y ocultar el mensaje.

timeShift (booleano). Requerido: No.

Configurado en true para habilitar Timehift Radio del lado del cliente. Se establece en false para deshabilitar TimeShifting. El valor predeterminado es false.

Crea un encabezado player.seek().  (Solo se aplica a montajes habilitados para Timeshift).

- Úsalo para buscar hacia adelante y hacia atrás.

por ejemplo: seek(10), seek(-10)

Crea un encabezado player.seekLive().  (Solo se aplica a montajes habilitados para Timeshift).

- Utilícelo para buscar la posición en vivo en el stream.

trackingParameters (objeto). Requerido: No.

Los valores trackingParameters se anexan a la URL de stream. Se usan para registrar información desde el reproductor. Ejemplo:

player.play( {
      station: 'STATION_NAME',
      trackingParameters: {
      dist: 'triton',
      KEY2: 'value2',
      KEY3: 'value3'
      }
} );
Ejemplo: Reproduzca el stream de la estación TRITONRADIOMUSIC:

player.play( {station: 'TRITONRADIOMUSIC'} );

Ejemplo: Reproduzca el stream de montaje de TRITONRADIOMUSICAAC:
player.play( {mount: 'TRITONRADIOMUSICAAC'} );

 
Ejemplo: Reproduzca el stream de la estación TRITONRADIOMUSIC con el tiempo de espera de conexión establecido en 60 minutos y TimeShifting habilitado.

player.play( {station: 'TRITONRADIOMUSIC', connectionTimeOut:60, timeShift:true} );

player.pause()

Detenga la transmisión. Funciona igual que player.stop()

player.pause();

player.stop()

Detener el stream.

player.stop();

player.resume()

Inicia el stream. Funciona igual que player.play()

player.resume();

player.restartConnectionTimeOut()

Reiniciar la expiración de la conexión.

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

player.restartConnectionTimeOut();

player.changePlayBackRate(tasa)

Cambie la velocidad de reproducción del podcast.

El valor de la tasa es un valor flotante, con un valor entre 0 e infinito.

Ejemplos: Si el valor cambia a 2, la velocidad se duplica. Si el valor cambia a 0.5, entonces se reproduce a media velocidad.

player.setVolume( volumePercent )

Configura el volumen del audio/video del controlador

No compatible: iOS, Android debido a limitaciones incorporadas.

Definición

volumePercent (número). Requerido: Sí

El nuevo porcentaje de volumen entre 0 y 1. Ejemplo: 0.75 para 75 %

Ejemplo:

player.setVolume(1);

player.getVolume

Volver al volumen actual

No compatible: iOS, Android, debido a que el nivel de audio está siempre bajo el control físico del usuario en el dispositivo móvil.

player.getVolume();

player.mute()

Detenga la transmisión. Funciona igual que player.stop()

player.mute();

player.unMute()

Inicia el stream. Funciona igual que player.play()

player.unMute();

player.playAd( adServerType, config )

Reproducir un anuncio (audio/video) - puede usarse antes, durante o después del podcast.

Definición

adServerType (cadena). Requerido: Sí.

adServerType define qué Ad Plugin usar, los posibles valores son:

  • vastAd: El plugin vastAd es necesario en la configuración para usar esta característica.
  • tap: El plugin tap es necesario en la configuración para usar esta función.
  • mediaAd: El plugin mediaAd es necesario en la configuración para utilizar esta función.

adConfig (objeto). Requerido: Sí.

Para adServerType vastAd, las propiedades de adConfig son:

  • adConfig.sid (integer) - TritonRunSpot Station Id - Si se establece un valor, se llama a la API TritonRunSpot.
  • adConfig.mediaformat (integer): valor opcional para el formato de contenido de la API TritonRunSpot. El valor predeterminado es 21.

o

  • adConfig.url: si se establece un valor, se llama al URL de VAST Ad mediante adConfig.url.
  • adConfig.rawXML: si se establece el valor, se usa la respuesta de VAST Ad (XML previamente analizado) mediante adConfig.rawXML .
Si adConfig.url y adConfig.sid están configurados en el objeto adConfig, se utiliza el sid 
por defecto.

Para adServerType tap, las propiedades adConfig son:

  • adConfig.host (cadena): nombre de host que se usará en las solicitudes de anuncios on demand. Requerido: sí.
  • adConfig.type (cadena): tipo de anuncio. Valores válidos: preroll o midroll. Requerido: sí.
  • adConfig.format (cadena): formato de representación. Valores válidos: vast, vast-jsonp, daast. Requerido: no. Predeterminado: vast.
  • adConfig.stationName (cadena): nombre de la estación. Requerido: sí.
  • adConfig.stationId (integer): ID de estación. Requerido: sí.
  • adConfig.maxAds (integer) - Número máximo de anuncios. Requerido: no.
  • adConfig.assetType (cadena): tipo de recurso. Requerido: no.
  • adConfig.minFileSize (integer): tamaño mínimo. Requerido: no.
  • adConfig.maxFileSize (integer): tamaño máximo. Requerido: no.
  • adConfig.fileFormat (String) - Formato de archivo. Lista separada por comas de: mp3, adts, flv, mp4, ogg. Requerido: no.
  • adConfig.minDuration (integer) - Duración mínima. Requerido: no.
  • adConfig.maxDuration (integer) - Duración máxima. Requerido: no.
  • adConfig.minBitrate (integer) - Tasa de bits mínima. Requerido: no.
  • adConfig.maxBitrate (integer) - Tasa de bits máxima. Requerido: no.
  • adConfig.minWidth (integer): ancho mínimo. Requerido: no.
  • adConfig.maxWidth (integer) - Ancho máximo. Requerido: no.
  • adConfig.minHeight (integer) - Altura mínima. Requerido: no.
  • adConfig.maxHeight (integer) - Altura máxima. Requerido: no.
  • adConfig.audioCodec (cadena): códec de audio. Requerido: no.
  • adConfig.audioMinChannels (integer) - Canales mínimos. Requerido: no.
  • adConfig.audioMaxChannels (integer) - Canal máximo. Requerido: no.
  • adConfig.audioSampleRates (cadena): tasas de muestras de audio. Requerido: no.
  • adConfig.videoCodec (cadena): códec de vídeo. Requerido: no.
  • adConfig.videoAspectRatio (cadena): radio de aspecto. Requerido: no.
  • adConfig.minFrameRate (integer): velocidad de fotogramas mínima. Requerido: no.
  • adConfig.maxFrameRate (integer): velocidad de fotogramas máxima. Requerido: no.
  • adConfig.excludedCategories (String) - Categorías excluidas. Solo disponible con los anuncios Triton Digital SSP/Exchange. Requerido: no.

Nota: Es necesario especificar el ID o el nombre de la estación al activar el servicio de solicitud de anuncios on demand. Si bien tanto las ID como los nombres son compatibles, se recomienda encarecidamente que utilice nombres de estaciones. Si se proporcionan tanto el ID como el nombre, se utiliza el nombre (no hay comprobación de validación de que el ID coincida con el nombre).

Para adServerType bloom, las propiedades de adConfig son:

  • adConfig.id - El ID obligatorio de BloomAd Spot debe ser solo un tipo de anuncio multimedia (es decir, archivo de video/audio). Los banners complementarios Bloom NO son gestionados por el kit de desarrollo de software de reproductor, deben cargarse dentro de un iFrame en JavaScript.

Para adServerType mediaAd, las propiedades de adConfig son:

  • adConfig.mediaUrl Cadena: archivo de anuncio multimedia de audio/vídeo que se va a reproducir.
  • adConfig.linkUrl Cadena: enlace asociado con el anuncio multimedia.

La propiedad trackingParameters se puede usar para pasar información de orientación al servidor de anuncios.

La propiedad volume puede ser útil para definir el nivel de volumen de la reproducción de anuncios.

Ejemplos:

//VAST Ad full URL
playAd( 'vastAd', { url:
'http://runspot4.tritondigital.com/RunSpotV4.svc/GetVASTAd?&StationID=8441&MediaForm
at=21&RecordImpressionOnCall=false&AdMinimumDuration=0&AdMaximumDuration=900&AdLevel
Placement=1&AdCategory=1' } );
 
//Call Triton Ad Platform (TAP)
player.playAd( 'tap', { host:'cmod.live.streamtheworld.com', type:'preroll', format:'vast', stationId:77583 } );
 
//Call TritonRunSpot V 4.0+ (Campaign manager) VAST Ad Preroll with preroll-synced banner. sid (integer) is the TritonRunSpot Station ID (required).
playAd( 'vastAd', { sid: 8441 } );
 
//Call Media Ad
player.playAd( 'mediaAd', { mediaUrl:
'http://cdnp.tremormedia.com/video/acudeo/Carrot_400x300_500kb.flv',
linkUrl:'http://www.google.fr/' } );
 
//Call Bloom Ad Spot id
player.playAd( 'bloom', { id: 4974 } );
 
//Call with trackingParamters. TritonRunSpot V 4.0+ (Campaign manager) VAST Ad
Preroll with preroll-synced banner. sid (integer) is the TritonRunSpot Station ID
(required).
 
player.playAd( 'vastAd', { sid: 8441, trackingParameters:{banners:300x250} } );

player.skipAd()

Saltarse el anuncio actual

player.skipAd();

NowPlayingApi.load( {mount:mount, hd:true, numberToFetch:10, eventType:'track', } )

Cargar el historial de reproducción en curso

 mount (cadena). Requerido: Sí.

El montaje de la estación en la plataforma de Triton Digital.

 hd (booleano). Requerido: No.

Falso predeterminado. Configurar en verdadero si el montaje tiene AAC.

numberToFetch (número). Requerido: No.

Cantidad de elementos a buscar

eventType (cadena). Requerido: No.

"Pista" predeterminada

player.NowPlayingApi.load({mount:'STD_PLAYER_DEMO1', hd:true, numberToFetch:10});