Updates a watermark template.

Usage notes

This operation allows you to modify the parameters of a watermark template with a specified ID.

QPS limit

You can call this operation up to 60 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateLiveStreamWatermark

The operation that you want to perform. Set the value to UpdateLiveStreamWatermark.

TemplateId String Yes 445409ec-7eaa-461d-8f29-4bec2eb9****

The ID of the watermark template.

Note You can obtain the template ID by checking the value of the TemplateId parameter that is returned by the AddLiveStreamWatermark operation.
Name String No livewatermark****

The name of the watermark.

Description String No my watermark

The description of the watermark.

RefWidth Integer No 1920

The width of the background video. Unit: pixel.

RefHeight Integer No 1080

The height of the background video. Unit: pixel.

XOffset Float No 50.0

The offset of the watermark along the x-axis. Unit: pixel.

Note In this case, the value of the RefWidth parameter is used as the reference. If the OffsetCorner parameter is set to TopLeft, the value of the XOffset parameter indicates the x-axis offset of the upper-left corner of the watermark relative to that of the background video. The directions from the coordinate axes to the center of the background video are positive. In other words, the x-axis is positive toward the right.
YOffset Float No 100.0

The offset of the watermark along the y-axis. Unit: pixel.

Note In this case, the value of the RefHeight parameter is used as the reference. If the OffsetCorner parameter is set to TopLeft, the value of the YOffset parameter indicates the y-axis offset of the upper-left corner of the watermark relative to that of the background video. The directions from the coordinate axes to the center of the background video are positive. In other words, the y-axis is positive downward.
Height Integer No 200

The height of the watermark. Unit: pixel. The height of the watermark is scaled in proportion to the height of the background video.

Transparency Integer No 255

The transparency of the watermark. A smaller value indicates a more transparent watermark. Valid values: 0 to 255.

OffsetCorner String No TopRight

The position of the watermark. Valid values:

  • TopLeft: the upper-left corner.
  • TopRight: the upper-right corner.
  • BottomLeft: the lower-left corner.
  • BottomRight: the lower-right corner.
PictureUrl String No http://example.com

The URL of the watermark image.

Response parameters

Parameter Type Example Description
RequestId String 5c6a2a0df228-4a64-af62-20e91b9676b3

The ID of the request.

Examples

Sample request

http(s)://live.aliyuncs.com/?Action=UpdateLiveStreamWatermark
&TemplateId=445409ec-7eaa-461d-8f29-4bec2eb9****
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateLiveStreamWatermarkResponse>
    <RequestId>5c6a2a0df228-4a64-af62-20e91b9676b3</RequestId>
</UpdateLiveStreamWatermarkResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "5c6a2a0df228-4a64-af62-20e91b9676b3"
}

Error codes

For a list of error codes, visit the API Error Center.