add_stream

This method allows you to add a stream to EyesOnIt which you can then monitor. When a stream is added to EyesOnIt, it is ready to be monitored, but monitoring must be initiated manually with the monitor_stream method.

Method: POST

Endpoint: /add_stream

Body

{
    "name": "Back Alley Camera",
    "stream_url": "rtsp://username:password@192.168.1.14/live0",
    "frame_rate": 15,
    "regions": [
        {
            "enabled": true,
            "name": "Back Alley",
            "polygon": [
                {
                    "x": 528,
                    "y": 175
                },
                {
                    "x": 876,
                    "y": 166
                },
                {
                    "x": 896,
                    "y": 285
                },
                {
                    "x": 506,
                    "y": 279
                },
                {
                    "x": 528,
                    "y": 175
                }
            ],
            "motion_detection": {
                "enabled": true,
                "detection_threshold": 300,
                "regular_check_frame_interval": 1,
                "backup_check_frame_interval": null
            },
            "detection_configs": [
                {
                    "class_name": "vehicle",
                    "class_threshold": 10,
                    "object_size": 150,
                    "object_descriptions": [
                        {
                            "text": "black sedan",
                            "threshold": 90,
                            "alert": true,
                            "background_prompt": false
                        },
                        {
                            "text": "vehicle",
                            "threshold": 90,
                            "alert": false,
                            "background_prompt": false
                        },
                        {
                            "text": "street building",
                            "threshold": null,
                            "alert": false,
                            "background_prompt": true
                        }
                    ],
                    "conditions": [
                        {
                            "type": "count_greater_than",
                            "count": 0,
                            "line_name": null,
                            "alert_direction": null
                        }
                    ],
                    "alert_seconds": 0.3,
                    "reset_seconds": 2.0,
                    "vms_config": null
                }
            ]
        },
    ],
    "lines": [
        {
            "name": "loading zone entrance",
            "vertices": [
                {
                    "x": 1302,
                    "y": 159
                },
                {
                    "x": 1047,
                    "y": 480
                }
            ]
        }
    ],
    "notification": {
        "phone_number": null,
        "image_notification": false,
        "genetec": {
            "webhook_event_id": null,
            "webhook_camera_uuid": null
        },
        "rest_url": null
    }
}

Body Attribute Descriptions

Name	Type	Description
name	string	a friendly name for the stream used in the EyesOnIt Web UI and in alerts
stream_url	string	the RTSP URL for the stream including credentials required to connect to the stream
frame_rate	integer	the EyesOnIt processing frame rate. This is the number of frames to process, not the source video frame rate. This attribute is optional. The default value is 5.
regions	Region[]	an array of detection regions
lines	Line[]	an array of boundary lines
notification	Notification	the notification settings for this stream

Response

{
    "success": true,
    "message": "stream rtsp://username:password@192.168.1.14/live0 successfully added",
    "data": null
}

Response Attribute Descriptions

Name	Type	Description
success	boolean	true if the operation was successful. false otherwise.
message	string	a human readable message describing the operation result
data	JSON	if the request is not successful, this field provides detailed JSON error information.