Stream

A configured stream returned by stream status endpoints.

Example

{
  "stream_url": "rtsp://camera/live",
  "stream_id": "stream-001",
  "name": "Warehouse Camera 01",
  "frame_rate": 5,
  "index_for_search": true,
  "search_index_types": ["image"],
  "status": "MONITORING",
  "regions": [],
  "lines": [],
  "notification": {
    "include_image": true
  },
  "recording": {
    "enabled": false
  }
}

Fields

Field	Type	Description
stream_url	string	Stream URL.
stream_id	string	Stream identifier returned by the server.
name	string	Stream display name.
frame_rate	number	Processing frame rate.
index_for_search	boolean	Whether the stream is indexed for search.
search_index_types	string[]	Search index types built for the stream.
status	string	Stream status such as IDLE, MONITORING, or ALERTING.
regions	Region[]	Detection regions for the stream.
lines	Line[]	Configured lines for the stream.
notification	Notification	Notification settings and status.
recording	Recording	Recording settings.