Skip to main content

get_all_streams_info

This method gets summary information about all streams that are currently added to EyesOnIt.

Method: GET

Endpoint: /get_all_streams_info

Response

{
"success": true,
"message": null,
"data": {
"streams": [
{
"stream_url": "rtsp://username:username@192.168.1.14/live0",
"name": "Front Street Camera",
"status": "MONITORING"
},
{
"stream_url": "rtsp://username:password@192.168.1.12/axis-media/media.amp?videocodec=h264&camera=2",
"name": "Back Alley Camera",
"status": "ALERTING"
}
]
}
}

Response Attribute Descriptions

NameTypeDescription
successbooleantrue if the operation was successful. false otherwise.
messagestringa human readable message describing the operation result
dataJSONprovides additional JSON data about the streams added to EyesOnIt as described below

Data Object Attributes

The data object contains a "streams" array. For each stream that has been added to EyesOnIt, this data element includes an object with the following attributes:

NameTypeDescription
stream_urlstringthe RTSP URL for the stream including credentials required to connect to the stream
namestringthe friendly name for the stream as provided through the add_stream endpoint
statusstringthe status of the stream. Values can be IDLE: the stream has been added but is not being monitored, MONITORING: the stream is being monitored, ALERTING: an alert has been triggered and the alert state has not been reset.