Domain name for API request: live.tencentcloudapi.com.
After a watermark is added and a watermark ID is successfully returned, you need to call the CreateLiveWatermarkRule API to bind the watermark ID to a stream.
After the number of watermarks exceeds the upper limit of 100, to add a new watermark, you must delete an old one first.
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: AddLiveWatermark. |
Version | Yes | String | Common Params. The value used for this API: 2018-08-01. |
Region | No | String | Common Params. This parameter is not required for this API. |
PictureUrl | Yes | String | Watermark image URL. Unallowed characters in the URL: ;(){}$>`#"'| |
WatermarkName | Yes | String | Watermark name. Up to 16 bytes. |
XPosition | No | Integer | Display position: X-axis offset in %. Default value: 0. |
YPosition | No | Integer | Display position: Y-axis offset in %. Default value: 0. |
Width | No | Integer | Watermark width or its percentage of the live streaming video width. It is recommended to just specify either height or width as the other will be scaled proportionally to avoid distortions. The original width is used by default. |
Height | No | Integer | Watermark height, which is set by entering a percentage of the live stream image’s original height. You are advised to set either the height or width as the other will be scaled proportionally to avoid distortions. Default value: original height. |
Parameter Name | Type | Description |
---|---|---|
WatermarkId | Integer | Watermark ID. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://live.tencentcloudapi.com/?Action=AddLiveWatermark
&PictureUrl=http://watermark-10005041.cos.myqcloud.com/1251830167/watermark_img_Alogo.png
&XPosition=80
&YPosition=10
&WatermarkName=logo
&<Common request parameters>
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
"WatermarkId": 123
}
}
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 |
---|---|
InternalError.ConfOutLimit | The number of templates exceeded the limit. |
InternalError.DBError | DB execution error. |
InternalError.WatermarkAddError | Failed to add the watermark. |
InvalidParameter | Invalid parameter. |
ResourceNotFound.ForbidService | You are blocked. |
ResourceNotFound.FreezeService | Service suspended. |
ResourceNotFound.StopService | The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first. |
ResourceNotFound.UserDisableService | You disabled the service. |
ResourceNotFound.UserNotFount | The user does not exist. |
この記事はお役に立ちましたか?