修改默认模板回放设置
接口描述
1、修改回放默认模板设置
2、接口支持https协议
接口URL
http://api.polyv.net/live/v4/user/template/playback-setting/update
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
2、当请求参数type为single时,origin可设置为record;
3、当请求参数type为list时,origin可以设置为playback或vod;
请求参数描述
请求体参数描述
playbackEnabled
false
String
回放开关 Y:开启 N:关闭
type
false
String
观看页回放方式 single:单个视频 list:列表回放
origin
false
String
回放视频来源 record:暂存 playback:回放列表 vod:点播列表
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:关闭
示例
http://api.polyv.net/live/v4/user/template/playback-setting/update?appId=frlr1zazn3&sign=9C73C7471CF969AD8AC042221C89551D×tamp=1677167340447
请求体json参数:
{
"sectionEnabled": "N",
"chatPlaybackEnabled": "Y",
"origin": "vod",
"type": "list",
"playbackEnabled": "N",
"playbackMultiplierEnabled": "Y",
"playbackProgressBarEnabled": "N",
"playbackProgressBarOperationType": "drag",
"showPlayButtonEnabled": "N"
}
响应参数描述
code
Integer
状态码,与 http 状态码相同,用于确定基本的响应状态
data
Object
成功响应的数据
requestId
String
请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩
status
String
响应结果,由业务决定,成功返回success,失败返回error
success
Boolean
是否成功响应
Error参数描述
code
Integer
错误代码,用于确定具体的错误原因
desc
String
错误描述,与 error.code 对应
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 修改回放默认模板设置
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void updatePlaybackSettingTemplateTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v4/user/template/playback-setting/update";
String chatPlaybackEnabled = "Y";
String origin = "vod";
String playbackEnabled = "N";
String sectionEnabled = "N";
String type = "list";
String playbackMultiplierEnabled = "N";
String playbackProgressBarEnabled = "N";
String playbackProgressBarOperationType = "drag";
String showPlayButtonEnabled = "N";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
Map<String, Object> jsonMap = new HashMap<>();
jsonMap.put("chatPlaybackEnabled", chatPlaybackEnabled);
jsonMap.put("origin", origin);
jsonMap.put("playbackEnabled", playbackEnabled);
jsonMap.put("sectionEnabled", sectionEnabled);
jsonMap.put("type", type);
jsonMap.put("playbackMultiplierEnabled", playbackMultiplierEnabled);
jsonMap.put("playbackProgressBarEnabled", playbackProgressBarEnabled);
jsonMap.put("playbackProgressBarOperationType", playbackProgressBarOperationType);
jsonMap.put("showPlayButtonEnabled", showPlayButtonEnabled);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
url = HttpUtil.appendUrl(url, requestMap);
String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
log.info("测试修改回放默认模板设置成功:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "a5e9b1d15f544d7a9db6f038156a851d.71.16771673423081591",
"data": null,
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
Last updated
Was this helpful?