There is currently no authorization information disclosed in the API.
Request parameters
Parameter
Type
Required
Description
Example
PageSize
long
No
The number of entries returned on each page.
10
PageNumber
long
No
The ID of the request.
1
State
string
No
The number of the returned page.
Normal
Response parameters
Parameter
Type
Description
Example
object
The details of the watermark templates.
TotalCount
long
The type of the watermark. Valid values:
Image: an image watermark.
Text: a text watermark.
Note Only watermarks of the Image types are supported.
1
PageSize
long
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.
10
RequestId
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.
FC029D04-8F47-57FF-A759-23383C15617D
PageNumber
long
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.
1
WaterMarkTemplateList
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 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.
Image
RatioRefer
object
The status of the watermark template. Valid values: Valid values:
Normal: The watermark template is normal.
Deleted: The watermark template is deleted.
Dx
string
The horizontal offset. Unit: pixel.
0.51
Width
string
The width of the watermark image. Unit: pixel.
0.36
Height
string
The height of the watermark image. Unit: pixel.
0.33
Dy
string
The timeline of the watermark.
0.2
ReferPos
string
The beginning of the time range during which the watermark is displayed.
Unit: seconds.
Default value: 0.
TopRight
State
string
The display duration of the watermark. Default value: ToEND. The default value indicates that the watermark is displayed until the video ends.
Normal
Dx
string
The name of the watermark template.
100
Width
string
The vertical offset. Unit: pixel.
8
Height
string
The ID of the watermark template.
8
Timeline
object
You can call this operation to query watermark templates in the specified state. If you do not specify the state, all watermark templates are queried by default.
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.
Start
string
The total number of returned entries.
0
Duration
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.
ToEND
Name
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.
example-watermark
Dy
string
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: