TextOverlayParameters

Endpoints · All schemas

Field	Required	Description
color	No	Text color in hex format
endMs	No	Overlay end time in milliseconds
position	No	See definition below
shadow	No	Draw a soft drop shadow behind the text
size	No	Font size as a percentage of video height
startMs	No	Overlay start time in milliseconds
text	Yes	string
x	Yes	Horizontal position as a percentage of video width
y	Yes	Vertical position as a percentage of video height

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: TextOverlayPosition

{
  "properties": {
    "color": {
      "default": "#ffffff",
      "description": "Text color in hex format",
      "pattern": "^#[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$",
      "type": "string"
    },
    "endMs": {
      "description": "Overlay end time in milliseconds",
      "maximum": 9007199254740991,
      "minimum": 1,
      "type": "integer"
    },
    "position": {
      "$ref": "#/components/schemas/TextOverlayPosition"
    },
    "shadow": {
      "description": "Draw a soft drop shadow behind the text",
      "type": "boolean"
    },
    "size": {
      "default": 0.06,
      "description": "Font size as a percentage of video height",
      "format": "double",
      "maximum": 0.2,
      "minimum": 0.01,
      "type": "number"
    },
    "startMs": {
      "description": "Overlay start time in milliseconds",
      "maximum": 9007199254740991,
      "minimum": 0,
      "type": "integer"
    },
    "text": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "x": {
      "description": "Horizontal position as a percentage of video width",
      "format": "double",
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    },
    "y": {
      "description": "Vertical position as a percentage of video height",
      "format": "double",
      "maximum": 1,
      "minimum": 0,
      "type": "number"
    }
  },
  "required": [
    "text",
    "x",
    "y"
  ],
  "type": "object"
}