CaptionDestinationSettings

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mediaconvert/refs/heads/main/json-schema/mediaconvert-api-caption-destination-settings-schema.json",
  "title": "CaptionDestinationSettings",
  "description": "Settings related to one captions tab on the MediaConvert console. In your job JSON, an instance of captions DestinationSettings is equivalent to one captions tab in the console. Usually, one captions tab corresponds to one output captions track. Depending on your output captions format, one tab might correspond to a set of output captions tracks. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html.",
  "type": "object",
  "properties": {
    "BurninDestinationSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BurninDestinationSettings"
        },
        {
          "xml": {
            "name": "burninDestinationSettings"
          },
          "description": "Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN."
        }
      ]
    },
    "DestinationType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CaptionDestinationType"
        },
        {
          "xml": {
            "name": "destinationType"
          },
          "description": "Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Note that your choice of video output container constrains your choice of output captions format. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. If you are using SCTE-20 and you want to create an output that complies with the SCTE-43 spec, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20)."
        }
      ]
    },
    "DvbSubDestinationSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DvbSubDestinationSettings"
        },
        {
          "xml": {
            "name": "dvbSubDestinationSettings"
          },
          "description": "Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to DVB_SUB."
        }
      ]
    },
    "EmbeddedDestinationSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EmbeddedDestinationSettings"
        },
        {
          "xml": {
            "name": "embeddedDestinationSettings"
          },
          "description": "Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded or ancillary) captions. Set up embedded captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED."
        }
      ]
    },
    "ImscDestinationSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImscDestinationSettings"
        },
        {
          "xml": {
            "name": "imscDestinationSettings"
          },
          "description": "Settings related to IMSC captions. IMSC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to IMSC."
        }
      ]
    },
    "SccDestinationSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SccDestinationSettings"
        },
        {
          "xml": {
            "name": "sccDestinationSettings"
          },
          "description": "Settings related to SCC captions. SCC is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SCC."
        }
      ]
    },
    "SrtDestinationSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SrtDestinationSettings"
        },
        {
          "xml": {
            "name": "srtDestinationSettings"
          },
          "description": "Settings related to SRT captions. SRT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SRT."
        }
      ]
    },
    "TeletextDestinationSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TeletextDestinationSettings"
        },
        {
          "xml": {
            "name": "teletextDestinationSettings"
          },
          "description": "Settings related to teletext captions. Set up teletext captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/teletext-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TELETEXT."
        }
      ]
    },
    "TtmlDestinationSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TtmlDestinationSettings"
        },
        {
          "xml": {
            "name": "ttmlDestinationSettings"
          },
          "description": "Settings related to TTML captions. TTML is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to TTML."
        }
      ]
    },
    "WebvttDestinationSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WebvttDestinationSettings"
        },
        {
          "xml": {
            "name": "webvttDestinationSettings"
          },
          "description": "Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to WebVTT."
        }
      ]
    }
  }
}