Video JSON Format
- 03 Jun 2024
- Print
- DarkLight
- PDF
Video JSON Format
- Updated On 03 Jun 2024
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
This page describes Video JSON, a data format for describing Video data in JavaScript Object Notation (JSON).
This JSON code includes the entity's data related to our software and its metadata.
The Video Annotation JSON file records KeyFrames and automated frames, not reflected frames.
In other words, an annotation in a specific frame that has not changed since the previous frame is not recorded in the JSON file. If the annotation is not the same as in the previous frame (for example, due to change in position, label, attribute, etc.), the annotation is recorded in the JSON file.
- Read more about different types of frames at Understanding KeyFrames, Interpolation, and Tracking.
- To download the JSON file of an item’s annotations, see Export selected/queried items.
Important
Dataloop recommends you read frame through the SDK, as it allows you to read annotations at any frame/point in time, even in reflected frames (which are not recorded in the JSON).
Video JSON Format
annotations": [
{
"id": "64c1212ea3437caa020724c2",
"datasetId": "64903809e358489517d0927f",
"itemId": "6490382b56ff3d06b33ba7db",
"url": "https://gate.dataloop.ai/api/v1/annotations/64c1212ea3437caa020724c2",
"item": "https://gate.dataloop.ai/api/v1/items/6490382b56ff3d06b33ba7db",
"dataset": "https://gate.dataloop.ai/api/v1/datasets/64903809e358489517d0927f",
"type": "box",
"label": "Body BB",
"attributes": [],
"metadata": {
"user": {},
"system": {
"status": null,
"startTime": 0,
"endTime": 54.33154787931788,
"frame": 0,
"endFrame": 618,
"snapshots_": [
{
"fixed": true,
"frame": 15,
"objectVisible": false,
"data": [
{
"x": 636.2031034482759,
"y": 606.0389655172414,
"z": 0
},
{
"x": 779.3031034482758,
"y": 925.0089655172415,
"z": 0
}
],
"label": "Body BB",
"attributes": [],
"namedAttributes": {}
}
],
"promptId": null,
"parentId": null,
"clientId": "ec04dbb6-b85f-44b6-90fe-256cbb697fd8",
"automated": false,
"objectId": "512",
"attributes": {},
"system": false,
"itemLinks": [],
"openAnnotationVersion": "1.65.0-prod.9",
"recipeId": "6490380a270b1d5a6bfff5ab"
}
},
"creator": "lior@dataloop.ai",
"createdAt": "2023-07-26T13:35:42.877Z",
"updatedBy": "lior@dataloop.ai",
"updatedAt": "2023-07-26T13:47:40.521Z",
"hash": "149d6e93bc24e0de9e1e1a8637470824eb532563",
"source": "ui",
"coordinates": [
{
"x": 522.41,
"y": 593.97,
"z": 0
},
{
"x": 665.51,
"y": 912.94,
"z": 0
}
]
}
Video JSON Fields Description
| Key Name | Definition | Parent Key |
|---|---|---|
| id | Annotation id | annotations |
| datasetId | Dataset id | annotations |
| itemId | Id of the item | annotations |
| url | API URL of the annotation | annotations |
| item | API URL of the item | annotations |
| dataset | API URL of the dataset | annotations |
| type | Annotation type | annotations |
| label | Annotation label | annotations |
| attributes | Annotation attributes | annotations |
| metadata | Information about the annotation | annotations |
| user | Metadata added by user via SDK | metadata |
| system | Annotation system information | metadata |
| status | Annotation status (e.g., null/issue/review) | system |
| startTime | Start time of the annotation in the video | system |
| endTime | End time of the annotation in the video | system |
| frame | Frame when the annotation appears in the video | system |
| endFrame | Last frame the annotation appears in the video | system |
| snapshots_ | Snapshot information relevant to video annotation | system |
| fixed | Shows if the frame is a fixed frame | snapshots_ |
| frame | Snapshot frame number | snapshots_ |
| objectVisible | Status of annotation (true = visible, false = hidden) | snapshots_ |
| data | Coordination in each snapshot | snapshots_ |
| label | Snapshot label | snapshots_ |
| attributes | Snapshots attributes | snapshots_ |
| namedAttributes | attributes that appear on all annotations | snapshots_ |
| promptId | ||
| parentId | Id of parent annotation | system |
| clientId | Annotation created in UI (clientId when not saved) | system |
| automated | True = Annotation created by automation process | system |
| objectId | Sequential mark for annotations | system |
| attributes | Information about the annotation attributes | system |
| system | Shows if annotation is a system annotation | system |
| itemLinks | The connection between ‘snapshot’ annotation (like snapping a frame from a video) to the newly created image item. | system |
| openAnnotationVersion | Platform version | system |
| recipeId | Id of the recipe | system |
| creator | User who created the annotation | annotations |
| createdAt | Date and time when annotation was created | annotations |
| updatedBy | User who updated the annotation | annotations |
| updatedAt | Date and time when annotation was last updated | annotations |
| hash | Used to map annotation’s data to a string | annotations |
| source | Where the annotation was created: UI/SDK | annotations |
| coordinates | Annotation position coordinates | system |