設定頻道內容保護(防錄屏資訊)
更新時間:2026-01-28 18:44:46
舊版介面位址跑馬燈設定(舊版)
介面描述
1、通过频道号,设置频道内容保护(防录屏信息)
2、接口支持https协议
介面URL
http://api.polyv.net/live/v3/channel/anti/record/setting
請求方式
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 | 頻道號 |
| enable | false | String | 內容保護開關,預設為開啟 Y:開啟 N:關閉 |
| antiRecordType | true | String | 內容保護方式 marquee:跑馬燈 watermark:浮水印 |
| modelType | true | String | 內容保護類型,浮水印方式時設定自訂URL無效 fixed:固定值 nickname:登入使用者名稱 diyurl:URL自訂跑馬燈 |
| content | true | String | 固定值時為設定內容 URL自訂設定時為網址,需要攜帶 http:// 或 https:// 【自訂跑馬燈參考文件】 內容保護類型為登入使用者名稱時可不傳 |
| fontSize | true | String | 字型大小 內容保護方式為跑馬燈時:設定數值,範圍1-256 內容保護方式為浮水印時: small:小 middle:中 large:大 |
| opacity | false | Integer | 透明度,不傳預設為80,範圍0-100 |
| fontColor | false | String | 跑馬燈字型顏色,色值,例如:#FFFFFF |
| autoZoomEnabled | false | String | 跑馬燈自訂縮放,預設為關閉 Y:開啟 N:關閉 |
| doubleEnabled | false | String | 雙跑馬燈,預設為關閉 Y:開啟 N:關閉 |
| showMode | false | String | 跑馬燈顯示方式,預設為滾動 roll:滾動 flicker:閃爍 |
範例
http://api.polyv.net/live/v3/channel/anti/record/setting
表單參數:
doubleEnabled=N&autoZoomEnabled=Y&sign=5C3360AE6C5ED07D973D7E75DAF2646B&showMode=flicker&modelType=fixed&content=test&antiRecordType=marquee&appId=frlr1zazn3&fontSize=20&opacity=80&channelId=2453970&fontColor=%23FFF×tamp=1629967807901
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或者500的時候,輔助描述錯誤原因 |
| data | String | 請求失敗時為空,請求成功時為"SUCCESS" |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(MarqueeTest.class);
/**
* 设置频道内容保护(防录屏信息)
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void marqueeSettingTest() 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/anti/record/setting";
String channelId = "2453970";
String antiRecordType = "marquee";
String modelType = "fixed";
String content = "test";
String opacity = "80";
String fontSize = "20";
String fontColor = "#FFF";
String autoZoomEnabled = "Y";
String doubleEnabled = "N";
String showMode = "flicker";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("antiRecordType", antiRecordType);
requestMap.put("modelType", modelType);
requestMap.put("content", content);
requestMap.put("opacity", opacity);
requestMap.put("fontSize", fontSize);
requestMap.put("fontColor", fontColor);
requestMap.put("autoZoomEnabled", autoZoomEnabled);
requestMap.put("doubleEnabled", doubleEnabled);
requestMap.put("showMode", showMode);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.postFormBody(url, requestMap);
log.info("测试设置频道内容保护:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"message": "",
"data": "SUCCESS"
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
