Cette documentation aborde le suivi dans la version 2.x du SDK.
Si vous mettez en œuvre une version 1.x du kit SDK, vous pouvez télécharger les Guides du développeur 1.x dans la rubrique Téléchargement des SDK.
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.
MediaObjectRéférence d’API :
mediaObject = ADBMobile.media.createMediaObject(<name>, <id>, <duration>, <streamType>, <mediaType>);
StreamTypeConstantes :
MediaTypeConstantes :
Ajout de métadonnées vidéo
Vous pouvez joindre des objets de métadonnées vidéo standard et/ou personnalisés à la session de suivi vidéo par le biais de variables de données contextuelles.
Métadonnées vidéo standard
Mise en œuvre de métadonnées standard sur Chromecast
Il est facultatif de joindre un objet de métadonnées vidéo standard à l’objet multimédia.
Métadonnées personnalisées
Créez un objet de variable pour les variables personnalisées et renseignez les données de cette vidéo. Par exemple :
/* 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’objet media.
ADBMobile.media.trackSessionStart(mediaObject, customVideoMetadata);
trackSessionStart effectue le suivi de l’intention de lecture de l’utilisateur, et non du début de la lecture. Cette API est utilisée pour charger les données/métadonnées de la vidéo et estimer le temps jusqu’au démarrage de la mesure QoS (durée entre trackSessionStart et trackPlay).
La deuxième valeur est le nom d’objet de métadonnées vidéo personnalisé que vous avez créé à l’étape 2. Si vous n’utilisez pas de métadonnées vidéo personnalisées, envoyez simplement un objet vide pour l’argument data dans trackSessionStart, tel que décrit dans la ligne commentée de l’exemple iOS ci-dessus.
Suivi du début réel de la lecture
Identifiez l’événement du lecteur vidéo correspondant au début de la lecture vidéo, où la première image de la vidéo s’affiche à l’écran, et appelez trackPlay :
ADBMobile.media.trackPlay();
Mettre à jour la valeur du curseur de lecture
Mettez à jour la valeur de la position du mediaUpdatePlayhead plusieurs fois lorsque le curseur de lecture change.
Pour les vidéos à la demande (VOD), la valeur est indiquée en secondes à partir du début de lʼélément média.
Pour la diffusion en direct, si le lecteur ne fournit pas d’informations sur la durée du contenu, la valeur peut être spécifiée comme le nombre de secondes écoulées depuis minuit UTC de ce jour.
Remarque : lors de l’utilisation de marques de progression, la durée du contenu est une donnée obligatoire et le curseur de lecture doit être mis à jour en tant que nombre de secondes écoulées depuis le début de l’élément média, en commençant par 0.
ADBMobile().mediaUpdatePlayhead(position)
Suivi de la fin de la lecture
Identifiez l’événement du lecteur vidéo correspondant à la fin de la lecture vidéo, où l’utilisateur a visionné le contenu jusqu’à la fin, et appelez trackComplete :
ADBMobile.media.trackComplete();
Suivi de la fin de la session
Identifiez l’événement du lecteur vidéo correspondant au déchargement/à la fermeture de la lecture vidéo, où l’utilisateur ferme la vidéo et/ou la vidéo est terminée et déchargée, et appelez trackSessionEnd :
ADBMobile.media.trackSessionEnd();
trackSessionEnd marque la fin d’une session de suivi vidéo. Si la session a été visionnée jusqu’à la fin, où l’utilisateur a visionné le contenu jusqu’à la fin, assurez-vous que trackComplete est appelé avant trackSessionEnd. Tout autre appel à l’API track* est ignoré après trackSessionEnd, sauf trackSessionStart dans le cadre d’une nouvelle session de suivi vidéo.
Suivi de tous les scénarios de mise en pause possibles
Identifiez l’événement du lecteur vidéo correspondant à l’interruption de la vidéo et appelez trackPause:
ADBMobile.media.trackPause();
Scénarios de mise en pause
Identifiez tous les scénarios dans lesquels le lecteur vidéo sera interrompu et assurez-vous que trackPause est correctement appelé. Les scénarios suivants exigent tous que votre application appelle trackPause() :
Identifiez l’événement du lecteur correspondant à la lecture vidéo et/ou à la reprise vidéo après une interruption et appelez trackPlay :
ADBMobile.media.trackPlay();
Il peut s’agir de la même source d’événement utilisée à l’étape 4. Assurez-vous que chaque appel de l’API trackPause() est suivi d’un appel de l’API trackPlay() à la reprise de la lecture vidéo.