裁剪影片

更新時間：2025-01-14 16:04:43

介面描述

1、通过视频id裁剪视频
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

介面URL

http://api.polyv.net/v2/video/{userid}/clip

線上API呼叫

請求方式

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: ""
}