Player Service

1、设置频道的暖场设置开关

描述

用于设置频道的暖场开关
接口地址(仅做说明使用):https://api.polyv.net/live/v3/channel/set-warmup-enabled

调用约束

1、接口调用有频率限制,详细请查看arrow-up-right,调用常见异常,详细请查看arrow-up-right

单元测试

	@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表示关闭

返回对象描述

true 设置成功 , false 设置失败


2、设置播放器暖场图片

描述

调用约束

1、接口调用有频率限制,详细请查看arrow-up-right,调用常见异常,详细请查看arrow-up-right

单元测试

单元测试说明

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

点击暖场图片后浏览器跳转地址

返回对象描述

true 设置成功 , false 设置失败


3、设置播放器暖场视频

描述

调用约束

1、接口调用有频率限制,详细请查看arrow-up-right,调用常见异常,详细请查看arrow-up-right

单元测试

单元测试说明

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视频文件

返回对象描述

true 设置成功,false 设置失败


描述

调用约束

1、接口调用有频率限制,详细请查看arrow-up-right,调用常见异常,详细请查看arrow-up-right

单元测试

单元测试说明

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图片点击跳转链接

返回对象描述

true 设置成功, fales 设置失败


5、设置播放器片头广告

描述

调用约束

1、接口调用有频率限制,详细请查看arrow-up-right,调用常见异常,详细请查看arrow-up-right

2、设置片头广告并不一定会展示,需要调用 设置频道默认项开关 把广告通用设置开关关闭

单元测试

单元测试说明

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

广告高度

返回对象描述

true 设置成功,false 设置失败


6、设置播放器暂停广告

描述

调用约束

1、接口调用有频率限制,详细请查看arrow-up-right,调用常见异常,详细请查看arrow-up-right

2、设置暂停广告并不一定会展示,需要调用 设置频道默认项开关 把广告通用设置开关关闭

单元测试

单元测试说明

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

返回对象描述

true 设置成功,false 设置失败


7、设置播放器自定义url跑马灯

描述

调用约束

1、接口调用有频率限制,详细请查看arrow-up-right,调用常见异常,详细请查看arrow-up-right

单元测试

单元测试说明

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, 在开关为关时可为空,开启开关时为必填

返回对象描述

true 设置成功,false 设置失败


8、设置频道防录屏信息

描述

调用约束

1、接口调用有频率限制,详细请查看arrow-up-right,调用常见异常,详细请查看arrow-up-right

单元测试

单元测试说明

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:关闭

返回对象描述

true 设置成功,false 设置失败


9、查询频道防录屏信息

描述

调用约束

1、接口调用有频率限制,详细请查看arrow-up-right,调用常见异常,详细请查看arrow-up-right

单元测试

单元测试说明

1、请求正确,返回LiveGetAntiRecordResponse对象,B端依据此对象处理业务逻辑;

2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]

请求入参描述

参数名
必选
类型
说明

channelId

false

String

频道号 传入频道号,查询频道防录屏信息 不传频道号,查询账号防录屏默认模板

返回对象描述

参数名
类型
说明

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、查询投诉反馈

描述

调用约束

1、接口调用有频率限制,详细请查看arrow-up-right,调用常见异常,详细请查看arrow-up-right

单元测试

单元测试说明

1、请求正确,返回LiveGetWatchFeedbackListResponse对象,B端依据此对象处理业务逻辑;

2、请求参数校验不合格,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 输入参数 [xxx.chat.LivexxxRequest]对象校验失败,失败字段 [pic不能为空 / msg不能为空] ]

3、服务器处理异常,抛出PloyvSdkException,错误信息见PloyvSdkException.getMessage(),如 [ 保利威请求返回数据错误,请求流水号:66e7ad29fd04425a84c2b2b562d2025b,错误原因: invalid signature. ]

请求入参描述

参数名
必选
类型
说明

channelId

false

String

频道号,不传则查询用户下的数据

pageNumber

false

Integer

分页页码,默认1

pageSize

false

Integer

分页大小,默认10,最大不超过1000

返回对象描述

参数名
类型
说明

contents

Array

当前页内容【详见FeedbackInfo参数描述arrow-up-right

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

更新时间

Last updated