修改频道回放设置

单独修改回放开关可使用旧版接口，接口地址修改频道回放开关

接口描述

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：点播列表
videoId	false	String	直播系统中视频id【可通过查询视频库列表获取】，如：73801f70c8， 注：不是指的点播vid
sectionEnabled	false	String	章节开关 Y：开启 N：关闭
chatPlaybackEnabled	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	Long	定时回放：自定义时间,crontabType为custom自定义时生效

示例

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": ""
}