Get information about a stream: Stream.Get

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 details objects for the given camera

result{}: any

No description

POST /api/

JSON

{
  "jsonrpc": "2.0",
  "method": "Stream.Get",
  "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.Get",
  "params": {
    "camera_uuid": [
      "stream_uuid"
    ]
  },
  "id": 123
}'

200 OK

JSON

{
  "jsonrpc": "2.0",
  "result": {
    "camera_uuid": {
      "stream_uuid": {
        "access": "private",
        "address": "192.168.204.30",
        "atime": 1771136134,
        "audio": {
          "codec": "PCMU",
          "enable": false
        },
        "buffer": false,
        "camera": "camera_uuid",
        "capture": {
          "enable": "always:full"
        },
        "cluster": {
          "primary": "labnsmse3.aivp.io"
        },
        "ctime": 1770899687,
        "dvr": {
          "capacity": -1,
          "duration": 86400,
          "enable": "always:full",
          "init": true,
          "location": "/storage/",
          "priority": 0,
          "quota": 0,
          "ranges": 4,
          "recorder": "persistent",
          "size": 66857133122
        },
        "enable": true,
        "error": {
          "msg": "",
          "no": 0
        },
        "kind": "primary",
        "live": {
          "enable": "always:full"
        },
        "priority": 0,
        "reconnects": {
          "attempt": 0,
          "limit": 500,
          "timeout": 0,
          "total": 0
        },
        "source": "rtsp://192.168.204.30:554/0",
        "state": "active",
        "stime": 1770899687,
        "subscribers": 3,
        "type": "capture",
        "uid": "stream_uuid",
        "video": {
          "bitrate": 1661666,
          "codec": "H264",
          "enable": true,
          "fps": 26,
          "height": 1080,
          "width": 1920
        }
      }
    }
  },
  "id": 123
}

400 Bad Request

JSON

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

500 Internal Server Error

Server error