`VideoBackgroundRemovalInput`

Fields

output_codecenumoptional

Output encoding. vp9 (the default) yields a single webm video with an alpha channel; h264 yields two files (the RGB video and an alpha matte) and is recommended for better RGB quality.

vp9h264Defaults to "vp9".

refine_foreground_edgesbooleanoptional

Improves the quality of the extracted subject's edges.

Defaults to true.

subject_is_personbooleanoptional

Set to false when the subject is not a person.

Defaults to true.

video_urlurlrequired

URL of the source video to remove the background from.

Must be an http(s) URL.

JSON Schema

VideoBackgroundRemovalInput.json

{
  "additionalProperties": false,
  "properties": {
    "$schema": {
      "description": "A URL to the JSON Schema for this object.",
      "examples": [
        "https://api.veed.io/schemas/VideoBackgroundRemovalInput.json"
      ],
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "output_codec": {
      "default": "vp9",
      "description": "Output encoding. vp9 (the default) yields a single webm video with an alpha channel; h264 yields two files (the RGB video and an alpha matte) and is recommended for better RGB quality.",
      "enum": [
        "vp9",
        "h264"
      ],
      "examples": [
        "vp9"
      ],
      "type": "string"
    },
    "refine_foreground_edges": {
      "default": true,
      "description": "Improves the quality of the extracted subject's edges.",
      "type": "boolean"
    },
    "subject_is_person": {
      "default": true,
      "description": "Set to false when the subject is not a person.",
      "type": "boolean"
    },
    "video_url": {
      "description": "URL of the source video to remove the background from.",
      "examples": [
        "https://media.veed.io/in.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"
}