功能描述
创建水印模板。
请求
请求示例
POST /template HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml<body>
请求头
请求体
该请求操作的实现需要有如下请求体。
<Request><Tag>Watermark</Tag><Name>TemplateName</Name><Watermark><Type>Text</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Text><Text>水印内容</Text><FontSize>30</FontSize><FontType></FontType><FontColor>0xRRGGBB</FontColor><Transparency>30</Transparency></Text></Watermark></Request><Request><Tag>Watermark</Tag><Name>TemplateName</Name><Watermark><Type>Image</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Image><Url>http://test-1234567890.ci.ap-beijing.myqcloud.com/shuiyin_2.png</Url><Mode>Proportion</Mode><Width>10</Width><Height></Height><Transparency>100</Transparency></Image></Watermark></Request>
具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Request | 无 | 保存请求的容器 | Container |
Container 类型 Request 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 必选 |
Tag | Request | 模板类型: Watermark | String | 是 |
Name | Request | 模板名称,仅支持中文、英文、数字、_、-和* | String | 是 |
Watermark | Request | 水印信息 | Container | 是 |
Container 类型 Watermark 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 必选 | 默认值 | 限制 |
Type | Request.Watermark | 水印类型 | String | 是 | 无 | Text:文字水印、 Image:图片水印 |
Pos | Request.Watermark | 基准位置 | String | 是 | 无 | TopRight、TopLeft、BottomRight、BottomLeft、Left、Right、Top、Bottom、Center |
LocMode | Request.Watermark | 偏移方式 | String | 是 | 无 | Relativity:按比例,Absolute:固定位置 |
Dx | Request.Watermark | 水平偏移 | String | 是 | 无 | 1. 在图片水印中,如果 Background 为 true,当 locMode 为 Relativity 时,为%,值范围:[-300 0];当 locMode 为 Absolute 时,为 px,值范围:[-4096 0]。 2. 在图片水印中,如果 Background 为 false,当 locMode 为 Relativity 时,为%,值范围:[0 100];当 locMode 为 Absolute 时,为 px,值范围:[0 4096]。 3. 在文字水印中,当 locMode 为 Relativity 时,为%,值范围:[0 100];当 locMode 为 Absolute 时,为 px,值范围:[0 4096]。 4. 当Pos为Top、Bottom和Center时,该参数无效。 |
Dy | Request.Watermark | 垂直偏移 | String | 是 | 无 | 1. 在图片水印中,如果 Background 为 true,当 locMode 为 Relativity 时,为%,值范围:[-300 0];当 locMode 为 Absolute 时,为 px,值范围:[-4096 0]。 2. 在图片水印中,如果 Background 为 false,当 locMode 为 Relativity 时,为%,值范围:[0 100];当 locMode 为 Absolute 时,为 px,值范围:[0 4096]。 3. 在文字水印中,当 locMode 为 Relativity 时,为%,值范围:[0 100];当 locMode 为 Absolute 时,为 px,值范围:[0 4096]。 4. 当Pos为Left、Right和Center时,该参数无效。 |
StartTime | Request.Watermark | 水印开始时间 | String | 否 | 0 | 1. [0 视频时长] 2. 单位为秒 3. 支持 float 格式,执行精度精确到毫秒 |
EndTime | Request.Watermark | 水印结束时间 | String | 否 | 视频结束时间 | 1. [0 视频时长] 2. 单位为秒 3. 支持 float 格式,执行精度精确到毫秒 |
SlideConfig | Request.Watermark | 水印滑动配置,配置该参数后水印位移设置不生效,极速高清/H265转码暂时不支持该参数 | Container | 否 | 无 | 无 |
Image | Request.Watermark | 图片水印节点 | Container | 否 | 无 | 无 |
Text | Request.Watermark | 文本水印节点 | Container | 否 | 无 | 无 |
Container 类型 SlideConfig 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 必选 | 默认值 | 限制 |
SlideMode | Request.Watermark. SlideConfig | 滑动模式 | String | 是 | 无 | Default: 默认不开启、ScrollFromLeft: 从左到右滚动,若设置了ScrollFromLeft模式,则Watermark.Pos参数不生效 |
XSlideSpeed | Request.Watermark. SlideConfig | 横向滑动速度 | String | 是 | 无 | 取值范围:[0,10]内的整数,默认为0 |
YSlideSpeed | Request.Watermark. SlideConfig | 纵向滑动速度 | String | 是 | 无 | 取值范围:[0,10]内的整数,默认为0 |
Container 类型 Image 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 必选 | 默认值 | 限制 |
Url | Request.Watermark. Image | 水印图地址(需要 Urlencode 后传入) | String | 是 | 无 | 同 bucket 的水印图片地址 |
Mode | Request.Watermark. Image | 尺寸模式 | String | 是 | 无 | 1. Original:原有尺寸 2. Proportion:按比例 3. Fixed:固定大小 |
Width | Request.Watermark. Image | 宽 | String | 否 | 无 | 1. 当 Mode 为 Original 时,不支持设置水印图宽度 2. 当 Mode 为 Proportion,单位为%,背景图值范围:[100 300];前景图值范围:[1 100],相对于视频宽,最大不超过4096px 3. 当 Mode 为 Fixed,单位为 px,值范围:[8,4096] 4. 若只设置 Width 时,按照水印图比例计算 Height |
Height | Request.Watermark. Image | 高 | String | 否 | 无 | 1. 当 Mode 为 Original 时,不支持设置水印图高度 2. 当 Mode 为 Proportion,单位为%,背景图值范围:[100 300];前景图值范围:[1 100],相对于视频高,最大不超过4096px 3. 当 Mode 为 Fixed,单位为 px,值范围:[8,4096] 4. 若只设置 Height 时,按照水印图比例计算 Width |
Transparency | Request.Watermark. Image | 透明度 | String | 是 | 无 | 值范围:[1 100],单位% |
Background | Request.Watermark. Image | 是否背景图 | String | 否 | false | true、false |
水印位置说明:
Container 类型 Text 的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 必选 | 默认值 | 限制 |
FontSize | Request.Watermark. Text | 字体大小 | String | 是 | 无 | 值范围:[5 100],单位 px |
FontType | Request.Watermark. Text | 字体类型 | String | 是 | 无 | 参考下表 |
FontColor | Request.Watermark. Text | 字体颜色 | String | 是 | 无 | 格式:0xRRGGBB |
Transparency | Request.Watermark. Text | 透明度 | String | 是 | 无 | 值范围:[1 100],单位% |
Text | Request.Watermark. Text | 水印内容 | String | 是 | 无 | 长度不超过64个字符,仅支持中文、英文、数字、_、-和* |
Text 的 FontType 具体数据描述如下:
字体名称 | 支持的语言 | 描述 |
simfang.ttf | 中/英 | 仿宋 |
simhei.ttf | 中/英 | 黑体 |
simkai.ttf | 中/英 | 楷体 |
simsun.ttc | 中/英 | 宋体 |
STHeiti-Light.ttc | 中/英 | 华文黑体 |
STHeiti-Medium.ttc | 中/英 | 华文黑体中 |
youyuan.TTF | 中/英 | 幼圆 |
ariblk.ttf | 英 | 无 |
arial.ttf | 英 | 无 |
ahronbd.ttf | 英 | 无 |
Helvetica.dfont | 英 | 无 |
HelveticaNeue.dfont | 英 | 无 |
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response><Template><TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId><Tag>Watermark</Tag><Name>TemplateName</Name><BucketId>test-1234567890</BucketId><Category>Custom</Category><Watermark><Type>Text</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Text><Text>水印内容</Text><FontSize>30</FontSize><FontType></FontType><FontColor>0xRRGGBB</FontColor><Transparency>30</Transparency></Text></Watermark><CreateTime>2020-08-05T11:35:24+0800</CreateTime><UpdateTime>2020-08-31T16:15:20+0800</UpdateTime></Template></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
TemplateId | Response.Template | 模板 ID | String |
Name | Response.Template | 模板名称 | String |
BucketId | Response.Template | 模板所属存储桶 | String |
Category | Response.Template | 模板属性,Custom 或者 Official | String |
Tag | Response.Template | 模板类型,VideoProcess | String |
UpdateTime | Response.Template | 更新时间 | String |
CreateTime | Response.Template | 创建时间 | String |
Watermark | Response.Template | 同请求体中的 Request.Watermark | Container |
错误码
实际案例
请求1(文本水印)
POST /template HTTP/1.1Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****Host: test-1234567890.ci.ap-beijing.myqcloud.comContent-Length: 1666Content-Type: application/xml<Request><Tag>Watermark</Tag><Name>TemplateName</Name><Watermark><Type>Text</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Text><Text>水印内容</Text><FontSize>30</FontSize><FontType></FontType><FontColor>0xRRGGBB</FontColor><Transparency>30</Transparency></Text></Watermark></Request>
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 100Connection: keep-aliveDate: Thu, 14 Jul 2022 12:37:29 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><Template><TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId><Tag>Watermark</Tag><Name>TemplateName</Name><BucketId>test-1234567890</BucketId><Category>Custom</Category><Watermark><Type>Text</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Text><Text>水印内容</Text><FontSize>30</FontSize><FontType></FontType><FontColor>0xRRGGBB</FontColor><Transparency>30</Transparency></Text></Watermark><CreateTime>2020-08-05T11:35:24+0800</CreateTime><UpdateTime>2020-08-31T16:15:20+0800</UpdateTime></Template></Response>
请求2(图片水印)
POST /template HTTP/1.1Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****Host: test-1234567890.ci.ap-beijing.myqcloud.comContent-Length: 1666Content-Type: application/xml<Request><Tag>Watermark</Tag><Name>TemplateName</Name><Watermark><Type>Image</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Image><Url>http://test-1234567890.ci.ap-beijing.myqcloud.com/shuiyin_2.png</Url><Mode>Proportion</Mode><Width>10</Width><Height>10</Height><Transparency>30</Transparency></Image></Watermark></Request>
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 100Connection: keep-aliveDate: Thu, 14 Jul 2022 12:37:29 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****<Response><Template><TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId><Tag>Watermark</Tag><Name>TemplateName</Name><BucketId>test-1234567890</BucketId><Category>Custom</Category><Watermark><Type>Image</Type><LocMode>Absolute</LocMode><Dx>128</Dx><Dy>128</Dy><Pos>TopRight</Pos><StartTime>0</StartTime><EndTime>100.5</EndTime><Image><Url>http://test-1234567890.ci.ap-beijing.myqcloud.com/shuiyin_2.png</Url><Mode>Proportion</Mode><Width>10</Width><Height>10</Height><Transparency>30</Transparency></Image></Watermark><CreateTime>2020-08-05T11:35:24+0800</CreateTime><UpdateTime>2020-08-31T16:15:20+0800</UpdateTime></Template></Response>