設定偽直播

更新時間：2024-05-31 10:21:44

介面描述

1、批量添加伪直播的视频，需预先将视频上传至点播系统或者视频来源于直播暂存录制
2、调用接口后，如果当前频道未在直播中，会自动设置直播方式为“伪直播“
3、如果当前使用其他直播推流方式直播中，则需要在直播结束后，调用”修改频道推流方式“接口修改为伪直播，才会在所设置的开始时间进行直播
4、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/stream/add-disk-videos

線上API呼叫

請求方式

POST

介面限制

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

2、僅支援正常延遲的純影片頻道設定偽直播

3、不允許新增加密影片、不允許新增m3u8格式的影片

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號，僅支援正常延遲的純影片頻道設定偽直播
vids	true	String	要設定偽直播的點播影片ID或者直播暫存檔案fileId，多個以英文逗號分隔
startTimes	false	String	偽直播開始時間列表，13位毫秒級時間戳，多個以英文逗號分隔，需要與vids數量匹配。如果為空，則表示不設定直播時間如果不為空，需大於當前時間，當設定的vid為直播暫存檔案時該欄位不能為空。
origin	false	String	偽直播影片來源，值為空或者是vod是點播影片，值為record時候代表是來自直播暫存檔案

範例

http://api.polyv.net/live/v3/channel/stream/add-disk-videos

表單參數：

vids=1b448be32389b93ea8be08bf0d257043_1&appId=frlr1zazn3&sign=2A861BD280299A4D7E6FF556C77C88D2&channelId=2149710&timestamp=1621843071824&startTimes=1616557881536

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或者500時，輔助描述錯誤原因
data	String	成功或失敗都返回空字串

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 设置伪直播
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testAddDiskVideos() 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/stream/add-disk-videos";
    String channelId = "2149710";
    String vids = "1b448be32389b93ea8be08bf0d257043_1";
    String startTimes = "1615356953000";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("vids", vids);
    requestMap.put("startTimes", startTimes);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试设置伪直播，返回值：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

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

異常範例

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