Référence SDK JavaScript

  • Mis à jour le 17 avr. 2024
  • Publié le 25 mai 2023
  • 5 procès-verbal (procès-verbaux) lu(s)
Précédent Suivant

Cette section décrit l'ensemble des méthodes JavaScript dans le SDK.

player.version

Revenir à la version du kit de développement logiciel (SDK) du lecteur Web Triton Digital 

console.log(player.version)

player.play( params )

Lancer la lecture instantanée d'un flux audio/vidéo en direct.

La fonction lecture automatique est désactivée sur mobile (iOS, Android) avec HTML5. Pour des informations connexes, veuillez consulter la rubrique Utiliser la lecture automatique.

Paramètres :

params (objet). Obligatoire : Oui.

L'objet configuration de lecture instantanée

Propriétés :

station (chaîne) ou mount (chaîne). Obligatoire : Oui.

La station sur la plateforme Triton Digital. Exemple : TRITONRADIOMUSIC

Montage sur la plateforme Triton Digital. Exemple : TRITONRADIOMUSICAAC

connectionTimeOut (nombre). Obligatoire : Non.

Durée du flux live Connexion avant l'expiration de la session (minutes) - la valeur par défaut est 0 (désactivée). Lorsqu’une valeur connectionTimeOut est définie, après les minutes « connectionTimeOut », le contrôleur envoie un événement « timeout-alert » indiquant que le flux va s'arrêter.

Lorsqu'il reçoit cette alerte, le développeur du site internet (côté client) doit transmettre à l'utilisateur un message pouvant être libellé comme suit : "Pour maintenir la connexion établie, cliquez ici, sinon le flux s'arrêtera".

L'utilisateur peut continuer à écouter le flux en direct en cliquant sur ce message : le développeur du site web (côté client) doit lancer la fonction restartConnectionTimeOut() (voir ci-dessous) et masquer le message. Si l'utilisateur ne clique pas sur le message, 30 secondes plus tard, l'alerte est affichée, le flux s'arrête automatiquement. Le contrôleur envoie un évènement "timeout-reached". Si l'utilisateur veut à nouveau écouter le flux, le développeur du Site Web (côté client) doit afficher un autre message. Par exemple :

"Le flux a été arrêté (une expiration de session s'est produite). Pour écouter à nouveau le flux live, cliquez ici. Merci. » Lorsque l'utilisateur clique sur ce message, le développeur du site web (côté client) doit exécuter la fonction play() et masquer le message.

timeShift (variable booléenne). Obligatoire : Non.

La valeur « true » permet d'activer le TimeShift Radio côté client. La valeur « false » permet de désactiver le TimeShifting. La valeur par défaut est false.

Créer une rubrique player.seek(). (Applicable uniquement aux montages compatibles avec Timeshift.)

- Permet de rechercher vers l’avant et vers l’arrière.

Par exemple : seek(10), seek(-10)

Créer une rubrique player.seekLive(). (Applicable uniquement aux montages compatibles avec Timeshift.)

- Sert à rechercher la position en direct dans le flux.

trackingParameters (objet). Obligatoire : Non.

Les valeurs trackingParameters sont ajoutées à l’URL du flux. Ils sont utilisés pour enregistrer les informations du lecteur. Exemple :

player.play( {
    station: 'STATION_NOM',
    paramètres de suivi : {
    dist : « triton »,
    CLÉ2: 'valeur2',
    CLÉ3: 'valeur3'
      }
} );
Exemple : lecture du flux de la station TRITONRADIOMUSIC :

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

Exemple : lecture du flux de montage de TRITONRADIOMUSICAAC :
player.play( {mount: 'TRITONRADIOMUSICAAC'} );

 
Exemple : lecture du flux de la station TRITONRADIOMUSIC avec délai d’attente de connexion fixé à 60 minutes et TimeShifting activé.

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

player.pause()

Interrompre le flux. Fonctionne de la même manière que player.stop()

player.pause();

player.stop()

Arrêter le flux.

player.stop();

player.resume()

Lancer le flux. Fonctionne de la même manière que player.play()

player.resume();

player.restartConnectionTimeOut()

Redémarrer le délai d'expiration de la connexion.

Veuillez vous référer à la documentation de la fonction play() (paramètre connectionTimeOut).

player.restartConnectionTimeOut();

player.changePlayBackRate(rate)

Modifie la vitesse de lecture instantanée du podcast.

La valeur du taux est un nombre à virgule flottante, dont la valeur est comprise entre 0 et l’infini.

Exemples : Si la valeur passe à 2, la vitesse est doublée. Si la valeur passe à 0,5, il joue à mi-vitesse.

player.setVolume( volumePercent )

Règle le volume audio/vidéo du contrôleur

Non pris en charge : iOS, Android en raison des limitations intégrées.

Définition

volumePercent (nombre). Obligatoire : Oui

Le nouveau pourcentage de volume entre 0 et 1. Exemple : 0.75 pour 75%

Exemple :

player.setVolume(1);

player.getVolume

Retourner le volume actuel

Non pris en charge ! iOS, Android, car le niveau sonore est toujours sous le contrôle physique de l'utilisateur sur mobile.

player.getVolume();

player.mute()

Interrompre le flux. Fonctionne de la même manière que player.stop()

player.mute();

player.unMute()

Lancer le flux. Fonctionne de la même manière que player.play()

player.unMute();

player.playAd( adServerType, config )

Lire une publicité (audio/vidéo) - peut être utilisée avant la diffusion du contenu, en cours de diffusion du contenu et à la fin du contenu.

Définition

adServerType (chaîne). Obligatoire : Oui.

Le type d'adServer définit quel plugin utilisé, les valeurs potentielles sont :

  • vastAd : Le plugin vastAd est requis au niveau de la configuration pour utiliser cette fonctionnalité.
  • tap : le plug-in tap est requis dans la configuration pour utiliser cette fonctionnalité.
  • mediaAd : le plug-in mediaAd est requis dans la configuration pour utiliser cette fonctionnalité.

adConfig (objet). Obligatoire : Oui.

Pour adServerType vastAd, les propriétés adConfig sont les suivantes :

  • adConfig.sid (entier) - TritonRunSpot Station Id - Si la valeur est définie, l'API TritonRunSpot est sollicitée.
  • adConfig.mediaformat (entier) : valeur facultative pour le format de contenu de l’API TritonRunSpot. La valeur par défaut est 21.

ou

  • adConfig.url - Si la valeur est définie, l'URL de la publicité VAST est demandée en utilisant adConfig.url.
  • adConfig.rawXML - Si la valeur est définie, la réponse VAST Ad (XML pré-paramétré) est utilisée par le biais de adConfig.rawXML.
Si adConfig.url et adConfig.sid  sont tous deux définis dans l'objet adConfig, le sid est utilisé 
par défaut.

Pour adServerType tap, les propriétés adConfig sont les suivantes :

  • adConfig.host  (chaîne) - Nom d'hôte à utiliser pour les requêtes publicitaires à la demande. Obligatoire : Oui.
  • adConfig.type (chaîne) - Type d'annonce Valeurs valides : preroll ou midroll. Obligatoire : Oui.
  • adConfig.format (chaîne) - Format d'affichage. Valeurs valides : vast, vast-jsonp, daast. Obligatoire : non. Par défaut : vast.
  • adConfig.stationName (chaîne) - Nom de la station. Obligatoire : oui.
  • adConfig.stationId (entier) - Identifiant de la station. Obligatoire : Oui.
  • adConfig.maxAds (entier) - Nombre maximal d’annonces. Obligatoire : non.
  • adConfig.assetType (chaîne) - Type de ressource. Obligatoire : non.
  • adConfig.minFileSize (entier) - Taille minimale. Obligatoire : non.
  • adConfig.maxFileSize (entier) - Taille maximale. Obligatoire : non.
  • adConfig.fileFormat (chaîne) - Format de fichier. Liste séparée par des virgules de : mp3, adts, flv, mp4, ogg. Obligatoire : non.
  • adConfig.minDuration (entier) - Durée minimale. Obligatoire : non.
  • adConfig.maxDuration (entier) - Durée maximale. Obligatoire : non.
  • adConfig.minBitrate (entier) - Débit binaire minimum. Obligatoire : non.
  • adConfig.maxBitrate (entier) - Débit binaire maximal. Obligatoire : non.
  • adConfig.minWidth (entier) - Largeur minimale. Obligatoire : non.
  • adConfig.maxWidth (entier) - Largeur maximale. Obligatoire : non.
  • adConfig.minHeight (entier) - Hauteur minimale. Obligatoire : non.
  • adConfig.maxHeight (entier) - Hauteur maximale. Obligatoire : non.
  • adConfig.audioCodec (chaîne) - Codec audio. Obligatoire : non.
  • adConfig.audioMinChannels (entier) - Canaux minimum. Obligatoire : non.
  • adConfig.audioMaxChannels (entier) - Nombre maximal de canaux. Obligatoire : non.
  • adConfig.audioSampleRates (chaîne) - Taux d’échantillonnage audio. Obligatoire : non.
  • adConfig.videoCodec (chaîne) - Codec vidéo. Obligatoire : non.
  • adConfig.videoAspectRatio (chaîne) - Rapport hauteur/largeur Obligatoire : non.
  • adConfig.minFrameRate (entier) - Fréquence d’images minimale. Obligatoire : non.
  • adConfig.maxFrameRate (entier) - Fréquence d’images maximale. Obligatoire : non.
  • adConfig.excludedCategories (chaîne) - Catégories exclues. Uniquement disponible avec Triton Digital SSP/Exchange ads. Obligatoire : non.

Remarque : L'identifiant ou le nom de la station doit être spécifié lors du lancement de la procédure relative à la publicité à la demande. Bien que les identifiants et les noms soient tous deux pris en charge, il est fortement recommandé d'utiliser les noms des stations. Si l'identifiant et le nom sont tous deux mentionnés, c'est le nom qui est utilisé (il n'y a pas de contrôle visant à valider la concordance entre l'identifiant et le nom).

Pour adServerType bloom, les propriétés adConfig sont les suivantes :

  • adConfig.id - L’identifiant obligatoire BloomAd Spot doit être un média de type publicitaire uniquement (c’est-à-dire un fichier vidéo/audio). Les bannières d'accompagnement Bloom ne sont PAS gérées par le SDK du lecteur, elles doivent être chargées dans un iFrame de JavaScript.

Pour adServerType mediaAd, les propriétés adConfig sont les suivantes :

  • adConfig.mediaUrl (chaîne) - Fichier média publicitaire vidéo/audio à lire
  • adConfig.linkUrl (chaîne) - Lien associé à l’annonce média.

La propriété trackingParameters peut être utilisée pour transmettre des informations de ciblage au serveur publicitaire.

La propriété volume peut être utile pour définir le volume de lecture de la publicité.

Exemples :

//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()

Ignorer la publicité actuelle

player.skipAd();

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

Charger l'historique de lecture

mount (chaîne). Obligatoire : Oui.

Le montage de station sur la plateforme Triton Digital.

hd (booléen). Obligatoire : Non.

Par défaut faux. Régler sur vrai si le montage a AAC.

numberToFetch (nombre). Obligatoire : Non.

Nombre d'éléments à récupérer

eventType (chaîne). Obligatoire : Non.

Par défaut 'track'

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