get_streams_info

This method gets information about each stream that is currently added to EyesOnIt.

Method: GET

Endpoint: /get_streams_info

Response

[
	{
		"stream_url": "rtsp://192.168.1.54/live0",
		"name": "Street Camera",
		"status": "MONITORING",
		"regions": [
			{
				"top_left_x": 435,
				"top_left_y": 388,
				"width": 600,
				"height": 224
			}
		],
		"object_size": 210
		"prompts": [
			{
				"text": "vehicle",
				"threshold": 90,
				"confidence": 83,
				"over_threshold": false,
				"background_prompt": false
			},
			{
				"text": "driveway",
				"background_prompt": true
			}
		],
		"alerting": {
			"alert_seconds_count": 0.4,
			"reset_seconds_count": 2.0,
			"phone_number": null,
			"image_notification": false,
			"last_detection": {
				"prompt_values": {
					"vehicle": 94,
					"driveway": 82
				},
				"alerting_prompt": "vehicle",
				"alert_time": "2024-07-13 22:55:30"
			},
			"alerting": true
		},
		"efficient_detection": {
			"periodic_check_enabled": true,
			"periodic_check_seconds": 5.0,
			"motion_detection_enabled": true,
			"motion_detection_threshold": 5000,
			"motion_detection_seconds": 0.5
		},
		"bounding_box": {
			"bounding_box_enabled": true,
			"detect_people": false,
			"detect_vehicles": true,
			"detect_bags": false,
			"person_confidence_threshold": 30,
			"vehicle_confidence_threshold": 30,
			"bag_confidence_threshold": 30
		},
		"frame_rate": 5
	}
]

Response JSON Attributes

Name	Type	Description
stream_url	string	the RTSP URL for the stream including credentials required to connect to the stream
name	string	a friendly name for the stream used in the EyesOnIt Web UI and in alerts
status	string	the status of the stream. Status values are explained here.
regions	Region[]	an array of rectangle detection regions
object_size	number	the estimated object size in pixels
prompts	Prompt[]	an array of object descriptions describing objects to detect
alerting	Alerting	the alerting settings and data for this stream
efficient_detection	EfficientDetection	the motion detection settings for this stream
bounding_box	BoundingBox	the common object detection settings for this stream
frame_rate	number	the frame rate for this stream.