Modify the Logo Displayed in the Channel Player

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

Interface Description

1、管理系统修改播放器logo图片：频道管理-播放器管理-播放器-logo设置
2、接口URL中的{channelId}为频道号
3、接口支持https协议

Interface URL

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

Online API Call

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 details: 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 saved 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 details: Signature Generation Rules
logoImage	true	String	Logo image URL. Recommended sizes: rectangle 140x50 or square 50x50
logoOpacity	true	Float	Logo opacity, value range (0,1], i.e., greater than 0 and less than or equal to 1 1: Fully opaque 0: Fully transparent
logoPosition	true	String	Logo display position tl: Top left tr: Top right bl: Bottom left br: Bottom right
logoHref	false	String	Click-through link for the logo image

Example

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

Form Parameters:

logoHref=https%3A%2F%2Fbaidu.com&logoImage=http%3A%2F%2Fliveimages.videocc.net%2Fuploadimage%2F20210318%2Fchat_img_1b448be323_16160330722736.jpeg&logoPosition=bl&appId=frlr1zazn3&sign=24249735B34176B69FABB951DCEA36CF&timestamp=1621842332739&logoOpacity=0.1

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See details: Global Error Description
status	String	Response status text
message	String	Response description message, assists in describing the error reason when code is 400 or 500
data	String	Returns true on successful request, returns an empty string on failure

Java Request Example

For quick integration of the 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 to implement API functionality. 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(PlayerTest.class);
/**
 * 修改频道播放器中显示的logo
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testUpdateLogo() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v2/channels/%s/update";
    String channelId = "2191532";
    String logoImage = "http://liveimages.videocc.net/uploadimage/20210318/chat_img_1b448be323_16160330722736.jpeg";
    String logoOpacity = "0.1";
    String logoPosition = "bl";
    String logoHref = "https://baidu.com";
    
    url = String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("logoImage", logoImage);
    requestMap.put("logoOpacity", logoOpacity);
    requestMap.put("logoPosition", logoPosition);
    requestMap.put("logoHref", logoHref);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改频道播放器中显示的logo，返回值：{}", response);
    //do somethings
    
}

Response Example

For system global error descriptions, see Global Error Description

Success Example

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

Error Example

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