camera.ui Node SDK

Appearance

@camera.ui/sdk / sensor / FaceDetectorSensor

Abstract Class: FaceDetectorSensor<TStorage> ​

Defined in: sensor/face.ts:169

Face detector that receives video frames from the backend pipeline. Extend this class and implement detectFaces for face detection and recognition.

Extends ​

Type Parameters ​

TStorage ​

TStorage extends object = Record<string, any>

Constructors ​

Constructor ​

new FaceDetectorSensor<TStorage>(name?, options?): FaceDetectorSensor<TStorage>

Defined in: sensor/face.ts:67

Parameters ​

name? ​

string = 'Face Sensor'

options? ​

SensorOptions

Returns ​

FaceDetectorSensor<TStorage>

Inherited from ​

FaceSensor.constructor

Properties ​

category ​

readonly category: Sensor = SensorCategory.Sensor

Defined in: sensor/face.ts:65

Inherited from ​

FaceSensor.category

name ​

readonly name: string

Defined in: sensor/base.ts:223

Inherited from ​

Sensor.name

onAssignmentChanged ​

readonly onAssignmentChanged: Observable<readonly string[]>

Defined in: sensor/base.ts:250

Inherited from ​

Sensor.onAssignmentChanged

onCapabilitiesChanged ​

readonly onCapabilitiesChanged: Observable<string[]>

Defined in: sensor/base.ts:242

Inherited from ​

FaceSensor.onCapabilitiesChanged

onConnectedChanged ​

readonly onConnectedChanged: Observable<boolean>

Defined in: sensor/base.ts:252

Inherited from ​

Sensor.onConnectedChanged

onPropertyChanged ​

readonly onPropertyChanged: Observable<PropertyChangeOf<FaceSensorProperties>>

Defined in: sensor/base.ts:240

Inherited from ​

FaceSensor.onPropertyChanged

type ​

readonly type: Face = SensorType.Face

Defined in: sensor/face.ts:64

Inherited from ​

FaceSensor.type

Accessors ​

assignedCameraIds ​

Get Signature ​

get assignedCameraIds(): readonly string[]

Defined in: sensor/base.ts:293

Returns ​

readonly string[]

Inherited from ​

Sensor.assignedCameraIds

assignmentLocked ​

Get Signature ​

get assignmentLocked(): boolean

Defined in: sensor/base.ts:297

Returns ​

boolean

Inherited from ​

Sensor.assignmentLocked

capabilities ​

Get Signature ​

get capabilities(): TCapability[]

Defined in: sensor/base.ts:316

Returns ​

TCapability[]

Set Signature ​

set capabilities(value): void

Defined in: sensor/base.ts:321

Set capabilities, deduplicated, and notify backend plus local listeners.

Parameters ​
value ​

TCapability[]

Returns ​

void

Inherited from ​

FaceSensor.capabilities

connected ​

Get Signature ​

get connected(): boolean

Defined in: sensor/base.ts:289

Returns ​

boolean

Inherited from ​

Sensor.connected

detected ​

Get Signature ​

get detected(): boolean

Defined in: sensor/face.ts:77

Returns ​

boolean

Inherited from ​

FaceSensor.detected

detections ​

Get Signature ​

get detections(): FaceDetection[]

Defined in: sensor/face.ts:81

Returns ​

FaceDetection[]

Inherited from ​

FaceSensor.detections

displayName ​

Get Signature ​

get displayName(): string

Defined in: sensor/base.ts:281

Returns ​

string

Inherited from ​

Sensor.displayName

id ​

Get Signature ​

get id(): string

Defined in: sensor/base.ts:269

Returns ​

string

Inherited from ​

Sensor.id

identities ​

Get Signature ​

get identities(): string[]

Defined in: sensor/face.ts:85

Returns ​

string[]

Inherited from ​

FaceSensor.identities

isAssigned ​

Get Signature ​

get isAssigned(): boolean

Defined in: sensor/base.ts:285

Returns ​

boolean

Inherited from ​

VibrationSensor.isAssigned

modelSpec ​

Get Signature ​

get abstract modelSpec(): ModelSpec

Defined in: sensor/face.ts:172

Returns ​

ModelSpec

nativeId ​

Get Signature ​

get nativeId(): string | undefined

Defined in: sensor/base.ts:273

Returns ​

string | undefined

Inherited from ​

Sensor.nativeId

origin ​

Get Signature ​

get origin(): string | undefined

Defined in: sensor/base.ts:277

Returns ​

string | undefined

Inherited from ​

VibrationSensor.origin

pluginId ​

Get Signature ​

get pluginId(): string | undefined

Defined in: sensor/base.ts:301

Returns ​

string | undefined

Inherited from ​

Sensor.pluginId

props ​

Get Signature ​

get protected props(): Readonly<TProperties>

Defined in: sensor/base.ts:546

Returns ​

Readonly<TProperties>

Inherited from ​

FaceSensor.props

storage ​

Get Signature ​

get storage(): DeviceStorage<TStorage>

Defined in: sensor/base.ts:305

Returns ​

DeviceStorage<TStorage>

Inherited from ​

FaceSensor.storage

storageSchema ​

Get Signature ​

get storageSchema(): JsonSchema[]

Defined in: sensor/base.ts:312

Returns ​

JsonSchema[]

Inherited from ​

VibrationSensor.storageSchema

Methods ​

clearDetections() ​

clearDetections(): void

Defined in: sensor/face.ts:144

Explicitly clear face detection state (detected = false, detections = []).

Returns ​

void

Example ​

ts
sensor.clearDetections();

Inherited from ​

FaceSensor.clearDetections

detectFaces() ​

abstract detectFaces(frames): Promise<FaceResult[]>

Defined in: sensor/face.ts:180

Detect faces in batch. Each frame is pre-scaled to modelSpec.input: normally a person region cropped by the upstream object detector, but the whole scene when no decoded frame is available. Must return exactly one FaceResult per input frame, in the same order.

Parameters ​

frames ​

VideoFrameData[]

Returns ​

Promise<FaceResult[]>

getValue() ​

Call Signature ​

getValue<K>(property): FaceSensorProperties[K] | undefined

Defined in: sensor/base.ts:345

Get the current value of a sensor property. Calling the generic overload with a property enum value gives a properly typed result.

Type Parameters ​
K ​

K extends keyof FaceSensorProperties

Parameters ​
property ​

K

Returns ​

FaceSensorProperties[K] | undefined

Inherited from ​

FaceSensor.getValue

Call Signature ​

getValue(property): unknown

Defined in: sensor/base.ts:346

Get the current value of a sensor property. Calling the generic overload with a property enum value gives a properly typed result.

Parameters ​
property ​

string

Returns ​

unknown

Inherited from ​

FaceSensor.getValue

getValues() ​

getValues(): Readonly<TProperties>

Defined in: sensor/base.ts:362

Get a read-only snapshot of all property values.

Returns ​

Readonly<TProperties>

Shallow copy of every property currently held by the sensor.

Example ​

ts
const snapshot = sensor.getValues();
console.log(snapshot);

Inherited from ​

FaceSensor.getValues

hasCapability() ​

hasCapability(capability): boolean

Defined in: sensor/base.ts:388

Check whether the sensor advertises a capability.

Parameters ​

capability ​

string

Capability flag to look for.

Returns ​

boolean

True if the sensor currently advertises it.

Example ​

ts
const dimmable = sensor.hasCapability('brightness');

Inherited from ​

FaceSensor.hasCapability

onStart() ​

protected onStart(): void | Promise<void>

Defined in: sensor/base.ts:651

Lifecycle hook, called once the sensor is registered and live (storage and RPC are wired up). Override it to start work whose lifetime matches the sensor's: polling loops, event subscriptions, timers.

Errors thrown here are swallowed, not logged. Handle failures inside the override. Paired 1:1 with onStop, which runs on removal, plugin shutdown or cleanup.

Returns ​

void | Promise<void>

Example ​

ts
protected override onStart(): void {
  this._timer = setInterval(() => this.poll(), 5_000);
}

Inherited from ​

FaceSensor.onStart

onStop() ​

protected onStop(): void | Promise<void>

Defined in: sensor/base.ts:664

Counterpart of onStart: tear down whatever it started, such as timers, subscriptions and external resources.

Returns ​

void | Promise<void>

Example ​

ts
protected override onStop(): void {
  if (this._timer) clearInterval(this._timer);
}

Inherited from ​

FaceSensor.onStop

reportDetections() ​

reportDetections(detected, detections?): void

Defined in: sensor/face.ts:118

Report detected faces.

  • reportDetections(true): face detected without specifics (e.g. a bare face-event from a discovery provider). The SDK synthesizes a single full-frame face detection without identity.
  • reportDetections(true, [...]): explicit face detections with identity, embedding, and/or thumbnail.
  • reportDetections(false): clear.

Parameters ​

detected ​

boolean

Whether any face is currently detected.

detections? ​

FaceDetection[]

Optional explicit face detections to publish.

Returns ​

void

Example ​

ts
import type { FaceDetection } from '@camera.ui/sdk';
sensor.reportDetections(true, [
  {
    label: 'person',
    confidence: 0.94,
    box: { x: 0.4, y: 0.2, width: 0.15, height: 0.25 },
    attribute: 'face',
    identity: 'Alice',
  } satisfies FaceDetection,
]);
sensor.reportDetections(false);

Inherited from ​

FaceSensor.reportDetections

setDisplayName() ​

setDisplayName(value): void

Defined in: sensor/base.ts:337

Set the display name (the only mutable identifier on a sensor).

Parameters ​

value ​

string

Human-readable label shown in the UI.

Returns ​

void

Example ​

ts
sensor.setDisplayName('Front Door Motion');

Inherited from ​

FaceSensor.setDisplayName

updateModelSpec() ​

updateModelSpec(): void

Defined in: sensor/base.ts:565

Re-announces the model spec, e.g. once the models finished loading.

The spec a detector reports at registration is what it knows at that moment: models that load in the background are missing from it. Call this after loading, the server replaces its copy.

Returns ​

void

Example ​

typescript
async onStart(): Promise<void> {
  await this.loadModel();
  this.updateModelSpec();
}

Inherited from ​

FaceSensor.updateModelSpec