字段	类型	是否必填	示例	描述
Action	String	是	DescribeWatermarkTemplate	公共参数，拉取上传，取值：DescribeWatermarkTemplate
WatermarkTemplateId	String	是	f1f1r13r	模板Id
SpaceName	String	否	other_space1	应用空间默认为：default_space

返回参数

字段	类型	示例	描述
CreateTime	String	2021-12-05T10:20:09Z	模板的创建时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
UpdateTime	String	2021-12-05T10:20:09Z	模板的更新时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
WatermarkTemplate	WatermarkTemplate		当模板类型为watermark时返回，水印模板参数内容。

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=DescribeWatermakrTemplate' \
-H 'Content-Type: application/json' \
-d 'WatermarkTemplateId=xxx' \
-H <公共参数>

错误码

ErrorCode	ErrorMessage	说明	状态码
ResourceNotFound	WatermarkTemplate not found.	模板不存在	404
InvalidArgument	WatermarkTemplateId required arguments are missing	必填参数WatermarkTemplateId 为空	400
InvalidArgument	Can't change type in watermarkTemplate	水印模板创建之后无法更改Type	400

上一篇：查询截图模板详情下一篇：查询任务流模板详情

该篇文档内容是否对您有帮助？

有帮助没帮助

关于我们

支持与服务

法律支持

联系我们

友情链接