Obtain the source list
1. API Description
This API is used to obtain the source list.
Request mode: GET/POST [ip]/api/source/list
| Administrator Rights | Logged-in |
|---|---|
| No | Yes |
2. Input Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| page | No | Integer | Page number. |
| page_size | No | Integer | The number of items per page. |
| type | Yes | String | "static" indicates a manually added source, and "dynamic" indicates a source discovered by ndi discovery. |
3. Output Parameters
| Name | Type | Description |
|---|---|---|
| status | Integer | Status code. |
| code | String | Status description. |
| page | Integer | Page number. |
| page_size | Integer | The number of items per page |
| total | Integer | The number of sources. |
| selected | Integer | ID of the currently selected source. |
| data | Array | List of sources. |
Data
| Name | Type | Description |
|---|---|---|
| id | Int | Source id. |
| config | struct | Refer to the Add sources. |
4. Example
Obtaining the list of manually added sources information.
Input Example
GET/POST /api/source/list?type=static
Output Example
{
"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 (C315230423002-2)",
"url": "100.100.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": "100.100.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. Error Code
No error code related to the API business logic. For other error codes, see Common Error Codes.