服务端 API 文档

创建水印模板

最近更新时间:2019-12-02 16:07:32

注意:

本接口已不再维护,新接口 CreateWatermarkTemplate 为您提供更完备的功能,请尽快迁移。

接口名称

CreateWatermarkTemplate

功能说明

创建新的水印模板。

说明:

通过服务端 API 创建水印模板步骤如下:

  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
    }
    目录