net.polyv.live.service

接口 PLChannelService

所有超级接口:

PLBaseService

所有已知实现类:

PLChannelServiceImpl

public interface PLChannelService
extends PLBaseService

  POLYV直播频道相关接口
 

作者:

HuangYF

方法概要

限定符和类型	方法和说明
PLChannelCommonResult	convertChannelRecords(int channelId, PLChannelRecordFileConvertRequest plChannelRecordFileConvertRequest) 直播录制文件转存点播(详见http://dev.polyv.net/2017/liveproduct/l-api/hfgn/livetovod/) 该接口提供用户将直播文件转存点播。
PLChannelCreateResult	createChannel(PLChannelCreateRequest plChannelCreateRequest) 创建频道(详见http://dev.polyv.net/2017/liveproduct/l-api/zbglgn/create-channel/) 该接口提供用户创建新的账号下的频道。
PLChannelCommonResult	deleteChannel(int channelId, PLChannelDeleteRequest plChannelDeleteRequest) 删除频道(详见http://dev.polyv.net/2018/liveproduct/l-api/zbglgn/deletechannel/) 该接口提供用户删除直播频道。
PLChannelCommonResult	deletePlaybackVideo(int channelId, PLChannelPlaybackDeleteRequest plChannelPlaybackDeleteRequest) 删除回放视频(详见http://dev.polyv.net/2017/liveproduct/l-api/hfgn/deleteplaybackvideo/) 该接口提供用户删除回放视频。
PLChannelGetResult	getChannel(int channelId, PLChannelGetRequest plChannelGetRequest) 获取频道信息(详见http://dev.polyv.net/2017/liveproduct/l-api/hqzbxx/getchannelid-2/) 该接口提供用户查询频道信息。
PLChannelDailySummaryResult	getChannelDailySummary(int channelId, PLChannelDailySummaryRequest plChannelDailySummaryRequest) 获取频道某段时间的直播统计数据(详见http://dev.polyv.net/2017/liveproduct/l-api/hqzbxx/summary/) 该接口提供用户获取频道某段时间的直播统计数据。
String	getChannelLiveStatus(String stream) 获取频道直播状态(详见http://dev.polyv.net/2016/liveproduct/l-api/hqzbxx/live_status/) 该接口提供用户获取当前频道的直播状态。
PLChannelPlaybackListGetResult	getChannelPlaybacks(int channelId, PLChannelPlaybackListGetRequest plChannelPlaybackListGetRequest) 获取频道回放列表(详见http://dev.polyv.net/2017/liveproduct/l-api/hfgn/getplaybacklist/) 该接口提供用户获取频道回放列表。
PLChannelRecordFilesGetResult	getChannelRecordFiles(int channelId, PLChannelRecordFilesGetRequest plChannelRecordFilesGetRequest) 查询频道录制文件信息(详见http://dev.polyv.net/2017/liveproduct/l-api/hfgn/recordfilesinfo/) 该接口提供用户获取频道录制文件信息。
PLChannelSummaryListGetResult	getChannelSummaryList(String userId, PLChannelSummaryListGetRequest plChannelSummaryListGetRequest) 获取频道汇总统计的播放数据(详见http://dev.polyv.net/2018/liveproduct/l-api/hqzbxx/channel_play_summary/) 该接口提供用户获取一段时间里的频道数据汇总统计。
PLChannelViewersGetResult	getChannelViewers(PLChannelViewersGetRequest plChannelViewersGetRequest) 获取多个频道的实时在线人数(详见http://dev.polyv.net/2018/liveproduct/l-api/hqzbxx/get-realtime-viewers/) 该接口提供用户获取频道的实时在线人数。
PLChannelViewLogsGetResult	getChannelViewLogs(int channelId, PLChannelViewLogsGetRequest plChannelViewLogsGetRequest) 查询某个频道观看分页日志信息(详见http://dev.polyv.net/2018/liveproduct/l-api/hqzbxx/viewlog-page/) 该接口提供用户获取频道观看分页日志信息。
PLChannelLikesGetResult	getLikes(PLChannelLikesGetRequest plChannelLikesGetRequest) 频道获取点赞数和历史观看人数(详见http://dev.polyv.net/2017/liveproduct/l-api/szgkygg/ymxxsz/live-likes/) 该接口提供用户设置频道的点赞数和观看人数。
PLChannelManagementListResult	getSimpleChannelList(PLChannelManagementListRequest plChannelManagementListRequest) 获取简单的频道列表(详见http://dev.polyv.net/2018/liveproduct/l-api/hqzbxx/get-simple-channel-list/) 该接口提供用户获取简单的频道列表。
PLChannelCommonResult	mergeChannelRecords(int channelId, PLChannelRecordFileMergeRequest plChannelRecordFileMergeRequest) 直播录制文件合并(详见http://dev.polyv.net/2018/liveproduct/l-api/hfgn/recordfile-merge/) 该接口提供用户将频道的几个录制文件合并。
PLChannelCommonResult	setChannelMaxViewer(int channelId, PLChannelMaxViewerSetRequest plChannelMaxViewerSetRequest) 设置频道最大在线人数(详见http://dev.polyv.net/2018/liveproduct/l-api/szgkygg/setmaxviewerv2/) 该接口提供设置直播频道的最大在线观看人数。
PLChannelCommonResult	setChannelName(int channelId, PLChannelNameSetRequest plChannelNameSetRequest) 修改频道名称(详见http://dev.polyv.net/2016/liveproduct/l-api/szgkygg/updatechannelname/) 该接口提供用户修改直播频道的名称。
PLChannelCommonResult	setChannelPassword(String userId, PLChannelPasswordSetRequest plChannelPasswordSetRequest) 设置频道密码(详见http://dev.polyv.net/2017/liveproduct/l-api/zbglgn/updatepasswd/) 该接口提供用户设置频道密码。
PLChannelCommonResult	setChannelPlayback(String userId, PLChannelPlaybackSetRequest plChannelPlaybackSetRequest) 设置频道回放开关(详见http://dev.polyv.net/2017/liveproduct/l-api/hfgn/setplaybackenabled/) 该接口提供用户设置频道的回放开关。
PLChannelCommonResult	setChannelPublisher(String userId, PLChannelPublisherSetRequest plChannelPublisherSetRequest) 修改主持人姓名(详见http://dev.polyv.net/2017/liveproduct/l-api/szgkygg/setpublisher/) 该接口提供用户修改直播频道的主持人名称。
PLChannelCommonResult	setPlaybackListDefault(int channelId, PLChannelPlaybackSetDefaultRequest plChannelPlaybackSetDefaultRequest) 设置频道回放列表的默认回放视频(详见http://dev.polyv.net/2017/liveproduct/l-api/hfgn/setdefault/) 该接口提供用户可以设置自己频道的默认回放视频。
PLChannelCommonResult	updateLikes(int channelId, PLChannelLikesUpdateRequest plChannelLikesUpdateRequest) 频道设置点赞数和观看人数(详见http://dev.polyv.net/2018/liveproduct/l-api/szgkygg/update-likes/) 该接口提供用户设置频道的点赞数和观看人数。

从接口继承的方法 net.polyv.live.service.PLBaseService

destroyProxy, initForwardProxy, initReverseProxy, initReverseProxy

方法详细资料

createChannel

PLChannelCreateResult createChannel(PLChannelCreateRequest plChannelCreateRequest)

 创建频道(详见http://dev.polyv.net/2017/liveproduct/l-api/zbglgn/create-channel/)
 该接口提供用户创建新的账号下的频道。
 需要调用该接口的情况：
 ◆ 业务需要创建新的频道进行直播；
 接口地址：http://api.polyv.net/live/v2/channels/
 

参数:

plChannelCreateRequest - 创建频道需要的参数对象。

返回:

创建频道结果对象

setChannelMaxViewer

PLChannelCommonResult setChannelMaxViewer(int channelId,
                                          PLChannelMaxViewerSetRequest plChannelMaxViewerSetRequest)

 设置频道最大在线人数(详见http://dev.polyv.net/2018/liveproduct/l-api/szgkygg/setmaxviewerv2/)
 该接口提供设置直播频道的最大在线观看人数。
 需要调用该接口的情况：
 ◆ 业务需要限制观看直播频道的最大在线人数；
 接口地址：http://api.polyv.net/live/v2/channelRestrict/{channelId}/set-max-viewer
 

参数:

channelId - 频道ID

plChannelMaxViewerSetRequest - 设置频道最大在线人数的请求对象

返回:

频道公共结果对象

setChannelName

PLChannelCommonResult setChannelName(int channelId,
                                     PLChannelNameSetRequest plChannelNameSetRequest)

 修改频道名称(详见http://dev.polyv.net/2016/liveproduct/l-api/szgkygg/updatechannelname/)
 该接口提供用户修改直播频道的名称。
 需要调用该接口的情况：
 ◆ 业务需要进行新的直播，有需要修改频道名称；
 接口地址：http://api.polyv.net/live/v2/channels/{channelId}/update
 

参数:

channelId - 频道ID

plChannelNameSetRequest - 修改频道频道名称需要的参数对象。

返回:

频道公共结果对象

setChannelPublisher

PLChannelCommonResult setChannelPublisher(String userId,
                                          PLChannelPublisherSetRequest plChannelPublisherSetRequest)

 修改主持人姓名(详见http://dev.polyv.net/2017/liveproduct/l-api/szgkygg/setpublisher/)
 该接口提供用户修改直播频道的主持人名称。
 需要调用该接口的情况：
 ◆ 业务需要更换直播频道主持人；
 接口地址：http://api.polyv.net/live/v2/channelSetting/{userId}/setPublisher
 

参数:

userId - 用户ID

plChannelPublisherSetRequest - 修改频道频道主持人需要的参数对象。

返回:

频道公共结果对象

deleteChannel

PLChannelCommonResult deleteChannel(int channelId,
                                    PLChannelDeleteRequest plChannelDeleteRequest)

 删除频道(详见http://dev.polyv.net/2018/liveproduct/l-api/zbglgn/deletechannel/)
 该接口提供用户删除直播频道。
 需要调用该接口的情况：
 ◆ 业务需要删除无用的直播频道；
 接口地址：http://api.polyv.net/live/v2/channels/{channelId}/delete
 

参数:

channelId - 频道ID

plChannelDeleteRequest - 删除频道的参数对象。

返回:

频道公共结果对象

setChannelPassword

PLChannelCommonResult setChannelPassword(String userId,
                                         PLChannelPasswordSetRequest plChannelPasswordSetRequest)

 设置频道密码(详见http://dev.polyv.net/2017/liveproduct/l-api/zbglgn/updatepasswd/)
 该接口提供用户设置频道密码。
 需要调用该接口的情况：
 ◆ 业务安全需要重新设置频道的密码；
 接口地址：http://api.polyv.net/live/v2/channels/{userId}/passwdSetting
 

参数:

userId - 用户ID

plChannelPasswordSetRequest - 设置频道密码参数对象。

返回:

频道公共结果对象

setChannelPlayback

PLChannelCommonResult setChannelPlayback(String userId,
                                         PLChannelPlaybackSetRequest plChannelPlaybackSetRequest)

 设置频道回放开关(详见http://dev.polyv.net/2017/liveproduct/l-api/hfgn/setplaybackenabled/)
 该接口提供用户设置频道的回放开关。
 需要调用该接口的情况：
 ◆ 业务需要频道是否开启回放开关的设置；
 接口地址：http://api.polyv.net/live/v2/channelSetting/{userId}/setPlayBackEnabled
 

参数:

userId - 用户ID

plChannelPlaybackSetRequest - 设置频道回放开关参数对象。

返回:

频道公共结果对象

getChannelSummaryList

PLChannelSummaryListGetResult getChannelSummaryList(String userId,
                                                    PLChannelSummaryListGetRequest plChannelSummaryListGetRequest)

 获取频道汇总统计的播放数据(详见http://dev.polyv.net/2018/liveproduct/l-api/hqzbxx/channel_play_summary/)
 该接口提供用户获取一段时间里的频道数据汇总统计。
 需要调用该接口的情况：
 ◆ 业务需要对一段时间内的频道进行数据统计；
 接口地址：http://api.polyv.net/live/v2/statistics/{userId}/channel_summary
 

参数:

userId - 用户ID

plChannelSummaryListGetRequest - 获取频道汇总统计的播放数据的参数对象。

返回:

频道汇总统计列表结果对象

getChannelLiveStatus

String getChannelLiveStatus(String stream)

 获取频道直播状态(详见http://dev.polyv.net/2016/liveproduct/l-api/hqzbxx/live_status/)
 该接口提供用户获取当前频道的直播状态。
 需要调用该接口的情况：
 ◆ 业务需要判断当前直播频道的直播状态以便进行业务操作；
 接口地址：http://api.polyv.net/live_status/query
 注：
 ◆ 如果正在直播，返回live，否则返回end
 

参数:

stream - 流名（可调用获取频道信息接口，获取stream字段的值）

返回:

直播状态

getChannelViewers

PLChannelViewersGetResult getChannelViewers(PLChannelViewersGetRequest plChannelViewersGetRequest)

 获取多个频道的实时在线人数(详见http://dev.polyv.net/2018/liveproduct/l-api/hqzbxx/get-realtime-viewers/)
 该接口提供用户获取频道的实时在线人数。
 需要调用该接口的情况：
 ◆ 业务需要获取频道的在线人数数据用于对比分析和展示；
 接口地址：http://api.polyv.net/live/v2/statistics/get-realtime-viewers
 

参数:

plChannelViewersGetRequest - 获取多个频道实时在线人数的参数对象。

返回:

获取频道观众列表结果对象

getChannelViewLogs

PLChannelViewLogsGetResult getChannelViewLogs(int channelId,
                                              PLChannelViewLogsGetRequest plChannelViewLogsGetRequest)

 查询某个频道观看分页日志信息(详见http://dev.polyv.net/2018/liveproduct/l-api/hqzbxx/viewlog-page/)
 该接口提供用户获取频道观看分页日志信息。
 需要调用该接口的情况：
 ◆ 业务需要获取；
 接口地址：http://api.polyv.net/live/v2/statistics/{channelId}/viewlog
 

参数:

channelId - 频道ID

plChannelViewLogsGetRequest - 获取用户获取频道观看分页日志信息的参数对象。

返回:

频道观看日志列表结果对象

getChannel

PLChannelGetResult getChannel(int channelId,
                              PLChannelGetRequest plChannelGetRequest)

 获取频道信息(详见http://dev.polyv.net/2017/liveproduct/l-api/hqzbxx/getchannelid-2/)
 该接口提供用户查询频道信息。
 需要调用该接口的情况：
 ◆ 业务需要获取频道信息；
 接口地址：http://api.polyv.net/live/v2/channels/{channelId}/get
 

参数:

channelId - 频道ID

plChannelGetRequest - 获取频道信息的参数对象。

返回:

频道信息结果对象

getChannelRecordFiles

PLChannelRecordFilesGetResult getChannelRecordFiles(int channelId,
                                                    PLChannelRecordFilesGetRequest plChannelRecordFilesGetRequest)

 查询频道录制文件信息(详见http://dev.polyv.net/2017/liveproduct/l-api/hfgn/recordfilesinfo/)
 该接口提供用户获取频道录制文件信息。
 需要调用该接口的情况：
 ◆ 业务需要获取频道录制文件信息进行播放；
 接口地址：http://api.polyv.net/live/v2/channels/{channelId}/recordFiles
 

参数:

channelId - 频道ID

plChannelRecordFilesGetRequest - 获取用户获取频道录制文件请求的参数对象。

返回:

频道录制文件列表结果对象

convertChannelRecords

PLChannelCommonResult convertChannelRecords(int channelId,
                                            PLChannelRecordFileConvertRequest plChannelRecordFileConvertRequest)

 直播录制文件转存点播(详见http://dev.polyv.net/2017/liveproduct/l-api/hfgn/livetovod/)
 该接口提供用户将直播文件转存点播。
 需要调用该接口的情况：
 ◆ 业务需要想录制文件转存到点播并使用点播播放器播放；
 接口地址：http://api.polyv.net/live/v2/channel/recordFile/{channelId}/convert
 

参数:

channelId - 频道ID

plChannelRecordFileConvertRequest - 录制文件转存请求的参数对象。

返回:

频道公共结果对象

getChannelPlaybacks

PLChannelPlaybackListGetResult getChannelPlaybacks(int channelId,
                                                   PLChannelPlaybackListGetRequest plChannelPlaybackListGetRequest)

 获取频道回放列表(详见http://dev.polyv.net/2017/liveproduct/l-api/hfgn/getplaybacklist/)
 该接口提供用户获取频道回放列表。
 需要调用该接口的情况：
 ◆ 业务需要对回放列表进行操作，需要先获取回放列表；
 ◆ 业务需要用于展示；
 接口地址：http://api.polyv.net/live/v2/channel/recordFile/{channelId}/playback/list
 

参数:

channelId - 频道ID

plChannelPlaybackListGetRequest - 回放列表请求的参数对象。

返回:

频道回放列表结果对象

setPlaybackListDefault

PLChannelCommonResult setPlaybackListDefault(int channelId,
                                             PLChannelPlaybackSetDefaultRequest plChannelPlaybackSetDefaultRequest)

 设置频道回放列表的默认回放视频(详见http://dev.polyv.net/2017/liveproduct/l-api/hfgn/setdefault/)
 该接口提供用户可以设置自己频道的默认回放视频。
 需要调用该接口的情况：
 ◆ 业务需要设置默认的回放用于频道回放需要；
 接口地址：http://api.polyv.net/live/v2/channel/recordFile/{channelId}/playback/set-Default
 

参数:

channelId - 频道ID

plChannelPlaybackSetDefaultRequest - 设置默认回放视频的请求的参数对象。

返回:

频道公共结果对象

deletePlaybackVideo

PLChannelCommonResult deletePlaybackVideo(int channelId,
                                          PLChannelPlaybackDeleteRequest plChannelPlaybackDeleteRequest)

 删除回放视频(详见http://dev.polyv.net/2017/liveproduct/l-api/hfgn/deleteplaybackvideo/)
 该接口提供用户删除回放视频。
 需要调用该接口的情况：
 ◆ 业务需要想删除回放列表中的视频；
 接口地址：http://api.polyv.net/live/v2/channel/recordFile/{channelId}/playback/delete
 

参数:

channelId - 频道ID

plChannelPlaybackDeleteRequest - 删除回放视频请求的参数对象。

返回:

频道公共结果对象

mergeChannelRecords

PLChannelCommonResult mergeChannelRecords(int channelId,
                                          PLChannelRecordFileMergeRequest plChannelRecordFileMergeRequest)

 直播录制文件合并(详见http://dev.polyv.net/2018/liveproduct/l-api/hfgn/recordfile-merge/)
 该接口提供用户将频道的几个录制文件合并。
 需要调用该接口的情况：
 ◆ 业务需要将两个录制文件合并；
 接口地址：https://api.polyv.net/live/v2/channel/recordFile/{channelId}/merge
 

参数:

channelId - 频道ID

plChannelRecordFileMergeRequest - 录制文件合并请求的参数对象。

返回:

频道公共结果对象

updateLikes

PLChannelCommonResult updateLikes(int channelId,
                                  PLChannelLikesUpdateRequest plChannelLikesUpdateRequest)

 频道设置点赞数和观看人数(详见http://dev.polyv.net/2018/liveproduct/l-api/szgkygg/update-likes/)
 该接口提供用户设置频道的点赞数和观看人数。
 需要调用该接口的情况：
 ◆ 业务需要在观看页展示自己要展示的点赞数和观看人数；
 接口地址：http://api.polyv.net/live/v2/channels/{channelId}/update-likes
 

参数:

channelId - 频道ID

plChannelLikesUpdateRequest - 设置点赞数和观看人数请求的参数对象。

返回:

频道公共结果对象

getLikes

PLChannelLikesGetResult getLikes(PLChannelLikesGetRequest plChannelLikesGetRequest)

 频道获取点赞数和历史观看人数(详见http://dev.polyv.net/2017/liveproduct/l-api/szgkygg/ymxxsz/live-likes/)
 该接口提供用户设置频道的点赞数和观看人数。
 需要调用该接口的情况：
 ◆ 业务需要获取频道的点赞数和观看人数用于统计；
 ◆ 业务需要获取频道的点赞数和观看人数用于展示；
 接口地址：http://api.polyv.net/live/v2/channels/live-likes
 

参数:

plChannelLikesGetRequest - 获取频道点赞数和历史观看人数请求的参数对象。

返回:

获取频道点赞结果对象

getChannelDailySummary

PLChannelDailySummaryResult getChannelDailySummary(int channelId,
                                                   PLChannelDailySummaryRequest plChannelDailySummaryRequest)

 获取频道某段时间的直播统计数据(详见http://dev.polyv.net/2017/liveproduct/l-api/hqzbxx/summary/)
 该接口提供用户获取频道某段时间的直播统计数据。
 需要调用该接口的情况：
 ◆ 业务需要获取频道某段时间的直播统计数据；
 接口地址：http://api.polyv.net/live/v2/statistics/{channelId}/summary
 

参数:

channelId - 频道ID

plChannelDailySummaryRequest - 获取频道某段时间的直播统计数据请求的参数对象。

返回:

频道按天汇总结果对象

getSimpleChannelList

PLChannelManagementListResult getSimpleChannelList(PLChannelManagementListRequest plChannelManagementListRequest)

 获取简单的频道列表(详见http://dev.polyv.net/2018/liveproduct/l-api/hqzbxx/get-simple-channel-list/)
 该接口提供用户获取简单的频道列表。
 需要调用该接口的情况：
 ◆ 业务需要获取频道列表并且想分页获取；
 接口地址：http://api.polyv.net/live/v3/channel/management/list
 

参数:

plChannelManagementListRequest - 获取频道列表请求的参数对象。

返回:

频道管理列表结果对象