更新播放器Logo資訊
更新時間:2025-02-20 19:09:11
介面描述
更新一个播放器的logo设置信息
介面URL
http://api.polyv.net/v2/player/update-logo
請求方式
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": ""
}
