API
On this section
← All schemas

ReframeInput

Fields

accent_colorstringoptional

Colour of the spoken word, as #rrggbb. Only the highlight and pill styles use it. Omit it for the style default.

captionsenumoptional

Style of the burned-in captions, or none for no captions.

AcceptsnonecleanboxedhighlightpillDefaults to "none".
video_urlurlrequired

URL of a landscape video with both a video and an audio track, up to 10 minutes and 4 GB.

Must be an http(s) URL.

JSON Schema

ReframeInput.json
{
  "additionalProperties": false,
  "properties": {
    "$schema": {
      "description": "A URL to the JSON Schema for this object.",
      "examples": [
        "https://api.veed.io/schemas/ReframeInput.json"
      ],
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "accent_color": {
      "description": "Colour of the spoken word, as #rrggbb. Only the highlight and pill styles use it. Omit it for the style default.",
      "examples": [
        "#ff0066"
      ],
      "pattern": "^#[0-9a-fA-F]{6}$",
      "type": "string"
    },
    "captions": {
      "default": "none",
      "description": "Style of the burned-in captions, or none for no captions.",
      "enum": [
        "none",
        "clean",
        "boxed",
        "highlight",
        "pill"
      ],
      "examples": [
        "boxed"
      ],
      "type": "string"
    },
    "video_url": {
      "description": "URL of a landscape video with both a video and an audio track, up to 10 minutes and 4 GB.",
      "examples": [
        "https://static-assets.veed.io/api-examples/reframe-input.mp4"
      ],
      "format": "uri",
      "maxLength": 8192,
      "minLength": 1,
      "pattern": "^[Hh][Tt][Tt][Pp][Ss]?://",
      "patternDescription": "an http(s) URL",
      "type": "string"
    }
  },
  "required": [
    "video_url"
  ],
  "type": "object"
}