模板操作

简介

本文档提供关于数据万象媒体处理任务的相关 API 概览以及 SDK 示例代码,此处以动图任务举例。

基本操作

创建模板

功能说明

用于创建一个新的模板。

方法原型

public MediaTemplateResponse createMediaTemplate(MediaTemplateRequest request);

参数说明

Request 的具体参数描述如下：

Request 节点 Container 的具体数据描述如下：

Request 节点 Video 的具体数据描述如下：

Request 节点 TimeInterval 的具体数据描述如下：

Container 类型 Snapshot 的具体数据描述如下：

Container 类型 Watermark 的具体数据描述如下：

Container 类型 Image 的具体数据描述如下：

水印位置说明：

Container 类型 Text 的具体数据描述如下：

Text 的 FontType 具体数据描述如下：

Audio 音频视频支持的格式如下表：

Audio 的具体数据描述如下：

Y表示支持这种采样率，N表示不支持

TransConfig 的具体数据描述如下：

Video 的具体数据描述如下：

返回结果说明

• 成功：返回 MediaTemplateResponse 对象响应信息，内含创建的模板详情。
• 失败：发生错误（如 Bucket 不存在），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。

请求示例

//1.创建模板请求对象
MediaTemplateRequest request = new MediaTemplateRequest();
//2.添加请求参数 参数详情请见api接口文档
request.setBucketName("examplebucket-1250000000");
request.setTag("Animation");
request.setName("TestTemplate40");
request.getContainer().setFormat("gif");
request.getVideo().setCodec("gif");
request.getVideo().setWidth("1280");
request.getVideo().setFps("15");
request.getVideo().setAnimateOnlyKeepKeyFrame("true");
request.getTimeInterval().setStart("0");
request.getTimeInterval().setDuration("60");
//3.调用接口,获取模板响应对象
MediaTemplateResponse response = client.createMediaTemplate(request);

删除模板

功能说明

删除一个模板

方法原型

public Boolean deleteMediaTemplate(MediaTemplateRequest request);

参数说明

返回结果说明

• 成功： 返回一个布尔类型，删除成功则返回 true。
• 失败： 发生错误（如身份认证失败），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。

请求示例

MediaTemplateRequest request = new MediaTemplateRequest();
request.setBucketName("examplebucket-1250000000");
request.setTemplateId("t19c4a60ae1a694621a01f0c7130c*****");
Boolean response = client.deleteMediaTemplate(request);

查询模板列表

功能说明

查询模板列表

方法原型

public MediaJobResponse describeMediaJob(MediaJobsRequest req);

参数说明

返回结果说明

• 成功： 返回模板响应包装类，其中包含模板详情集合 templateList。
• 失败： 发生错误（如身份认证失败），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。

请求示例

//1.创建任务请求对象
MediaTemplateRequest request = new MediaTemplateRequest();
request.setBucketName("examplebucket-1250000000");
MediaListTemplateResponse response = client.describeMediaTemplates(request);
List<MediaTemplateObject> templateList = response.getTemplateList();

修改模板

功能说明

修改模板

方法原型

public Boolean updateMediaTemplate(MediaTemplateRequest request);   

参数说明

说明：

其余参数请参见 创建模板接口，与其参数一致。

返回结果说明

• 成功： 修改成功则返回 true。
• 失败： 发生错误（如身份认证失败），抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理。

请求示例

MediaTemplateRequest request = new MediaTemplateRequest();
request.setBucketName("examplebucket-1250000000");
request.setTemplateId("t19c4a60ae1a694621a01f0c7130*****");
request.setTag("Animation");
request.setName("updateName");
request.getContainer().setFormat("gif");
Boolean aBoolean = client.updateMediaTemplate(request);