为了简化水印任务的处理过程,视频点播将复杂的水印位置、水印大小、水印文字的字体、颜色等水印参数固化成模板,并通过具有唯一性的水印模板ID来指代。调用本接口可以添加图片水印模板或文字水印模板。
接口说明
- 调用本接口可以添加图片水印模板(
Image
)或文字水印模板(Text
),其中,图片水印模板支持如下格式:静态图片(PNG)、动态图片(GIF、APNG、MOV)。 - 调用本接口添加图文水印模板后,您还需调用 AddTranscodeTemplateGroup 或 UpdateTranscodeTemplateGroup 接口,将图文水印模板关联到转码模板组上,以便后续发起水印转码时选用。
- 为视频添加图文水印的详细信息,请参见视频图文水印。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vod:AddWatermark |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Type | string | 是 | 水印模板类型:
| Image |
Name | string | 是 | 水印模板名称。
| 图片水印模板 |
WatermarkConfig | string | 是 | 图文水印的配置信息(JSON 字符串),包括水印显示位置、水印效果等配置。图片水印和文字水印的配置参数不同,参数结构详情,请参见 WatermarkConfig 。 | { "Width": "55", "Height": "55", "Dx": "9", "Dy": "9", "ReferPos": "BottomLeft" } |
FileUrl | string | 否 | 水印图片文件的 OSS 地址(不带鉴权)。 说明
Type 为Image )时,本参数必传。FileURL 的值可作为本参数的请求参数。 | http://outin-326268*****63e1403e7.oss-cn-shanghai.aliyuncs.com/image/cover/C99345*****E7FDEC-6-2.png |
AppId | string | 否 | 应用 ID。默认取值:app-1000000。若已开通多应用体系,传入应用 ID,可将水印模板添加到指定应用下。使用说明,请参见多应用体系。 | app-**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
"WatermarkInfo": {
"CreationTime": "2018-11-07T09:05:52Z",
"Type": "Image",
"IsDefault": "NotDefault",
"FileUrl": "https://outin-3262*****9f4b3e7.oss-cn-shanghai.aliyuncs.com/image/cover/E6C3448CC8B715E6F8A72EC6B-6-2.png?Expires=1541600583&OSSAccessKeyId=****&Signature=gmf1eYMoDVg%2BHQCb4UGozBW****",
"WatermarkConfig": "{\n \"Width\": \"55\",\n \"Height\": \"55\",\n \"Dx\": \"9\",\n \"Dy\": \"9\",\n \"ReferPos\": \"BottomLeft\"\n}",
"Name": "图片水印模板",
"WatermarkId": "9bcc8bfadb84*****109a2671d0df97"
}
}
错误码
访问错误中心查看更多错误码。