Amazon MediaLive · Schema

CaptionRectangle

Caption Rectangle

BroadcastingMedia ProcessingMedia

Properties

Name Type Description
Height object
LeftOffset object
TopOffset object
Width object
View JSON Schema on GitHub

JSON Schema

medialive-api-caption-rectangle-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-medialive/refs/heads/main/json-schema/medialive-api-caption-rectangle-schema.json",
  "title": "CaptionRectangle",
  "description": "Caption Rectangle",
  "type": "object",
  "properties": {
    "Height": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__doubleMin0Max100"
        },
        {
          "xml": {
            "name": "height"
          },
          "description": "See the description in leftOffset.\nFor height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \\\"80\\\" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less.\nThis field corresponds to tts:extent - Y in the TTML standard."
        }
      ]
    },
    "LeftOffset": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__doubleMin0Max100"
        },
        {
          "xml": {
            "name": "leftOffset"
          },
          "description": "Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages.\nIf you specify a value for one of these fields, you must specify a value for all of them.\nFor leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \\\"10\\\" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame.\nThis field corresponds to tts:origin - X in the TTML standard."
        }
      ]
    },
    "TopOffset": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__doubleMin0Max100"
        },
        {
          "xml": {
            "name": "topOffset"
          },
          "description": "See the description in leftOffset.\nFor topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \\\"10\\\" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame.\nThis field corresponds to tts:origin - Y in the TTML standard."
        }
      ]
    },
    "Width": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__doubleMin0Max100"
        },
        {
          "xml": {
            "name": "width"
          },
          "description": "See the description in leftOffset.\nFor width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \\\"80\\\" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less.\nThis field corresponds to tts:extent - X in the TTML standard."
        }
      ]
    }
  },
  "required": [
    "TopOffset",
    "Height",
    "Width",
    "LeftOffset"
  ]
}