# 设置频道重制课件配置信息

### 接口描述

```
1、设置频道重制课件配置信息
2、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v3/channel/pptRecord/setting
```

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v3/channel/pptRecord/setting/README.md)

### 请求方式

```
POST
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)

2、画中画视频布局方式需要账号开通生效

### 请求参数描述

| 参数名                  | 必选    | 类型      | 说明                                                                                                                                                                                                        |
| -------------------- | ----- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId                | true  | String  | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp            | true  | Long    | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign                 | true  | String  | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| channelId            | true  | String  | 频道号                                                                                                                                                                                                       |
| globalSettingEnabled | true  | String  | <p>是否使用通用设置<br>Y：是<br>N：否</p>                                                                                                                                                                             |
| type                 | true  | Integer | <p>视频布局方式<br>0：三分屏<br>1：纯文档<br>2：画中画</p>                                                                                                                                                                  |
| videoRatio           | false | Integer | <p>摄像头画面比例，新版重制有效<br>0：画面比例16:9<br>1：画面比例4:3</p>                                                                                                                                                          |
| brandImgFile         | false | File    | <p>展示图片，新版重制有效，支持jpg和png格式<br>摄像头画面比例为16:9时尺寸为480X810<br>摄像头画面比例为4:3时尺寸为480X720</p>                                                                                                                       |
| backgroundImgFile    | false | File    | 背景图片，旧版重制有效，尺寸为1280X720，支持jpg和png格式                                                                                                                                                                       |

### 示例

```requestUrl
http://api.polyv.net/live/v3/channel/pptRecord/setting
```

表单参数：

```requestUrl
videoRatio=0&brandImgFile=&appId=frlr1zazn3&sign=10546F6DDAE7B918E0124A53FA899E99&backgroundImgFile=http%3A%2F%2Fliveimages.videocc.net%2Fuploadimage%2F20201126%2FremakeCoursewareBg_1606386346554_8190198.jpg&globalSettingEnabled=N&type=1&channelId=2453970&timestamp=1629710058592
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                                                                |
| ------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| code    | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)】                                                  |
| status  | String  | 响应状态文本信息                                                                                                                                                                          |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                                                                                 |
| data    | Object  | 响应成功时返回重制课件结果集【详见[data字段描述](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/channel/operate/ppt_setting.md?id=data%E5%AD%97%E6%AE%B5%E6%8F%8F%E8%BF%B0)】 |

#### data字段描述

| 参数名    | 类型      | 说明        |
| ------ | ------- | --------- |
| result | Boolean | 处理结果，是否成功 |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 设置频道重制课件配置信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void pptSettingTest() 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/pptRecord/setting";
    String channelId = "2453970";
    String globalSettingEnabled = "N";
    String type = "1";
    String videoRatio = "0";
    String brandImgFile = "http://liveimages.videocc.net/uploadimage/20201126/remakeCoursewareBg_1606386346554_8190198.jpg";
    String backgroundImgFile = "http://liveimages.videocc.net/uploadimage/20201126/remakeCoursewareBg_1606386346554_8190198.jpg";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("globalSettingEnabled", globalSettingEnabled);
    requestMap.put("type", type);
    requestMap.put("videoRatio", videoRatio);
    requestMap.put("brandImgFile", new File(brandImgFile));
    requestMap.put("backgroundImgFile", new File(backgroundImgFile));
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试设置频道重制课件配置信息：{}", response);
    //do somethings
    
}
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

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

异常示例

```json
{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
```