Update Channel Remake Courseware Settings

Updated: 2022-09-02 18:08:07

Interface Description

1、更新频道重制课件设置
2、接口支持https协议

Interface URL

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

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls are subject to frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server to obtain response data.` [See Signature Generation Rules]
channelId	true	String	Channel ID
globalSettingEnabled	false	String	Whether to use global settings, Y for Yes, N for No
type	false	Integer	Video layout mode, 0. Triple split screen, 1. Document only
videoRatio	false	Integer	Camera aspect ratio, valid for new remake, default 0, 0 for 16:9, 1 for 4:3
brandImgFile	false	File	Display image, valid for new remake. Size is 480X810 when camera aspect ratio is 16:9, 480X720 when camera aspect ratio is 4:3. Supports jpg and png formats
backgroundImgFile	false	File	Background image, valid for old remake. Size is 1280X720. Supports jpg and png formats

Example

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

Form parameters:

appId=fso8gzbxlr&timestamp=1628074098000&channelId=1947328&globalSettingEnabled=N&type=0&videoRatio=0&sign=FB1357F4199FF7838A158D6BE25791C5

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure [See Global Error Description]
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	Object	Response data
data.result	boolean	Processing result, true for success

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 修改回调设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateSetting() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url="https://api.polyv.net/live/v3/channel/pptRecord/setting";
    String channelId="1947328";
    String globalSettingEnabled = "N";
    String type = "0";
    String videoRatio = "0";

    //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("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("更新频道重制课件设置，返回值：{}", response);
    //do somethings

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

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

Error Example

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

Live Streaming Server API