AddLiveStreamWatermark - 添加⽔印模板

调用AddLiveStreamWatermark添加水印模板。

接口说明

  • 本接口支持添加直播⽔印模板配置,模板配置支持描述⽔印内容、布局等信息。

  • 添加水印模板后,您还需要调用 AddLiveStreamWatermarkRule 接口添加水印规则,重新推流后,播流中才能带水印。

QPS 限制

本接口的单用户 QPS 限制为 60 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:AddLiveStreamWatermarkcreate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Typeinteger

水印类型。取值:

  • 0:图片。

  • 1:文字(目前只支持图片)。

0
Namestring

水印名称。

livewatermark****
RefWidthinteger

参考背景视频宽,单位:px。

1920
RefHeightinteger

参考背景视频高,单位:px。

1080
XOffsetfloat

⽔印 X 轴偏移,单位:px。

说明 相对于参考背景宽 RefWidth, 如果选择的是 TopLeft,那么 XOffset 是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置 X。其中坐标指向背景视频中⼼的⽅向为正⽅向,即 X 轴的正⽅向是向右。
50.0
YOffsetfloat

⽔印 Y 轴偏移,单位:px。

说明 相对于参考背景⾼RefHeight,如果选择的是 TopLeft,那么 YOffset 是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置 Y。其中坐标指向背景视频中⼼的⽅向为正⽅向,即 Y 轴的正⽅向是向下。
100.0
Heightinteger

水印图片高度,单位:px。对比参考背景 RefHeight,最终按照⽐例进⾏⾃适应缩放为准。

200
Transparencyinteger

水印透明度,数值越小越透明。取值:0~255。

255
OffsetCornerstring

位置。取值:

  • TopLeft:左上。

  • TopRight:右上。

  • BottomLeft:左下。

  • BottomRight:右下。

TopRight
PictureUrlstring

水印图片链接。

http://example.com
Descriptionstring

自定义水印描述信息。

my watermark
Domainstring

播流域名。

example.aliyundoc.com

返回参数

名称类型描述示例值
object
TemplateIdstring

水印模板 ID。

445409ec-7eaa-461d-8f29-4bec2eb9****
RequestIdstring

请求 ID。

5c6a2a0df228-4a64- af62-20e91b96****

示例

正常返回示例

JSON格式

{
  "TemplateId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b96****"
}

错误码

HTTP status code错误码错误信息
400InvalidParameters%s

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史