裁剪视频
更新时间:2025-01-14 16:04:43
接口描述
1、通过视频id裁剪视频
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
接口URL
http://api.polyv.net/v2/video/{userid}/clip
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| ptime | true | Long | 当前时间的毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| vid | true | String | 视频id |
| title | true | String | 裁剪后的视频名称 |
| timeFrame | true | String | 特定时间段【详见timeFrame字段说明】,格式为json数组对象,例:[{"start":1,"end":6},{"start":10,"end":16}] 时间段数量不能超过5个,每个片段开始时间不能大于结束时间,开始与结束时间间隔大于或等于5秒,结束时间不能超过视频的播放时长 |
timeFrame参数描述
| 字段 | 类型 | 说明 |
|---|---|---|
| start | Integer | 开始时间,单位秒 |
| end | Integer | 结束时间,单位秒 |
示例
http://api.polyv.net/v2/video/1b448be323/clip
表单参数:
vid=1b448be323631e6e80e12e0790609f68_1&sign=004B30AE72BF5E96624A6FF81370FCCE64F379B1&title=美食&ptime=1617765720251&timeFrame=[{"start":1,"end":6},{"start":10,"end":16}]
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | String | 响应成功时返回新的视频id,失败时返回空字符串 |
返回错误代码列表
| 错误代码 | message | 说明 |
|---|---|---|
| 400 | sign can not be empty. | 加密串为空 |
| 400 | ptime is too old. | 时间戳过期 |
| 400 | ptime is illegal. | 时间戳参数格式不对或者超过当前时间3分钟 |
| 400 | Could not find user by userid. | userid不存在 |
| 400 | the sign is not right. | 加密串不正确 |
| 410 | vid is blank. | vid为空 |
| 411 | timeFrame is blank. | 时间段为空 |
| 412 | vid doesn't exist. | vid不存在 |
| 413 | illegal timeFrames. | timeframe的json格式有问题 |
| 414 | timeFrames's size exceed 5. | timeFrame时间段超过5段 |
| 415 | illegal timeFrames. | timeFrame的结束时间小于开始时间 |
| 416 | illegal timeFrames. | timeFrame时间段长度小于5秒 |
| 417 | illegal timeFrames. | timeFrame的结束时间超过视频的时长 |
| 418/419 | inital clip task filed. | 初始化任务失败,需要查看后台日志原因 |
| 500 | save clip task failed. | 后台程序抛异常 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。
强烈建议您使用点播Java SDK完成API的功能对接,点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(VodClipTest.class);
/**
* 裁剪视频
* @throws Exception
* @throws NoSuchAlgorithmException
*/
@Test
public void testUploadWatermark() throws Exception, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String secretKey = super.secretKey;
String userId = super.userId;
String ptime = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/v2/video/"+userId+"/clip";
String vid = "1b448be323631e6e80e12e0790609f68_1";
String title="美食";
String timeFrame = "[{\"start\":1,\"end\":6},{\"start\":10,\"end\":16}]";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("ptime", ptime);
requestMap.put("vid", vid);
requestMap.put("title", title);
requestMap.put("timeFrame", timeFrame);
requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
String response = HttpUtil.postFormBody(url,requestMap);
log.debug("测试裁剪视频,{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code":200,
"status":"success",
"message":"success",
"data":"1b448be323615635294a548b3c8a9953"
}
异常示例
{
code: 400,
status: "error",
message: "ptime is too old.",
data: ""
}
