简介
数字水印功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于数字水印的相关 API 概览以及 SDK 示例代码。
注意
COS Javascript SDK 版本需要大于等于 v1.3.1。
API | 操作描述 |
提交一个添加数字水印任务 | |
提交一个提取数字水印任务 |
提交添加数字水印任务
功能说明
提交一个添加数字水印任务
使用示例
function postDigitalWatermark() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/11459const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `jobs`; // 固定值,必须const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;const body = COS.util.json2xml({Request: {// 创建任务的 Tag:DigitalWatermark;是否必传:是Tag: 'DigitalWatermark',// 待操作的文件信息;是否必传:是Input: {// 文件路径;是否必传:是Object: 'test.mp4',},// 操作规则;是否必传:是Operation: {DigitalWatermark: {Message: '123456', // 嵌入数字水印的水印信息;是否必传:是Type: 'Text', // 数字水印类型;是否必传:是Version: 'V1', // 数字水印版本;是否必传:是IgnoreError: true, // 当添加水印失败是否忽略错误继续执行任务;是否必传:是},// 结果输出配置;是否必传:是Output: {Region: config.Region,// 存储结果的存储桶;是否必传:是Bucket: config.Bucket,// 输出结果的文件名;是否必传:是Object: 'output/output.mp4',},// 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0;是否必传:否JobLevel: '0',// 透传用户信息,可打印的 ASCII 码,长度不超过1024;是否必传:否UserData: '',},// 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式;是否必传:否CallBackFormat: '',// 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型;是否必传:否CallBackType: 'Url',// 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调;是否必传:否CallBack: '',},});cos.request({Method: 'POST', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Body: body, // 请求体参数,必须ContentType: 'application/xml', // 固定值,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}});}postDigitalWatermark();
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:POST | String | 是 |
Url | 请求 url,固定值 | String | 是 |
Key | 固定值:jobs | String | 是 |
ContentType | 固定值 | String | 是 |
Body | 请求体详情请参见 提交任务 | Object | 是 |
回调函数说明
function(err, data) { ... }
相关链接
提交提取数字水印任务
功能说明
提交一个提取数字水印任务
使用示例
function postExtractDigitalWatermark() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/11459const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `jobs`; // 固定值,必须const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;const body = COS.util.json2xml({Request: {// 创建任务的 Tag:ExtractDigitalWatermark;是否必传:是Tag: 'ExtractDigitalWatermark',// 待操作的文件信息;是否必传:是Input: {// 文件路径;是否必传:是Object: 'test.mp4',},// 操作规则;是否必传:是Operation: {// 提取数字水印配置;是否必传:是ExtractDigitalWatermark: {// 水印类型;限制:Text;;是否必传:是Type: 'Text',// 水印版本;限制:V1;;是否必传:是Version: 'V1',},// 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0;是否必传:否JobLevel: '0',// 透传用户信息,可打印的 ASCII 码,长度不超过1024;是否必传:否UserData: '',},// 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式;是否必传:否CallBackFormat: '',// 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型;是否必传:否CallBackType: 'Url',// 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调;是否必传:否CallBack: '',},});cos.request({Method: 'POST', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Body: body, // 请求体参数,必须ContentType: 'application/xml', // 固定值,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}});}postExtractDigitalWatermark();
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:POST | String | 是 |
Url | 请求 url,固定值 | String | 是 |
Key | 固定值:jobs | String | 是 |
ContentType | 固定值 | String | 是 |
Body | 请求体详情请参见 提交任务 | Object | 是 |
回调函数说明
function(err, data) { ... }