保利威文档中心

幫助中心

修改頻道回放設定

更新時間:2026-03-05 17:25:45

單獨修改回放開關可使用舊版介面,介面位址修改頻道回放開關

介面描述

1、修改频道回放设置
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/playback/set-setting

線上API呼叫

請求方式

POST

介面約束

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

2、當請求參數type為single時,origin可設定為record、playback或vod,當origin設定為playback或vod時還需要設定videoId;

3、當請求參數type為list時,origin可以設定為playback以及vod;

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 當前13位毫秒級時間戳,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器轉發呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
channelId true String 頻道號
globalSettingEnabled false String 是否使用通用設定,預設為N(新版後台頻道設定不生效)
Y:是
N:否
crontabType false String 定時回放類型:timedOpen-定時開啟,timedClosed-定時關閉,period-時間段內開啟,custom-自訂,disable-關閉
startTime false Long 放開回放的時間,13位時間戳
endTime false Long 關閉回放的時間,13位時間戳
playbackEnabled false String 回放開關狀態,預設為N
Y:開啟
N:關閉
type false String 回放方式
single:單一回放
list:列表回放
origin false String 回放來源
record:暫存
playback:回放列表
vod:點播列表
material:素材庫
videoId false String 直播系統中影片id【可透過查詢影片庫列表取得】,如:73801f70c8,
註:不是指點播vid
sectionEnabled false String 章節開關
Y:開啟
N:關閉
playbackMultiplierEnabled false String 倍數播放開關
Y:開啟
N:關閉
playbackProgressBarEnabled false String 進度條開關
Y:開啟
N:關閉
playbackProgressBarOperationType false String 進度條操作方式
drag 拖曳,prohibitDrag 禁止拖曳,dragHistoryOnly 只能拖曳已觀看內容
showPlayButtonEnabled false String 顯示播放按鈕開關
Y:開啟
N:關閉
productPlaybackEnabled false String 商品庫開關
Y:開啟
N:關閉
customOpenDuration false Long 定時回放:自訂時間,crontabType為custom自訂時生效
chatPlaybackEnabled false String 聊天互動重現開關
Y:開啟
N:關閉
productPlaybackEnabled false String 商品庫互動重現開關
Y:開啟
N:關閉
questionnairePlaybackEnabled false String 問卷互動重現開關
Y:開啟
N:關閉
qaPlaybackEnabled false String 答題卡互動重現開關
Y:開啟
N:關閉
cardPushPlaybackEnabled false String 卡片推播互動重現開關
Y:開啟
N:關閉
checkInPlaybackEnabled false String 簽到互動重現開關
Y:開啟
N:關閉

範例

http://api.polyv.net/live/v3/channel/playback/set-setting

表單參數:

appId=frlr1zazn3&origin=playback&sign=01556AABE64ED5C285FF5378392FCD8C&globalSettingEnabled=N&videoId=73801f70c8&type=list&channelId=2191532&timestamp=1621840770330&playbackEnabled=Y

回應參數描述

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

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 testSetRecordSetting() 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/playback/set-setting";
    String channelId = "2139283";
    String globalSettingEnabled = "N";
    String playbackEnabled = "Y";
    String type = "single";
    String origin = "playback";
    String videoId = "73801f70c8";
    String playbackMultiplierEnabled = "Y";
    String playbackProgressBarEnabled = "Y";
    String playbackProgressBarOperationType = "drag";
    String showPlayButtonEnabled = "Y";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("globalSettingEnabled", globalSettingEnabled);
    requestMap.put("playbackEnabled", playbackEnabled);
    requestMap.put("type", type);
    requestMap.put("origin", origin);
    requestMap.put("videoId", videoId);
    requestMap.put("playbackMultiplierEnabled", playbackMultiplierEnabled);
    requestMap.put("playbackProgressBarEnabled", playbackProgressBarEnabled);
    requestMap.put("playbackProgressBarOperationType", playbackProgressBarOperationType);
    requestMap.put("showPlayButtonEnabled", showPlayButtonEnabled);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改频道回放设置,返回值:{}", response);
    //do somethings
    
}

回應範例

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

成功範例

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

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服,在线咨询