AddWaterMarkTemplate - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Creates a watermark template.

Operation description

After you create a watermark template by calling this operation, you can specify the watermark template and watermark asset when you submit a transcoding job. This allows you to add watermark information to the output video.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the watermark template. The value can contain letters and digits and can be up to 128 bytes in size.	example-watermark-****
Config	string	Yes	The configuration of the watermark template. The value is a JSON object. For more information, see the "WaterMarks" section of the Parameter details topic. Note If you do not require a positive correlation between the size of text in the watermark and the resolution, you can enable adaptation for the watermark. To do so, add `['adaptive']=true` to the TextWaterMark parameter.	{"Width":"10","Height":"30","Dx":"10","Dy":"5","ReferPos":"TopRight","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
WaterMarkTemplate	object	The details of the watermark template.
Type	string	The type of the watermark. Valid values: Image: an image watermark. Text: a text watermark.	Image
RatioRefer	object	The values of the Height, Width, Dx, and Dy parameters relative to the reference edges. If the values of the Height, Width, Dx, and Dy parameters are decimals between 0 and 1, the values are calculated by referring to the following edges in sequence: Width: the width edge. Height: the height edge. Long: the long edge. Short: the short edge.
Dx	string	The horizontal offset of the watermark relative to the output video image. Default value: 0. The default value indicates no offset. The value can be an integer or a decimal. Integer: the vertical offset. This indicates the absolute position. Unit: pixel. Decimal: the ratio of the horizontal offset to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.	0.51
Width	string	The width of the watermark image in the output video. The value can be an integer or a decimal. Integer: the width of the watermark image. This indicates the absolute position. Unit: pixel. Decimal: the ratio of the width of the watermark image to the width of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.	0.36
Height	string	The height of the watermark image in the output video. The value can be an integer or a decimal. Integer: the height of the watermark image. This indicates the absolute position. Unit: pixel. Decimal: the ratio of the height of the watermark image to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.	0.33
Dy	string	The vertical offset of the watermark relative to the output video image. Default value: 0. The default value indicates no offset. The value can be an integer or a decimal. Integer: the vertical offset. This indicates the absolute position. Unit: pixel. Decimal: the ratio of the vertical offset to the height of the output video. The ratio varies based on the size of the video. Four decimal places are supported, such as 0.9999. More decimal places are discarded.	0.28
ReferPos	string	The position of the watermark. Valid values: TopRight: the upper-right corner. TopLeft: the upper-left corner. BottomRight: the lower-right corner. BottomLeft: the lower-left corner.	TopRight
State	string	The status of the watermark template. Normal: The watermark template is normal. Deleted: The watermark template is deleted.	Normal
Dx	string	The horizontal offset. Unit: pixel.	10
Width	string	The width of the watermark image. Unit: pixel.	10
Height	string	The height of the watermark image. Unit: pixel.	30
Timeline	object	The timeline of the watermark.
Start	string	The beginning of the time range during which the watermark is displayed. Unit: seconds. Default value: 0.	0
Duration	string	The display duration of the watermark. Default value: ToEND. The default value indicates that the watermark is displayed until the video ends.	ToEND
Name	string	The name of the watermark template.	example-watermark-****
Dy	string	The vertical offset. Unit: pixel.	5
Id	string	The ID of the watermark template. We recommend that you keep this ID for subsequent operation calls.	3780bd69b2b74540bc7b1096f564****
RequestId	string	The ID of the request.	54BB917F-DD35-4F32-BABA-E60E31B21W63

Examples

Sample success responses

JSONformat

{
  "WaterMarkTemplate": {
    "Type": "Image",
    "RatioRefer": {
      "Dx": "0.51",
      "Width": "0.36",
      "Height": "0.33",
      "Dy": "0.28"
    },
    "ReferPos": "TopRight",
    "State": "Normal",
    "Dx": "10",
    "Width": "10",
    "Height": "30",
    "Timeline": {
      "Start": "0",
      "Duration": "ToEND"
    },
    "Name": "example-watermark-****",
    "Dy": "5",
    "Id": "3780bd69b2b74540bc7b1096f564****"
  },
  "RequestId": "54BB917F-DD35-4F32-BABA-E60E31B21W63"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history