logologo
售前咨询
点播云
文档中心服务端API媒体处理获取水印模板列表

获取水印模板列表


请求参数

字段

类型

是否必填

示例

描述

Action

String

ListWatermarkTemplate

公共参数,拉取上传,取值:ListWatermarkTemplate

Offset

Integer

0

分页偏移量,默认值:0

Limit

Integer

20

分页返回条数,最大不超过50

默认值:20

SpaceName

String

other_space1

应用空间

默认为:default_space

返回参数

字段

类型

示例

描述

WatermarkTemplates

Array of WatermarkTemplate


对应的水印模板对象列表

Limit

Integer

10

返回的模板个数

Offset

Integer

0

分页起始坐标

Total

Integer


满足查询条件的模板总数


WatermarkTemplate

字段

类型

是否必填(创建)

示例

描述

TemplateId

String

xxx

模板ID

Name

String

watermark_template

水印模板名称,长度限制:64 个字符。只可设置字母、数字、中划线、下划线。

  • 创建接口,需要传入
  • 更新接口,不需要传入

Description

String

test xxx

模板描述信息,长度限制:256 个字符。

Type

String

image

水印类型,可选值:

  • image:图片水印
  • text:文字水印

一个模板只能是一种类型。

ReferPosition

String


原点位置,可选值:

  • topLeft:表示坐标原点位于视频图像左上角,水印原点为图片或文字的左上角;
  • topRight:表示坐标原点位于视频图像的右上角,水印原点为图片或文字的右上角;
  • bottomLeft:表示坐标原点位于视频图像的左下角,水印原点为图片或文字的左下角;
  • bottomRight:表示坐标原点位于视频图像的右下角,水印原点为图片或文字的右下角。

默认值:topLeft。

MarginX

String


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

默认值:0

值有两种形式:

  • 整数型代表偏移像素。
    • 范围:[8,4096],
    • 单位:px
  • 代表水平偏移量与输出分辨率宽的比率。
    • 范围:(0,1),
    • 支持4位小数,如0.9999,超出部分系统自动丢弃。

MarginY

String


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

默认值:0

值有两种形式:

  • 整数型代表偏移像素。
    • 范围:[8,4096],
    • 单位:px
  • 小数型代表水平偏移量与输出分辨率高的比率。
    • 范围:(0,1),
    • 支持4位小数,如0.9999,超出部分系统自动丢弃。

ImageTemplate

ImageTemplate


图片水印模板,仅当 Type 为 image,该字段必填且有效。

TextTemplate

TextTemplate


文字水印模板,仅当 Type 为 text,该字段必填且有效。

ImageTemplate

字段

类型

是否必填(创建)

示例

描述

Resource

Resource


水印图片的存储标识。只支持静图图片。

Width

String

0.1

水印图片的宽

  • 小数型代表相对输出视频分辨率宽的比率。
    • 范围:(0,1),
    • 支持4位小数,如0.9999,超出部分系统自动丢弃。

默认值为 0.1

Height

String

0.1

水印图片的高

  • 小数型代表相对输出视频分辨率高的比率。
    • 范围:(0, 1),
    • 支持4位小数,如0.9999,超出部分系统自动丢弃。

默认值为 0。(0代表图片按照原始比例的宽高比进行缩放)

Resource

字段

类型

是否必填(创建)

示例

描述

Bucket

String

store-bucket-1

存储桶名称,不超过64个字符

Object

String

overWatch.png

存储在这个存储桶中的水印素材对象。不超过64个字符。

TextTemplate

字段

类型

是否必填(创建)

示例

描述

FontType

String

SourceHanSans

字体类型,目前支持一种:

  • SourceHanSans

默认值为SourceHanSans

Text

String

hello

文字水印的文本内容。长度应小于64个字符。

FontSize

Integer

48

字体大小,单位是px。取值应大于0。默认值为48。

FontColor

String

#FFFFFF

字体颜色,缺省为灰色,需设置为十六进制 RGB 格式(如 #FF0000),详情参考 RGB 编码表,默认值为 #3D3D3D


API示例

请求示例

curl -X POST 'https://vod.streamlakeapi.com/?Action=ListWatermarkTemplate' \
-H 'Content-Type: application/json' \
-d 'Offset=0' \
-d 'Limit=10' \
-H <公共参数>


返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
"ResponseMeta": {
"RequestId":"CixgpmAFOYcAAAAAAAAAAw",
"ErrorCode":"",
"ErrorMessage":""
},
"ResponseData": {
"Limit": 10,
"Offset": 0,
"Total": 10,
"WatermarkTemplates": [
{
"TemplateId": "xxx",
"Name": "xxx",
...
}, {
"TemplateId": "xxx",
"Name": "xxx",
...
}
]
}
}




错误码

ErrorCode

ErrorMessage

说明

状态码

InvalidArgument

limit arguments are invalid,limit should between 0 and 50

参数错误(包括参数格式、类型、长度等错误)

400

InvalidArgument

offset arguments are invalid,offset should greater than or  equal to 0

参数错误(包括参数格式、类型、长度等错误)

400

上一篇:获取截图模板列表下一篇:获取任务流模板列表
该篇文档内容是否对您有帮助?
有帮助没帮助