获取硬盘推流(伪直播)视频列表
更新时间:2023-12-27 15:43:51
接口描述
1、获取硬盘推流(伪直播)视频列表
2、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/disk-video/list
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | true | String | 频道号 |
| page | false | Integer | 当前页码,默认为1 |
| limit | false | Integer | 分页大小,默认为10 |
示例
http://api.polyv.net/live/v3/channel/disk-video/list?appId=frlr1zazn3&sign=2E8DE3C2E5D62468917CF3A9B2DBC3D6&channelId=3889955×tamp=1681983834988
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | String | 返回数据【详见Data参数描述】 |
data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| pageSize | Integer | 每页数据大小 |
| pageNumber | Integer | 当前页数 |
| totalItems | Integer | 总的条数 |
| contents | Array | 频道详细信息列表【详见Contents参数描述】 |
Content参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| videoId | String | 直播系统videoId |
| videoPoolId | String | 点播系统videoPoolId |
| userId | String | 直播系统userId |
| channelId | Integer | 频道号 |
| title | String | 伪直播视频标题 |
| firstImage | String | 伪直播首图,需拼接域名才能使用 |
| duration | String | 视频长度,如:00:17:36 |
| startTime | Long | 伪直播开始时间,13位时间戳 |
| endTime | Long | 伪直播结束时间,13位时间戳 |
| createdTime | Long | 该记录保存时间 |
| lastModified | Long | 该记录最后修改时间 |
| url | String | 伪直播mp4地址 |
| streamStatus | String | 伪直播流状态:waiting-未直播,live-直播中,end-已结束 |
| langType | String | 语言:CN-中文,EN-英文(频道开启双流直播可设置英文伪直播) |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(ChannelStateTest.class);
/**
* 获取硬盘推流(伪直播)视频列表
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testListDiskVideo() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v3/channel/disk-video/list";
String channelId = "3889955";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试获取硬盘推流(伪直播)视频列表,返回值:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "",
"data": {
"pageSize": 10,
"pageNumber": 1,
"totalItems": 1,
"contents": [
{
"videoId": "gjzwgmer37",
"videoPoolId": "1b448be323e0bb0564cdd816ce4fac61",
"userId": "1b448be323",
"channelId": 3889955,
"title": "2-1 认识对象",
"firstImage": "1b448be323/1/1b448be323e0bb0564cdd816ce4fac61_0.jpg",
"duration": "00:17:36",
"status": "N",
"startTime": 1681373864000,
"endTime": 1681374920000,
"createdTime": 1681373802000,
"lastModified": 1681373865000,
"url": "http://mpv.videocc.net/1b448be323/1/1b448be323e0bb0564cdd816ce4fac61_1.mp4",
"localFileName": "/data/diskvideo/202304/gjzwgmer37.mp4",
"processId": 27944,
"streamStatus": "end",
"pushIp": "172.18.148.58",
"langType": "CN",
"source": "VideoPool"
}
],
"limit": 1,
"endRow": 1,
"nextPageNumber": 1,
"totalPages": 1,
"startRow": 1,
"firstPage": true,
"lastPage": true,
"prePageNumber": 1,
"offset": 0
}
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
