Frame
Scene metadata for a single frame in a video stream, including all object detections present in the frame.
This schema builds on the following shared schemas:
| Property | Type | Required | Note |
|---|---|---|---|
| channel_id | Integer | Yes | Uniquely identifies a source within a single device, for example, a video or radar sensor |
| timestamp | String | Yes | According to format: YYYY-MM-DDTHH:MM:SS.MMMMMMZ |
| detections | Array of ObjectDetection | No | All object detections present in this frame |
| track_events | Array of TrackingEvent | No | Tracking events that occur at this frame\u2019s timestamp |
TrackingEvent
An event that updates or describes the state of an object track.
TrackEnded
Event indicating that tracking has been completed and that the object track will not receive any further detections.
| Property | Type | Required | Note |
|---|---|---|---|
| type | String | Yes | Value: TrackEnded |
| object_track_id | ID | Yes | Globally unique identifier |
Rename
Event indicating that one ObjectTrack refers to the same object as another ObjectTrack. It is typically emitted as a result of a positive re-identification between two ObjectTracks. The contents and length of the ObjectTracks (IDs) involved in the rename are not changed; the rename only indicates the relationship between the two.
| Property | Type | Required | Note |
|---|---|---|---|
| type | String | Yes | Value: Rename |
| from_id | ID | Yes | Globally unique identifier |
| to_id | ID | Yes | Globally unique identifier |