调用AddWaterMarkTemplate创建水印模板。

使用说明

通过本接口创建水印模板后，在提交转码作业时指定水印模板和水印素材，即可为输出视频添加水印信息。

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 AddWaterMarkTemplate

操作接口名，系统规定参数，取值：AddWaterMarkTemplate。

Name String 是 example-watermark-****

水印模板名称。支持中英文，数字等，最大长度128字节。

Config String 是 {"Width":"10","Height":"30","Dx":"10","Dy":"5","ReferPos":"TopRight","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}

水印模板配置。JSON对象，其中Type（水印类型）目前仅支持Image。更多信息请参见水印模板配置详情。

返回数据

名称 类型 示例值 描述
WaterMarkTemplate Object

水印模板。
Type String Image

水印类型。
RatioRefer Object

取值为百分比时参考的边。当Height，Width，Dx，Dy的取值处于（0,1）时，这个百分比是参考下列边得到的（按顺序）：

  • Width：宽。
  • Height：高。
  • Long：长边。
  • Short：短边。
Dx String 0.51

水印图片相对输出视频的水平偏移量。默认值：0（无偏移）。

值有两种形式：

  • 整数型：代表偏移像素，单位：px。
  • 小数型：代表水平偏移量与输出分辨率宽的比率，支持4位小数，如0.9999，超出部分系统自动丢弃。
Width String 0.36

输出视频上水印图片宽。值有两种形式：

  • 整数型：代水印图片宽的像素值，单位：px。
  • 小数型：代表相对输出视频分辨率宽的比率，支持4位小数，如0.9999，超出部分系统自动丢弃。
Height String 0.33

输出视频上水印图片高。值有两种形式：

  • 整数型：代表水印图片高的像素值，单位：px。
  • 小数型：代表相对输出视频分辨率高的比率，支持4位小数，如0.9999，超出部分系统自动丢弃。
Dy String 0.28

水印图片相对输出视频的垂直偏移量。默认值：0（无偏移）。值有两种形式：

  • 整数型：代表偏移像素，单位：px。
  • 小数型：代表垂直偏移量与输出分辨率高的比率，支持4位小数，如0.9999，超出部分系统自动丢弃。
ReferPos String TopRight

水印的位置。取值：

  • TopRight：右上。
  • TopLeft：左上。
  • BottomRight：右下。
  • BottomLeft：左下。
State String Normal

水印模板的状态。

  • Normal：正常。
  • Deleted：已删除。
Dx String 10

水平偏移量。单位：px。
Width String 10

水印图片宽。单位：px。
Height String 30

水印图片高。单位：px。
Timeline Object

动态水印。
Start String 0

水印开始出现时间。

  • 单位：秒。
  • 默认值：0。
Duration String ToEND

水印持续时间。默认值：ToEND（直至视频结束）。

Name String example-watermark-****

水印模板名称。
Dy String 5

垂直偏移量。单位：px。
Id String 3780bd69b2b74540bc7b1096f564****

水印模板ID。建议您保存此ID便于后续调用相关接口时使用。
RequestId String 54BB917F-DD35-4F32-BABA-E60E31B21W63

请求ID。

示例

请求示例

http(s)://mts.cn-shanghai.aliyuncs.com/?Action=AddWaterMarkTemplate
&Name=example-watermark-****
&Config={"Width":"10","Height":"30","Dx":"10","Dy":"5","ReferPos":"TopRight","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}
&<公共请求参数>

正常返回示例

XML格式 

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

<AddWaterMarkTemplateResponse>
    <WaterMarkTemplate>
        <Type>Image</Type>
        <RatioRefer>
            <Dx>0.51</Dx>
            <Width>0.36</Width>
            <Height>0.33</Height>
            <Dy>0.28</Dy>
        </RatioRefer>
        <ReferPos>TopRight</ReferPos>
        <State>Normal</State>
        <Dx>10</Dx>
        <Width>10</Width>
        <Height>30</Height>
        <Timeline>
            <Start>0</Start>
            <Duration>ToEND</Duration>
        </Timeline>
        <Name>example-watermark-****</Name>
        <Dy>5</Dy>
        <Id>3780bd69b2b74540bc7b1096f564****</Id>
    </WaterMarkTemplate>
    <RequestId>54BB917F-DD35-4F32-BABA-E60E31B21W63</RequestId>
</AddWaterMarkTemplateResponse>

JSON格式 

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

{
  "WaterMarkTemplate" : {
    "Type" : "Image",
    "RatioRefer" : {
      "Dx" : "0.51",
      "Width" : "0.36",
      "Height" : "0.33",
      "Dy" : "0.28"
    },
    "ReferPos" : "TopRight",
    "State" : "Normal",
    "Dx" : "10",
    "Width" : "10",
    "Height" : "30",
    "Timeline" : {
      "Start" : "0",
      "Duration" : "ToEND"
    },
    "Name" : "example-watermark-****",
    "Dy" : "5",
    "Id" : "3780bd69b2b74540bc7b1096f564****"
  },
  "RequestId" : "54BB917F-DD35-4F32-BABA-E60E31B21W63"
}

错误码

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