Skip to content

@camera.ui/sdk / camera / DetectionEvent

Interface: DetectionEvent

Defined in: camera/events.ts:109

Aggregated detection event with lifecycle (start → update → end). Groups individual sensor detections into structured events.

Properties

cameraId

cameraId: string

Defined in: camera/events.ts:113

Camera that produced this event


endTime?

optional endTime?: number

Defined in: camera/events.ts:119

Event end time (Unix ms, only when ended)


expectedEndTime?

optional expectedEndTime?: number

Defined in: camera/events.ts:139

Expected event end time (Unix ms) — the latest dwell expiry across all currently-active triggers. Monotonically non-decreasing during the event lifetime. Updated on each update / segment-* message.


id

id: string

Defined in: camera/events.ts:111

Unique event ID


lastUpdate

lastUpdate: number

Defined in: camera/events.ts:121

Last activity timestamp (Unix ms)


segmentIndex?

optional segmentIndex?: number

Defined in: camera/events.ts:133

Index of the segment in segments[0] for segment-* messages.


segments

segments: EventSegment[]

Defined in: camera/events.ts:131

Detection segments (object detection phases). For segment-* messages: contains only the current segment. For start/end messages: empty.


startTime

startTime: number

Defined in: camera/events.ts:117

Event start time (Unix ms)


state

state: DetectionEventState

Defined in: camera/events.ts:115

Event lifecycle state


thumbnail?

optional thumbnail?: Buffer<ArrayBufferLike>

Defined in: camera/events.ts:145

Full-frame downscaled JPEG captured at event start. Inline only on the first message that delivers it (start or the first update); the NVR plugin persists it and clients fetch it on demand via getEventThumbnails.


triggers

triggers: EventTrigger[]

Defined in: camera/events.ts:125

Event triggers (motion/audio)


types

types: string[]

Defined in: camera/events.ts:123

Detection types present in this event (for filtering)