Skip to content

OVM Metadata Schema ​

Reference for the Zod-validated metadata structure in .ovm interactive video files.

Schema Overview ​

OVM metadata extends the core slot definitions to support temporal motion tracking (keyframes) and video-specific metadata.

Top-Level Fields ​

FieldTypeRequiredDescription
ovm_versionstringFormat identifier (e.g. "3.0")
versionstringSchema version
ovm_idstringUnique ID for document tracking
creator_user_idstringCreator identifier
metadataobjectVideo properties: { fps: number, resolution: [w, h] }
slotsSlot[]Interactive overlay definitions
zonesZone[]Container zones

Temporal Tracking Data (tracking_data) ​

For video overlays, each slot contains an array of keyframes tracking physical motion: [time, x1, y1, x2, y2, x3, y3, x4, y4, cx, cy]

  • time: Time offset in seconds.
  • x1, y1 ... x4, y4: Quadrilateral bounding box corners (normalized 0-100).
  • cx, cy: Center coordinate.

Example JSON ​

json
{
  "ovm_version": "3.0",
  "version": "3.0",
  "ovm_id": "vid_lmn456tuv",
  "metadata": {
    "fps": 30,
    "resolution": [1920, 1080]
  },
  "slots": [
    {
      "id": "interactive_overlay_1",
      "content": {
        "en": "View Details",
        "es": "Ver Detalles"
      },
      "style": {
        "color": "#ffffff",
        "fontSize": "1.2rem"
      },
      "tracking_data": [
        [0.0, 10.0, 20.0, 15.0, 20.0, 15.0, 25.0, 10.0, 25.0, 12.5, 22.5],
        [5.0, 12.0, 22.0, 17.0, 22.0, 17.0, 27.0, 12.0, 27.0, 14.5, 24.5]
      ]
    }
  ]
}