Skip to content

@camera.ui/sdk / camera / AlertZone

Interface: AlertZone ​

Defined in: camera/detection.ts:123

Alert zone configuration. Never filters detections: a label selected here only sends push notifications while an object of that label is inside the zone.

Properties ​

color ​

color: string

Defined in: camera/detection.ts:145

Zone display color (hex).


faces? ​

optional faces?: string[]

Defined in: camera/detection.ts:136

Faces that may push from inside this zone. Undefined leaves faces out of the decision, an empty list lets every recognized face push, otherwise only the listed identities do. unknown covers everyone the recognition could not name, including people whose face was never captured.


labels ​

labels: ("motion" | "audio" | "person" | "vehicle" | "animal")[]

Defined in: camera/detection.ts:129

Labels that alert from inside this zone (empty = every label alerts here).


match ​

match: AlertZoneMatch

Defined in: camera/detection.ts:143

When an object counts as inside. Default: contain.


name ​

name: string

Defined in: camera/detection.ts:125

Zone display name.


plates? ​

optional plates?: string[]

Defined in: camera/detection.ts:141

Plates that may push from inside this zone, same rules as AlertZone.faces. Plates are OCR text, so the list is free-form rather than picked from a roster.


points ​

points: Point[]

Defined in: camera/detection.ts:127

Polygon points (0-100 percentage coordinates).