新建水印模板
功能介绍
自定义水印模板，水印模板目前默认支持创建100000个。
在视频内容中嵌入可见的水印，水印有多种应用场景和内容类型，例如:"赞助商或合作伙伴Logo"、"质量或认证标志"等。
水印模板是预设的一系列参数集合，用于定义水印的位置、大小等关键属性。通过使用水印模板，开发者可以简化水印应用的开发流程，实现快速、一致的水印添加效果。
-
水印模板只适用于图片水印，不适用于文字水印。文字水印请在CreateTranscodingTask - 新建转码任务接口中指定WaterMarks参数。
-
水印模板仅包含水印的位置、大小属性，不包含水印素材。水印素材需要在提交媒资转码任务时添加。
-
水印模板可以通过控制台，或调用 CreateWatermarkTemplate - 新建水印模板。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/template/watermark
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参考获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必选，携带的鉴权信息。 |
|
X-Project_Id |
否 |
String |
使用AK/SK方式认证时必选，携带项目ID信息, 与路径参数中的项目ID相同。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选，请求的发生时间。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dx |
否 |
String |
水印图片起点相对输出视频顶点的水平偏移量。 设置方法有如下两种：
示例：输出视频分辨率宽1920，设置“dx”为“0.1”，“referpos”为“TopRight”（右上角），则水印图片右上角到视频右顶点在水平方向上偏移距离为192。 |
|
dy |
否 |
String |
水印图片起点相对输出视频顶点的垂直偏移量。
示例：输出视频分辨率高1080，设置“dy”为“0.1”，“referpos”为“TopRight”（右上角），则水印图片右上角到视频右顶点在垂直方向上的偏移距离为108。 |
|
referpos |
否 |
String |
水印的位置。 取值如下：
|
|
timeline_start |
否 |
String |
水印开始时间，与“timeline_duration”配合使用。 取值范围：数字。 单位：秒。 |
|
timeline_duration |
否 |
String |
水印持续时间，与“timeline_start”配合使用。 取值范围：[数字，ToEND]。“ToEND”表示持续到视频结束。 默认值：ToEND。 |
|
image_process |
否 |
String |
图片水印处理方式，type设置为Image时有效。 取值如下：
|
|
width |
否 |
String |
水印图片宽，值有两种形式：
|
|
height |
否 |
String |
水印图片高，值有两种形式：
|
|
base |
否 |
String |
水印叠加母体 取值如下：
|
|
template_id |
否 |
Integer |
水印模板ID |
|
template_name |
否 |
String |
水印模板名称，最大支持64个字符。 |
|
type |
否 |
String |
水印类型，当前只支持Image（图片水印）。后续根据需求再支持Text（文字水印）。 |
响应参数
状态码：201
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
template_id |
Integer |
水印模板Id |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
新建水印模板，水印模板目前默认支持创建100000个。
POST https://{endpoint}/v1/{project_id}/template/watermark
{
"template_name" : "watermark_1920*1080_10*10_ BottomLeft",
"type" : "Image",
"image_process" : "Grayed",
"width" : "1920",
"height" : "1080",
"dx" : "10",
"dy" : "10",
"referpos" : "BottomLeft",
"timeline_start" : "6",
"timeline_duration" : "8"
}响应示例
状态码：201
新建水印模板成功。
{
"template_id" : 100211
}状态码：403
新建水印模板失败。
{
"error_code" : "MPC.10202",
"error_msg" : "Invalid request parameter."
}状态码
|
状态码 |
描述 |
|---|---|
|
201 |
新建水印模板成功。 |
|
403 |
新建水印模板失败。 |
错误码
请参见错误码。
