Scene Controller API Reference#

Version: 1.3.0

Overview#

scenescape/regulated/scene/{scene_id}

Analytics service publishes regulated track data, 6

scenescape/data/region/{scene_id}/{region_id}/{thing_type}

Analytics service publishes the subset of tracked objects currently inside a region, 8

scenescape/event/{region_type}/{scene_id}/{region_id}/{event_type}

Analytics service publishes scene event messages, 10

scenescape/data/scene/{scene_id}/{thing_type}

Scene Controller publishes unregulated track data, 4

MQTT Channels#

scenescape/data/camera/{camera_id}
parameters
camera_id
description:
Camera identifier
schema
type:
string
scenescape/data/camera/{camera_id}
subscribe
summary:
Scene Controller subscribes to live camera data
message
payload
type:
object
properties
timestamp
type:
string
format:
date-time
debug_timestamp_end
type:
string
format:
date-time
debug_mac
type:
string
id
type:
string
objects
type:
object
additionalProperties
type:
array
items
type:
object
rate
type:
number
minimum:
0
intrinsics
type:
object
properties
fx
type:
number
fy
type:
number
cx
type:
number
cy
type:
number
distortion
type:
object
description:
Lens distortion coefficients keyed by name.
properties
k1
type:
number
k2
type:
number
p1
type:
number
p2
type:
number
k3
type:
number
scenescape/data/scene/{scene_id}/{thing_type}
parameters
scene_id
description:
Scene identifier
schema
type:
string
thing_type
description:
Type of object (e.g., person, car)
schema
type:
string
scenescape/data/scene/{scene_id}/{thing_type}
publish
summary:
Scene Controller publishes unregulated track data
message
payload
type:
object
properties
timestamp
type:
string
format:
date-time
id
type:
string
name
type:
string
rate
type:
number
minimum:
0
unique_detection_count
type:
integer
minimum:
0
objects
type:
array
description:
Array of tracked scene objects. Each object includes fields such as `id`, `translation`, `velocity`, `visibility`, `metadata`, and more.
items
type:
object