文档

AddWaterMarkTemplate - 新增水印模版

更新时间:

创建水印模板。

接口说明

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

QPS限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

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

example-watermark-****
Configstring

水印模板配置。JSON对象。更多信息请参见水印模板配置详情

说明如果水印文字不需要与分辨率变化正相关,可配置自适应,即在文字水印的text中添加选项['adaptive']=true
{"Width":"10","Height":"30","Dx":"10","Dy":"5","ReferPos":"TopRight","Type":"Image","Timeline":{"Start":"0","Duration":"10"}}

返回参数

名称类型描述示例值
object

返回参数。

WaterMarkTemplateobject

水印模板。

Typestring

水印类型。可取值:

  • Image:图片水印。

  • Text:文字水印。

Image
RatioReferobject

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

  • Width:宽。

  • Height:高。

  • Long:长边。

  • Short:短边。

Dxstring

水印图片相对输出视频的水平偏移量。默认值:0(无偏移)。 值有两种形式:

  • 整数型:代表偏移像素,绝对位置,单位:px。
  • 小数型:代表水平偏移量与输出分辨率宽的比率,相对比例,按照视频尺寸变化,支持4位小数,如0.9999,超出部分系统自动丢弃。
0.51
Widthstring

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

  • 整数型:代表水印图片宽的像素值,绝对位置,单位:px。
  • 小数型:代表相对输出视频分辨率宽的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。
0.36
Heightstring

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

  • 整数型:代表水印图片高的像素值,绝对位置,单位:px。
  • 小数型:代表相对输出视频分辨率高的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。
0.33
Dystring

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

  • 整数型:代表偏移像素,绝对位置,单位:px。
  • 小数型:代表垂直偏移量与输出分辨率高的比率,相对比例,按照视频尺寸变动,支持4位小数,如0.9999,超出部分系统自动丢弃。
0.28
ReferPosstring

水印的位置。取值:

  • TopRight:右上。

  • TopLeft:左上。

  • BottomRight:右下。

  • BottomLeft:左下。

TopRight
Statestring

水印模板的状态。

  • Normal:正常。

  • Deleted:已删除。

Normal
Dxstring

水平偏移量。单位:px。

10
Widthstring

水印图片宽。单位:px。

10
Heightstring

水印图片高。单位:px。

30
Timelineobject

动态水印。

Startstring

水印开始出现时间。

  • 单位:秒。
  • 默认值:0
0
Durationstring

水印持续时间。默认值:ToEND(直至视频结束)。

ToEND
Namestring

水印模板名称。

example-watermark-****
Dystring

垂直偏移量。单位:px。

5
Idstring

水印模板ID。建议您保存此ID便于后续调用相关接口时使用。

3780bd69b2b74540bc7b1096f564****
RequestIdstring

请求ID。

54BB917F-DD35-4F32-BABA-E60E31B21W63

示例

正常返回示例

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"
}

错误码

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

  • 本页导读 (1)
文档反馈