Effectuer le suivi de la lecture principale à l’aide de JavaScript 2.x track-core-playback-on-javascript

Configuration initiale du suivi

Déterminez le moment où l’utilisateur déclenche l’intention de lecture (l’utilisateur clique sur le bouton de lecture et/ou la lecture automatique est activée) et créez une instance MediaObject.

API createMediaObject

StreamTypeConstantes :

MediaTypeConstantes :

var mediaObject =
  MediaHeartbeat.createMediaObject(<MEDIA_NAME>,
                                  <MEDIA_ID,
                                  <MEDIA_LENGTH>,
                                  MediaHeartbeat.StreamType.VOD,
                                  <MEDIA_TYPE>);

Ajout de métadonnées

Vous pouvez joindre des métadonnées standard et/ou de publicité à la session de suivi par le biais de variables de données contextuelles.

• Métadonnées standard

  Mise en œuvre de métadonnées standard sur JavaScript

  note note
  NOTE
  Il est facultatif de joindre un objet de métadonnées standard à l’objet multimédia.

  • Référence à l’API des clés de métadonnées multimédia - Clés de métadonnées standard - JavaScript

    Consultez la liste complète des métadonnées disponibles dans la rubrique Paramètres audio et vidéo.

• Métadonnées personnalisées

  Créez un objet de variable pour les variables personnalisées et renseignez les données de ce média. Par exemple :

  code language-js
  /* Set custom context data */ var customVideoMetadata = { isUserLoggedIn: "false", tvStation: "Sample TV station", programmer: "Sample programmer" };

Suivi de l’intention de démarrer la lecture

Pour commencer le suivi d’une session multimédia, appelez trackSessionStart sur l’instance Media Heartbeat :

mediaHeartbeat.trackSessionStart(mediaObject, customVideoMetadata);

Suivi du début réel de la lecture

Identifiez l’événement du lecteur multimédia correspondant au début de la lecture, où la première image du média s’affiche à l’écran, et appelez trackPlay :

mediaHeartbeat.trackPlay();

Suivi de la fin de la lecture

Identifiez l’événement du lecteur multimédia correspondant à la fin de la lecture, où l’utilisateur a visionné le contenu jusqu’à la fin, et appelez trackComplete :

mediaHeartbeat.trackComplete();

Suivi de la fin de la session

Identifiez l’événement du lecteur multimédia correspondant au déchargement/à la fermeture de la lecture, où l’utilisateur ferme la vidéo et/ou le contenu média est terminé et déchargé, et appelez trackSessionEnd :

mediaHeartbeat.trackSessionEnd();

Suivi de tous les scénarios de mise en pause possibles

Identifiez l’événement du lecteur multimédia pour le mettre en pause et appelez trackPause :

mediaHeartbeat.trackPause();

Scénarios de mise en pause

Identifiez tous les scénarios dans lesquels le lecteur multimédia sera interrompu et assurez-vous que trackPause est correctement appelé. Les scénarios suivants exigent tous que votre application appelle trackPause() :

• L’utilisateur appuie délibérément sur pause dans l’application.
• Le lecteur se met en pause.
• (Applications mobiles) : l’utilisateur place l’application en arrière-plan, mais vous souhaitez que l’application conserve la session ouverte.
• (Applications mobiles) : tout type d’interruption système qui entraîne la mise en arrière-plan d’une application. Par exemple, l’utilisateur reçoit un appel ou une fenêtre contextuelle provenant d’une autre application apparaît, mais vous souhaitez que l’application conserve la session ouverte pour donner à l’utilisateur la possibilité de reprendre le média à partir du point d’interruption.

Identifiez l’événement du lecteur correspondant à la lecture et/ou à la reprise après une interruption et appelez trackPlay :

mediaHeartbeat.trackPlay();