Modify the Default Video of a Video Library

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

Interface Description

1、将回放列表中的某个视频设置为默认回放视频
2、接口URL中的{channelId}为频道号
3、接口支持https协议

Interface URL

http://api.polyv.net/live/v2/channel/recordFile/{channelId}/playback/set-Default

Online API Call

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls have frequency limits. See details
Only one default playback video can be set per channel.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details: Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 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 saved or used directly on the client side. All APIs must be relayed through the customer's own server to call the POLYV server for response data.` See details: Signature Generation Rules
videoId	true	String	Video ID in the live streaming system. videoId can be obtained via Query Video Library List
listType	false	String	Video list type. Default is vod for normal live streaming scenarios, and playback for three-screen scenarios. playback: Playback list vod: On-demand list

Example

http://api.polyv.net/live/v2/channel/recordFile/2139283/playback/set-Default

Form Parameters:

appId=frlr1zazn3&sign=1F5F72A96A084766957D607641389C9C&videoId=73801f70c8&listType=playback&timestamp=1621841600411

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. See details: Global Error Description
status	String	Response status text
message	String	Response description. When code is 400 or 500, it provides auxiliary error reason description
data	String	Returns "success" on successful request, returns empty on failure

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. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

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

private static final Logger log = LoggerFactory.getLogger(ChannelPlayBackTest.class);
/**
 * 设置视频库列表的默认视频
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testSetRecordDefault() 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/v2/channel/recordFile/%s/playback/set-Default";
    String channelId = "2139283";
    String videoId = "73801f70c8";
    String listType = "playback";
    
    url= String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("videoId", videoId);
    requestMap.put("listType", listType);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试设置视频库列表的默认视频，返回值：{}", response);
    //do somethings
    
}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

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

Error Example

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

Live Streaming Server API