FramesManifest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ffpipe-dev/json-schema/ffpipe-dev-frames-manifest-schema.json",
  "title": "FramesManifest",
  "description": "Index of everything one frames job produced. Read `source.width`/`height` (DISPLAY dimensions, post-rotation) as the size the frames actually depict; the coded pair is reported separately and must not be compared against the frames.",
  "x-generated": "2026-11-07",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ffpipe-dev-openapi.json#/components/schemas/FramesManifest",
  "type": "object",
  "required": [
    "frame_count",
    "frames"
  ],
  "additionalProperties": true,
  "properties": {
    "source": {
      "type": "object",
      "additionalProperties": true,
      "description": "The input as we measured it: duration, display width/height, coded width/height, fps, codec, rotation, HDR flag."
    },
    "params": {
      "type": "object",
      "additionalProperties": true,
      "description": "Echo of the sampling parameters this job ran with, so a stored manifest explains itself."
    },
    "frame_count": {
      "type": "integer",
      "description": "How many frames the job produced."
    },
    "frames": {
      "type": "array",
      "description": "One entry per frame, ordered by time.",
      "items": {
        "type": "object",
        "required": [
          "index",
          "pts_time",
          "url"
        ],
        "additionalProperties": true,
        "properties": {
          "index": {
            "type": "integer",
            "description": "Array position, the number in the frame's file name, and the `{index}` of its download route."
          },
          "pts_time": {
            "type": "number",
            "description": "Seconds in the SOURCE timeline (a window offset is added back in for you)."
          },
          "url": {
            "type": "string",
            "format": "uri",
            "description": "Download URL for this frame: `GET /v1/jobs/{id}/frames/{index}` on this gateway, carrying the same ownership token — just GET it."
          },
          "width": {
            "type": "integer"
          },
          "height": {
            "type": "integer"
          }
        }
      }
    }
  }
}