View a markdown version of this page

MediaTailor variables de service pour le contrôle de session - AWS Elemental MediaTailor
Paramètres pris en chargeHeure de début AWSaws.prerollAWS. Overlay est disponibleAWS. Log Modeaws.avail SuppressionMode

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

MediaTailor variables de service pour le contrôle de session

AWS Elemental MediaTailor réserve l'espace de noms des paramètres de aws. requête pour les variables de service qui contrôlent le comportement au niveau de la session. Contrairement aux ads. paramètres (qui sont transmis à l'ADS) et aux manifest. paramètres (qui sont ajoutés aux URL du manifeste personnalisé), les aws. paramètres sont consommés directement par le serveur d'origine ou l'ADS MediaTailor et ne sont pas transmis à celui-ci.

Paramètres pris en charge

Le tableau suivant répertorie les aws.* paramètres que vous pouvez utiliser pour contrôler le comportement au niveau de la session.

Paramètre Type Valeurs Par défaut Description
aws.startTime Horodatage ISO 8601 Par exemple, 2026-06-17T10:00:00Z Non défini (jointure live-edge) Démarre la session à un endroit précis de la fenêtre du DVR. MediaTailor résout l'horodatage à la limite de segment la plus proche et émet EXT-X-START:TIME-OFFSET dans le manifeste HLS.
aws.preroll String enum enabled, disabled (sans distinction majuscules/minuscules) enabled Détermine si l'insertion d'annonces avant diffusion a lieu pour la session. Lorsquedisabled, le pré-roll est supprimé même si la configuration de lecture comporte unLivePreRollConfiguration.
aws.overlayAvails String enum on, off (sans distinction majuscules/minuscules) on Contrôle si la superposition (non linéaire) et les disponibilités sont traitées pour la session. Lorsque off les marqueurs publicitaires superposés dans le manifeste source sont ignorés et qu'aucune annonce superposée n'est insérée.
aws.logMode String enum DEBUG, DISABLED DISABLED Active une journalisation détaillée du débogage pour la session. Lorsque ce paramètre est défini surDEBUG, MediaTailor envoie des journaux de session détaillés vers CloudWatch Logs à des fins de dépannage.
aws.availSuppressionMode String enum OFF,BEHIND_LIVE_EDGE, AFTER_LIVE_EDGE (sans distinction majuscules/minuscules) OFF Contrôle si les publicités sont supprimées en fonction de leur position par rapport au Live Edge.
aws.availSuppressionValue Durée HH:MM:SS format (par exemple,00:00:10) Non défini Le créneau horaire pour la suppression de la disponibilité. Obligatoire quand availSuppressionMode c'est BEHIND_LIVE_EDGE ouAFTER_LIVE_EDGE.
aws.availSuppressionFillPolicy String enum FULL_AVAIL_ONLY, PARTIAL_AVAIL (sans distinction majuscules/minuscules) FULL_AVAIL_ONLY Lorsque le mode est AFTER_LIVE_EDGE défini, contrôle si les valeurs partiellement supprimées sont remplies.

Heure de début AWS

Quand aws.startTime est défini, MediaTailor démarre la session à la limite du segment la plus proche de la date et de l'heure du programme spécifié.

Usage

Passez aws.startTime en tant que paramètre de requête dans la requête manifeste :

GET /v1/master/{hashed-account-id}/{origin-id}/{asset}.m3u8?aws.startTime=2026-06-17T10:00:00Z

Ou lors d'une initialisation explicite de session, transmettez-le en tant que champ de niveau supérieur sans le aws. préfixe :

POST /v1/session/{hashed-account-id}/{origin-id}/{asset}.m3u8

{
    "startTime": "2026-06-17T10:00:00Z"
}
Exigences

Les exigences suivantes s'appliquent à aws.startTime :

  • Le manifeste source doit contenir EXT-X-PROGRAM-DATE-TIME (PDT) sur les segments. Sans PDT, il aws.startTime ne peut pas être résolu et est ignoré.

  • S'applique uniquement aux sessions HLS live (SSAI et SGAI).

Comportement

Le tableau suivant décrit le aws.startTime comportement dans différents scénarios :

Scénario Résultat
Horodatage dans la fenêtre du DVR Commencez à la limite du segment le plus proche, émettez EXT-X-START
Horodatage antérieur à la fenêtre du DVR Fixez à 3 fois la durée de la cible à partir de la tête de la fenêtre
Horodatage inférieur à 3 fois la durée cible et la durée du live edge Traiter comme une jointure en direct (non) EXT-X-START
Horodatage à ou après Live Edge Jointure Live-Edge normale
Malformé ou non ISO 8601 Ignoré : retour à la jointure live-edge, erreur enregistrée
Le manifeste n'a pas de PDT Ignoré : retour à la jointure live-edge, erreur enregistrée
Paramètre omis Par défaut : jointure live-edge normale
Comportement de serrage

Si le point de départ dépasse la fenêtre du DVR en milieu de session, il EXT-X-START est limité à 3 fois la durée de la cible par rapport à la tête de la fenêtre. La mémoire tampon 3×TargetDuration est conforme aux recommandations de mise en mémoire tampon des joueurs de la RFC 8216 §6.3.3.

Exemple Sortie du manifeste avec AWS.StartTime

Lorsqu'un joueur initialise une session avec aws.startTime=2026-06-17T10:00:00Z un décalage résolu à 120 secondes du Live Edge, il MediaTailor émet :

#EXTM3U
#EXT-X-TARGETDURATION:6
#EXT-X-START:TIME-OFFSET=-120.120,PRECISE=YES
#EXT-X-MEDIA-SEQUENCE:500
#EXT-X-PROGRAM-DATE-TIME:2026-06-17T09:58:00.000Z
#EXTINF:6.006,
segment500.ts
#EXTINF:6.006,
segment501.ts
...

TIME-OFFSET=-120.120Indique au joueur de commencer la lecture 120 secondes après le Live Edge, à la limite du segment la plus proche de l'heure de début demandée.

Limitations

Les limites suivantes s'appliquent :

  • Vous ne pouvez pas modifier ce paramètre après l'initialisation de la session.

  • Nécessite EXT-X-PROGRAM-DATE-TIME dans le manifeste source.

  • EXT-X-STARTest un indice pour les joueurs. Nous MediaTailor ne pouvons pas garantir que tous les joueurs l'honoreront.

aws.preroll

Lorsqueaws.preroll=disabled, MediaTailor supprime l'insertion d'annonces avant diffusion pour la session, même si la configuration de lecture comporte un. LivePreRollConfiguration

Usage

Passez aws.preroll en tant que paramètre de requête dans la requête manifeste :

GET /v1/master/{hashed-account-id}/{origin-id}/{asset}.m3u8?aws.preroll=disabled

Ou lors d'une initialisation explicite de session, transmettez-le en tant que champ de niveau supérieur sans le aws. préfixe :

POST /v1/session/{hashed-account-id}/{origin-id}/{asset}.m3u8

{
    "preroll": "disabled"
}
Exigences

Les exigences suivantes s'appliquent à aws.preroll :

  • La configuration de lecture doit comporter un LivePreRollConfiguration pour que ce paramètre ait un effet. Si aucun pré-roll n'est configuré, la définition de ce paramètre n'a aucun effet.

  • S'applique aux sessions HLS live (SSAI et SGAI).

Comportement

Le tableau suivant décrit comment aws.preroll se comporte :

Value Résultat
enabled(ou omis) Pre-roll inséré comme d'habitude
disabled Pre-roll supprimé pour cette session
Valeur non valide Consigné comme une erreur, traité comme enabled
Limitations

Vous ne pouvez pas modifier ce paramètre après l'initialisation de la session.

AWS. Overlay est disponible

Lorsqueaws.overlayAvails=off, MediaTailor ignore les marqueurs publicitaires superposés (non linéaires) dans le manifeste source et n'insère pas de publicités superposées pour la session.

Usage

Passez aws.overlayAvails en tant que paramètre de requête dans la requête manifeste :

GET /v1/master/{hashed-account-id}/{origin-id}/{asset}.m3u8?aws.overlayAvails=off
Exigences

Les exigences suivantes s'appliquent à aws.overlayAvails :

  • Le manifeste source doit contenir des marqueurs publicitaires superposés (par exemple, SCTE-35 des événements dont le type de segmentation est superposé) pour que ce paramètre ait un effet.

  • S'applique aux sessions HLS et DASH, en direct et à la VOD (SSAI et SGAI).

Comportement

Le tableau suivant décrit comment aws.overlayAvails se comporte :

Value Résultat
on(ou omis) Les superpositions disponibles sont traitées et les publicités sont insérées comme d'habitude
off Les marqueurs publicitaires superposés sont ignorés, aucune annonce superposée n'est insérée
Valeur non valide Consigné comme erreur, traité comme non spécifié (par défaut :on)
Limitations

Vous ne pouvez pas modifier ce paramètre après l'initialisation de la session.

AWS. Log Mode

Quandaws.logMode=DEBUG, MediaTailor active la journalisation détaillée du débogage pour la session. Les journaux de débogage sont envoyés aux CloudWatch journaux et fournissent des informations détaillées sur la personnalisation des manifestes, les demandes du serveur de décision en matière d'annonces et l'état de la session, ce qui est utile pour résoudre les problèmes d'insertion d'annonces.

Usage

Passez aws.logMode en tant que paramètre de requête dans la requête manifeste :

GET /v1/master/{hashed-account-id}/{origin-id}/{asset}.m3u8?aws.logMode=DEBUG
Exigences

Les exigences suivantes s'appliquent à aws.logMode :

  • La journalisation doit être activée (PercentEnabled > 0ou EnabledLoggingStrategies configurée) dans la configuration de lecture pour que les journaux de débogage soient émis.

  • La journalisation des débogages est limitée par client afin d'éviter un volume de journaux excessif.

Comportement

Le tableau suivant décrit comment aws.logMode se comporte :

Value Résultat
DEBUG Journaux de débogage détaillés émis pour la session
DISABLED(ou omis) Comportement de journalisation normal (basé sur les paramètres de configuration de lecture)
Valeur non valide Erreur générée, échec de l'initialisation de la session
Limitations

Les limites suivantes s'appliquent :

  • Vous ne pouvez pas modifier ce paramètre après l'initialisation de la session.

  • Les valeurs distinguent les majuscules et minuscules (DEBUGnondebug).

aws.avail SuppressionMode

Contrôle si les publicités sont supprimées en fonction de leur position par rapport au Live Edge. Utilisez cette option pour ignorer les pauses publicitaires qui se situent dans la fenêtre de temps précédant ou suivant le Live Edge, par exemple, pour éviter de remplir les pauses publicitaires que les spectateurs ont déjà passées lorsqu'ils ont rejoint une diffusion en direct en plein milieu d'un événement.

Usage

Transmettez les paramètres de suppression de disponibilité en tant que paramètres de requête dans la demande manifeste :

GET /v1/master/{hashed-account-id}/{origin-id}/{asset}.m3u8?aws.availSuppressionMode=BEHIND_LIVE_EDGE&aws.availSuppressionValue=00:00:10

Ce paramètre fonctionne avec deux paramètres complémentaires :

  • aws.availSuppressionValue— La fenêtre temporelle (obligatoire lorsque le mode n'est pas activéOFF)

  • aws.availSuppressionFillPolicy— Contrôle le comportement de remplissage partiel (s'applique uniquement au AFTER_LIVE_EDGE mode)

Exigences

Les exigences suivantes s'appliquent pour bénéficier des paramètres de suppression :

  • S'applique aux sessions en direct HLS et DASH.

  • aws.availSuppressionValuedoit être fourni au HH:MM:SS format lorsque le mode est BEHIND_LIVE_EDGE ouAFTER_LIVE_EDGE.

  • aws.availSuppressionFillPolicyn'est valide que lorsque le mode est activéAFTER_LIVE_EDGE.

Comportement du mode

Le tableau suivant décrit l'effet de chaque mode de suppression :

Mode Effet
OFF(ou omis) Suppression inutile : toutes les pauses publicitaires sont remplies normalement
BEHIND_LIVE_EDGE Supprimez les pauses publicitaires qui commencent dans la fenêtre de temps spécifiée, après le Live Edge
AFTER_LIVE_EDGE Supprimez les pauses publicitaires qui commencent après la fenêtre de temps spécifiée depuis Live Edge
Politique de remplissage (AFTER_LIVE_EDGE uniquement)

Le tableau suivant décrit le comportement de la politique de remplissage lorsque le mode est AFTER_LIVE_EDGE :

Politique de remplissage Effet
FULL_AVAIL_ONLY (par défaut) Ne remplissez que les zones qui se trouvent complètement en dehors de la fenêtre de suppression
PARTIAL_AVAIL Remplissez la partie d'un champ qui s'étend au-delà de la fenêtre de suppression
Exemple Exemple de suppression de Avail

La requête suivante supprime les interruptions de publicité dans les 10 secondes qui suivent le Live Edge :

GET /v1/master/{hashed-account-id}/{origin-id}/{asset}.m3u8?aws.availSuppressionMode=BEHIND_LIVE_EDGE&aws.availSuppressionValue=00:00:10
Limitations

Les limites suivantes s'appliquent :

  • Vous ne pouvez pas modifier ce paramètre après l'initialisation de la session.

  • aws.availSuppressionValuene doit pas être fourni lorsque le mode est activéOFF.

  • Format d'heure non valide aws.availSuppressionValue dans lequel le mode est rétabliOFF.