Skip to main content

Stream

Encapsulates data for a a complete video stream definition for video monitoring and alerting).

Example

{
"name": "Street Camera",
"stream_url": "rtsp://username:password@192.168.1.13/live0",
"frame_rate": 5,
"regions": [...],
"lines": [...],
"notification": {...}
"status": "MONITORING"
}

Attributes

NameTypeDescription
namestringthe friendly name for this video stream used in the EyesOnIt Web UI and in alert notification
stream_urlstringthe RTSP URL for the stream including credentials required to connect to the stream
frame_rateintegerthe number of frames per second to process from the video stream
regionsarray of Regionthe detection regions for this video stream
linesarray of Lineoptional. The lines for this video stream. If no lines are used, this should be null.
notificationNotificationThe notification configuration for this video stream.
statusstringprovided as output from EyesOnIt. The value can be "IDLE" when a stream is not being monitored, "MONITORING" when a stream is being
monitored by there is no active alert, or "ALERTING" when an alert condition has been met and not yet reset.