Get stream Configuration: Stream.GetConfig

Returns detailed information for the specified streams

Parameters

params: object

params{}: array

Min size: 1

List of stream UIDs to get information for

params{}...

params{}[]: Uid aka string

Pattern: ^[a-zA-Z0-9_-]+$

Unique identifier used throughout the system

Result

result: object

Stream objects for the given camera

result{}: any

No description

POST /api/

JSON

{
  "jsonrpc": "2.0",
  "method": "Stream.GetConfig",
  "params": {
    "camera_uuid": [
      "stream_uuid"
    ]
  },
  "id": 123
}

cURL

Bash

curl -k --request POST \
    --url 'https://your-domain/api/' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <api-authorization-token>' \
    --data '{
  "jsonrpc": "2.0",
  "method": "Stream.GetConfig",
  "params": {
    "camera_uuid": [
      "stream_uuid"
    ]
  },
  "id": 123
}'

200 OK

JSON

{
  "jsonrpc": "2.0",
  "result": {
    "camera_uuid": {
      "stream_uuid": {
        "access": {
          "allow": "private",
          "whitelist": []
        },
        "buffer": false,
        "camera": "camera_uuid",
        "capture": {
          "enable": "always:full"
        },
        "cluster": {
          "primary": "labnsmse3.aivp.io"
        },
        "dvr": {
          "buffer": "1M",
          "duration": 86400,
          "enable": "always:full",
          "location": "/storage",
          "quota": "0G"
        },
        "enable": true,
        "live": {
          "enable": "always:full"
        },
        "priority": 0,
        "reconnect": {
          "interval": 10,
          "period": 1800,
          "total": 500
        },
        "secure": null,
        "source": "rtsp://admin:123Camera_stand@192.168.204.30:554/0",
        "tracks": [
          "video"
        ]
      }
    }
  },
  "id": 123
}

400 Bad Request

JSON

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32601,
    "message": "Method not found"
  },
  "id": 123
}

500 Internal Server Error

Server error