camera.ui Node SDK

Appearance

@camera.ui/sdk / sensor / FaceSensorLike

Interface: FaceSensorLike ​

Defined in: sensor/face.ts:43

Read-only proxy interface for a face sensor.

Extends ​

Properties ​

capabilities ​

readonly capabilities: string[]

Defined in: sensor/base.ts:149

Inherited from ​

SensorLike.capabilities

displayName ​

readonly displayName: string

Defined in: sensor/base.ts:147

Inherited from ​

SensorLike.displayName

id ​

readonly id: string

Defined in: sensor/base.ts:144

Inherited from ​

SensorLike.id

name ​

readonly name: string

Defined in: sensor/base.ts:146

Inherited from ​

SensorLike.name

onCapabilitiesChanged ​

readonly onCapabilitiesChanged: Observable<string[]>

Defined in: sensor/base.ts:170

Observable for capability changes. Emits the full capabilities array when capabilities change.

Inherited from ​

SensorLike.onCapabilitiesChanged

onPropertyChanged ​

readonly onPropertyChanged: Observable<PropertyChangeOf<FaceSensorProperties>>

Defined in: sensor/face.ts:47

Property change observable narrowed to face properties.

Overrides ​

SensorLike.onPropertyChanged

pluginId? ​

readonly optional pluginId?: string

Defined in: sensor/base.ts:148

Inherited from ​

SensorLike.pluginId

type ​

readonly type: Face

Defined in: sensor/face.ts:45

Sensor type discriminant.

Overrides ​

SensorLike.type

Methods ​

getValue() ​

Call Signature ​

getValue(property): boolean | undefined

Defined in: sensor/face.ts:49

Get the current value of a sensor property

Parameters ​
property ​

Detected

Returns ​

boolean | undefined

Overrides ​

SensorLike.getValue

Call Signature ​

getValue(property): FaceDetection[] | undefined

Defined in: sensor/face.ts:50

Get the current value of a sensor property

Parameters ​
property ​

Detections

Returns ​

FaceDetection[] | undefined

Overrides ​

SensorLike.getValue

Call Signature ​

getValue(property): unknown

Defined in: sensor/face.ts:51

Get the current value of a sensor property

Parameters ​
property ​

string

Returns ​

unknown

Overrides ​

SensorLike.getValue

getValues() ​

getValues(): Readonly<Record<string, unknown>>

Defined in: sensor/base.ts:154

Get a read-only snapshot of all property values

Returns ​

Readonly<Record<string, unknown>>

Inherited from ​

SensorLike.getValues

hasCapability() ​

hasCapability(capability): boolean

Defined in: sensor/base.ts:171

Parameters ​

capability ​

string

Returns ​

boolean

Inherited from ​

SensorLike.hasCapability

updateValue() ​

updateValue(property, value): void | Promise<void>

Defined in: sensor/base.ts:166

Write a property generically. Cross-process bridges (e.g. HomeKit) bind generic property names to UI characteristics and call this on a sensor proxy — the proxy forwards via RPC to the owning sensor, where control sensor classes (Light, Siren, etc.) override updateValue to dispatch to the appropriate semantic method (setOn, setActive, ...). This means plugin-side hardware-action overrides ARE honored end-to-end.

Plugin authors must not call this — they should call the semantic methods directly on the concrete sensor class.

Parameters ​

property ​

string

value ​

unknown

Returns ​

void | Promise<void>

Inherited from ​

SensorLike.updateValue