Skip to content
EyesOnItDocumentation6.1

StreamResponse

Fields

Section titled “Fields”
Field Type Required Description and constraints
id string (uuid) Yes
revision integer Yes minimum 1.0
name string Yes
location string or null Yes
description string or null Yes
externalId string or null Yes
tags object with string values Yes
timeZone string Yes
sourceKind string Yes values "rtsp", "http", "file", "device", "unknown"
fileSource FileSourceBody or null No
sourceStartTimeMs integer or null No
sourceEndTimeMs integer or null No
sourceFilename string or null No
pinnedNodeId string or null No
sourceRunId string (uuid) or null No
sourcePositionMs integer or null No
sourceDurationMs integer or null No
sourceCompletedAt string (date-time) or null No
sourceWidth integer or null No
sourceHeight integer or null No
configurationAccess boolean No default true
analyticsAccess boolean No default false
managedEdgeRecording boolean No default false
captureRetired boolean No default false
archiveDismissed boolean No default false
state StreamState Yes
stateReason string or null Yes
targetAnalyzedFps number Yes
enabled boolean Yes
processingResolution VideoResolutionPolicyModel Yes
scene StreamSceneModel Yes
recording LocalRecordingPolicyModel Yes
archiveIndexing ArchiveIndexingPolicyModel Yes
faceRecognition FaceRecognitionPolicyModel Yes

Additional properties are rejected by this schema.

JSON schema

Section titled “JSON schema”
{
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "title": "Id"
    },
    "revision": {
      "type": "integer",
      "minimum": 1.0,
      "title": "Revision"
    },
    "name": {
      "type": "string",
      "title": "Name"
    },
    "location": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Location"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "externalId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Externalid"
    },
    "tags": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object",
      "title": "Tags"
    },
    "timeZone": {
      "type": "string",
      "title": "Timezone"
    },
    "sourceKind": {
      "type": "string",
      "enum": [
        "rtsp",
        "http",
        "file",
        "device",
        "unknown"
      ],
      "title": "Sourcekind"
    },
    "fileSource": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/FileSourceBody"
        },
        {
          "type": "null"
        }
      ]
    },
    "sourceStartTimeMs": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sourcestarttimems"
    },
    "sourceEndTimeMs": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sourceendtimems"
    },
    "sourceFilename": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sourcefilename"
    },
    "pinnedNodeId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pinnednodeid"
    },
    "sourceRunId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sourcerunid"
    },
    "sourcePositionMs": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Sourcepositionms"
    },
    "sourceDurationMs": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Sourcedurationms"
    },
    "sourceCompletedAt": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sourcecompletedat"
    },
    "sourceWidth": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 16384.0,
          "minimum": 1.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Sourcewidth"
    },
    "sourceHeight": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 16384.0,
          "minimum": 1.0
        },
        {
          "type": "null"
        }
      ],
      "title": "Sourceheight"
    },
    "configurationAccess": {
      "type": "boolean",
      "title": "Configurationaccess",
      "default": true
    },
    "analyticsAccess": {
      "type": "boolean",
      "title": "Analyticsaccess",
      "default": false
    },
    "managedEdgeRecording": {
      "type": "boolean",
      "title": "Managededgerecording",
      "default": false
    },
    "captureRetired": {
      "type": "boolean",
      "title": "Captureretired",
      "default": false
    },
    "archiveDismissed": {
      "type": "boolean",
      "title": "Archivedismissed",
      "default": false
    },
    "state": {
      "$ref": "#/components/schemas/StreamState"
    },
    "stateReason": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Statereason"
    },
    "targetAnalyzedFps": {
      "type": "number",
      "title": "Targetanalyzedfps"
    },
    "enabled": {
      "type": "boolean",
      "title": "Enabled"
    },
    "processingResolution": {
      "$ref": "#/components/schemas/VideoResolutionPolicyModel"
    },
    "scene": {
      "$ref": "#/components/schemas/StreamSceneModel"
    },
    "recording": {
      "$ref": "#/components/schemas/LocalRecordingPolicyModel"
    },
    "archiveIndexing": {
      "$ref": "#/components/schemas/ArchiveIndexingPolicyModel"
    },
    "faceRecognition": {
      "$ref": "#/components/schemas/FaceRecognitionPolicyModel"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "id",
    "revision",
    "name",
    "location",
    "description",
    "externalId",
    "tags",
    "timeZone",
    "sourceKind",
    "state",
    "stateReason",
    "targetAnalyzedFps",
    "enabled",
    "processingResolution",
    "scene",
    "recording",
    "archiveIndexing",
    "faceRecognition"
  ],
  "title": "StreamResponse"
}
Section titled “Related models”
Image preview