保利威文档中心

帮助中心

更新播放器logo信息

更新时间:2025-02-20 19:09:11

接口描述

更新一个播放器的logo设置信息

接口URL

http://api.polyv.net/v2/player/update-logo

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看

请求参数描述

参数名 必选 类型 说明
userid true String 账号id
ptime true Long 当前时间的毫秒级时间戳,3分钟内有效
sign true String 签名,为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则
playerId true String 播放器id
logoImageFile false File logo图片文件,大小不超过5MB
支持的文件类型:jpg, jpeg, png, gif
logoLinkUrl false String logo点击跳转地址
logoOpacity false String logo不透明度,0~100,必须为10的倍数,例如0、10、20等
logoDisplayLocation false String logo显示位置
0: 不显示
1: 左上角
2: 右上角
3: 左下角
4:右下角

示例

http://api.polyv.net/v2/player/update-logo?userid=abcde12345sign=F809B946258A112A78627A832B1F6A7D&ptime=1617845463779&playerId=xxx&logoOpacity=100&logoDisplayLocation=1&logoLinkUrl=xxx

响应参数描述

参数名 类型 说明
code Integer 响应状态码,200为成功返回,非200为失败【详见全局错误说明
status String 响应状态文本信息
message String 响应描述信息,当code为400或者500的时候,辅助描述错误原因
data Object 响应成功时返回更新后的播放器信息【详见data字段说明】,响应失败时返回空

data字段说明

字段 类型 说明
playerId String 播放器id,例如"1b448be323"
playerName String 播放器名称
isDefault Integer 是否是默认播放器,1:是,0:否
updateTime String 最后更新时间,例如 "2025-02-18 14:51:36"
skin Object 播放器的皮肤设置信息,详见skin字段说明
logo Object 播放器的logo设置信息,详见logo字段说明
teaserTrailer Object 播放器的片头片尾设置信息,详见teaserTrailer字段说明

skin字段说明

字段 类型 说明
skinTheme String 皮肤主题
skin_blue: 简雅黑
skin_gold: 高贵金
skin_green: 清新绿
skin_red: 活力红
skinColor String 皮肤颜色,例如 "#03a9f4"
skinColorApplyType String 皮肤颜色应用类型
panel: 面板
control: 控制栏
skinControlLocation String 控制栏位置
0: 不显示
1: 视频内
2: 视频外

logo字段说明

字段 类型 说明
logoImageUrl String logo图片地址
logoLinkUrl String logo点击跳转地址
logoOpacity Integer logo不透明度,0~100
logoDisplayLocation Integer logo显示位置
0: 不显示
1: 左上角
2: 右上角
3: 左下角
4:右下角

teaserTrailer字段说明

字段 类型 说明
teaserShow Integer 是否显示片头,1:显示,0:不显示
teaserMediaUrl String 片头视频或图片地址
teaserPlayTime Integer 片头播放时长(秒)
trailerShow Integer 是否显示片尾,1:显示,0:不显示
trailerMediaUrl String 片尾视频或图片地址
trailerPlayTime Integer 片尾播放时长(秒)

Java请求示例

快速接入基础代码请下载相关依赖源码点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。

强烈建议您使用点播Java SDK完成API的功能对接,点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(VodVideoPlayerTest.class);

/**
 * 查询播放器列表
 */
@Test
public void testPlayerUpdateLogo() throws Exception, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String secretKey = "xxx";
        String userid = "xxx";
        String ptime = String.valueOf(System.currentTimeMillis());
        String url = "http://api.polyv.net/v2/player/update-logo";

        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("userid", userid);
        requestMap.put("ptime", ptime);
        requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
        
        requestMap.put("playerId", "xxx");
        requestMap.put("logoOpacity", "100");
        requestMap.put("logoDisplayLocation", "1");
        requestMap.put("logoLinkUrl", "xxx");
    
        Map<String,File> fileMap = new HashMap<>();
        fileMap.put("logoImageFile",new File("abc.jpg"));
    
        String response = HttpUtil.postFile(url, requestMap, fileMap, Constant.UTF8);
        log.debug("测试更新播放器logo,{}", response);
        //do something
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": {
        "playerId": "abcde12345",
        "playerName": "默认播放器",
        "isDefault": 1,
        "updateTime": "2025-02-18 17:10:39",
        "skin": {
            "skinTheme": "skin_39",
            "skinColor": "#d1d1d1",
            "skinColorApplyType": "",
            "skinControlLocation": 2
        },
        "logo": {
            "logoImageUrl": "https://img.videocc.netxxx.jpg",
            "logoLinkUrl": "http://www.polyv.net",
            "logoOpacity": 100,
            "logoDisplayLocation": 1
        },
        "teaserTrailer": {
            "teaserShow": 0,
            "teaserMediaUrl": "",
            "teaserPlayTime": 0,
            "trailerShow": 0,
            "trailerMediaUrl": "",
            "trailerPlayTime": 0
        }
    }
}

异常示例

{
    "code": 400,
    "status": "error",
    "message": "the sign is not right.",
    "data": ""
}
联系客服,在线咨询