Release Notes
공지 사항
Domain name for API request: mps.intl.tencentcloudapi.com.
This API is used to create a custom watermarking template. Up to 1,000 templates can be created.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateWatermarkTemplate. |
| Version | Yes | String | Common Params. The value used for this API: 2019-06-12. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Type | Yes | String | Watermarking type. Valid values: |
| Name | No | String | Watermarking template name. Length limit: 64 characters. |
| Comment | No | String | Template description. Length limit: 256 characters. |
| CoordinateOrigin | No | String | Origin position. Valid values: Default value: TopLeft. |
| XPos | No | String | The horizontal position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:XPos of the watermark will be the specified percentage of the video width; for example, 10% means that XPos is 10% of the video width;XPos of the watermark will be the specified px; for example, 100px means that XPos is 100 px.Default value: 0 px. |
| YPos | No | String | The vertical position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported:YPos of the watermark will be the specified percentage of the video height; for example, 10% means that YPos is 10% of the video height;YPos of the watermark will be the specified px; for example, 100px means that YPos is 100 px.Default value: 0 px. |
| ImageTemplate | No | ImageWatermarkInput | Image watermarking template. This field is required and valid only when Type is image. |
| TextTemplate | No | TextWatermarkTemplateInput | Text watermarking template. This field is required and valid only when Type is text. |
| SvgTemplate | No | SvgWatermarkInput | SVG watermarking template. This field is required and valid only when Type is svg. |
| Parameter Name | Type | Description |
|---|---|---|
| Definition | Integer | Unique ID of a watermarking template. |
| ImageUrl | String | Watermark image address. This field is valid only when Type is image. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWatermarkTemplate
<Common request parameters>
{
"Name": "Watermark Template 1",
"Comment": "svg watermark"
"Type": "svg",
"CoordinateOrigin": "TopRight",
"XPos": "5%",
"YPos": "5%",
"ImageTemplate": {
"ImageContent": "",
"Width": "10%",
"Height": "0px",
"RepeatType": "once"
},
"TextTemplate": {
"FontType": "arial.ttf",
"FontSize": "10px",
"FontColor": "#ffffff",
"FontAlpha": 0.5
},
"SvgTemplate": {
"Width": "10%",
"Height": "0px"
}
}
{
"Response": {
"Definition": 123,
"ImageUrl": "",
"RequestId": "93dda61a-c2c5-465d-a78c-0860997fb01b"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.InvalidMpsUser | Operation failed: unauthorized MPS user. |
| InternalError | Internal error. |
| InternalError.GenDefinition | Internal error: failed to generate template ID. |
| InternalError.UploadWatermarkError | Internal error: failed to upload watermark image. |
| InvalidParameterValue.Comment | Parameter error: template description. |
| InvalidParameterValue.CoordinateOrigin | Incorrect parameter value: CoordinateOrigin. |
| InvalidParameterValue.Height | Parameter error: height. |
| InvalidParameterValue.ImageContent | Invalid ImageContent |
| InvalidParameterValue.ImageTemplate | Parameter error: image watermarking template. |
| InvalidParameterValue.Name | Incorrect parameter value: Name exceeds the length limit. |
| InvalidParameterValue.RepeatType | Parameter error: invalid RepeatType. |
| InvalidParameterValue.SvgTemplate | Incorrect parameter value: SVG is empty. |
| InvalidParameterValue.SvgTemplateHeight | Incorrect parameter value: SVG height. |
| InvalidParameterValue.SvgTemplateWidth | Incorrect parameter value: SVG width. |
| InvalidParameterValue.TextAlpha | Parameter error: text transparency. |
| InvalidParameterValue.TextTemplate | Parameter error: text template. |
| InvalidParameterValue.Type | Parameter error: incorrect Type value. |
| InvalidParameterValue.Width | Parameter error: Wwdth. |
| InvalidParameterValue.XPos | The horizontal position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported. |
| InvalidParameterValue.YPos | The vertical position of the origin of the watermark relative to the origin of coordinates of the video. % and px formats are supported. |
| LimitExceeded.TooMuchTemplate | Limit reached: the number of templates exceeds the limit. |
피드백