创建水印模板

最近更新时间:2018-07-24 15:20:54

接口名称

CreateWatermarkTemplate

功能说明

创建新的水印模板。

注:通过服务端 API 创建水印模板分为三步,本接口为其中的第 3 步:

  1. 调用 申请上传水印文件(ApplyUploadWatermark)接口,申请水印文件的上传URL;
  2. 使用 HTTP PUT 方法,将水印文件上传到上一步返回的上传 URL,请求 Body 为水印图片的二进制数据;
  3. 调用本接口创建水印模板。

请求方式

请求域名

vod.api.qcloud.com

最高调用频率

100次/分钟

参数说明

参数名称 必填 类型 说明
name String 水印模板的名称,最长 64 个字节。
comment String 对该模板的描述,最长 1024 个字节。
type String 水印类型,固定为 image
url String 水印的 url 地址,必须为调用 ApplyUploadWatermark 接口返回的 url
left String 水印图片左上角距离视频图像左上角的水平位置。
  • 带 % 结尾的字符串表示水印 left 为视频宽度百分比的大小,如 10% 表示 left 为视频宽度的 10%;
  • 带 px 结尾的字符串表示 left 单位为像素,100px 表示 left 为100像素;
默认为 0px
top String 水印图片左上角距离视频图像左上角的垂直位置。
  • 带 % 结尾的字符串表示水印 top 为视频高度百分比的大小,如 10% 表示 top 为视频高度的 10%;
  • 带 px 结尾的字符串表示 top 单位为像素,100px 表示 top 为100像素
默认为 0px
width String 水印图片的宽度。
  • 带 % 结尾的字符串表示 width 为视频宽度百分比的大小,如 10% 表示 width 为视频宽度的 10%;
  • 带 px 结尾的字符串表示 width 单位为像素,100px 表示 width 为 100 像素;
默认为 10%
height String 水印图片的高度。
  • 带 % 结尾的字符串表示水印 height 为视频高度百分比的大小,如 10%表示 height 为视频高度的 10%
  • 带 px 结尾的字符串表示 height 单位为像素,100px 表示 height 为100像素;
默认为 0px,表示 height 按照对视频的 width 的比例缩放
COMMON_PARAMS 参见公共参数

请求示例

https://vod.api.qcloud.com/v2/index.php?Action=CreateWatermarkTemplate
&name=test
&type=image
&url=http://0b9e4a22vodgzp1256xxx827-10022853.cosgzp.myqcloud.com/0b9e4a22vodgzp1256xxx827/0/watermark/74473xxxxxx56285.png
&left=20px
&top=30px
&width=100px
&COMMON_PARAMS

接口应答

参数说明

参数名称 类型 说明
code Integer 错误码, 0:成功,其他值:失败
message String 错误信息
definition Integer 采样截图模板 ID

错误码说明

错误码 含义说明
4000-7000 参见 公共错误码
1000 无效参数
1001 内部错误
10706 水印模板个数已经达到最大限制
10801 请求中的 url 参数错误
10802 请求中的 type 参数错误
10803 请求中的 left 参数错误
10804 请求中的 top 参数错误
10810 请求中的 width 参数错误
10811 请求中的 height 参数错误

应答示例

{
    "code": 0,
    "message": "",
    "definition": 1008
}