提交任务

最近更新时间:2024-10-17 16:16:52

我的收藏

简介

提交视频截帧任务功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。 本文档提供关于提交视频截帧任务的相关 API 概览以及 SDK 示例代码。
注意
COS Javascript SDK 版本需要大于等于 v1.3.1。
API
操作描述
提交一个截帧任务

提交任务

功能说明

提交一个截帧任务

使用示例

function postSnapshot() {
// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/11459
const 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:Snapshot;是否必传:是
Tag: 'Snapshot',
// 待操作的文件信息;是否必传:是
Input: {
// 文件路径;是否必传:是
Object: 'test.mp4',
},
// 操作规则;是否必传:是
Operation: {
// TemplateId与Snapshot二选一传入
// 截帧模板 ID;是否必传:否,可通过控制台获取
TemplateId: 'xxx',
// Snapshot: {},
// 结果输出配置;是否必传:是
Output: {
// 存储桶的地域;是否必传:是
Region: config.Region,
// 存储结果的存储桶;是否必传:是
Bucket: config.Bucket,
// 输出结果的文件名;是否必传:是
Object: 'output/snapshot-${number}.jpg',
// 雪碧图的名字。当有多个输出文件时必须包含 ${number} 通配符。仅支持 jpg 格式;是否必传:否
SpriteObject: 'output/sprite-${number}.jpg',
},
// 透传用户信息,可打印的 ASCII 码,长度不超过1024;是否必传:否
UserData: '',
// 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0;是否必传:否
JobLevel: '0',
},
// 任务回调格式,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);
}
}
);
}
postSnapshot();

参数说明

cos.request 方法参数说明:
参数名称
参数描述
类型
是否必填
Method
固定值:POST
String
Url
请求 url,固定值
String
Key
固定值:jobs
String
ContentType
固定值
String
Body
请求体详情请参见 提交任务
Object

回调函数说明

function(err, data) { ... }
参数名称
参数描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误。如果请求成功则为空,更多详情请参见 错误码
Object
- statusCode
请求返回的 HTTP 状态码,例如 200、403、404 等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,例如 200、403、404 等
Number
- headers
请求返回的头部信息
Object
- Response
响应结果 详情请参见 提交任务
Object

相关链接