1. 接口描述
- 域名:live.api.qcloud.com
- 接口名:DescribeLVBChannelList
获取用户的全部直播频道信息,包括频道的 ID、当前状态、名称和创建时间。
2. 输入参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
channelStatus | 否 | 无符号整型 | 用作频道列表过滤,频道状态(0:无输入流;1:有输入流;2:异常;3:关闭;4:配置不完整) |
ascDesc | 否 | 无符号整型 | 结果排序,默认按频道创建时间排序,0:按时间升序,1:按时间降序 |
pageNo | 否 | 无符号整型 | 分页页号,例如,想查看第3页的列表,将该变量设置为3 |
pageSize | 否 | 无符号整型 | 每一个分页上显示的频道的个数 |
orderBy | 否 | 字符串型 | 默认以频道创建时间来排序 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 错误码,0: 成功,其他值:失败 |
message | String | 错误信息 |
all_count | int | 总频道数 |
channelSet | 数组 | 频道列表 |
4. 示例
输入1
https://domain/v2/index.php?Action=DescribeLVBChannelList&channelStatus=0&ascDesc=1&pageNo=1&pageSize=10&公共请求参数
输出1
{
"code": 0,
"message": "",
"all_count": "2",
"channelSet": [
{
"channel_id": "96171715553394811",
"channel_name": "国际乒乓球锦标赛3",
"channel_status": "0",
"create_time": "2015-07-23 20:05:52"
},
{
"channel_id": "96171715553394810",
"channel_name": "国际乒乓球锦标赛2",
"channel_status": "0",
"create_time": "2015-07-23 19:54:05"
}
]
}
5.标准参数定义
频道状态定义:
值 | 状态 |
---|---|
0 | 无输入流 |
1 | 直播中 |
2 | 异常 |
3 | 关闭 |
接收方类型定义:
类型 | 含义 |
---|---|
1 | RTMP 输出 |
2 | HLS 输出 |
3 | RTMP 和 HLS 输出 |
类型 | 含义 |
---|---|
1 | RTMP 推流 |
2 | RTMP 拉流 |
3 | HLS 拉流 |