简介
本文档提供关于创建明水印模板的相关 API 概览以及 SDK 示例代码。
API | 操作描述 |
创建明水印模板 |
创建模板
功能说明
创建明水印模板。
示例代码
<?phprequire dirname(__FILE__, 2) . '/vendor/autoload.php';$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket$cosClient = new Qcloud\\Cos\\Client(array('region' => $region,'scheme' => 'https', // 审核时必须为https'credentials'=> array('secretId' => $secretId ,'secretKey' => $secretKey)));try {//创建明水印模板$result = $cosClient->CreateWatermarkTemplate(array('Bucket' => 'test-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket'Headers' => array('Content-Type' => 'application/xml',),'Tag'=> 'Watermark', // 模板类型: Watermark;是否必传:否'Name'=> 'TemplateName', // 模板名称,仅支持中文、英文、数字、_、-和*,长度不超过 64;是否必传:否// 水印信息;是否必传:否'Watermark'=> array( 'Type'=> 'Text', // 水印类型Text:文字水印Image:图片水印;是否必传:是 'Pos'=> 'TopRight', // 基准位置TopRightTopLeftBottomRightBottomLeftLeftRightTopBottomCenter;是否必传:是 'LocMode'=> 'Relativity', // 偏移方式Relativity:按比例Absolute:固定位置;是否必传:是 'Dx'=> '0', // 水平偏移在图片水印中,如果 Background 为 true,当 locMode 为 Relativity 时,为%,值范围:[-300 0];当 locMode 为 Absolute 时,为 px,值范围:[-4096 0]。在图片水印中,如果 Background 为 false,当 locMode 为 Relativity 时,为%,值范围:[0 100];当 locMode 为 Absolute 时,为 px,值范围:[0 4096]。在文字水印中,当 locMode 为 Relativity 时,为%,值范围:[0 100];当 locMode 为 Absolute 时,为 px,值范围:[0 4096]。当Pos为Top、Bottom和Center时,该参数无效。;是否必传:是 'Dy'=> '0', // 垂直偏移在图片水印中,如果 Background 为 true,当 locMode 为 Relativity 时,为%,值范围:[-300 0];当 locMode 为 Absolute 时,为 px,值范围:[-4096 0]。在图片水印中,如果 Background 为 false,当 locMode 为 Relativity 时,为%,值范围:[0 100];当 locMode 为 Absolute 时,为 px,值范围:[0 4096]。在文字水印中,当 locMode 为 Relativity 时,为%,值范围:[0 100];当 locMode 为 Absolute 时,为 px,值范围:[0 4096]。当Pos为Left、Right和Center时,该参数无效。;是否必传:是 'StartTime'=> '0', // 水印开始时间[0,视频时长] 单位为秒 支持 float 格式,执行精度精确到毫秒;是否必传:否 'EndTime'=> '', // 水印结束时间[0,视频时长] 单位为秒 支持 float 格式,执行精度精确到毫秒;是否必传:否'Text' => array( 'Text' => 'test', 'FontSize' => '30', 'FontType' => 'simfang.ttf', 'FontColor' => '0x000000', 'Transparency' => '90', ), ),));// 请求成功print_r($result);} catch (\\Exception $e) {// 请求失败echo($e);}
参数说明
参数名称 | 参数描述 | 类型 | 是否必填 |
Tag | 模板类型: Watermark | string | 否 |
Name | 模板名称,仅支持中文、英文、数字、_、-和*,长度不超过 64 | string | 否 |
Watermark | 水印信息 | Container | 否 |
Watermark 的具体数据描述如下:
参数名称 | 参数描述 | 类型 | 是否必填 |
Type | 水印类型 Text:文字水印 Image:图片水印 | string | 是 |
Pos | 基准位置 TopRight TopLeft BottomRight BottomLeft Left Right Top Bottom Center | string | 是 |
LocMode | 偏移方式 Relativity:按比例 Absolute:固定位置 | string | 是 |
Dx | 水平偏移 在图片水印中,如果 Background 为 true,当 locMode 为 Relativity 时,为%,值范围:[-300 0];当 locMode 为 Absolute 时,为 px,值范围:[-4096 0]。 在图片水印中,如果 Background 为 false,当 locMode 为 Relativity 时,为%,值范围:[0 100];当 locMode 为 Absolute 时,为 px,值范围:[0 4096]。 在文字水印中,当 locMode 为 Relativity 时,为%,值范围:[0 100];当 locMode 为 Absolute 时,为 px,值范围:[0 4096]。 当 Pos 为 Top、Bottom 和 Center 时,该参数无效。 | string | 是 |
Dy | 垂直偏移 在图片水印中,如果 Background 为 true,当 locMode 为 Relativity 时,为%,值范围:[-300 0];当 locMode 为 Absolute 时,为 px,值范围:[-4096 0]。 在图片水印中,如果 Background 为 false,当 locMode 为 Relativity 时,为%,值范围:[0 100];当 locMode 为 Absolute 时,为 px,值范围:[0 4096]。 在文字水印中,当 locMode 为 Relativity 时,为%,值范围:[0 100];当 locMode 为 Absolute 时,为 px,值范围:[0 4096]。 当 Pos 为 Left、Right 和 Center 时,该参数无效。 | string | 是 |
StartTime | 水印开始时间 [0,视频时长] 单位为秒 支持 float 格式,执行精度精确到毫秒 | string | 否 |
EndTime | 水印结束时间 [0,视频时长] 单位为秒 支持 float 格式,执行精度精确到毫秒 | string | 否 |
SlideConfig | 水印滑动配置,配置该参数后水印位移设置不生效,极速高清/H265转码暂时不支持该参数 | Container | 否 |
Image | 图片水印节点 | Container | 否 |
Text | 文本水印节点 | Container | 否 |
Image 的具体数据描述如下:
参数名称 | 参数描述 | 类型 | 是否必填 |
Url | 水印图地址(需要 Urlencode 后传入) | string | 是 |
Mode | 尺寸模式 Original:原有尺寸 Proportion:按比例 Fixed:固定大小 | string | 是 |
Width | 宽 当 Mode 为 Original 时,不支持设置水印图宽度 当 Mode 为 Proportion,单位为%,背景图值范围:[100 300];前景图值范围:[1 100],相对于视频宽,最大不超过4096px 当 Mode 为 Fixed,单位为 px,值范围:[8,4096] 若只设置 Width 时,按照水印图比例计算 Height | string | 否 |
Height | 高 当 Mode 为 Original 时,不支持设置水印图高度 当 Mode 为 Proportion,单位为%,背景图值范围:[100 300];前景图值范围:[1 100],相对于视频高,最大不超过4096px 当 Mode 为 Fixed,单位为 px,值范围:[8,4096] 若只设置 Height 时,按照水印图比例计算 Width | string | 否 |
Transparency | 透明度,值范围:[1 100],单位% | string | 是 |
Background | 是否背景图,取值 true、false | string | 否 |
SlideConfig 的具体数据描述如下:
参数名称 | 参数描述 | 类型 | 是否必填 |
SlideMode | 滑动模式 Default: 默认不开启 ScrollFromLeft: 从左到右滚动 若设置了 ScrollFromLeft 模式,则 Watermark.Pos 参数不生效 | string | 是 |
XSlideSpeed | 横向滑动速度,取值范围:[0,10]内的整数 | string | 否 |
YSlideSpeed | 纵向滑动速度,取值范围:[0,10]内的整数 | string | 否 |
Text 的具体数据描述如下:
参数名称 | 参数描述 | 类型 | 是否必填 |
FontSize | 字体大小,值范围:[5 100],单位 px | string | 是 |
FontType | 字体类型,参考下表 | string | 是 |
FontColor | 字体颜色,格式:0xRRGGBB | string | 是 |
Transparency | 透明度,值范围:[1 100],单位% | string | 是 |
Text | 水印内容,长度不超过64个字符,仅支持中文、英文、数字、_、-和* | string | 是 |
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 | 英 | 无 |