裁剪錄製檔案

更新時間：2022-09-02 18:08:07

介面描述

1、裁剪直播录制视频文件，裁剪文件过程为异步处理过程
2、裁剪视频的最小粒度仅支持到单位为秒(s)的裁剪
3、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/record/clip

線上API呼叫

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號
fileId	true	String	檔案ID【可透過查詢頻道錄製影片資訊取得】
deleteTimeFrame	true	String	要裁剪移除的時間區間傳入格式要求：（1）start、end值是單位為秒的數值，格式為：`[{"start":xx, "end":xx},{"start":xx, "end":xx}]` （2）多個區間請依照時間順序從小到大排列（3）時間區間不允許重疊（4）時間區間不得超過100個限制【範例：要裁剪移除的是第1s到第14s，以及第25s到第30s的區間，則傳入的字串為 `[{"start":1, "end":14},{"start":25, "end":30}]` 】誤差說明：（1）裁剪區間存在一定的時間誤差（2）誤差原因：回放預設為m3u8格式裁剪，由於m3u8的影片裁剪是精確到每片ts，所以裁剪時會判斷裁剪要移除的時間區間所包含的ts片，進行裁剪移除，如需更精準的裁剪，可聯繫保利威客服人員開通mp4裁剪
callbackUrl	false	String	裁剪成功或失敗回呼的url【詳見回呼說明】
autoConvert	false	String	是否自動轉存回放到點播，預設為N Y：是 N：否
fileName	false	String	裁剪後檔案名稱

範例

http://api.polyv.net/live/v3/channel/record/clip

表單參數：

fileName=3-25%E6%B5%8B%E8%AF%95%E8%A3%81%E5%89%AAN%E4%B8%8D%E8%BD%AC%E5%AD%98&appId=frlr1zazn3&deleteTimeFrame=%5B%7B%22start%22%3A1%2C%22end%22%3A30%7D%2C%7B%22start%22%3A50%2C%22end%22%3A60%7D%5D&sign=BCA5136EEE29D14C0EA483BD5FC24464&autoConvert=N&callbackUrl=http%3A%2F%2Fxxxx&channelId=2191541&timestamp=1621841922358&fileId=249fd64bdf9329aa1e1c1228fb0732cd

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500的時候，輔助描述錯誤原因
data	String	請求成功時返回提交成功資訊 "submit success."：提交的影片正在裁剪處理中

回呼說明

裁剪結果即時資訊回呼，可以及時通知使用者裁剪任務的結果。

原理

透過HTTP介面（設定的callbackUrl）向使用者伺服器發送GET請求，將合併結果推送給使用者伺服器。

舉例說明

舉例如下：http://abc.com/test.do?status=success&fileId=xxxx&channelId=xxx&sign=xxdxxxxx&clippedFileId=xxx&fileName=xxxx&timestamp=xxx&actualTimeFrame=xxx

參數名	類型	說明
status	String	介面處理結果，成功為success，失敗為error
channelId	String	頻道號，成功時返回
fileId	String	裁剪後的檔案ID，成功時返回
clippedFileId	String	裁剪前的檔案ID，成功時返回
fileUrl	String	裁剪後的影片地址，成功時返回
timestamp	String	回呼的當前時間戳
sign	String	校驗的加密字串，產生的規則md5(AppSecret+timestamp)，AppSecret是直播系統的用金鑰
actualTimeFrame	String	真實裁剪後保留的時間區間，經過urlEncode的字串，格式為：`[{"start":xx, "end":xx},{"start":xx, "end":xx}]`
fileName	String	檔案名稱，經過urlEncode的字串

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(ChannelPlayBackTest.class);
/**
 * 异步裁剪直播录制文件
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testClipRecordFile() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/channel/record/clip";
    String channelId = "2191532";
    String fileId = "635b8e3c74d8a43530a138b0e75d841e";
    String deleteTimeFrame = "[{\"start\":1, \"end\":30},{\"start\":50, \"end\":60}]";
    String callbackUrl="http://xxxx";
    String autoConvert="N";
    String fileName="fileName";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("fileId", fileId);
    requestMap.put("deleteTimeFrame", deleteTimeFrame);
    requestMap.put("callbackUrl", callbackUrl);
    requestMap.put("autoConvert", autoConvert);
    requestMap.put("fileName", fileName);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试异步裁剪直播录制文件，返回值：{}", response);
    //do somethings
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":"submit success."
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}