There is currently no authorization information disclosed in the API.
Request parameters
Parameter
Type
Required
Description
Example
WaterMarkTemplateId
string
Yes
The type of the watermark. Valid values:
Image: an image watermark.
Text: a text watermark.
Note Only watermarks of the Image type are supported.
3780bd69b2b74540bc7b1096f564****
Name
string
Yes
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.
example-watermark-****
Config
string
Yes
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.
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.
WaterMarkTemplate
object
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.
Type
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.
Image
RatioRefer
object
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.
Dx
string
The status of the watermark template. Default value: Normal.
0.51
Width
string
The horizontal offset. Unit: pixel.
0.36
Height
string
The width of the watermark image. Unit: pixel.
0.33
Dy
string
The height of the watermark image. Unit: pixel.
0.28
ReferPos
string
The timeline of the watermark.
TopRight
State
string
The beginning of the time range during which the watermark is displayed.
Unit: seconds.
Default value: 0.
Normal
Dx
string
The display duration of the watermark. Default value: ToEND. The default value indicates that the watermark is displayed until the video ends.
10
Width
string
The name of the watermark template.
10
Height
string
The vertical offset. Unit: pixel.
30
Timeline
object
The ID of the watermark template. We recommend that you keep this ID for subsequent operation calls.
Start
string
The ID of the request.
0
Duration
string
You can call this operation to update the information about a watermark template based on the ID of the watermark template. For example, you can update the name and configuration of a watermark template.
A watermark template cannot be updated if it is being used by a job that has been submitted.
QPS limit
You can call this API operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit.
10
Name
string
The type of the watermark. Valid values:
Image: an image watermark.
Text: a text watermark.
Note Only watermarks of the Image type are supported.
example-watermark-****
Dy
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.