camera.ui Node SDK

Appearance

@camera.ui/sdk / camera / PtzAutotrackSettings

Interface: PtzAutotrackSettings ​

Defined in: camera/detection.ts:204

PTZ autotracking settings: the camera follows detected objects automatically.

Properties ​

activeHours? ​

optional activeHours?: TimeWindow

Defined in: camera/detection.ts:248

Hours the camera is allowed to follow. Outside them autotracking rests.

enabled ​

enabled: boolean

Defined in: camera/detection.ts:206

Whether PTZ autotracking is enabled.

homeWaitMs ​

homeWaitMs: number

Defined in: camera/detection.ts:233

How long to wait (ms) without a target before returning home.

leadMs ​

leadMs: number

Defined in: camera/detection.ts:223

Motion prediction (0 - 4000): aim this many milliseconds ahead along the target's measured velocity, covering the time the camera needs to move and settle. 0 disables prediction.

maxTargetSize? ​

optional maxTargetSize?: number

Defined in: camera/detection.ts:246

Largest target to keep following, as a fraction of the frame height (0 - 1). Above it the object is so close that the picture says nothing, so the camera holds its position until it moves away again. 0 disables the limit.

minConfidence ​

minConfidence: number

Defined in: camera/detection.ts:210

Minimum detection confidence to track (0.3 - 1.0).

minTargetSize? ​

optional minTargetSize?: number

Defined in: camera/detection.ts:239

Smallest target to start following, as a fraction of the frame height (0 - 0.5). Below it the object is too far away to be worth a move. 0 disables the limit.

panRate ​

panRate: number

Defined in: camera/detection.ts:229

Camera pan-rate calibration (0.1 - 3): assumed pan travel at full motor speed in normalized frame-widths per second. Lower it if the camera stops short of the target, raise it if it overshoots.

returnToHome ​

returnToHome: boolean

Defined in: camera/detection.ts:231

Return to home position when no target is found for homeWaitMs.

targetLabels ​

targetLabels: string[]

Defined in: camera/detection.ts:208

Object labels to track (e.g. 'person', 'vehicle').

trackingSpeed ​

trackingSpeed: number

Defined in: camera/detection.ts:217

How aggressively the camera moves to re-center the target (1 - 5). Higher reaches full pan/tilt speed at a smaller off-center error.

triggerDeadZone ​

triggerDeadZone: number

Defined in: camera/detection.ts:212

Dead zone around frame center (0 - 0.3). No motor command while the target is inside this zone.