@camera.ui/sdk / sensor / SensorMeta
Interface: SensorMeta ​
Defined in: sensor/meta.ts:104
Metadata for a sensor type, declared alongside its class via defineSensor.
Collected into the sensor registry, from which plugin assignment keys and the host's per-type tables derive, so each type is described once instead of in several parallel tables that drift apart.
Properties ​
assignmentKey ​
readonlyassignmentKey:string
Defined in: sensor/meta.ts:110
Key under which a camera stores its assignment for this type.
cameraBound? ​
readonlyoptionalcameraBound?:boolean
Defined in: sensor/meta.ts:118
Sensor only makes sense attached to a camera, never standalone.
cascadeTrigger? ​
readonlyoptionalcascadeTrigger?:SensorCascadeTrigger
Defined in: sensor/meta.ts:122
Condition under which this sensor arms an automation cascade.
category ​
readonlycategory:SensorCategory
Defined in: sensor/meta.ts:108
Role the sensor plays: read-only, control, trigger or info.
isDetectionType ​
readonlyisDetectionType:boolean
Defined in: sensor/meta.ts:114
Whether the sensor analyzes frames and reports detections.
multiProvider ​
readonlymultiProvider:boolean
Defined in: sensor/meta.ts:112
Whether a camera can have several sensors of this type at once.
properties ​
readonlyproperties:Readonly<Record<string,SensorPropertySpec>>
Defined in: sensor/meta.ts:116
Value description per property, keyed by property name.
propertyCapabilities? ​
readonlyoptionalpropertyCapabilities?:Readonly<Record<string,string>>
Defined in: sensor/meta.ts:124
Property name to the capability that has to be present for it.
semantics? ​
readonlyoptionalsemantics?:SensorSemantics|null
Defined in: sensor/meta.ts:128
Transport-independent meaning, or null when the type has none.
shortcutable? ​
readonlyoptionalshortcutable?:boolean
Defined in: sensor/meta.ts:120
Sensor can be pinned as a UI shortcut.
type ​
readonlytype:SensorType
Defined in: sensor/meta.ts:106
Sensor type this metadata describes.
virtual? ​
readonlyoptionalvirtual?:SensorVirtualDefaults
Defined in: sensor/meta.ts:126
Defaults used when the user creates a virtual sensor of this type.