playerService
1、設定頻道的暖場設定開關
描述
用于设置频道的暖场开关
接口地址(仅做说明使用):https://api.polyv.net/live/v3/channel/set-warmup-enabled
呼叫限制
1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testSetPlayerWarmupEnable() throws Exception, NoSuchAlgorithmException, URISyntaxException {
LiveSetWarmupEnableRequest liveSetWarmupEnableRequest = new LiveSetWarmupEnableRequest();
Boolean liveSetWarmupEnableResponse = null;
try {
String channelId = super.createChannel();
liveSetWarmupEnableRequest.setChannelId(channelId).setWarmUpEnabled(LiveConstant.Flag.YES.getFlag());
liveSetWarmupEnableResponse = new LivePlayerServiceImpl().setPlayerWarmupEnable(liveSetWarmupEnableRequest);
Assert.assertNotNull(liveSetWarmupEnableResponse);
if (liveSetWarmupEnableResponse != null) {
//to do something ......
log.debug("测试设置频道的暖场设置开关成功{}", JSON.toJSONString(liveSetWarmupEnableResponse));
}
} catch (PloyvSdkException e) {
//参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
log.error(e.getMessage(), e);
// 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
throw e;
} catch (Exception e) {
log.error("SDK调用异常", e);
throw e;
}
}
單元測試說明
1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]
請求入參描述
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| channelId | true | String | 頻道號 |
| warmUpEnabled | true | String | 開關值,Y 或 N,Y 表示開啟,N 表示關閉 |
| appId | false | String | POLYV 使用者 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
| appSecret | false | String | POLYV 使用者 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
回傳物件描述
true 設定成功,false 設定失敗
2、設定播放器暖場圖片
描述
1、修改播放器的暖场图片
2、暖场视频和暖场图片是处于非直播状态时,播放器显示的画面,两者在同一时间只能显示一种,以最晚设置者为准,若想删除暖场画面,则将coverImage或warmUpFlv的值设为"http://"。
接口地址(仅做说明使用):https://api.polyv.net/live/v2/channels/%s/update
呼叫限制
1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testSetPlayerImg() throws Exception, NoSuchAlgorithmException, URISyntaxException {
LiveSetPlayerImgRequest liveSetChatAdminDataRequest = new LiveSetPlayerImgRequest();
Boolean liveSetChatAdminDataResponse = null;
try {
String channelId = super.createChannel();
liveSetChatAdminDataRequest.setChannelId(channelId)
.setCoverImage("https://car3.autoimg.cn/cardfs/product/g25/M08/C7/57" +
"/1024x0_1_q95_autohomecar__ChsEmF8EOK-AB5uaAAfsj_iwPdE906.jpg")
.setCoverHref("http://www.baidu.com");
liveSetChatAdminDataResponse = new LivePlayerServiceImpl().setPlayerImg(liveSetChatAdminDataRequest);
Assert.assertNotNull(liveSetChatAdminDataResponse);
if (liveSetChatAdminDataResponse) {
//to do something ......
log.debug("测试设置播放器暖场图片成功 ");
}
} catch (PloyvSdkException e) {
//参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
log.error(e.getMessage(), e);
// 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
throw e;
} catch (Exception e) {
log.error("SDK调用异常", e);
throw e;
}
}
單元測試說明
1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因:invalid signature. ]
請求參數說明
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| channelId | true | String | 頻道號 |
| coverImage | true | String | 暖場圖片位址,圖片大小建議:800x450,支援PNG、JPEG、GIF格式 |
| coverHref | false | String | 點擊暖場圖片後瀏覽器跳轉位址 |
| appId | false | String | POLYV使用者APP_ID,多帳號呼叫時該參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
| appSecret | false | String | POLYV使用者APP_SECRET,多帳號呼叫時該參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
回傳物件描述
true 設定成功,false 設定失敗
3、設定播放器暖場影片
描述
1、修改播放器的暖场视频
2、暖场视频和暖场图片是处于非直播状态时,播放器显示的画面,两者在同一时间只能显示一种,以最晚设置者为准,若想删除暖场画面,则将coverImage或warmUpFlv的值设为"http://"。
接口地址(仅做说明使用):https://api.polyv.net/live/v2/channels/%s/update
呼叫限制
1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testSetPlayerWarmUpVedio() throws Exception, NoSuchAlgorithmException, URISyntaxException {
LiveSetWarmupVedioRequest liveSetWarmupVedioRequest = new LiveSetWarmupVedioRequest();
Boolean liveSetWarmupVedioResponse = null;
try {
String channelId = super.createChannel();
liveSetWarmupVedioRequest.setChannelId(channelId)
.setWarmUpFlv("http://www.w3school.com.cn/example/html5/mov_bbb.mp4");
// .setWarmUpFlv("http://")//删除视频
liveSetWarmupVedioResponse = new LivePlayerServiceImpl().setPlayerWarmUpVedio(liveSetWarmupVedioRequest);
Assert.assertNotNull(liveSetWarmupVedioResponse);
if (liveSetWarmupVedioResponse != null) {
//to do something ......
log.debug("测试设置播放器暖场视频成功{}", JSON.toJSONString(liveSetWarmupVedioResponse));
}
} catch (PloyvSdkException e) {
//参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
log.error(e.getMessage(), e);
// 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
throw e;
} catch (Exception e) {
log.error("SDK调用异常", e);
throw e;
}
}
單元測試說明
1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤資訊請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因:invalid signature. ]
請求入參說明
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| channelId | true | String | 頻道號 |
| warmUpFlv | true | String | 暖場影片網址(http 網址),行動裝置不支援 FLV 影片檔案,建議使用 MP4 影片檔案 |
| appId | false | String | POLYV 使用者 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
| appSecret | false | String | POLYV 使用者 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
回傳物件描述
true 設定成功,false 設定失敗
4、設定播放器Logo
描述
设置播放器Logo
接口地址(仅做说明使用):https://api.polyv.net/live/v2/channels/%s/update
呼叫限制
1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testSetPlayerLogo() throws Exception, NoSuchAlgorithmException, URISyntaxException {
LiveSetPlayerLogoRequest liveSetPlayerLogoRequest = new LiveSetPlayerLogoRequest();
Boolean liveSetPlayerLogoResponse = null;
try {
String channelId = super.createChannel();
liveSetPlayerLogoRequest.setChannelId(channelId)
.setLogoHref("http://www.baidu.com")
.setLogoPosition(LiveConstant.LogoPosition.BL.getPosition())
.setLogoImage(
"https://c-ssl.duitang.com/uploads/blog/202009/01/20200901155255_e8037.thumb.1000_0.jpg")
.setLogoOpacity(0.32f);
liveSetPlayerLogoResponse = new LivePlayerServiceImpl().setPlayerLogo(liveSetPlayerLogoRequest);
Assert.assertNotNull(liveSetPlayerLogoResponse);
if (liveSetPlayerLogoResponse != null) {
//to do something ......
log.debug("测试设置播放器Logo成功{}", JSON.toJSONString(liveSetPlayerLogoResponse));
}
} catch (PloyvSdkException e) {
//参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
log.error(e.getMessage(), e);
// 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
throw e;
} catch (Exception e) {
log.error("SDK调用异常", e);
throw e;
}
}
單元測試說明
1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤資訊請參閱 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]
請求入參說明
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| channelId | true | String | 頻道號 |
| logoImage | true | String | Logo 圖片網址,建議大小為:長方形 140x50 或正方形 50x50 |
| logoOpacity | true | Float | Logo 透明度,取值範圍為 (0,1],即大於 0 且小於等於 1 |
| logoPosition | true | String | Logo 位置,取值為左上角 (tl)、右上角 (tr)、左下角 (bl)、右下角 (br) |
| logoHref | false | String | Logo 圖片點擊跳轉連結 |
| appId | false | String | POLYV 使用者 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網 -> 登入 -> 直播(開發設定) |
| appSecret | false | String | POLYV 使用者 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網 -> 登入 -> 直播(開發設定) |
回傳物件描述
true 設定成功,false 設定失敗
5、設定播放器片頭廣告
描述
设置某频道播放器的片头广告
接口地址(仅做说明使用):https://api.polyv.net/live/v2/channelAdvert/%s/updateHead
呼叫限制
1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
2、設定片頭廣告不一定會顯示,需呼叫「設定頻道預設項開關」將廣告通用設定開關關閉
單元測試
@Test
public void testSetPlayerHeaderAdvert() throws Exception, NoSuchAlgorithmException, URISyntaxException {
LiveSetPlayerHeaderAdvertRequest liveSetPlayerHeaderAdvertRequest = new LiveSetPlayerHeaderAdvertRequest();
Boolean liveSetPlayerHeaderAdvertResponse = null;
try {
String channelId = super.createChannel();
liveSetPlayerHeaderAdvertRequest.setChannelId(channelId)
.setEnabled(LiveConstant.Flag.YES.getFlag())
.setHeadAdvertDuration(5)
.setHeadAdvertHeight(100)
.setHeadAdvertType(LiveConstant.HeadAdvertType.IMAGE.getDesc())
.setHeadAdvertWidth(100)
.setHeadAdvertHref("http://www.baidu.com")
.setHeadAdvertMediaUrl("https://car3.autoimg.cn/cardfs/product/g25/M08/C7/57" +
"/1024x0_1_q95_autohomecar__ChsEmF8EOK-AB5uaAAfsj_iwPdE906.jpg");
liveSetPlayerHeaderAdvertResponse = new LivePlayerServiceImpl().setPlayerHeaderAdvert(
liveSetPlayerHeaderAdvertRequest);
Assert.assertNotNull(liveSetPlayerHeaderAdvertResponse);
if (liveSetPlayerHeaderAdvertResponse != null) {
//to do something ......
log.debug("测试设设置播放器片头广告成功{}", JSON.toJSONString(liveSetPlayerHeaderAdvertResponse));
}
} catch (PloyvSdkException e) {
//参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
log.error(e.getMessage(), e);
// 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
throw e;
} catch (Exception e) {
log.error("SDK调用异常", e);
throw e;
}
}
單元測試說明
1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]
請求參數說明
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| channelId | true | String | 頻道號 |
| enabled | false | String | 設定播放器片頭廣告開關: Y-開啟,N-關閉 |
| headAdvertType | false | String | 廣告類型,NONE-無廣告,IMAGE-圖片廣告,FLV-影片廣告 |
| headAdvertMediaUrl | false | String | 廣告位址 |
| headAdvertHref | false | String | 廣告跳轉位址 |
| headAdvertDuration | false | Integer | 廣告時長,單位:秒 |
| headAdvertWidth | false | Integer | 廣告寬度 |
| headAdvertHeight | false | Integer | 廣告高度 |
| appId | false | String | POLYV 使用者 APP_ID,多帳號呼叫時該參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
| appSecret | false | String | POLYV 使用者 APP_SECRET,多帳號呼叫時該參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
回傳物件描述
true 設定成功,false 設定失敗
6、設定播放器暫停廣告
描述
用于设置某频道播放器的暂停广告
接口地址(仅做说明使用):https://api.polyv.net/live/v2/channelAdvert/%s/updateStop
呼叫限制
1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
2、設定暫停廣告不一定會顯示,需呼叫「設定頻道預設項開關」將廣告通用設定開關關閉
單元測試
@Test
public void testSetPlayerPauseAdvert() throws Exception, NoSuchAlgorithmException, URISyntaxException {
LiveSetPlayerPauseAdvertRequest liveSetPlayerPauseAdvertRequest = new LiveSetPlayerPauseAdvertRequest();
Boolean liveSetPlayerPauseAdvertResponse = null;
try {
String channelId = super.createChannel();
liveSetPlayerPauseAdvertRequest.setChannelId(channelId)
.setEnabled(LiveConstant.Flag.YES.getFlag())
.setStopAdvertHref("http://www.baidu.com")
.setStopAdvertImage("https://car3.autoimg.cn/cardfs/product/g25/M08/C7/57" +
"/1024x0_1_q95_autohomecar__ChsEmF8EOK-AB5uaAAfsj_iwPdE906.jpg");
liveSetPlayerPauseAdvertResponse = new LivePlayerServiceImpl().setPlayerPauseAdvert(
liveSetPlayerPauseAdvertRequest);
Assert.assertNotNull(liveSetPlayerPauseAdvertResponse);
if (liveSetPlayerPauseAdvertResponse != null) {
//to do something ......
log.debug("测试设置播放器暂停广告成功{}", JSON.toJSONString(liveSetPlayerPauseAdvertResponse));
}
} catch (PloyvSdkException e) {
//参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
log.error(e.getMessage(), e);
// 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
throw e;
} catch (Exception e) {
log.error("SDK调用异常", e);
throw e;
}
}
單元測試說明
1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤資訊請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因:invalid signature. ]
請求入參描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| channelId | true | String | 頻道號 |
| enabled | false | String | 設定播放器暫停廣告開關:Y-開啟,N-關閉 |
| stopAdvertImage | false | String | 圖片位址,不填代表刪除 |
| stopAdvertHref | false | String | 點擊圖片跳轉Url |
| appId | false | String | POLYV 使用者 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
| appSecret | false | String | POLYV 使用者 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
回傳物件描述
true 設定成功,false 設定失敗
7、設定播放器自訂 URL 跑馬燈
描述
可以设置播放器防录屏自定义url跑马灯开关,在开启时需提交url参数。
接口地址(仅做说明使用):https://api.polyv.net/live/v2/channelRestrict/%s/set-diyurl-marquee
呼叫限制
1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testSetPlayerUrlMarquee() throws Exception, NoSuchAlgorithmException, URISyntaxException {
LiveSetPlayerUrlMarqueeRequest liveSetPlayerUrlMarqueeRequest = new LiveSetPlayerUrlMarqueeRequest();
Boolean liveSetPlayerUrlMarqueeResponse;
try {
String channelId = super.createChannel();
liveSetPlayerUrlMarqueeRequest.setChannelId(channelId).setMarqueeRestrict("Y").setUrl("https://polyv.net");
liveSetPlayerUrlMarqueeResponse = new LivePlayerServiceImpl().setPlayerUrlMarquee(
liveSetPlayerUrlMarqueeRequest);
Assert.assertTrue(liveSetPlayerUrlMarqueeResponse);
if (liveSetPlayerUrlMarqueeResponse) {
//to do something ......
log.debug("测试设置播放器自定义url跑马灯成功");
}
} catch (PloyvSdkException e) {
//参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
log.error(e.getMessage(), e);
// 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
throw e;
} catch (Exception e) {
log.error("SDK调用异常", e);
throw e;
}
}
單元測試說明
1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]
請求入參說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| channelId | true | String | 頻道號 |
| marqueeRestrict | true | String | 自訂URL防錄影跑馬燈開關,Y或N |
| url | false | String | 自訂URL,開關關閉時可為空,開啟開關時為必填 |
| appId | false | String | POLYV用戶APP_ID,多帳號呼叫時此參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
| appSecret | false | String | POLYV用戶APP_SECRET,多帳號呼叫時此參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
回傳物件描述
true 設定成功,false 設定失敗
8、設定頻道防錄影資訊
描述
通过频道号,设置频道防录屏信息
接口地址(仅做说明使用):https://api.polyv.net/live/v3/channel/anti/record/setting
呼叫限制
1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testSetLiveAntiRecode() throws Exception, NoSuchAlgorithmException {
LiveSetAntiRecordRequest liveSetAntiRecordRequest = new LiveSetAntiRecordRequest();
Boolean liveSetAntiRecordResponse;
try {
String channelId = super.createChannel();
liveSetAntiRecordRequest.setChannelId(channelId)
.setEnable(LiveConstant.Flag.YES.getFlag())
.setAntiRecordType(LiveConstant.AntiRecordType.MARQUEE.getValue())
.setModelType(LiveConstant.ModelType.Fixed.getValue())
.setContent("测试固定跑马灯")
.setFontSize("30")
.setOpacity(70)
.setFontColor("#FFF")
.setAutoZoomEnabled(LiveConstant.Flag.YES.getFlag())
.setDoubleEnabled(LiveConstant.Flag.NO.getFlag())
.setShowMode(LiveConstant.ShowMode.FLICKER.getValue());
liveSetAntiRecordResponse = new LivePlayerServiceImpl().setLiveAntiRecord(liveSetAntiRecordRequest);
Assert.assertTrue(liveSetAntiRecordResponse);
if (liveSetAntiRecordResponse) {
//to do something ......
log.debug("测试设置频道防录屏信息成功");
}
} catch (PloyvSdkException e) {
//参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
log.error(e.getMessage(), e);
// 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
throw e;
} catch (Exception e) {
log.error("SDK调用异常", e);
throw e;
}
}
單元測試說明
1、請求正確,回傳 Boolean 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤資訊請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]
請求入參描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| channelId | true | String | 頻道號 |
| antiRecordType | true | String | 防錄影方式 marquee:跑馬燈 watermark:浮水印 |
| modelType | true | String | 防錄影類型,浮水印方式時設定自訂URL無效 fixed:固定值 nickname:登入使用者名稱 diyurl:URL自訂跑馬燈 |
| content | false | String | 固定值時為設定內容 URL自訂設定時為網址,需攜帶 http:// 或 https:// 【自訂跑馬燈參考文件】 防錄影類型為登入使用者名稱時可不傳 |
| fontSize | true | String | 字型大小 防錄影方式為跑馬燈時:設定數值,範圍1-256 防錄影方式為浮水印時: small:小 middle:中 large:大 |
| opacity | false | Integer | 透明度,不傳預設為80,範圍0-100,0為不透明 |
| fontColor | false | String | 跑馬燈字型顏色,色值,例如:#FFFFFF |
| autoZoomEnabled | false | String | 跑馬燈自訂縮放,預設為關閉 Y:開啟 N:關閉 |
| doubleEnabled | false | String | 雙跑馬燈,預設為關閉 Y:開啟 N:關閉 |
| showMode | false | String | 跑馬燈顯示方式,預設為滾動 roll:滾動 flicker:閃爍 |
| enable | false | String | 防錄影開關,預設為開啟 Y:開啟 N:關閉 |
| appId | false | String | POLYV使用者APP_ID,多帳號呼叫時該參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
| appSecret | false | String | POLYV使用者APP_SECRET,多帳號呼叫時該參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
回傳物件描述
true 設定成功,false 設定失敗
9、查詢頻道防錄影資訊
描述
通过频道号,查询频道防录屏信息
接口地址(仅做说明使用):https://api.polyv.net/live/v3/channel/anti/record/get
呼叫限制
1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testGetLiveAntiRecode() throws Exception, NoSuchAlgorithmException {
LiveGetAntiRecordRequest liveGetAntiRecordRequest = new LiveGetAntiRecordRequest();
LiveGetAntiRecordResponse liveGetAntiRecordResponse;
try {
String channelId = super.createChannel();
liveGetAntiRecordRequest.setChannelId(channelId);
liveGetAntiRecordResponse = new LivePlayerServiceImpl().getLiveAntiRecord(liveGetAntiRecordRequest);
Assert.assertNotNull(liveGetAntiRecordResponse);
if (liveGetAntiRecordResponse != null) {
//to do something ......
log.debug("测试查询频道防录屏信息成功{}", JSON.toJSONString(liveGetAntiRecordResponse));
}
} catch (PloyvSdkException e) {
//参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
log.error(e.getMessage(), e);
// 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
throw e;
} catch (Exception e) {
log.error("SDK调用异常", e);
throw e;
}
}
單元測試說明
1、請求正確,回傳 LiveGetAntiRecordResponse 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic 不能為空 / msg 不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤資訊請見 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]
請求入參描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| channelId | false | String | 頻道號 傳入頻道號,查詢頻道防錄影資訊 不傳頻道號,查詢帳號防錄影預設模板 |
| appId | false | String | POLYV 用戶 APP_ID,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
| appSecret | false | String | POLYV 用戶 APP_SECRET,多帳號呼叫時此參數必填(即呼叫了 initMultiAccount() 設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
回傳物件描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| antiRecordType | String | 防錄影方式 marquee:跑馬燈 watermark:浮水印 |
| modelType | String | 防錄影類型 fixed:固定值 nickname:登入使用者名稱 diyurl:URL自訂設定 |
| content | String | 固定值時為設定內容 URL自訂設定時為網址 |
| opacity | Integer | 透明度,取值0-100,0為不透明 |
| fontSize | String | 字型大小 防錄影方式為跑馬燈時,設定數值,範圍1-256 防錄影方式為浮水印時 small:小 middle:中 large:大 |
| fontColor | String | 跑馬燈字型顏色,色值,浮水印時不回傳此參數 |
| autoZoomEnabled | String | 跑馬燈自訂縮放,浮水印時不回傳此參數 Y:開啟 N:關閉 |
| doubleEnabled | String | 雙跑馬燈,浮水印時不回傳此參數 Y:開啟 N:關閉 |
| showMode | String | 跑馬燈顯示方式,浮水印時不回傳此參數 roll:滾動 flicker:閃爍 |
10、查詢投訴回饋
描述
查询投诉反馈
接口地址(仅做说明使用):https://api.polyv.net/live/v4/channel/feedback/list
呼叫限制
1、介面呼叫有頻率限制,詳細請查看,呼叫常見異常,詳細請查看
單元測試
@Test
public void testGetWatchFeedbackList() throws IOException, NoSuchAlgorithmException {
LiveGetWatchFeedbackListRequest liveGetWatchFeedbackListRequest = new LiveGetWatchFeedbackListRequest();
LiveGetWatchFeedbackListResponse liveGetWatchFeedbackListResponse;
try {
String channelId = super.createChannel();
liveGetWatchFeedbackListRequest.setChannelId(channelId);
liveGetWatchFeedbackListResponse = new LivePlayerServiceImpl().getWatchFeedbackList(
liveGetWatchFeedbackListRequest);
Assert.assertNotNull(liveGetWatchFeedbackListResponse);
if (liveGetWatchFeedbackListResponse != null) {
//to do something ......
log.debug("测试查询投诉反馈成功 {}", JSON.toJSONString(liveGetWatchFeedbackListResponse));
}
} catch (PloyvSdkException e) {
//参数校验不合格 或者 请求服务器端500错误,错误信息见PloyvSdkException.getMessage()
log.error(e.getMessage(), e);
// 异常返回做B端异常的业务逻辑,记录log 或者 上报到ETL 或者回滚事务
throw e;
} catch (Exception e) {
log.error("SDK调用异常", e);
throw e;
}
}
單元測試說明
1、請求正確,回傳 LiveGetWatchFeedbackListResponse 物件,B 端依據此物件處理業務邏輯;
2、請求參數驗證不合格,拋出 PloyvSdkException,錯誤訊息請見 PloyvSdkException.getMessage(),例如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗,失敗欄位 [pic不能為空 / msg不能為空] ]
3、伺服器處理異常,拋出 PloyvSdkException,錯誤資訊請參閱 PloyvSdkException.getMessage(),例如 [ 保利威請求回傳資料錯誤,請求流水號:66e7ad29fd04425a84c2b2b562d2025b,錯誤原因: invalid signature. ]
請求參數說明
| 參數名稱 | 必填 | 類型 | 說明 |
|---|---|---|---|
| channelId | 否 | String | 頻道號,不傳則查詢使用者下的資料 |
| pageNumber | 否 | Integer | 分頁頁碼,預設為1 |
| pageSize | 否 | Integer | 分頁大小,預設為10,最大不超過1000 |
| appId | 否 | String | POLYV使用者APP_ID,多帳號呼叫時此參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
| appSecret | 否 | String | POLYV使用者APP_SECRET,多帳號呼叫時此參數必填(即呼叫了initMultiAccount()設定多帳號呼叫),透過註冊保利威官網取得,路徑:官網->登入->直播(開發設定) |
回傳物件描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| contents | Array | 當前頁內容【詳見FeedbackInfo參數說明】 |
| pageSize | Integer | 每頁顯示的資料筆數,預設每頁顯示20筆資料 |
| currentPage | Integer | 當前頁【對應API文件的pageNumber欄位】 |
| totalItems | Integer | 記錄總筆數 |
| totalPage | Integer | 總頁數【對應API文件的totalPages欄位】 |
FeedbackInfo參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| id | Integer | 投訴回饋ID |
| channelId | String | 頻道號 |
| type | String | 投訴回饋類型 suggestion:意見回饋 complaint:投訴 |
| label | String | 所屬分類 stuck:頁面卡頓 black-screen:畫面黑屏 slow-access:存取緩慢 poor-experience:體驗不佳 play-suggestion:玩法建議 other-feedback:其他回饋 porn:色情低俗 politics:涉及政治 drug:涉及毒品 bloody:血腥恐怖 scam:詐騙 other-violations:其他違規 |
| content | String | 內容 |
| imageUrls | Array | 圖片URL列表 |
| createTime | Date | 建立時間 |
| updateTime | Date | 更新時間 |
