Creates an image or text watermark. ApsaraVideo VOD allows you to create watermark templates to reuse your parameter configurations such as watermark position, size, font, and color. Each watermark template is assigned a unique ID. This simplifies the progress of creating watermark tasks.
Operation description
- You can call this operation
to create an
Image
watermark template or aText
watermark template. You can use static images in the PNG format or dynamic images in the GIF, APNG, and MOV formats as image watermarks. - After you call this operation to create a watermark template, you must call the AddTranscodeTemplateGroup or UpdateTranscodeTemplateGroup operation to associate the watermark template with a transcoding template group. This way, you can add watermarks to videos during transcoding.
- For more information, see Video watermarks.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
Type | string | Yes | The type of the watermark template. Valid values:
| Text |
Name | string | Yes | The name of the watermark template.
| watermark |
WatermarkConfig | string | Yes | The configuration information of the watermark such as the display position and special effects. The value must be a JSON string. The configuration parameters for image and text watermarks are different. For more information about the parameter structure, see WatermarkConfig . | {"Width":"55","Height":"55","Dx":"9","Dy":"9","ReferPos":"BottonLeft"} |
FileUrl | string | No | The URL of the watermark file. The URL must be an Object Storage Service (OSS) URL and cannot contain the information used for URL signing. Note
Type to
Image .FileURL
parameter in the response to the CreateUploadAttachedMedia
operation that you call to upload the watermark
image to ApsaraVideo VOD. | http://outin-326268*****63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345*****E7FDEC-6-2.png |
AppId | string | No | The ID of the application. Default value: app-1000000. If you have activated the multi-application service, specify the ID of the application to add the watermark template in the specified application. For more information, see Overview . | app-**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
"WatermarkInfo": {
"CreationTime": "2018-11-07T09:05:52Z",
"Type": "Text",
"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": "{\"FontColor\": \"Blue\",\"FontSize\": 80, \"Content\": \"watermark test\" }",
"Name": " text watermark test",
"WatermarkId": "9bcc8bfadb84*****109a2671d0df97"
}
}
Error codes
For a list of error codes, visit the Service error codes.
Common errors
The following table describes the common errors that this operation can return.
Error code | Error message | HTTP status code | Description |
---|---|---|---|
NoSuchResource | The specified resource %s does not exist. | 404 | The error message returned because the user-related resource does not exist. %s indicates the specific resource information. |