media processing parameter description for vod api - ApsaraVideo VOD

EncryptConfig : Paramètres de chiffrement HLS

|
Nom du champ
|
Type
|
Obligatoire
|
Description
| | --- | --- | --- | --- | |
CipherText
|
String
|
Oui
|
Le texte chiffré de la clé. Utilisez ce paramètre pour obtenir la clé en clair.
| |
DecryptKeyUri
|
String
|
Oui
|
L'URI utilisé pour obtenir la clé de déchiffrement à partir du texte chiffré de la clé. Exemple : `http://example.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk****`.
| |
KeyServiceType
|
String
|
Oui
|
Le type de service de clé. Valeur par défaut : `KMS`. KMS est l'abréviation d'Alibaba Cloud Key Management Service.
|

Exemple de paramètres EncryptConfig

{
  "CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk****",
  "DecryptKeyUri":"http://example.aliyundoc.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk****",
  "KeyServiceType":"KMS"
}

OverrideParams : Paramètres de substitution des jobs de transcodage

Nom du champ	Type	Obligatoire	Description
Watermarks	Watermark[]	Non	Requis pour remplacer les filigranes.
SubtitleSetting	SubtitleSetting	Non	Requis pour remplacer les sous-titres. Remarque Le modèle de transcodage que vous utilisez doit avoir des paramètres de sous-titres configurés au préalable. Sinon, les paramètres de sous-titres ne seront pas écrasés. Pour plus d'informations sur les paramètres de sous-titres, consultez SubtitleConfig. L'URL du fichier de sous-titres de remplacement doit être une URL OSS HTTP (et non HTTPS). Les URLs des noms de domaine accélérés par CDN ne sont pas prises en charge. Exemple : `http://out-dda****.cn-shanghai.aliyuncs.com/subtitle/subtitle.ass`
PackageSubtitleSetting	PackageSubtitleSetting[]	Non	Requis pour écraser l'URL du sous-titre lors de l'empaquetage en streaming adaptatif.
TranscodeTemplateList	TranscodeTemplate[]	Non	Requis pour remplacer les paramètres du modèle. Prend en charge l'écrasement des paramètres Video, Audio, Clip, Rotate et TranscodeFileRegular dans le modèle de transcodage. Les paramètres des modèles de qualité originale ne peuvent pas être écrasés. Le paramètre TranscodeTemplateId est requis pour écraser les paramètres.

Remarque

Actuellement, vous pouvez uniquement remplacer le fichier image ou le contenu textuel d'un filigrane.

Exemple TranscodeTemplateList

        [
                {
                  "TranscodeTemplateId":"9580424e49b28c952a46544e3e8f****",
                  "Video":{
                          "Width":720,
                          "Height":480,
                          "Bitrate":"600"
                  },
                  "Audio":{
                          "Bitrate":128
                  },
                  "Clip":{
                          "TimeSpan":{
                                "Seek":"1",
                                "Duration":"5"
                        },
                  "Rotate":"270",
                  "TranscodeFileRegular":"{MediaId}/{JobId}/{PlayDefinition}"
                  }
                }
        ]

Watermark : Paramètres de substitution des filigranes

|
Nom du champ
|
Type
|
Obligatoire
|
Description
| | --- | --- | --- | --- | |
WatermarkId
|
String
|
Oui
|
L'ID du filigrane associé au modèle de transcodage. Vous pouvez trouver cet ID dans la console ApsaraVideo VOD. Pour plus d'informations, consultez [Gestion des filigranes](t1959252.dita#multiTask1210).
| |
FileUrl
|
String
|
Non
|
L'URL OSS du fichier de filigrane. Ce paramètre est requis pour les filigranes image. Pour plus d'informations sur l'obtention de l'URL OSS d'un fichier, consultez [CreateUploadAttachedMedia](t1235496.dita#topic_2459094).
| |
Content
|
String
|
Non
|
Le contenu du filigrane textuel. Ce paramètre est requis pour les filigranes textuels.
|

Important

La valeur FileUrl doit correspondre à l'emplacement de stockage de la source vidéo.

SubtitleSetting : Paramètres de substitution des sous-titres

|
Nom du champ
|
Type
|
Obligatoire
|
Description
| | --- | --- | --- | --- | |
SubtitleList
|
[Sous-titre](#section_8th_hoc_yai)
|
Oui
|
La liste des sous-titres de remplacement.
|

Configuration des sous-titres

Nom du champ

Type

Obligatoire

Description

SubtitleUrl

String

Oui

L'URL OSS du fichier de sous-titres. Les URLs HTTPS ne sont pas prises en charge.

CharEncode

String

Oui

Le format d'encodage du contenu des sous-titres. Valeurs valides :

auto (détection automatique)
UTF-8
GBK
BIG5

Remarque

Définissez CharEncode sur un format d'encodage spécifique. Si vous définissez ce paramètre sur auto, le format d'encodage risque d'être détecté incorrectement.

PackageSubtitleSetting : Paramètres de remplacement des sous-titres empaquetés

|
Nom du champ
|
Type
|
Obligatoire
|
Description
| | --- | --- | --- | --- | |
PackageSubtitleList
|
[PackageSubtitle](#section_dyk_xxx_03o)[]
|
Oui
|
Requis pour remplacer les sous-titres.
|

PackageSubtitle : Paramètres de remplacement des sous-titres empaquetés

Nom du champ	Type	Obligatoire	Description
SubtitlePackageTemplateId	String	Oui	L'ID du modèle d'empaquetage des sous-titres.
Language	String	Oui	La langue. Pour plus d'informations, consultez la RFC 5646. Exemple : en-US. Remarque Le paramètre Language sert uniquement à récupérer le fichier de sous-titres à remplacer. La langue elle-même n'est pas remplacée.
SubtitleUrl	String	Oui	L'URL du sous-titre. Seules les URL HTTP OSS sont prises en charge. Les URL HTTP CDN et HTTPS ne sont pas prises en charge. Remarque Actuellement, une seule URL HTTP est prise en charge. Les fichiers de sous-titres peuvent être stockés uniquement dans les compartiments système alloués par ApsaraVideo VOD.

Remarque

Les paramètres SubtitlePackageTemplateId et Language servent à récupérer l'URL du sous-titre à remplacer. La langue elle-même ne peut pas être remplacée.

Exemple de paramètres OverrideParams

{
  "Watermarks":[
    {
      "WatermarkId":"watermark1",
      "FileUrl":"http://****.bucket.aliyuncs.com/image/replace.png"
    },
    {
      "WatermarkId":"watermark2",
      "Content":"Watermark test"
    }
  ],
  "SubtitleSetting":{
          "SubtitleList":[
                {
                "SubtitleUrl":"http://outin-****.oss-cn-shanghai.aliyuncs.com/subtitles/7b850b-724c-4011-b885-dd16c****.ass",
                "CharEncode":"UTF-8"
                },
                {
                "SubtitleUrl":"http://outin-****.oss-cn-shanghai.aliyuncs.com/subtitles/7b86db-724c-4011-b885-dd161d****.srt",
                "CharEncode":"auto"
                }
        ]
  },
  "PackageSubtitleSetting": {
    "PackageSubtitleList": [
      {
        "Language": "en-US",
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395****", 
        "SubtitleUrl": "http://outin-****.oss-cn-shanghai.aliyuncs.com/789679188D1F36A00AEB****.vtt" 
      },
      {
        "Language": "ja",  
        "SubtitlePackageTemplateId": "32d665807c08d25d4a5d513395ad****",
        "SubtitleUrl": "http://outin-****.oss-cn-shanghai.aliyuncs.com/F43FD90FF4B936A00AEB****.vtt"
      }
    ]
  }
}

WatermarkConfig : Paramètres de filigrane

Si le type de filigrane est Image

Nom du paramètre	Type de paramètre	Obligatoire	Description
Dx	String	Oui	Le décalage horizontal est disponible sous deux formes. Valeur en pixels : [8,4096] Pourcentage de l'écran : (0,1). Une valeur de 0 représente 0 %, une valeur de 1 représente 100 % et une valeur de 0,5 représente 50 %. Les autres valeurs sont interprétées proportionnellement.
Dy	String	Oui	Le décalage vertical peut être spécifié selon deux formats. Valeur en pixels : [8,4096] Proportion de l'écran : (0,1). Une valeur de 0 représente 0 % de l'écran, 1 représente 100 % et 0,5 représente 50 %. Les autres valeurs sont interprétées de la même manière.
Width	String	Oui	Spécifiez la largeur du filigrane selon deux formats. Valeur en pixels : [8,4096] Proportion de l'écran : (0,1). Une valeur de 0 représente 0 % de l'écran, une valeur de 1 représente 100 % et une valeur de 0,5 représente 50 %. Les autres valeurs sont interprétées de la même manière.
Height	String	Oui	La hauteur du filigrane prend en charge deux formats de valeur. Valeur en pixels : [8,4096] Proportion de l'image : (0,1). Une valeur de 0 représente 0 % de la zone de l'image, 1 représente 100 % et 0,5 représente 50 %. Les autres valeurs sont interprétées proportionnellement.
ReferPos	String	Oui	Position du filigrane : BottomRight (en bas à droite) BottomLeft (en bas à gauche) TopRight (en haut à droite) TopLeft (en haut à gauche)
Timeline	Timeline	Non	La chronologie du filigrane. Cela spécifie l'heure de début et de fin de l'affichage du filigrane. La valeur est une chaîne JSON.

Important

Le paramètre Timeline est valide uniquement pour les filigranes image.

Si le type de filigrane est Texte

|
Nom du paramètre
|
Type de paramètre
|
Obligatoire
|
Description
| | --- | --- | --- | --- | |
Content
|
String
|
Oui
|
Le contenu du filigrane textuel. Exemple : « Filigrane textuel ».
| |
FontName
|
String
|
Non
|
[Nom de la police](#section_ejy_o5b_342)
| |
FontColor
|
String
|
Non
|
[Couleur de la police](t1235677.dita#topic5518)
| |
FontAlpha
|
String
|
Non
|
La transparence de la police. Valeurs valides : (0, 1]. Valeur par défaut : 1,0.
| |
BorderColor
|
String
|
Non
|
[Couleur du contour](t1235677.dita#topic5518)
| |
Top
|
Integer
|
Non
|
La marge supérieure du texte. Seules les valeurs entières sont prises en charge. Unité : px. Valeur par défaut : 0. Valeurs valides : [0, 4096].
| |
Left
|
Integer
|
Non
|
La marge gauche du texte. Seules les valeurs entières sont prises en charge. Unité : px. Valeur par défaut : 0. Valeurs valides : [0, 4096].
| |
FontSize
|
Integer
|
Non
|
La taille de la police. Seules les valeurs entières sont prises en charge. Valeur par défaut : 16. Valeurs valides : (4, 120).
| |
BorderWidth
|
Integer
|
Non
|
La largeur du contour. Seules les valeurs entières sont prises en charge. Unité : px. Valeur par défaut : 0. Valeurs valides : (0, 4096].
|

Chronologie du filigrane

|
Nom du paramètre
|
Type
|
Obligatoire
|
Description
| | --- | --- | --- | --- | |
Start
|
String
|
Oui
|
L'heure à laquelle le filigrane commence à apparaître. Unité : secondes. La valeur doit être un nombre. Valeur par défaut : 0.
| |
Duration
|
String
|
Oui
|
La durée d'affichage du filigrane. Unité : secondes. Valeurs valides : un nombre ou `ToEND`. Valeur par défaut : `ToEND`, ce qui indique la fin de la vidéo.
|

Important

Le paramètre Timeline n'est valide que pour les filigranes image.

Nom de la police

|
Nom de la police
|
Description
| | --- | --- | |
SimSun
|
Police Song
| |
WenQuanYi Zen Hei
|
WenQuanYi Zen Hei
| |
WenQuanYi Zen Hei Mono
|
WenQuanYi Zen Hei Monospace
| |
WenQuanYi Zen Hei Sharp
|
WenQuanYi Zen Hei Bitmap
| |
Yuanti SC
|
Simplified Round, Regular
|

Vignettes vidéo

Paramètres du modèle de vignette

SnapshotTemplateConfig

Name

Type

Required

Description

SnapshotType

String

Yes

Le type de vignette. Valeurs valides :

NormalSnapshot : une vignette normale.
SpriteSnapshot : un sprite.
WebVttSnapshot : une vignette WebVTT.

SnapshotConfig

JSON

Yes

Les paramètres du modèle de vignette. Ces paramètres varient en fonction de la valeur de SnapshotType. Pour plus d'informations, consultez SnapshotConfig ci-dessous.

SnapshotConfig

Remarque

Un sprite est créé en capturant des vignettes normales, puis en les combinant. Par conséquent, le paramètre SnapshotConfig est requis pour les vignettes normales et les sprites.

Parameter Name	Type	Required	Description
FrameType	String	Yes	Le type d'image pour les vignettes. Valeurs valides : intra : image clé. normal : image normale.
Count	Long	Yes	Le nombre de vignettes à capturer.
Interval	Long	Yes	L'intervalle de capture des vignettes. La valeur doit être supérieure ou égale à 0. Unité : secondes. Une valeur de 0 indique que les vignettes sont capturées à intervalles réguliers en fonction de la durée de la vidéo et de la valeur de Count.
SpecifiedOffsetTime	Long	Yes	L'heure de début de la capture des vignettes. Unité : millisecondes.
Width	Integer	No	La largeur de la vignette. Valeurs valides : [8, 4096]. Valeur par défaut : la largeur de la vidéo source. Unité : px.
Height	Integer	No	La hauteur de la vignette. Valeurs valides : [8, 4096]. Valeur par défaut : la hauteur de la vidéo source. Unité : px.
SpriteSnapshotConfig	JSON	No	Les paramètres du sprite. Ce paramètre est obligatoire si SnapshotType est défini sur SpriteSnapshot. Pour plus d'informations, consultez SpriteSnapshotConfig ci-dessous.
Format	String	No	Le format du fichier de vignette de sortie. Définissez la valeur sur `vtt`. Ce paramètre n'est valide que si SnapshotType est défini sur `WebVttSnapshot`.
SubOut	JSON	No	Contrôle l'affichage des vignettes lorsque SnapshotType est défini sur WebVttSnapshot. Pour plus d'informations, consultez SubOut ci-dessous.

SpriteSnapshotConfig

Parameter name	Type	Required	Description
CellWidth	String	No	La largeur de chaque petite image dans le sprite. Valeur par défaut : la largeur d'une vignette normale. Unité : px.
CellHeight	String	No	La hauteur de chaque petite image dans le sprite. Valeur par défaut : la hauteur d'une vignette normale. Unité : px.
Padding	String	Yes	Le remplissage (padding) de chaque petite image. Unité : px.
Margin	String	Yes	La marge de chaque petite image. Unité : px.
Color	String	Yes	La couleur d'arrière-plan du sprite. Pour plus d'informations, consultez Paramètres de couleur. Remarque La définition de la couleur à l'aide de valeurs RGB n'est pas prise en charge.
Columns	String	Yes	Le nombre de colonnes de petites images. Valeurs valides : [1, 10000].
Lines	String	Yes	Le nombre de lignes de petites images. Valeurs valides : [1, 10000].
KeepCellPic	String	Yes	Indique s'il faut conserver les petites images. Valeurs valides : keep : Conserver. delete : Supprimer l'élément.

SubOut

Parameter Name

Type

Required

Description

IsSptFrag

String

Yes

Valeurs valides :

false : Stocker chaque vignette en tant qu'image distincte.
true : Combiner les vignettes en une grande image semblable à un sprite avant le stockage.

Exemple de modèle de vignette

{
  "SnapshotConfig": {
    "Count": 10,
    "SpecifiedOffsetTime": 0,
    "Interval": 1
  },
  "SnapshotType": "NormalSnapshot"
}

Images animées extraites de vidéos

Paramètres du modèle d'image animée

DynamicImageTemplateConfig

Nom du paramètre	Type	Obligatoire	Description
Name	String	Oui	Nom du modèle d'image animée.
Video	JSON	Oui	Paramètres vidéo de l'image animée. Pour plus d'informations, consultez la section Video ci-dessous.
Container	JSON	Oui	Paramètres de format de conteneur pour l'image animée. Pour plus d'informations, consultez la section Container ci-dessous.
Clip	JSON	Oui	Paramètres de découpage pour l'image animée. Pour plus d'informations, consultez la section Clip ci-dessous.
SetDefaultCover	String	Oui	Indique si l'image animée générée doit être définie comme vignette vidéo par défaut. Valeurs possibles : true : définir comme vignette par défaut. false : ne pas définir comme vignette par défaut.

Video

Remarque

Si vous ne spécifiez pas les paramètres Width et Height, l'image animée de sortie aura les mêmes dimensions que la vidéo source.
Si vous spécifiez uniquement le paramètre Width, la hauteur est mise à l'échelle proportionnellement en fonction du rapport d'aspect de la vidéo source.
Si vous spécifiez uniquement le paramètre Height, la largeur est mise à l'échelle proportionnellement en fonction du rapport d'aspect de la vidéo source.

|
**Nom du paramètre**
|
**Type**
|
**Obligatoire**
|
**Description**
| | --- | --- | --- | --- | |
Width
|
String
|
Non
|
Largeur de l'image animée de sortie. Valeurs possibles : [128, 4096].
| |
Height
|
String
|
Non
|
Hauteur de l'image animée de sortie. Valeurs possibles : [128, 4096].
| |
Fps
|
String
|
Oui
|
Taux de rafraîchissement (images par seconde). Valeurs possibles : (0, 60].
|

Container

Nom du paramètre

Type

Obligatoire

Description

Format

String

Oui

Format de l'image animée de sortie. Valeurs possibles :

webp
gif

Clip

|
**Nom du paramètre**
|
**Type**
|
**Obligatoire**
|
**Description**
| | --- | --- | --- | --- | |
TimeSpan
|
JSON
|
Oui
|
Paramètres de timeline pour le découpage. Pour plus d'informations, consultez la section [TimeSpan](#ba02fb2068rcp) ci-dessous.
|

TimeSpan

Remarque

Pour découper la vidéo en fonction d'une durée, spécifiez les paramètres Seek et Duration. Pour découper la vidéo en rognant le début et la fin, spécifiez les paramètres Seek et End.
Si vous spécifiez simultanément les paramètres Seek, Duration et End, les paramètres Seek et End sont pris en compte.

Nom du paramètre	Type	Obligatoire	Description
Seek	String	Oui	Heure de début du clip pour l'image animée. Format 1 : sssss[.SSS]. Valeurs possibles : [0.000, 86399.999]. Exemple : 0 Format 2 : hh:mm:ss[.SSS]. Valeurs possibles : [00:00:00.000, 23:59:59.999]. Exemple : 00:00:05.003
Duration	String	Non	Durée du clip. Format 1 : sssss[.SSS]. Valeurs possibles : [0.000, 86399.999]. Exemple : 15 Format 2 : hh:mm:ss[.SSS]. Valeurs possibles : [00:00:00.000, 23:59:59.999]. Exemple : 00:00:10.003
End	String	Non	Durée de la partie finale de la vidéo à supprimer. Si vous spécifiez ce paramètre, le paramètre Duration devient invalide. Format 1 : sssss[.SSS]. Valeurs possibles : [0.000, 86399.999]. Exemple : 12000.55 Format 2 : hh:mm:ss[.SSS]. Valeurs possibles : [00:00:00.000, 23:59:59.999]. Exemple : 00:00:15.003

Exemple de modèle d'image animée

{
  "Video": {
    "Fps": 5,
    "Width": 1024
  },
  "Clip": {
    "TimeSpan": {
      "Seek": 0,
      "Duration": 15
    }
  },
  "Container": {
    "Format": "gif"
  },
  "SetDefaultCover": "false"
}