Updated on 2022-10-24 GMT+08:00

Creates a watermark template

Function

Creates a watermark template

URI

POST /v1.0/{project_id}/template/watermark

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

It 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 a 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Name of a watermark template

watermark_type

No

String

Watermark type, which can only be images

image_process

No

String

This parameter is used when type is set to Image.

Possible values are:

  • Original: Only simple scaling is performed.

  • Transparent: The background color is transparent.

  • Grayed: The color image turns gray.

dx

No

String

Horizontal offset of the watermark image relative to the output video. The default value is 0.

The value can be an integer or in decimals. You are advised to set this parameter to a value in decimals. If the value is an integer, images on the console can be transcoded but may fail to be previewed.

  • 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. Value range: (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.

dy

No

String

Vertical offset of the watermark image relative to the output video. The default value is 0.

The value can be an integer or in decimals. You are advised to set this parameter to a value in decimals. If the value is an integer, images on the console can be transcoded but may fail to be previewed.

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

  • Decimal: vertical offset ratio of the watermark start point to the video height. Value range: (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.

position

No

String

Watermark position. The default value is TOPRIGHT.

width

No

String

Watermark image width. You are advised to set this parameter to a value in decimals. If the value is an integer, images on the console can be transcoded but may fail to be previewed.

Possible values are:

  • 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 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.

height

No

String

Watermark image height. You are advised to set this parameter to a value in decimals. If the value is an integer, images on the console can be transcoded but may fail to be previewed.

Possible values are:

  • 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.

timeline_start

No

String

Watermark start time, which is used together with timeline_duration Value range: [0, END). "END" indicates the video end time. Unit: second

timeline_duration

No

String

Watermark duration, which is used together with "timeline_start". Value range: (0, END - start time]. "END" indicates the video end time. Unit: second Default value: END

type

Yes

String

Watermark image format

md5

No

String

MD5 value of a watermark image

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Watermark configuration template ID

upload_url

String

URL for uploading a watermark image

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

POST https://{endpoint}/v1.0/{project_id}/template/watermark

{
  "name" : "test",
  "type" : "PNG"
}

Example Responses

Status code: 200

The information is returned when the request succeeds.

{
  "id" : "a52ba84366abebb4c4614e1b16973549",
  "upload_url" : "https://vod-bucket-26-cn-north-4.obs.cn-north-4.myhuaweicloud.com:443/05ab5cef408026f22f62c018de60cf2e/a52ba84366abebb4c4614e1b16973549/watermark.png?AWSAccessKeyId=MZH0LUL329N1SSXNB3S4&Expires=1625479312&Signature=eF9ERWN5QwuZFUfPdoddHW64Vro%3D"
}

Status code: 400

The information is returned when the request fails.

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

Status Codes

Status Code

Description

200

The information is returned when the request succeeds.

400

The information is returned when the request fails.

Error Codes

See Error Codes.