Hérité - Présentation de la configuration du SDK Media setup-overview

Après avoir téléchargé le SDK Media pour votre application ou lecteur vidéo, suivez les informations de cette section pour configurer et implémenter le SDK Media.

Instructions générales de mise en œuvre general-implementation-guidelines

Trois composants principaux du SDK sont utilisés dans le suivi d’Adobe Streaming Media :

  • Media Heartbeat Config : le MediaHeartbeatConfig contient les paramètres de base de la création de rapports.
  • Media Heartbeat Delegate : le MediaHeartbeatDelegate contrôle la durée de lecture et l’objet QoS.
  • Media Heartbeat : le MediaHeartbeat correspond à la bibliothèque principale qui contient les membres et les méthodes.

Implémenter le SDK Streaming Media

Pour configurer et utiliser le SDK Streaming Media, procédez comme suit :

  1. Créez une instance MediaHeartbeatConfig et définissez les valeurs des paramètres de configuration.

    table 0-row-4 1-row-4 2-row-4 3-row-4 4-row-4 5-row-4 6-row-4 7-row-4 3-align-center 8-align-center 13-align-center 18-align-center 23-align-center 28-align-center 33-align-center 38-align-center
    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.

    table 0-row-3 1-row-3 2-row-3 3-align-center 7-align-center 11-align-center
    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 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.
    Oui
    note tip
    TIP
    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 :
    table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 3-align-center 7-align-center 11-align-center 15-align-center 19-align-center
    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.

    note important
    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.
    note tip
    TIP
    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 :

    code language-javascript
    // 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 validate

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.

    note important
    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 :

recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb