1. 接口描述
- 域名:live.api.qcloud.com
- 接口名:DescribeLVBChannel
输入待查询频道的 ID 号,获得该频道的当前状态、名称、描述、直播源信息和输出源信息。
2. 输入参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
channelId | 是 | 无符号整型 | 频道的 ID 号 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 错误码,0:成功,其他值:失败 |
message | String | 错误信息 |
channelInfo | 数组型 | 频道的信息(当前状态、名称、描述、直播源信息和输出源信息) |
4. 示例
输入1
https://domain/v2/index.php?Action=DescribeLVBChannel&channelId=96171715553394807&公共请求参数
输出1
{
"code": 0,
"message": "",
"channelInfo": [
{
"channel_id": "XXX",
"channel_name": "XXX",
"channel_describe": "XXX",
"channel_status": "1",
"upstream_list": [
{
"sourceName": "RTMP",
"sourceID": "YYYYYYYYYYY",
"sourceType": "1",
"sourceAddress": "rtmp://2000.livepush.myqcloud.com/live/YYYYYYYYYYYYYYYYYY?bizid2000"
}
],
"hls_downstream_address": "",
"rtmp_downstream_address": "rtmp://2000.liveplay.myqcloud.com/live/XXX",
"player_id": "226",
"resolution": null,
"password": null
}
]
}
5.标准参数定义
频道状态定义:
值 | 状态 |
---|---|
0 | 无输入流 |
1 | 直播中 |
2 | 异常 |
3 | 关闭 |
接收方类型定义:
类型 | 含义 |
---|---|
1 | RTMP 输出 |
2 | HLS 输出 |
3 | RTMP 和 HLS 输出 |
类型 | 含义 |
---|---|
1 | RTMP 推流 |
2 | RTMP 拉流 |
3 | HLS 拉流 |