Modify Video Preview Duration

Updated: 2025-01-14 15:49:50

API Description

1、通过视频id设置视频的播放预览时长
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

API URL

http://api.polyv.net/v2/video/{userid}/set-preview-duration

<a href="/req.html?api=http://api.polyv.net/v2/video/{userid}/set-preview-duration"" target="_blank">Online API Call

Request Method

POST

API Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
ptime	true	Long	Current time in milliseconds, valid within 3 minutes
sign	true	String	Signature, a 40-character uppercase SHA1 value. `The secretkey 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 for response data.` See signature generation rules
vid	true	String	Video ID
duration	true	Integer	Preview duration (in seconds), e.g., 20

Example

http://api.polyv.net/v2/video/1b448be323/set-preview-duration

Form parameters:

vid=1b448be3233579036dbaecef0fe49f30_1&duration=5&sign=93679FB56C56A3F75BDAA9E704B63583F7FB49D5&ptime=1617159285478

Response Parameter Description

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

Java Request Example

For quick integration of basic code, please 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 VodSignUtil.java in the downloaded file.

It is strongly recommended to use the VOD Java SDK for API integration. The VOD 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(VodVideoManageManagementTest.class);
/**
 *修改视频预览时长
 */
@Test
public void testSettingPreviewDuration() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userid = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/v2/video/"+userid+"/set-preview-duration";
    String vid="1b448be3233579036dbaecef0fe49f30_1";
    String duration=String.valueOf(5);

    //调用参数
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("vid", vid);
    requestMap.put("duration", duration);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.debug("测试修改视频预览时长,{}", response);
    //do somethings
}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code":200,
    "status":"success",
    "message":"success",
    "data":"设置成功."
}

Error Example

{
  code: 400,
  status: "success",
  message: "success",
  data: "修改的视频不存在."
}