Skip to main content
Skip table of contents

Creating a stream

Creating a stream for analytics.

POST /api/streams/?format=json
Body
json
JSON
{
    "Collections": [
        "7318bbe8-1090-11ec-a9fc-addec8dfe22c"
    ],
    "CaseType": "face-recognition",
    "CameraGroupUid": "3625bbe8-1090-11ec-a9fc-addec8dfe22c",
    "Source": {
        "Uid": "ca64108f-bcd1-431e-8e5a-07862d0976f3",
        "Url": "rtsp://testvmsms3.<vms>.video:4554/live/d1d97b55-0564-4da6-be9f-dc2d079b8823/?token=lHHNFr0E-laDJb7o0lu5_V7VUnJlCfTtsQit1EWvLxOcWvLxOc7FiSQ9_p2ptR5GKF4rvh7UX3EB1FTthG3oR1yvDMq0-70_cBGs-IiKwLoIKUvw_syjisCI_FhPDw2XHbNRV9aql4AeO5HyUeXtd-VpLiTw~~",
        "Output": {
            "Encoding": "none",
            "FPS": 5
        }
    },
    "Pipeline": {
        "ConfigPath": "....",
        "Events": {
            "FrequencyMs": 200
        },
        "Detector": {
            "Threshold": 0.5
        },
        "Watcher": {
            "ObjectMax": [
                400,
                400
            ],
            "MaxCountObject": 2,
            "MaxTrackObject": 8,
            "FullFrameFrequency": 5
        },
        "Fences": [],
        "Areas": []
    }
}
Collectionsrequired
array

An array of collection identifiers that will be applied when processing events for this stream, if necessary.

CaseTyperequired
string

Type of analytics.

Pipelinerequired
json

Stream configuration specifying the required parameters for the analytics to work.

CameraGroupUidrequired
uid

Identifier of the camera group that multiple streams are grouped under.

Source.Uidrequired
uid

Stream identifier.

Source.Urlrequired
string

URL to retrieve the stream.

Response
200

Returns a JSON object with the identifier of the created stream.

JSON
{
                 "stream_uid": "f5fdc046-10b1-11ec-a9fc-addec8dfe22c"
            }
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.