Présentation de la configuration

IMPORTANT

Avec l’abandon de la prise en charge des SDK mobiles de version 4 programmée au 31 août 2021, Adobe cessera également de prendre en charge les SDK Media Analytics pour iOS et Android. Pour plus d’informations, reportez-vous à la FAQ sur l’abandon de la prise en charge du SDK Media Analytics.

Les instructions suivantes s’appliquent aux SDK Media 2.x. Si vous mettez en œuvre une version 1.x du SDK Media, consultez la Documentation du SDK Media 1.x. Pour les intégrateurs Primetime, consultez la Documentation du SDK Media Primetime ci-dessous.

Prise en charge de version minimum de plateforme

Le tableau suivant décrit les versions minimum de plateforme prises en charge pour chaque SDK, à compter du 19 février 2019.

OS/Navigateur Version min requise
iOS iOS 6+
Android Android 5.0+ - Lollipop
Chrome v22+
Mozilla v27+
Safari v7+
IE v11+

Instructions générales de mise en œuvre

Trois composants principaux du SDK sont impliqués dans le suivi multimédia :

  • Media Heartbeat Config : la configuration contient les paramètres de base des rapports.
  • Media Heartbeat Delegate : le délégué contrôle la durée de lecture et l’objet QoS.
  • Media Heartbeat : la bibliothèque principale contient les membres et les méthodes.

Suivez les étapes de mise en œuvre suivantes :

  1. Créez une instance MediaHeartbeatConfig et définissez vos valeurs de paramètre de configuration.

    Nom de variable Description Obligatoire Valeur par défaut
    trackingServer Serveur de suivi pour Media Analytics. Différent de votre serveur de suivi Analytics. Oui Chaîne vide
    channel Nom du canal Non Chaîne vide
    ovp Nom de la plateforme multimédia en ligne sur laquelle le contenu est distribué. Non Chaîne vide
    appVersion Version de l’application/du kit SDK du lecteur multimédia Non Chaîne vide
    playerName Nom du lecteur multimédia en cours d’utilisation ; par exemple, « AVPlayer », « Lecteur HTML5 », « Mon lecteur personnalisé ». Non Chaîne vide
    ssl Indique si les appels doivent être effectués par HTTPS Non false
    debugLogging Indique si la journalisation de débogage est activée Non false
  2. Mettez en œuvre le MediaHeartbeatDelegate.

    Nom de méthode Description Obligatoire
    getQoSObject() Retourne l’instance MediaObject contenant les informations actuelles sur la qualité de service (QoS). Cette méthode est appelée à plusieurs reprises au cours d’une session de lecture. La mise en œuvre du lecteur doit toujours retourner les plus récentes données QoS disponibles. Oui
    getCurrentPlaybackTime() Renvoie la position actuelle du curseur de lecture. Pour le suivi VOD, la valeur est indiquée en secondes à partir du début de l’élément média. Pour le suivi LINEAR/LIVE, la valeur est indiquée en secondes à partir du début du programme. Oui
    CONSEIL

    L’objet Qualité de service (QoS) est facultatif. Si les données QoS sont disponibles pour votre lecteur et que vous souhaitez en effectuer le suivi, les variables suivantes sont requises :

    Nom de variable Description Obligatoire
    bitrate Débit du média, en bits par seconde. Oui
    startupTime Temps de démarrage du média, en millisecondes. Oui
    fps Images affichées par seconde. Oui
    droppedFrames Nombre de pertes d’images jusqu’ici. Oui
  3. Créez l’instance MediaHeartbeat.

    Utilisez les instances MediaHertbeatConfig et MediaHertbeatDelegate pour créer l’instance MediaHeartbeat.

    IMPORTANT

    Assurez-vous que votre instance MediaHeartbeat est accessible et reste attribuée jusqu’à la fin de la session. Cette instance sera utilisée pour tous les événements de suivi multimédia suivants.

    CONSEIL

    MediaHeartbeat requiert une instance de AppMeasurement pour envoyer des appels à Adobe Analytics.

  4. Combinez tous les éléments.

    L’exemple de code suivant utilise notre SDK JavaScript 2.x pour un lecteur vidéo HTML5 :

    // Create local references to the heartbeat classes
    var MediaHeartbeat = ADB.va.MediaHeartbeat;
    var MediaHeartbeatConfig = ADB.va.MediaHeartbeatConfig;
    var MediaHeartbeatDelegate = ADB.va.MediaHeartbeatDelegate;
    
    //Media Heartbeat Config
    var mediaConfig = new MediaHeartbeatConfig();
    mediaConfig.trackingServer = "[your_namespace].hb.omtrdc.net";
    mediaConfig.playerName = "HTML5 Basic";
    mediaConfig.channel = "Video Channel";
    mediaConfig.debugLogging = true;
    mediaConfig.appVersion = "2.0";
    mediaConfig.ssl = false;
    mediaConfig.ovp = "";
    
    // Media Heartbeat Delegate
    var mediaDelegate = new MediaHeartbeatDelegate();
    
    // Set mediaDelegate CurrentPlaybackTime
    mediaDelegate.getCurrentPlaybackTime = function() {
        return video.currentTime;
    };
    
    // Set mediaDelegate QoSObject - OPTIONAL
    mediaDelegate.getQoSObject = function() {
        return MediaHeartbeat.createQoSObject(video.bitrate,  
                                              video.startuptime,  
                                              video.fps,  
                                              video.droppedframes);
    }
    // Create mediaHeartbeat instance      
    this.mediaHeartbeat =  
      new MediaHeartbeat(mediaDelegate, mediaConfig, appMeasurementInstance);  
    

Validation

Les mises en œuvre de suivi Media Analytics génèrent deux types d’appels de suivi :

  • Les appels de démarrage du média et de la publicité sont envoyés directement au serveur Adobe Analytics (AppMeasurement).

  • Les appels Heartbeat sont envoyés au serveur de suivi Media Analytics (Heartbeats), y sont traités et transmis au serveur Adobe Analytics.

  • Serveur Adobe Analytics (AppMeasurement) Pour plus d’informations sur les options du serveur de suivi, voir Remplissage correct des variables trackingServer et trackingServerSecure.

    IMPORTANT

    Un serveur de suivi RDC ou CNAME se résolvant sur un serveur RDC est requis pour le service d’identifiant visiteur Experience Cloud.

    Le serveur de suivi des analyses doit se terminer par « .sc.omtrdc.net » ou être un serveur CNAME.

  • ** Serveur Media Analytics (Heartbeats)**
    Ceci a toujours le format « [your_namespace].hb.omtrdc.net ». La valeur de « [your_namespace] » indique votre société et est fournie par Adobe.

Le suivi multimédia fonctionne de la même manière sur toutes les plateformes, de poste de travail comme mobiles. Le suivi audio fonctionne actuellement sur les plateformes mobiles. Pour tous les appels de suivi, quelques variables universelles clés doivent être validées :

Documentation SDK 1.x

Kits SDK Video Analytics 1.x Guides du développeur (PDF uniquement)
Android Configuration pour Android
Apple TV Configuration pour Apple TV
Chromecast Configuration pour Chromecast
iOS Configuration pour iOS
JavaScript Configuration pour JavaScript
Primetime
TVML Configuration pour TVML

Documentation du SDK Media Primetime

Sur cette page

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now