createMediaSession

La commande createMediaSession fait partie du composant streamingMedia de Web SDK. Vous pouvez utiliser ce composant pour collecter des données relatives aux sessions multimédia sur votre site web. Voir la streamingMedia documentation pour savoir comment configurer ce composant.

Les données collectées peuvent inclure des informations sur les lectures de médias, les pauses, les terminaisons et d’autres événements associés. Une fois collectées, vous pouvez envoyer ces données à Adobe Analytics for Streaming Media, afin d’agréger les mesures. Cette fonctionnalité fournit une solution complète pour suivre et comprendre le comportement de consommation des médias sur votre site web.

Vous pouvez créer des sessions multimédia dans Web SDK de deux manières :

  • Les sessions multimédias suivies automatiquement permettent au SDK Web de gérer l’envoi d’événements ping multimédia à Adobe Analytics for Streaming Media. La fréquence de ces pings est déterminée par les paramètres de configuration du composant streamingMedia.
  • Sessions multimédias suivies manuellement vous permet de mieux contrôler l’envoi des événements ping de session à Adobe Analytics for Streaming Media. De plus, vous avez la possibilité de stocker le sessionID pour les sessions multimédia.

Création d’une session multimédia suivie automatiquement automatic

Pour démarrer le suivi automatique d’une session multimédia, appelez la méthode createMediaSession avec les options décrites ci-dessous :

    alloy("createMediaSession", {
        playerId: "movie-test",
        getPlayerDetails: () => {
            return {
                playhead: document.getElementById("movie-test").currentTime,
                qoeDataDetails: {
                    bitrate: 1000,
                    startupTime: 1000,
                    fps: 30,
                    droppedFrames: 10
                }
            };
        },
        xdm: {
            eventType: "media.sessionStart",
            mediaCollection: {
                sessionDetails: {
                    ...
                }
            }
        }
    });
Propriété
Type
Obligatoire
Description
playerId
Chaîne
Oui
L’identifiant du lecteur, un identifiant unique représentant la session multimédia.
getPlayerDetails
Fonction
Oui
Une fonction qui renvoie les détails du lecteur. Cette fonction de rappel sera appelée par le SDK Web avant chaque événement multimédia pour le playerId fourni.
xdm.eventType
Objet
Non
Type d’événement multimédia. S’il n’est pas fourni, ce champ est automatiquement défini sur media.sessionStart.
xdm.mediaCollection.sessionDetails
Objet
Oui
Contient les propriétés des détails de la session. Voir Schéma Media Collection pour plus d’informations.

Création d’une session multimédia suivie manuellement manual

Pour démarrer le suivi manuel d’une session multimédia, appelez la méthode createMediaSession avec les options décrites ci-dessous :

const sessionPromise = alloy("createMediaSession", {
    xdm: {
        eventType: "media.sessionStart",
        mediaCollection: {
            playhead: 0,
            sessionDetails: {
                ...
            },
            qoeDataDetails: {
                bitrate: 1000,
                startupTime: 1000,
                fps: 30,
                droppedFrames: 10
            }
        }
    }
});
Propriété
Type
Requis
Description
xdm.eventType
Objet
Non
Type d’événement multimédia. Si elle n’est pas fournie, elle est automatiquement définie sur media.sessionStart.
xdm.mediaCollection.sessionDetails
Objet
Oui
Contient les propriétés des détails de la session. Voir Schéma Media Collection pour plus d’informations.
xdm.mediaCollection.playhead
Nombre entier
Oui
Curseur de lecture actuel.
xdm.mediaCollection.qoeDataDetails
Objet
Non
Détails sur la qualité des données d’expérience. Pour plus d’informations, consultez la documentation Schéma de collecte de médias .

Création d’une session multimédia à l’aide de l’extension de balise Web SDK

L’extension de balise Web SDK équivalente à cette commande est le type d’événement Session start dans l’action « Send media event ».

recommendation-more-help
1ae86b30-e55e-49c1-ab11-9d0356a5f3e1