重制课件参数设置
更新时间：2023-06-09 09:08:29
接口URL
https://api.polyv.net/live/v3/channel/pptRecord/setting
接口说明
1、接口用于设置重制课件参数
2、接口支持https
支持格式
JSON
请求方式
POST
请求数限制
TRUE
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | 从API设置中获取，在直播系统登记的appId |
| timestamp | 是 | long | 13位当前毫秒级时间戳 |
| sign | 是 | String | 签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | 是 | int | 频道号 |
| globalSettingEnabled | 是 | string | 是否使用通用设置，Y是，N否 |
| type | 是 | int | 视频布局方式，0.三分屏、1.纯文档 |
| videoRatio | 否 | int | 摄像头画面比例，新版重制有效，默认0，0表示16:9、1表示4:3 |
| brandImgFile | 否 | File | 展示图片，新版重制有效，摄像头画面比例为16:9时尺寸为480X810，摄像头画面比例为4:3时尺寸为480X720,支持jpg和png格式 |
| backgroundImgFile | 否 | File | 背景图片，旧版重制有效，尺寸为1280X720,支持jpg和png格式 |
响应成功JSON示例：
{
"code": 200,
"status": "success",
"message": "",
"data": {
"result": true
}
}
响应字段说明
| 参数名 | 说明 |
|---|---|
| code | 状态码,成功为200，签名失败为403，参数错误为400，服务端错误为500 |
| status | 成功为success,错误时为error |
| message | 成功为""，错误时为错误描述信息 |
| data | 响应数据 |
| data.result | 处理结果, true成功 |
响应失败JSON示例：
参数错误
{
"code": 400,
"status": "error",
"message": "param validate error",
"data": ""
}
未输入appId
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
appId不正确
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
时间戳错误
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
签名错误
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
非法频道号
{
"code": 403,
"status": "error",
"message": "illegal channel id: %s",
"data": ""
}
java请求示例
public void testAddRecordTask() {
String url = "https://api.polyv.net/live/v3/channel/pptRecord/setting";
// appId和加密串
String appId = "xxxxxxx";
String appSecret = "xxxxxxxxxxxxxxxxxx";
int channelId = 123;
Map<String, String> params = new HashMap<>();
params.put("channelId", String.valueOf(channelId));
params.put("globalSettingEnabled", "N");
params.put("type", "0");
params.put("videoRatio", "0");
// 调用Polyv的工具类方法设置sign
PolyvTool.setLiveSign(params, appId, appSecret);
String content = HttpClientUtil.getInstance()
.sendHttpPost(url, params);
System.out.println(content);
}
