提交视频截帧任务

最近更新时间:2023-08-01 17:19:11

我的收藏

简介

本文档提供关于提交视频截帧任务相关的 API 概览以及 SDK 示例代码。
API
操作描述
提交视频截帧任务

SDK API 参考

SDK 所有接口的具体参数与方法说明,请参考 SDK API

提交视频截帧任务

功能说明

提交视频截帧任务
注意
COS Android SDK 版本需要大于等于 v5.9.14。

示例代码

// 存储桶名称,格式为 BucketName-APPID
String bucket = "examplebucket-1250000000";
// 对象键,是对象在 COS 上的完整路径,如果带目录的话,格式为 "dir1/object1"
String object = "dir1/exampleobject.mp4";
// 输出路径文件夹
String outputResultPath = "media/job_result/";
SubmitSnapshotJobRequest request = new SubmitSnapshotJobRequest(bucket);
// 请求实体
SubmitSnapshotJob submitSnapshotJob = new SubmitSnapshotJob();
SubmitSnapshotJob.SubmitSnapshotJobInput input = new SubmitSnapshotJob.SubmitSnapshotJobInput();
// 文件路径
input.object = object;
submitSnapshotJob.input = input;
// 操作配置
SubmitSnapshotJob.SubmitSnapshotJobOperation operation = new SubmitSnapshotJob.SubmitSnapshotJobOperation();
//该任务的截帧参数
TemplateSnapshot.TemplateSnapshotSnapshot snapshot = new TemplateSnapshot.TemplateSnapshotSnapshot();
// 截图数量;是否必传:是;默认值:无;限制:(0 10000];
snapshot.count = "3";
operation.snapshot = snapshot;
// 输出配置
SubmitSnapshotJob.SubmitSnapshotJobOutput output = new SubmitSnapshotJob.SubmitSnapshotJobOutput();
// 输出存储桶地域
output.region = "ap-guangzhou";
// 输出存储桶
output.bucket = bucket;
// 结果文件的名字。当有多个输出文件时必须包含 ${number} 通配符;是否必传:否;
output.object = outputResultPath+"video_snapshot-${number}.jpg";
// 雪碧图的名字。当有多个输出文件时必须包含 ${number} 通配符。仅支持 jpg 格式;是否必传:否;
output.spriteObject = outputResultPath+"video_sprite-${number}.jpg";
operation.output = output;
// 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0;是否必传:否;
operation.jobLevel = "0";
// 透传用户信息, 可打印的 ASCII 码, 长度不超过1024;是否必传:否;
operation.userData = "userData";
submitSnapshotJob.operation = operation;
// 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式;是否必传:否;
submitSnapshotJob.callBackFormat = "XML";
// 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型;是否必传:否;
submitSnapshotJob.callBackType = "Url";
// 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调;是否必传:否;
submitSnapshotJob.callBack = "http://callback.demo.com";
// 更多配置请查看api文档或者SDK源码
request.setSubmitSnapshotJob(submitSnapshotJob);
ciService.submitSnapshotJobAsync(request, new CosXmlResultListener() {
@Override
public void onSuccess(CosXmlRequest request, CosXmlResult cosResult) {
// result 提交视频截帧任务的结果
// 详细字段请查看api文档或者SDK源码
SubmitSnapshotJobResult result = (SubmitSnapshotJobResult) cosResult;
}
@Override
public void onFail(CosXmlRequest request, CosXmlClientException clientException, CosXmlServiceException serviceException) {
if (clientException != null) {
clientException.printStackTrace();
} else {
serviceException.printStackTrace();
}
}
});
说明
更多完整示例,请前往 GitHub 查看。