Évènements du SDK du lecteur Web

module : SDK global

Événement :player-ready

Rappel lorsque le kit de développement logiciel du lecteur Web est prêt. Tous les modules sont chargés.

module : MediaPlayer

Événement : stream-start

Lecture instantanée du flux lancée.

module : MediaPlayer

Événement : stream-stop

Lecture instantanée du flux interrompue.

module : MediaPlayer

Événement : stream-select
Un point de montage du flux a été sélectionné.

module : MediaPlayer

Événement : stream-config-ready
La configuration du flux en direct est prête.

module : MediaPlayer

Événement : stream-config-error
L'analyse de config. du flux en direct a détecté une erreur.

module : MediaPlayer

Événement : stream-config-load-error
Le chargement de config. du flux en direct a détecté une erreur.

module : MediaPlayer

Événement : stream-fail

Échec de connexion au flux.

module : MediaPlayer

Événement : stream-error

Une erreur de flux s'est produite.

propriétés de l'événement :

text (chaîne) - Le texte d'erreur.

module : MediaPlayer

Événement : stream-status

Informations de statut du flux.

propriétés de l'événement :

• état (chaîne) Message texte d'état « La lecture du média dans le contexte actuel n'est pas autorisée ».Disponible en anglais, français, espagnol et portugais (selon la langue du système d'exploitation).
• code (code d'état de chaîne, reportez-vous à la liste ci-dessous.)
• message (chaîne). Champ permettant d'ajouter un message d'erreur ou un autre message d'événement.

Voici la liste des messages de statut et les codes qui leur sont associés.

Le code peut être utilisé pour afficher un message autre que le message par défaut fourni au niveau de la propriété « statut ».

Remarque : lorsqu’un flux en direct est géobloqué, LIVE_FAILED est reçu. Lorsqu’un flux HLS est géobloqué, HLS_STREAM_GEOBLOCKED .

module : MediaPlayer

Événement : track-cue-point

Un nouveau marqueur temporel de piste a été reçu dans le flux.

propriétés des données de l'événement

• cuePoint (Objet) - Les propriétés de l'objet cuePoint sont :
  • cueTitle  (chaîne) - Le titre de la chanson
  • artistName  (chaîne) - Le nom de l'artiste
  • albumName  (chaîne) - Le nom de l'album
• parameters (Objet) : liste des paramètres d'origine envoyée par le marqueur temporel.

Exemple (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;
}

module : MediaPlayer

Événement : Custom-cue-point

Un nouveau marqueur temporel personnalisé a été reçu dans le flux.

propriétés des données de l'événement

• cuePoint (Objet) contenant les propriétés personnalisées.
• parameters (Objet) : liste des paramètres d'origine envoyée par le marqueur temporel.

module : MediaPlayer

Événement : Speech-cue-point

Un nouveau marqueur vocal a été reçu dans le flux.

propriétés des données de l'événement

• cuePoint (Objet) - Les propriétés de l'objet cuePoint sont :
  • cueTitle  (chaîne) - Le titre de la chanson
  • artistName (chaîne) : nom de l’artiste de la chanson
• parameters (Objet) : liste des paramètres d'origine envoyée par le marqueur temporel.

Pour les autres paramètres disponibles dans ce marqueur, veuillez vous référer au dictionnaire des métadonnées STWCue.

module : MediaPlayer

Événement : hls-cue-point

Un nouveau marqueur temporel HLS a été reçu dans le flux (iOS uniquement).

propriétés des données de l'événement

• cuePoint (Objet) - Les propriétés de l'objet cuePoint sont :
  • hls_track_id  (chaîne) : ID de piste du segment suivant.
  • hls_segment_id  (chaîne) : ID du segment suivant.

module : MediaPlayer

événement : timeout-alert

Alerte de connexion TimeOut : le flux s'arrêtera dans 30 secondes.

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

module : MediaPlayer

événement : timeout-reach

TimeOut atteint (l'utilisateur n'a pas cliqué sur le message d'alerte TimeOut précédent).

Le flux a alors été automatiquement arrêté par le SDK du lecteur.

module : MediaPlayer

événement : targetspot-cue-point

Un nouveau marqueur temporel TargetSpot a été reçu dans le flux.

propriétés de l'événement :

duration : durée de la coupure publicitaire TargetSpot, en millisecondes

module : MediaPlayer

événement : timeshift-info

Fournit des informations générales sur le flux HLS. Intégrez le bout de code décrit sous Auditeur d'événements pour vous abonner aux informations.

propriétés de l'événement :

totalDuration : durée de la session Timeshift, en millisecondes

module : MediaPlayer

événement : ad-break-cue-point

Un nouveau marqueur temporel de pause publicitaire a été reçu dans le flux.

propriétés de l'événement :

• adBreakData (objet) : les propriétés de l’objet adBreakData sont les suivantes :
  • url (chaîne) - L’url de la bannière synchronisée
  • duration (chiffre entier) - La durée de la coupure publicitaire
  • cueTitle (chaîne) : titre de la coupure publicitaire
  • adVast (chaîne) : réponse VAST de la publicité.
  • vastUrl (chaîne) - URL pour obtenir le VAST.
  • duration (chaîne) - Durée de la publicité

module : MediaPlayer

événement : ad-break-cue-point-complete

La coupure publicitaire actuelle est terminée.

module : MediaPlayer

événement : ad-playback-start

Lecture publicitaire : cet événement est déclenché à chaque fois qu'une publicité audio/vidéo commence à être diffusée.

propriétés de l'événement :

type (chaîne) : type de serveur publicitaire (c’est-à-dire vastAd lorsque VAST Ad Server a été utilisé).

module : MediaPlayer

événement : ad-blocker-detected

Événement déclenché lorsqu'un bloqueur de publicité est activé côté client.

propriétés de l'événement :

message (chaîne) : message du bloqueur de publicités.

module : MediaPlayer

événement : ad-playback-complete

Lecture publicitaire : cet événement est déclenché à chaque fois que la lecture d'une publicité audio/vidéo est terminée. C’est ici que vous devez appeler la fonction play() pour lire le flux en direct.

propriétés de l'événement :

type (chaîne) : type de serveur publicitaire (c’est-à-dire vastAd lorsque VAST Ad Server a été utilisé).

module : MediaPlayer

événement : ad-playback-error

Lecture publicitaire : chaque fois qu'une publicité audio/vidéo renvoie une erreur (c'est-à-dire, que la publicité n'a pas été diffusée), cet événement est déclenché. C’est ici que vous devez appeler la fonction play() pour lire le flux en direct.

module : MediaPlayer

événement : ad-countdown

Ad CountDown : l'événement est déclenché lorsqu'une publicité audio/vidéo est diffusée, ce qui vous permet d'afficher un message de décompte (c'est-à-dire, un avertissement : le flux va commencer dans xx seconde(s)).

propriétés de l'événement :

• countDown (chiffre entier) : valeur en secondes avant la fin de l’annonce.

module : MediaPlayer

événement : ad-quartile

Ad Quartile. L'événement est déclenché sur chaque quartile, lorsqu'une publicité audio/vidéo est diffusée.

propriétés de l'événement :

• type (chaîne) : les valeurs possibles pour type sont les suivantes :
  • start (début de la lecture de la publicité = 0 %)
  • firstQuartile (25 %)
  • midpoint (50 %)
  • thirdQuartile (75 %)
  • complete (100 %)

module : MediaPlayer

événement : vpaid-ad-companions

VPAID campaign : cet événement est déclenché lorsqu'une campagne VPAID contient des compagnons publicitaires. Écouter cet événement pour afficher les compagnons publicitaires VPAID sur la page.

propriétés de l'événement :

• companions (Array) - Gamme de publicités complémentaires VAST

module : MediaPlayer

événement : configuration-error

Configuration Error - L'erreur d'événement est déclenchée parce que l'objet de données JSON envoyé à la bibliothèque est invalide.
Veuillez vérifier si l'objet de données JSON est correct.

module : MediaPlayer

événement : stream-geo-blocked

Le flux est géobloqué. L'événement est déclenché lorsque l'appel au serveur d'approvisionnement renvoie un statut de flux géobloqué.
La connexion au flux ne sera pas possible. Un message doit être affiché à l'utilisateur, tel que : « Désolé, le flux n'est pas disponible dans votre région ».

module : MediaPlayer

événement : video-mid-roll-playback-start

Lecture instantanée de publicité vidéo intercalaire : à chaque début de la lecture d'une publicité vidéo intercalaire, un événement est déclenché.

module : MediaPlayer

événement : video-mid-roll-playback-complete

Lecture instantanée de publicité vidéo intercalaire : chaque fois que la lecture d'une publicité vidéo intercalaire est terminée, un événement est déclenché.

module : SyncBanners

événement : ad-break-synced-element

Une bannière de coupure publicitaire est disponible dans le marqueur de coupure publicitaire et sera automatiquement chargée et affichée dans son élément div HTML dans la page.

propriétés de l'événement :

• type (chaîne) : type de bannière synchronisé. Valeurs possibles : existante ou VAST.
• id (chaîne) - L’ID de la bannière HTML, tel que défini dans la propriété « elements » du module SyncBanners.
• data (objet) : défini uniquement si le type est VAST. Contient la propriété objet VAST de la bannière.
• url (chaîne) : défini uniquement si le type est hérité. Contient l'URL de la bannière synchronisée.

module : NowPlayingApi

événement : list-loaded

Historique En cours de lecture chargé. L'événement est déclenché lorsque les données de l'historique de lecture ont été chargées et sont disponibles.

propriétés de l'événement :

• data (objet) - Liste des données En cours de lecture (piste, publicité, parole)

/** 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 );
    } );
}

module : NowPlayingApi

événement : list-empty

Historique En cours de lecture vide (pas de données). L'événement est déclenché lorsque les données de l'historique de lecture ont été chargées et sont vides.

/** 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' );
}

module : NowPlayingApi

événement : nowplaying-api-error

Erreur API en cours de lecture - L'événement est déclenché lorsque les données de l'historique de lecture n'ont pas été récupérées en raison d'une erreur de lecture.

/** 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 );
}