Querying Watermark Templates

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. (tag:hc,hk)

Project ID. For details about how to obtain the project ID, see [Obtaining a Project ID]. (tag:hcso,g42,cmcc)

template_id

No

Array of integers

Watermark template ID. A maximum of 10 template IDs can be queried at a time.

page

No

Integer

Page number. If task_id is specified, this parameter is invalid.

Default value: 0

size

No

Integer

Number of records on each page. If template_id is specified, this parameter is invalid. The value ranges from 1 to 100.

X-Auth-Token

No

String

User token

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory when AK/SK-based authentication is used.

X-Project_Id

No

String

Project ID. This parameter is mandatory when AK/SK-based authentication is used. It is same as the project ID in path parameters.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used.

total

Integer

Total number of queried watermark templates

templates

Array of WatermarkTemplate objects

Details about queried watermark templates

dx

String

Horizontal offset between the start point of the watermark and the vertex of the output video

Possible options are:

• Integer: horizontal offset between the watermark start point and the video vertex, in pixels. Value range: [0, 4096]

• Decimal: horizontal offset ratio of the watermark start point to the video width. The value range is (0, 1). Up to four decimal places are displayed, for example, 0.9999. If the value contains more than four decimal places, the part behind the fourth decimal place is automatically truncated.

For example, if the output video width is 1920 pixels, dx is set to 0.1, and referpos is set to TopRight, the horizontal offset between the upper right corner of the watermark and the right vertex of the video is 192.

dy

String

Vertical offset between the start point of the watermark and the vertex of the output video

• Possible options are: Integer: vertical offset between the watermark start point and the video vertex, in pixels. The value range is [0, 4096].

• Decimal: vertical offset ratio of the watermark start point to the video height. The value range is (0, 1). Up to four decimal places are displayed, for example, 0.9999. If the value contains more than four decimal places, the part behind the fourth decimal place is automatically truncated.

For example, if the output video height is 1080 pixels, dy is set to 0.1, and referpos is set to TopRight, the vertical offset between the upper right corner of the watermark and the right vertex of the video is 108.

referpos

String

Watermark position.

Possible values:

• TopRight: upper right corner

• TopLeft: upper left corner

• BottomRight: lower right corner

• BottomLeft: lower left corner

timeline_start

String

Watermark start time, which is used together with timeline_duration.

Its value is a digit.

Unit: second

timeline_duration

String

Watermark duration, which is used together with timeline_start.

The value ranges from number to ToEND. ToEND indicates that the watermark lasts until the end of the video.

Default value: ToEND

random_time_min

Float

Minimum rotation interval, unit: second

random_time_max

Float

Maximum rotation interval time, unit: second

image_process

String

Image watermarking method. This parameter is valid only when type is set to Image.

Options:

• Original: Only simple scaling is performed.

• Grayed: Image graying is performed.

• Transparent: The transparency of the source image is retained. If the source image contains transparent areas, these areas remain transparent after transcoding, allowing the underlying background or image to be displayed. This enables seamless fusion between the image and the background.

width

String

Watermark image width. The options are as follows:

• Integer: width of a watermark image, in pixels. The value ranges from 8 to 4,096.

• Decimal: ratio of the width to the width of the output video. The value range is (0, 1). Up to four decimal places are displayed, for example, 0.9999. If the value contains more than four decimal places, the part behind the fourth decimal place is automatically truncated.

height

String

Watermark image height. The options are as follows:

• Integer: height of a watermark image, in pixels. The value ranges from 8 to 4,096.

• Decimal: ratio of the height to the height of the output video. The value is greater than 0 and less than 1, and can contain up to four decimal places, for example, 0.9999. If the value contains more than four decimal places, the part behind the fourth decimal place is automatically truncated.

base

String

Video on which a watermark is overlaid

Options:

• input: A watermark is overlaid on the input file. The size of the watermark in the transcoded file is scaled based on the aspect ratio of the video.

• output: A watermark is overlaid on the transcoded file. The size of the watermark in the transcoded file is not scaled based on the aspect ratio of the video.

template_id

Integer

ID of a watermark template.

template_name

String

Watermark template name, which contains a maximum of 64 characters

type

String

Watermark type, which can only be set to Image. Text watermark (Text) will be supported later as required.

error_code

String

Error code

error_msg

String

Error description

200

Watermark template queried successfully.

403

Failed to query the watermark template.