Modify Warm-up Video

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

API Description

1、通过频道号，修改播放器的暖场视频
2、接口支持https协议
3、接口URL中的{channelId}为"频道号"
4、暖场视频和暖场图片是处于非直播状态时，播放器显示的画面，两者在同一时间只能显示一种，以最晚设置者为准
5、若想删除暖场画面，则将coverImage或warmUpFlv的值设为"http://"

API URL

http://api.polyv.net/live/v2/channels/{channelId}/update

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency limits. See details

Request Parameters

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
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 your own server to relay requests to the POLYV server for response data.` See signature generation rules
warmUpFlv	true	String	Warm-up video URL. Mobile devices do not support FLV video files; MP4 video files are recommended.

Example

http://api.polyv.net/live/v2/channels/2202970/update

Form parameters:

appId=frlr1zazn3&sign=37BDDEAD6ABE1DF80A6AA4D1494396B7&warmUpFlv=http%3A%2F%2Fmpv.videocc.net%2Fd212a37499%2Fb%2Fd212a37499d8190f063bcfc5642fa82b_2.mp4&timestamp=1621842518344

Response Parameters

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success; non-200 indicates failure. See global error descriptions
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides additional error details.
data	String	Empty on failure; `true` on success.

Java Request Example

For quick integration of the base code, download the relevant dependency source code. Click to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the download file.

It is strongly recommended to use the Live Java SDK for API 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(ChannelWarmUpTest.class);

/**
 * 修改暖场视频
 * @throws IOException
 */
@Test
public void testUpdateWarmUpVideo() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String channelId = "2202970";
        String url = "http://api.polyv.net/live/v2/channels/"+channelId+"/update";
        String warmUpFlv = "http://mpv.videocc.net/d212a37499/b/d212a37499d8190f063bcfc5642fa82b_2.mp4";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("warmUpFlv",warmUpFlv);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.info("测试修改暖场视频接口返回值：{}",response);

}

Response Example

For global system error descriptions, see Global Error Descriptions

Success example

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

Error example

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