Description of request parameters and configuration examples - ApsaraVideo VOD

Cette rubrique décrit les paramètres de requête suivants des opérations API ApsaraVideo VOD : PlayConfig, ReAuthInfo, UserData, SpriteSnapshotConfig et EncryptConfig. Elle fournit également des exemples de configuration de ces paramètres.

PlayConfig : spécifie les configurations personnalisées pour la lecture multimédia

Description

Ce paramètre définit les configurations personnalisées pour la lecture des médias. La valeur est une chaîne JSON. Vous pouvez configurer les paramètres de lecture pour un domaine de diffusion spécifique. Le tableau ci-dessous détaille les champs contenus dans PlayConfig.

Champ	Type	Obligatoire	Description
PlayDomain	String	Non	Le domaine de diffusion. Si vous configurez plusieurs noms de domaine d'origine, vous pouvez spécifier un nom de domaine pour lire la vidéo. Si le domaine de diffusion spécifié n'existe pas, l'URL de diffusion renvoie le domaine de diffusion par défaut configuré pour l'adresse de stockage de la vidéo. Exemple : `"vod.test_domain"`.
XForwardedFor	String	Non	L'adresse IP d'origine du client qui initie la requête. Ce champ permet de vérifier si la requête provient d'une adresse IP ajoutée à un groupe de sécurité de modération. Pour plus d'informations, consultez Aperçu des adresses IP de sécurité. ApsaraVideo VOD peut obtenir l'adresse IP du client sur la base de ce champ après qu'une requête a traversé plusieurs serveurs proxy. Pour améliorer la sécurité des données, l'adresse IP du client est chiffrée à l'aide de `AES/ECB/PKCS5Padding`. Pour obtenir la clé de chiffrement, soumettez un ticket. Exemple : yqCD7Fp1uqChoVj/sl/p5Q==.
PreviewTime	String	Non	La durée de l'aperçu. Unité : secondes. La valeur minimale est 1. La valeur maximale correspond à la durée totale de la vidéo. Si vous laissez ce champ vide, la vidéo entière est diffusée en aperçu. Pour savoir comment activer la fonctionnalité d'aperçu, consultez Configurer la fonctionnalité d'aperçu.
MtsHlsUriToken	String	Non	Le MtsHlsUriToken généré par un service d'émission de jetons. Vous pouvez spécifier ce champ pour déchiffrer et lire les vidéos chiffrées à l'aide du chiffrement HTTP Live Streaming (HLS). Cela empêche le vol des clés de déchiffrement. Pour plus d'informations, consultez Chiffrement HLS.
EncryptType	String	Non	Le type de chiffrement. Vous pouvez spécifier ce champ pour lire des vidéos non chiffrées ou chiffrées selon un type spécifique. Valeurs valides : Unencrypted : non chiffré AliyunVoDEncryption : cryptographie propriétaire Alibaba Cloud HLSEncryption : chiffrement HLS Remarque Pour plus d'informations sur les URL de lecture des flux chiffrés, consultez Obtenir une URL de lecture.
StorageClass	String	Non	La classe de stockage de l'élément multimédia. Vous pouvez utiliser ce champ pour filtrer les flux de lecture d'une classe de stockage spécifique. Valeurs valides : Par défaut, ce champ est laissé vide. Une chaîne vide indique qu'aucune condition de filtrage n'est appliquée. Si la classe de stockage du fichier audio ou vidéo est Standard, les URL de lecture de tous les flux sont renvoyées. Si la classe de stockage des ressources multimédias n'est pas Standard, aucune URL de lecture n'est renvoyée. Si la classe de stockage du fichier source n'est pas Standard, seules les URL de lecture des flux transcodés sont renvoyées ; l'URL de lecture du flux de qualité originale n'est pas renvoyée. All : toutes les classes de stockage. Standard : Toutes les ressources multimédias sont stockées en tant qu'objets Standard. IA : Toutes les ressources multimédias sont stockées en tant qu'objets IA (Infrequent Access). Archive : Toutes les ressources multimédias sont stockées en tant qu'objets Archive. ColdArchive : Toutes les ressources multimédias sont stockées en tant qu'objets Cold Archive. SourceIA : Seuls les fichiers sources sont des objets IA. SourceArchive : Seuls les fichiers sources sont des objets Archive. SourceColdArchive : Seuls les fichiers sources sont des objets Cold Archive. Changing : La classe de stockage des ressources multimédias est en cours de modification. SourceChanging : La classe de stockage du fichier source est en cours de modification.

Exemple de code

PlayConfig={
  "PlayDomain": "vod.test_domain",
  "XForwardedFor": "yqCD7Fp1uqChoVj/sl/p5Q==",
  "PreviewTime": "20",
  "MtsHlsUriToken": "yqCD7Fp1uqChoVjslp5Q",
  "StorageClass": "Standard"
}

ReAuthInfo : spécifie les configurations de la réauthentification CDN

Description

Ce champ définit les configurations de la réauthentification CDN pour la lecture multimédia. La valeur est une chaîne JSON. Après avoir activé la fonctionnalité de réauthentification CDN, vous pouvez utiliser ce champ pour spécifier les champs uid et rand pour la signature d'URL. Le tableau ci-dessous détaille les champs contenus dans ReAuthInfo.

|
**Champ**
|
**Type**
|
**Obligatoire**
|
**Description**
| | --- | --- | --- | --- | |
uid
|
String
|
Non
|
Le champ supplémentaire. Dans la plupart des cas, la valeur est définie sur 0. Vous pouvez spécifier une valeur personnalisée pour ce champ.
| |
rand
|
String
|
Non
|
Le nombre aléatoire. Dans la plupart des cas, la valeur est définie sur 0. Pour générer une URL différente à chaque demande de vidéo, vous pouvez utiliser l'UUID comme nombre aléatoire.
|

Exemple de code

ReAuthInfo={
  "uid": "12345",
  "rand": "abckljd"
}

UserData : spécifie les configurations personnalisées pour le téléchargement multimédia

Description

Ce champ définit les configurations personnalisées pour le téléchargement multimédia, telles que les configurations de rappel pour les notifications d'événements. La valeur est une chaîne JSON.

Le tableau ci-dessous détaille les champs contenus dans UserData.

Champ	Type	Obligatoire	Description
MessageCallback	String	Non	Les configurations de rappel pour les notifications d'événements. La valeur est un objet JSON. Si vous spécifiez ce champ, les configurations de rappel spécifiées s'appliquent. Sinon, les configurations de rappel par défaut s'appliquent. Pour plus d'informations, consultez Spécifier plusieurs URL de rappel. Le contenu suivant décrit les paramètres : CallbackType : la méthode de rappel. Valeurs valides : `http` et `mns`. CallbackURL : l'URL de rappel HTTP. Ce paramètre est obligatoire si vous définissez `CallbackType` sur `http`. MNSQueueName : le nom de la file d'attente Message Service (MNS). Ce paramètre est obligatoire si vous définissez `CallbackType` sur `mns`. MSSEndpoint : le point de terminaison de la file d'attente MNS. Ce paramètre est obligatoire si vous définissez `CallbackType` sur `mns`. Exemples : Rappel HTTP : `{"CallbackType":"http", "CallbackURL":"http://callback-host/addr"}` Rappel MNS : `{"CallbackType":"mns","MNSQueueName":"vod-callback-bj","MNSEndpoint":"http://174809843091****.mns.cn-beijing.aliyuncs.com"}`
Extend	String	Non	Le champ étendu personnalisé, qui est transmis de manière transparente lors des rappels d'événements. La valeur peut atteindre 512 octets. Il s'agit d'un objet JSON. Remarque Nous vous recommandons de convertir une valeur contenant des caractères spéciaux tels que le signe dollar ($), les barres obliques (/) ou les barres obliques inverses (\) en une chaîne encodée en Base64.
AccelerateConfig	String	Non	Les configurations pour l'accélération du téléchargement. La valeur est un objet JSON. Exemple : {"Type":"oss","Domain":"https://oss-accelerate.aliyuncs.com"}. Type spécifie la méthode d'accélération et sa valeur ne peut être que oss. Domain spécifie le nom de domaine accéléré. Vous pouvez obtenir le nom de domaine accéléré à partir de Régions et points de terminaison. Par défaut, HTTPS est utilisé. Remarque Vous ne pouvez utiliser la fonctionnalité d'accélération du téléchargement qu'après avoir soumis une demande pour l'activer. Pour plus d'informations sur l'activation de la fonctionnalité d'accélération du téléchargement et les règles de facturation associées, consultez Accélération du téléchargement.

Exemple de code

UserData={
  "MessageCallback": {
    "MNSEndpoint":"http://174809843091****.mns.cn-beijing.aliyuncs.com",
    "MNSQueueName":"vod-callback-bj",
    "CallbackType": "mns"
  },
  "Extend": {
    "localId": "xxx",
    "test": "www"
  },
  "AccelerateConfig": {
    "Type": "oss",
    "Domain": "https://oss-accelerate.aliyuncs.com"
  }
}

EncryptConfig : spécifie les configurations pour le chiffrement HLS

Ce champ définit les configurations pour le chiffrement HLS.

Champ	Type	Obligatoire	Description
CipherText	String	Oui	La clé de texte chiffré utilisée pour obtenir la clé en texte clair. Définissez ce paramètre sur la valeur de `CiphertextBlob` dans la réponse à l'opération GenerateKMSDataKey.
DecryptKeyUri	String	Oui	L'URI de clé obtenu sur la base de la clé de texte chiffré. L'URI se compose de l'adresse IP du service de déchiffrement et de la valeur de `Ciphertext`. Le service de déchiffrement que vous avez configuré. Par exemple, si l'adresse IP de votre service de déchiffrement est `http://demo.aliyundoc.com`, définissez ce paramètre sur la valeur suivante : `http://demo.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3MTMt****`
KeyServiceType	String	Oui	Le type de service de clé. Valeur par défaut : KMS, qui spécifie Key Management Service d'Alibaba Cloud.

SpriteSnapshotConfig : spécifie les configurations pour la capture de sprites d'images

Champ	Type	Obligatoire	Description
CellWidth	String	Non	La largeur des captures d'écran originales qui composent le sprite d'image. Valeur par défaut : la largeur d'une capture d'écran normale. Unité : pixels.
CellHeight	String	Non	La hauteur des captures d'écran originales qui composent le sprite d'image. Valeur par défaut : la hauteur d'une capture d'écran normale. Unité : pixels.
Padding	String	Non	Le remplissage des captures d'écran originales qui composent le sprite d'image. Valeur par défaut : 0. Unité : pixels.
Margin	String	Non	La marge des captures d'écran originales qui composent le sprite d'image. Valeur par défaut : 0. Unité : pixels.
Color	String	Non	La couleur d'arrière-plan du sprite d'image. Valeur par défaut : Black (Noir).
Columns	String	Non	Le nombre de colonnes pour les captures d'écran originales qui composent le sprite d'image. Valeurs valides : [1,10000]. Valeur par défaut : 10.
Lines	String	Non	Le nombre de lignes pour les captures d'écran originales qui composent le sprite d'image. Valeurs valides : [1,10000]. Valeur par défaut : 10.
KeepCellPic	String	Non	Indique s'il faut conserver les captures d'écran originales qui composent le sprite d'image. Valeurs valides : keep delete Valeur par défaut : keep.

Remarque

Si vous souhaitez définir tous les champs de SpriteSnapshotConfig sur leurs valeurs par défaut respectives, spécifiez une chaîne JSON vide pour SpriteSnapshotConfig.