修改頻道播放器中顯示的 Logo

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

介面描述

1、管理系统修改播放器logo图片：频道管理-播放器管理-播放器-logo设置
2、接口URL中的{channelId}为频道号
3、接口支持https协议

介面 URL

http://api.polyv.net/live/v2/channels/{channelId}/update

線上 API 呼叫

請求方式

POST

介面限制

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

請求參數說明

參數名	必選	類型	說明
appId	true	String	帳號 appId【詳見取得金鑰】
timestamp	true	Long	目前 13 位毫秒級時間戳記，3 分鐘內有效
sign	true	String	簽名，為 32 位大寫的 MD5 值，`產生簽名的 appSecret 金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有 API 都必須透過客戶自己的伺服器中轉呼叫 POLYV 伺服器取得回應資料`【詳見簽名產生規則】
logoImage	true	String	Logo 圖片網址，建議大小為：長方形 140x50 或正方形 50x50
logoOpacity	true	Float	Logo 不透明度，取值範圍為 (0,1]，即大於 0 且小於等於 1 1：表示完全不透明 0：表示完全透明
logoPosition	true	String	Logo 顯示位置 tl：左上角 tr：右上角 bl：左下角 br：右下角
logoHref	false	String	Logo 圖片點擊後跳轉連結

範例

http://api.polyv.net/live/v2/channels/2191532/update

表單參數：

logoHref=https%3A%2F%2Fbaidu.com&logoImage=http%3A%2F%2Fliveimages.videocc.net%2Fuploadimage%2F20210318%2Fchat_img_1b448be323_16160330722736.jpeg&logoPosition=bl&appId=frlr1zazn3&sign=24249735B34176B69FABB951DCEA36CF&timestamp=1621842332739&logoOpacity=0.1

回應參數說明

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

Java 請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(PlayerTest.class);
/**
 * 修改频道播放器中显示的logo
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateLogo() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v2/channels/%s/update";
    String channelId = "2191532";
    String logoImage = "http://liveimages.videocc.net/uploadimage/20210318/chat_img_1b448be323_16160330722736.jpeg";
    String logoOpacity = "0.1";
    String logoPosition = "bl";
    String logoHref = "https://baidu.com";
    
    url = String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("logoImage", logoImage);
    requestMap.put("logoOpacity", logoOpacity);
    requestMap.put("logoPosition", logoPosition);
    requestMap.put("logoHref", logoHref);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改频道播放器中显示的logo，返回值：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

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

異常範例

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