修改頻道推流方式

更新時間：2023-11-23 17:39:12

介面描述

1、修改频道的直播推流方式
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/stream/update

線上API呼叫

請求方式

POST

介面限制

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

2、直播過程中不允許修改直播推流方式

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
streamType	true	String	直播推流方式 client：用戶端推流 disk：偽直播 audio：音訊直播 pull：拉流直播
pullUrl	false	String	拉流url
pullStreamTime	false	Long	開始拉流時間，streamType為pull時可傳。如：1700558940000，表示在2023-11-21 17:29:00向pullUrl進行拉流
channelId	true	String	頻道號

範例

http://api.polyv.net/live/v3/channel/stream/update

表單參數：

streamType=client&appId=frlr1zazn3&sign=46D2EA10829A84BDF52DAF2ABA0C5507&channelId=2191541&timestamp=1621840828944

回應參數描述

參數名	類型	說明
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 testUpdateStreamType() 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/update";
    String channelId = "2191541";
    String streamType = "client";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("streamType", streamType);
    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": ""
}