查询水印模板列表

最近更新时间:2018-05-24 09:58:52

接口名称

QueryWatermarkTemplateList

功能说明

  1. 查询水印模板列表。

请求方式

请求域名

vod.api.qcloud.com

最高调用频率

100次/分钟

参数说明

参数名称 必填 类型 说明
COMMON_PARAMS 参见公共参数

请求示例

https://vod.api.qcloud.com/v2/index.php?Action=QueryWatermarkTemplateList
&COMMON_PARAMS

接口应答

参数说明

参数名称 类型 说明
code Integer 错误码, 0: 成功, 其他值: 失败
watermarkList Array 水印模板信息列表,参见水印模板信息

watermark(水印模板信息)

参数名称 类型 说明
definition Integer 水印模板 ID
name String 水印模板的名字
type String 水印类型,固定为 image
url String 水印的 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 的比例缩放
comment String 对该模板的描述
status Integer 是否为默认模板,1表示是,0表示否
create_time Integer 模板创建时间(Unix时间戳)
update_time Integer 模板更新时间(Unix时间戳)

错误码说明

错误码 含义说明
4000-7000 参见公共错误码
1000 无效参数
1001 内部错误
1050 内部错误
1102 内部错误
1702 内部错误

应答示例

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "watermarkList": [
        {
            "name": "watermark_1",
            "definition": 403770,
            "create_time": 1510233336,
            "update_time": 1510233336,
            "comment": "",
            "type": "image",
            "url": "http://vodgzp1251132654-10022853.cosgzp.myqcloud.com/vodgzp1251132654/0/watermark/14508071098252378919.png",
            "status": 0,
            "posType": "",
            "left": "11%",
            "top": "10%",
            "width": "10%",
            "height": "10%",
            {...}
        },
        {
            "name": "watermark_2",
            "definition": 403771,
            "create_time": 1510233394,
            "update_time": 1510233394,
            "comment": "",
            "type": "image",
            "url": "http://vodgzp1251132654-10022853.cosgzp.myqcloud.com/vodgzp1251132654/0/watermark/14508071098252378920.png",
            "status": 0,
            "left": "40%",
            "top": "40%",
            "width": "10%",
            "height": "10%",
            {...}
        },
        ...
    ]
}