Skip to content

@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 ​

readonly assignmentKey: string

Defined in: sensor/meta.ts:110

Key under which a camera stores its assignment for this type.


cameraBound? ​

readonly optional cameraBound?: boolean

Defined in: sensor/meta.ts:118

Sensor only makes sense attached to a camera, never standalone.


cascadeTrigger? ​

readonly optional cascadeTrigger?: SensorCascadeTrigger

Defined in: sensor/meta.ts:122

Condition under which this sensor arms an automation cascade.


category ​

readonly category: SensorCategory

Defined in: sensor/meta.ts:108

Role the sensor plays: read-only, control, trigger or info.


isDetectionType ​

readonly isDetectionType: boolean

Defined in: sensor/meta.ts:114

Whether the sensor analyzes frames and reports detections.


multiProvider ​

readonly multiProvider: boolean

Defined in: sensor/meta.ts:112

Whether a camera can have several sensors of this type at once.


properties ​

readonly properties: Readonly<Record<string, SensorPropertySpec>>

Defined in: sensor/meta.ts:116

Value description per property, keyed by property name.


propertyCapabilities? ​

readonly optional propertyCapabilities?: Readonly<Record<string, string>>

Defined in: sensor/meta.ts:124

Property name to the capability that has to be present for it.


semantics? ​

readonly optional semantics?: SensorSemantics | null

Defined in: sensor/meta.ts:128

Transport-independent meaning, or null when the type has none.


shortcutable? ​

readonly optional shortcutable?: boolean

Defined in: sensor/meta.ts:120

Sensor can be pinned as a UI shortcut.


type ​

readonly type: SensorType

Defined in: sensor/meta.ts:106

Sensor type this metadata describes.


virtual? ​

readonly optional virtual?: SensorVirtualDefaults

Defined in: sensor/meta.ts:126

Defaults used when the user creates a virtual sensor of this type.