保利威文档中心

幫助中心

合併直播錄製

更新時間:2025-02-28 11:49:06

介面描述

1、合并直播录制文件,保存至频道号内视频库,接口合并过程为异步处理过程
2、接口支持https协议

介面URL

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

線上API呼叫

請求方式

POST

介面限制

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

2、合併MP4檔案不能超過15個,合併影片總時長不能超過24小時

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 目前13位毫秒級時間戳記,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
channelId true String 頻道號
fileIds true String 要合併的錄製影片檔案ID,多個id用英文逗號, 分隔【fileId可透過查詢頻道錄製影片資訊取得】
fileName false String 合併後的影片的檔案名稱
callbackUrl false String 合併成功或失敗回呼的url,可以帶上自訂參數【詳見回呼說明
autoConvert false String 是否自動轉存到點播,預設為N
Y:自動轉存到對應點播分類下(點播儲存路徑:直播回放-頻道號-場次)
N:不自動轉存
mergeMp4 false String 合併後檔案類型,預設為N
Y:合併為MP4檔案
N:合併為m3u8檔案
orderByCustom false String 是否按照參數的fileIds順序做合併,取值Y或N,不傳預設N會按照開播時間順序合併

範例

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

表單參數:

mergeMp4=N&fileName=%E6%B5%8B%E8%AF%95%E5%BC%82%E6%AD%A5%E5%90%88%E5%B9%B633333&fileIds=46a586558b9e716c2cc2802a52b9e907%2C9a41298b5f032f3d5a8119b104c5dfcc&appId=frlr1zazn3&sign=1C08E1AB4882DEFB00CC2A5582472A03&autoConvert=N&callbackUrl=http%3A%2F%2Fabc.com&channelId=2191541&timestamp=1621841986670

回應參數描述

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data String 請求成功時返回提交成功資訊
"processing.":合併任務正在處理中
"submit success.":合併任務提交成功

回呼說明

合併結果即時資訊回呼,可以及時通知使用者合併任務的結果。

原理

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

舉例說明

舉例如下:http://abc.com/test.do?status=success&timestamp=1603506240000&fileId=xxxx&fileIds=xxx,xxx&sign=xxdxxxxx&fileUrl=urlxxxx&fileName=xxxx

參數名 類型 說明
status String 介面處理結果,成功為success,失敗為error
timestamp Long 目前13位毫秒級時間戳記
fileId String 合併後的檔案ID,成功時返回
fileIds String 合併前的檔案ID
fileUrl String 合併後的影片檔案地址,成功時返回
fileName String 合併後的檔案名稱,成功時返回
sign String 校驗的加密字串,產生的規則md5(AppSecret+timestamp),AppSecret是直播系統使用的金鑰

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 testRecordFileMergeAsync() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/record/merge";
    String channelId = "2191541";
    String fileIds = "249fd64bdf9329aa1e1c1228fb0732cd,66fda01de2e11bf1d91e801ea7cbc431";
    String fileName = "合并后文件名MP4";
    String callbackUrl = "http://abc.com";
    String autoConvert = "N";
    String mergeMp4 = "Y";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("fileIds", fileIds);
    requestMap.put("fileName", fileName);
    requestMap.put("callbackUrl", callbackUrl);
    requestMap.put("autoConvert", autoConvert);
    requestMap.put("mergeMp4", mergeMp4);
    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": ""
}
联系客服,在线咨询