文档首页 > > API参考> 水印模板接口> 查询水印模板

查询水印模板

分享
更新时间: 2019/12/06 GMT+08:00

功能描述

查询用户自定义水印模板,支持指定模板ID查询,也支持分页查询。

请求URI

GET /v1/{project_id}/template/watermark

请求参数

表1 请求参数说明

参数

类型

说明

必选项(M)/可选项(O)

template_id

Integer

水印配置模板ID,最多10个

O

page

Integer

分页编号,查询指定template_id时,该参数无效。

默认值:0。

O

size

Integer

每页记录数,查询指定template_id时,该参数无效。

取值范围:[1,100]。

默认值:10。

O

请求样例

GET /v1/{project_id}/template/watermark?template_id=0002&page=0&size=10

返回参数

  • 查询成功返回
    表2 返回参数说明

    参数

    类型

    说明

    total

    Integer

    水印模板总数。

    templates

    Array of Template objects

    水印模板查询结果数组。

    表3 Template参数说明

    名称

    类型

    说明

    template_id

    String

    水印模板ID。

    template_name

    String

    水印模板名称。

    type

    String

    水印类型。

    取值如下:
    • Image:图片水印。

    image_process

    String

    图片水印处理方式。“type”设置为“Image”时有效。

    取值如下:
    • Original:只做简单缩放,不做其他处理。
    • Grayed:彩色图片变灰。
    • Transparent:透明化。

    width

    String

    水印图片宽度。

    设置方法有如下两种:
    • 整数型:表示水印图片宽的像素值,单位为px。

      取值范围:[8,4096]。

    • 小数型:表示水印图片宽度相对于视频分辨率的宽的比率。

      取值范围:(0,1),支持4位小数,如0.9999,超出部分系统自动丢弃。

      示例:输出视频分辨率宽1920,设置“width”“0.1”,则水印图片宽为192。

    height

    String

    水印图片高度。

    设置方法有如下两种:
    • 整数型:表示水印图片宽的像素值,单位为px。

      取值范围:[8,4096]。

    • 小数型:表示水印图片宽度相对于视频分辨率的宽的比率。

      取值范围:(0,1),支持4位小数,如0.9999,超出部分系统自动丢弃。

      示例:例如输出视频分辨率高1080,设置“height”“0.1”,则水印图片高为108。

    dx

    String

    水印图片起点相对输出视频定点的水平偏移量。

    设置方法有如下两种:
    • 整数型:表示图片起点水平偏移视频顶点的像素值,单位px。

      取值范围:[0,4096]

    • 小数型:表示图片起点相对于视频分辨率宽的水平偏移比率。

      取值范围:(0,1),支持4位小数,如0.9999,超出部分系统自动丢弃。

      示例:输出视频分辨率宽1920,设置“dx”“0.1”“referpos”“TopRight”(右上角),则水印图片右上角到视频右顶点在水平方向上偏移距离为192。

    默认值:0。

    dy

    String

    水印图片起点相对输出视频定点的垂直偏移量。

    设置方法有如下两种:
    • 整数型:表示图片起点水平偏移视频顶点的像素值,单位px。

      取值范围:[0,4096]

    • 小数型:表示图片起点相对于视频分辨率宽的水平偏移比率。

      取值范围:(0,1),支持4位小数,如0.9999,超出部分系统自动丢弃。

      示例:输出视频分辨率高1080,设置“dy”“0.1”“referpos”“TopRight”(右上角),则水印图片右上角到视频右顶点在垂直方向上的偏移距离为180。

    默认值:0。

    referpos

    String

    水印的位置。

    取值如下:
    • TopRight:右上角。
    • TopLeft:左下角。
    • BottomRight:右下角。
    • BottomLeft:左下角。

    timeline_start

    String

    水印开始时间,与“timeline_duration”配合使用。

    取值范围:数字。

    默认值:0。

    单位:秒。

    timeline_duration

    String

    水印持续时间,与“timeline_start”配合使用。

    取值范围:[数字,ToEND]。

    默认值:ToEND。

  • 查询失败返回
    表4 返回参数说明

    参数

    类型

    说明

    error_code

    String

    错误码。

    error_msg

    String

    错误描述。

返回样例

  • 查询成功返回(200 OK)
    {
      "total": 1,
      "templates": [
        {
          "template_id": 573,
          "template_name": "watermark_1920*1080_10*10_ BottomLeft",
          "type": "Image",
          "image_process": "Grayed",
          "width": "1920",
          "height": "1080",
          "dx": "10",
          "dy": "20",
          "referpos": "BottomLeft",
          "timeline_start": "6",
          "timeline_duration": "8"
        }
      ]
    }
  • 处理失败返回(500 Internal Server Error)
    {
      "error_code": "MPC.10200",
      "error_msg": "系统问题,请联系华为工程师解决。"
    }

错误码

错误码请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区