Modify Channel Streaming Method

Updated: 2023-11-23 17:39:12

API Description

1、修改频道的直播推流方式
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/stream/update

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
Modifying the live streaming method is not allowed during an ongoing live broadcast.

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 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 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]
streamType	true	String	Live streaming method client: Client push disk: Simulated live audio: Audio live pull: Pull stream live
pullUrl	false	String	Pull stream URL
pullStreamTime	false	Long	Start time for pulling the stream. Can be passed when streamType is pull. Example: 1700558940000, indicates pulling from pullUrl at 2023-11-21 17:29:00
channelId	true	String	Channel ID

Example

http://api.polyv.net/live/v3/channel/stream/update

Form Parameters:

streamType=client&appId=frlr1zazn3&sign=46D2EA10829A84BDF52DAF2ABA0C5507&channelId=2191541&timestamp=1621840828944

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 auxiliary error reason
data	String	Returns an empty string for both success and failure

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download 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 encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 修改直播推流方式
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateStreamType() 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/stream/update";
    String channelId = "2191541";
    String streamType = "client";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("streamType", streamType);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改直播推流方式，返回值：{}", response);
    //do somethings
    
}

Response Example

See Global Error Description for system-wide error descriptions.

Success Example

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

Error Example

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