get_stream_details

This method gets the configuration values that were provided to the add_stream endpoint for a specific stream.

Method: POST

Endpoint: /get_stream_details

Body

{
	"stream_url": "rtsp://192.168.1.54/live0",
}

Body Attribute Descriptions

Name	Type	Description
stream_url	string	the URL of the stream for which to retrieve details. This URL must exactly match the streamUrl provided to the add_stream endpoint.

Response

{
    "success": true,
    "message": null,
    "data": {
        "stream": {
            "name": "Back Alley Camera",
            "stream_url": "rtsp://username:password@192.168.1.14/live0",
            "frame_rate": 15,
            "status": "MONITORING",
            "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
            }
        }
    }
}

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.

Data Object Attributes

The data object contains a stream object with the following 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 as provided to the add_stream endpoint
frame_rate	integer	the frame rate for the stream.
status	string	the 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.
regions	Region[]	an array of detection regions for the stream
lines	Line[]	an array of boundary lines for the stream
notification	Notification	the notification configuration for this stream