AddWatermark - - Centre de documentation Alibaba Cloud

Pour simplifier le traitement des tâches de filigrane, ApsaraVideo VOD regroupe les paramètres complexes de filigrane tels que la position, la taille, la police et la couleur dans des modèles, chacun étant identifié par un identifiant de modèle de filigrane unique. Cette opération permet d'ajouter un modèle de filigrane image ou texte.

Description de l'opération

Appelez cette opération pour ajouter un modèle de filigrane image (Image) ou un modèle de filigrane texte (Text). Les modèles de filigrane image prennent en charge les formats suivants : images statiques (PNG) et images animées (GIF, APNG, MOV).
Après avoir ajouté un modèle de filigrane en appelant cette opération, appelez AddTranscodeTemplateGroup ou UpdateTranscodeTemplateGroup pour associer le modèle de filigrane à un groupe de modèles de transcodage pour le transcodage ultérieur des filigranes.
Pour plus d'informations sur l'ajout de filigranes image et texte aux vidéos, consultez Filigranes vidéo.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

vod:AddWatermark

create

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Type	string	Oui	Le type de modèle du filigrane. Valeurs valides : Image (par défaut) : modèle de filigrane image. Text : modèle de filigrane texte.	Image
Name	string	Oui	Le nom du modèle de filigrane. Seuls les caractères chinois, les lettres et les chiffres sont pris en charge. Le nom peut comporter jusqu'à 128 octets. Encodage UTF-8.	Modèle de filigrane image
WatermarkConfig	string	Oui	Les informations de configuration du filigrane (chaîne JSON), y compris la position d'affichage et l'effet du filigrane. Les paramètres de configuration diffèrent entre les filigranes image et les filigranes texte. Pour plus d'informations sur la structure des paramètres, consultez WatermarkConfig.	{ "Width": "55", "Height": "55", "Dx": "9", "Dy": "9", "ReferPos": "BottomLeft" }
FileUrl	string	Non	L'URL Object Storage Service (OSS) du fichier image du filigrane (sans authentification). Remarque Ce paramètre de requête est requis lorsque vous définissez un modèle de filigrane image (Type est Image). Vous pouvez appeler CreateUploadAttachedMedia pour téléverser l'image du filigrane vers ApsaraVideo VOD. La valeur du paramètre FileURL renvoyée après le téléversement peut être utilisée comme valeur pour ce paramètre de requête.	http://outin-326268***63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345***E7FDEC-6-2.png
AppId	string	Non	L'identifiant de l'application. Valeur par défaut : app-1000000. Si vous avez activé le service multi-applications, spécifiez l'identifiant de l'application pour ajouter le modèle de filigrane à l'application spécifiée. Pour plus d'informations, consultez Service multi-applications.	app-****

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	25818875-5F78-4A*****F6-D7393642CA58
WatermarkInfo	object	Les informations du modèle de filigrane.
CreationTime	string	L'heure de création du modèle de filigrane. L'heure est au format yyyy-MM-ddTHH:mm:ssZ (UTC).	2018-11-07T09:05:52Z
Type	string	Le type du modèle de filigrane. Valeurs valides : Image : modèle de filigrane image. Text : modèle de filigrane texte.	Image
IsDefault	string	Indique si le modèle de filigrane est le modèle par défaut. Valeurs valides : Default : le modèle de filigrane par défaut. NotDefault : n'est pas le modèle de filigrane par défaut.	NotDefault
FileUrl	string	L'URL du fichier de filigrane (URL OSS ou URL CDN). Remarque Ce paramètre n'est renvoyé que pour les modèles de filigrane image.	https://outin-3262***9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=&Signature=gmf1eYMoDVg%2BHQCb4UGozBW**
WatermarkConfig	string	Les informations de configuration du filigrane (chaîne JSON), y compris la position d'affichage et l'effet du filigrane. Les paramètres de configuration diffèrent entre les filigranes image et les filigranes texte. Pour plus d'informations sur la structure des paramètres, consultez WatermarkConfig.	{ "Width": "55", "Height": "55", "Dx": "9", "Dy": "9", "ReferPos": "BottomLeft" }
Name	string	Le nom du modèle de filigrane.	Modèle de filigrane image
WatermarkId	string	L'identifiant du modèle de filigrane. Vous pouvez utiliser cet identifiant de modèle de filigrane pour associer le modèle à un groupe de modèles de transcodage, ou pour interroger, modifier, supprimer ou définir le modèle comme modèle de filigrane par défaut.	9bcc8bfadb84*****109a2671d0df97

Exemples

JSON format

{
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "WatermarkInfo": {
    "CreationTime": "2018-11-07T09:05:52Z",
    "Type": "Image",
    "IsDefault": "NotDefault",
    "FileUrl": "https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
    "WatermarkConfig": "{\n      \"Width\": \"55\",\n      \"Height\": \"55\",\n      \"Dx\": \"9\",\n      \"Dy\": \"9\",\n      \"ReferPos\": \"BottomLeft\"\n}",
    "Name": "Image watermark template",
    "WatermarkId": "9bcc8bfadb84*****109a2671d0df97"
  }
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.