调用AddLiveStreamWatermark添加水印模板。
使用说明
- 本接口支持添加直播⽔印模板配置,模板配置支持描述⽔印内容、布局等信息。
- 添加水印模板后,您还需要调用AddLiveStreamWatermarkRule接口添加水印规则,重新推流后,播流中才能带水印。
QPS限制
本接口的单用户QPS限制为60次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | AddLiveStreamWatermark | 系统规定参数。取值:AddLiveStreamWatermark。 |
Type | Integer | 是 | 0 | 水印类型。取值:
|
Name | String | 是 | livewatermark**** | 水印名称。 |
RefWidth | Integer | 是 | 1920 | 参考背景视频宽,单位:px。 |
RefHeight | Integer | 是 | 1080 | 参考背景视频高,单位:px。 |
XOffset | Float | 是 | 50.0 | ⽔印X轴偏移,单位:px。 说明 相对于参考背景宽RefWidth, 如果选择的是TopLeft,那么XOffset是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置X。其中坐标指向背景视频中⼼的⽅向为正⽅向,即X轴的正⽅向是向右。 |
YOffset | Float | 是 | 100.0 | ⽔印Y轴偏移,单位:px。 说明 相对于参考背景⾼RefHeight,如果选择的是TopLeft,那么YOffset是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置Y。其中坐标指向背景视频中⼼的⽅向为正⽅向,即Y轴的正⽅向是向下。 |
Height | Integer | 是 | 200 | 水印图片高度,单位:px。对比参考背景RefHeight,最终按照⽐例进⾏⾃适应缩放为准。 |
Transparency | Integer | 是 | 255 | 水印透明度,数值越小越透明。取值:0~255。 |
OffsetCorner | String | 是 | TopRight | 位置。取值:
|
PictureUrl | String | 是 | http://example.com | 水印图片链接。 |
Description | String | 否 | my watermark | 自定义水印描述信息。 |
Domain | String | 否 | example.aliyundoc.com | 播流域名。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TemplateId | String | 445409ec-7eaa-461d-8f29-4bec2eb9**** | 水印模板ID。 |
RequestId | String | 5c6a2a0df228-4a64- af62-20e91b9676b3 | 请求ID。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=AddLiveStreamWatermark
&Height=200
&Name=livewatermark****
&OffsetCorner=TopRight
&PictureUrl=http://example.com
&RefHeight=1080
&RefWidth=1920
&Transparency=255
&Type=0
&XOffset=50.0
&YOffset=100.0
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<AddLiveStreamWatermarkResponse>
<RequestId>5c6a2a0df228-4a64- af62-20e91b9676b3</RequestId>
<TemplateId>445409ec-7eaa-461d-8f29-4bec2eb9****</TemplateId>
</AddLiveStreamWatermarkResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "5c6a2a0df228-4a64- af62-20e91b9676b3",
"TemplateId" : "445409ec-7eaa-461d-8f29-4bec2eb9****"
}
错误码
访问错误中心查看更多错误码。