Querying Watermark Templates

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

name

No

String

Watermark template name

scene

No

String

Distinguishes between Media Live and Cloud Live. By default, cloud_live (Cloud Live) is queried.

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

limit

No

Integer

Number of records on each page. The value ranges from 1 to 100 and defaults to 10.

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used. 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 for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.

X-request-id

String

Request ID for task tracing. Format: request_id-timestamp-hostname. (request_id is the UUID generated on the server. timestamp is the current timestamp. hostname is the name of the server that handles the current request.)

total

Integer

Total number

template_infos

Array of WatermarkTemplate objects

Response data

name

String

Watermark template name

type

Integer

Watermark type. 0: image; 1: text; 2: image and text

description

String

Template comment

picture_url

String

Image download path

Verification rule: An image URL can contain up to 2,048 characters, should be parsed properly, and use the HTTP or HTTPS protocol. (In the OTT scenario, only HTTPS is supported.)

Image format: The file name extension must be .png, .jpg, .PNG, or .JPG.

width

Number

1. Integer: width of a watermark image, in pixels. The value can be 0 or range from 8 to 4,096.

2. Decimal: ratio of the watermark width to the output video width. The value range is [0, 1).

You are advised to set either the width or height, as the other side will automatically adapt to avoid distortion. If both the width and height are set to 0, the original width and height of the watermark image are used.

The percentage can contain a maximum of four decimal places. The width and height must be both in pixels or both in percentage.

height

Number

Watermark image height. Options:

1. Integer: height of a watermark image, in pixels. The value can be 0 or range from 8 to 4,096.

2. Decimal: ratio of the watermark height to the output video height. The value range is [0, 1).

You are advised to set either the width or height, as the other side will automatically adapt to avoid distortion. If both the width and height are set to 0, the original width and height of the watermark image are used.

The percentage can contain a maximum of four decimal places. The width and height must be both in pixels or both in percentage.

location

WatermarkLocation object

Watermark position

text

WordWaterMarkInfo object

Text watermark information

scene

String

Service attribute. cloud_live: Cloud Live (default); media_live: Media Live (cannot be modified)

format

String

Watermark text content, which contains 1 to 64 characters.

This parameter is mandatory when type is set to 1 or 2 and is optional when type is set to 0.

font_color

String

Parameter verification: The first character is #, and the number of other characters is 6 or 8. Characters can contain digits (0–9), uppercase letters (A–F), and lowercase letters (a–f). [Verification is mandatory. If the verification fails, information will be displayed in white.]

font_size

Integer

Font size

font

String

Font. The default value is empty. The options are harmonyRegular and douyu2.0.

time_zone

String

Time zone. [The value ranges from UTC-1200 to UTC+1200. The first three characters are UTC, the fourth character is + or -, the fifth and sixth characters indicate the hour, and the seventh and eighth characters are fixed to 00.]

shadow_color

String

The default value is none. Parameter verification: The first character is #, and the number of other characters is 6 or 8. Characters can contain digits (0–9), uppercase letters (A–F), and lowercase letters (a–f). [Verification is mandatory. If the verification fails, information will be displayed in black.]

location

WatermarkLocation object

location is mandatory.

location

String

Watermark position. The options are TOPLEFT (upper left), TOPRIGHT (upper right), BOTTOMLEFT (lower left), BOTTOMRIGHT (lower right), and RANDOM (random). If RANDOM is used, the watermark will randomly appear on the upper left, upper right, lower left, or lower right of the video.

x_offset

Number

Horizontal offset between the watermark and the output video.

Options:

(1) An integer indicates the offset pixel. The value ranges from 1 to 4,096, in pixels.

(2) A decimal indicates the ratio of the horizontal offset to the output video width. The value range is [0, 1).

The percentage can contain a maximum of four decimal places.

y_offset

Number

Vertical offset between the watermark and the output video.

Options:

(1) An integer indicates the offset pixel. The value ranges from 1 to 4,096, in pixels.

(2) A decimal indicates the ratio of the vertical offset to the output video height. The value range is [0, 1).

The percentage can contain a maximum of four decimal places.

X-request-id

String

Request ID for task tracing. Format: request_id-timestamp-hostname. (request_id is the UUID generated on the server. timestamp is the current timestamp. hostname is the name of the server that handles the current request.)

error_code

String

Error Code

error_msg

String

Error description

200

Watermark templates queried.

400

Invalid parameter.