获取源信息列表
1.接口描述
接口说明:获取源信息列表
请求方式:GET/POST [ip]/api/source/list
管理员权限 | 登录认证 |
---|---|
否 | 是 |
2.输入参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
page | 否 | Integer | 页码 |
page_size | 否 | Integer | 每页显示条数 |
type | 是 | String | 源类型:static代表静态添加源,dynamic代表动态发现的源,如果后续需要查询其它类型可继续扩展(如ndi静态源) |
3.输出参数
参数名称 | 类型 | 描述 |
---|---|---|
status | Int | 状态码 |
code | String | 状态描述 |
page | Integer | 页码 |
page_size | Integer | 每页显示条数 |
total | Integer | source的个数 |
selected | Integer | 当前被选中的源ID |
data | Array | source 列表 |
data
参数名称 | 类型 | 描述 |
---|---|---|
id | Int | 源id |
config | struct | 参考源配置 |
4.示例
获取静态源信息列表
输入示例
GET/POST /api/source/list?type=static
输出示例
{
"status": 0,
"code" : "Success",
"page": 2,
"page_size": 25,
"total": 100,
"selected": 1,
"data":[
{
"id":1,
"config": {
"name": "name1",
"protocol": "ndi",
"type": "ndi",
"data": {
"name": "ULTRA ENCODE AOGUN (C315230423002-2)",
"url": "10.10.33.21:5000",
"low_bw": false,
"transport": "tcp",
"pts_mode": "auto",
"buffer_ms": 60
}
}
},
{
"id":2,
"config": {
"name": "name1",
"protocol": "rtsp",
"type": "url",
"data": {
"url": "10.10.33.21:5000",
"buffer_ms": 60,
"ptz_en": true,
"ptz": {
"protocol": "VISCA over UDP",
"ip": "192.168.1.1",
"port": 3000,
"device_id": 1,
"message_header": true,
"invert_pan": false,
"invert_tilt": false
}
}
}
}
]
}
5.错误码
无接口业务逻辑相关的错误码,其他错误码详见 API 状态码。|