Format du flux

Cette page traite de la collecte de données pour la variable Format de flux. Voir Format de flux pour la dimension de reporting correspondante.

La variable de format du flux identifie le niveau de qualité du flux (généralement "HD" ou "SD", mais toute chaîne est acceptée). Définissez-le lorsque vous souhaitez ventiler l’engagement, l’achèvement ou la qualité par niveau de qualité de diffusion.

Propriété
Valeur
Variable de données contextuelles
a.media.format
champ de collection XDM
xdm.mediaCollection.sessionDetails.streamFormat
Caractéristique
c_contextdata.a.media.format
Obligatoire
Non
Envoyé avec
Début de session, fermeture de session

Types d’implémentation recommandés

SDK Web

streamFormat à l’intérieur des xdm.mediaCollection.sessionDetails lors de l’appel de sendEvent :

code language-javascript
alloy("sendEvent", {
  xdm: {
    eventType: "media.sessionStart",
    mediaCollection: {
      sessionDetails: {
        streamFormat: "HD"
      },
      playhead: 0
    }
  }
});
iOS

Transmettez le format de flux en tant que clé de métadonnées dans l’argument HashMap à trackSessionStart. Utilisez MediaConstants.VideoMetadataKeys.STREAM_FORMAT.

code language-swift
var metadata: [String: String] = [:]
metadata[MediaConstants.VideoMetadataKeys.STREAM_FORMAT] = "HD"

tracker.trackSessionStart(info: mediaObject, metadata: metadata)
Android

Transmettez le format de flux en tant que clé de métadonnées dans l’argument HashMap à trackSessionStart. Utilisez MediaConstants.VideoMetadataKeys.STREAM_FORMAT.

code language-kotlin
val metadata = HashMap<String, String>()
metadata[MediaConstants.VideoMetadataKeys.STREAM_FORMAT] = "HD"

tracker.trackSessionStart(mediaInfo, metadata)
Roku

Utilisez createMediaSession pour définir des streamFormat dans sessionDetails :

code language-brightscript
m.aepSdk.createMediaSession({
    "xdm": {
        "eventType": "media.sessionStart",
        "mediaCollection": {
            "sessionDetails": {
                "streamFormat": "HD"
            },
            "playhead": 0
        }
    }
})
API Media Edge

Appelez le point d’entrée sessionStart avec streamFormat à l’intérieur du xdm.mediaCollection.sessionDetails :

code language-json
{
  "events": [{
    "xdm": {
      "eventType": "media.sessionStart",
      "mediaCollection": {
        "sessionDetails": {
          "name": "video-123",
          "length": 128,
          "contentType": "vod",
          "playerName": "HTML5 Player",
          "channel": "Sports",
          "streamFormat": "HD"
        },
        "playhead": 0
      }
    }
  }]
}

Types d’implémentation hérités (Analytics uniquement)

Media SDK JS 3.x

Transmettez le format de flux dans l’objet contextData à l’aide de ADB.Media.VideoMetadataKeys.StreamFormat :

code language-javascript
var contextData = {};
contextData[ADB.Media.VideoMetadataKeys.StreamFormat] = "HD";

tracker.trackSessionStart(mediaInfo, contextData);
Chromecast

Utilisez ADBMobile.media.VideoMetadataKeys.STREAM_FORMAT pour définir le format de flux dans la propriété StandardMediaMetadata de l’objet média avant d’appeler trackSessionStart :

code language-javascript
var mediaInfo = ADBMobile.media.createMediaObject("My Video", "video-123", 128,
  ADBMobile.media.StreamType.VOD, ADBMobile.media.MediaType.Video);
var standardMetadata = {};
standardMetadata[ADBMobile.media.VideoMetadataKeys.STREAM_FORMAT] = "HD";
mediaInfo[ADBMobile.media.MediaObjectKey.StandardMediaMetadata] = standardMetadata;
ADBMobile.media.trackSessionStart(mediaInfo, null);
API Media Collection

Incluez media.streamFormat dans l’objet params de votre sessionStart requête POST :

code language-json
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "sessionStart",
  "params": {
    "media.streamFormat": "HD"
  }
}

Consultez la référence des sessions de l’API Media Collection pour obtenir la structure complète des requêtes.

recommendation-more-help
media-analytics-help