Creates a watermark template
Function
Creates a watermark template
URI
POST /v1.0/{project_id}/template/watermark
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
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Name of a watermark template |
watermark_type |
No |
String |
Watermark type. Currently, only IMAGE (image watermark) is supported. |
image_process |
No |
String |
This parameter is valid when watermark_type is set to IMAGE. Possible options:
|
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.
|
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.
|
position |
No |
String |
Watermark position. The default value is TOPRIGHT. Possible options:
|
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:
|
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:
|
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
Parameter |
Type |
Description |
---|---|---|
id |
String |
Watermark configuration template ID. |
upload_url |
String |
URL for uploading a watermark image. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error description |
Example Requests
Creates a watermark template.
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot