General Captions
See JSON Examples Overview for shared project fields and general parameter rules.
General Caption
Creates a general caption with text, font, size, color, alignment, and timing.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timelines[].captionTracks[].captions[].align | Text alignment | string; for example left-vCenter, center-vCenter, or right-vCenter | center-vCenter |
timelines[].captionTracks[].captions[].color | Color | string; #AARRGGBB | #ffffffff |
timelines[].captionTracks[].captions[].duration | Timeline position or duration | integer, microseconds; normally >= 0 | 48680000 |
timelines[].captionTracks[].captions[].font | Font family | string; should match a font asset mapping | Non-empty |
timelines[].captionTracks[].captions[].fontSizeRatio | Font-size ratio | positive finite number | 0.1 |
timelines[].captionTracks[].captions[].inPoint | Timeline position or duration | integer, microseconds; normally >= 0 | 520000 |
timelines[].captionTracks[].captions[].text | Caption text | string; line breaks are supported | Non-empty |
timelines[].captionTracks[].captions[].type | Object or parameter type | string; allowed values depend on the containing object | general |
Caption Outline
Enables a caption outline and configures its color and width.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timelines[].captionTracks[].captions[].outline | Feature switch | boolean; true or false | true |
timelines[].captionTracks[].captions[].outlineColor | Color | string; #AARRGGBB | #ffdf1010 |
timelines[].captionTracks[].captions[].outlineWidth | Style parameter | finite number; limits depend on the caption renderer | 80 |
Caption Shadow
Enables a caption shadow and configures its color, feathering, and offsets.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timelines[].captionTracks[].captions[].shadow | Feature switch | boolean; true or false | true |
timelines[].captionTracks[].captions[].shadowColor | Color | string; #AARRGGBB | #c1ca1a1a |
timelines[].captionTracks[].captions[].shadowFeather | Style parameter | finite number; limits depend on the caption renderer | 40 |
timelines[].captionTracks[].captions[].shadowOffsetX | Style parameter | finite number; limits depend on the caption renderer | 3 |
timelines[].captionTracks[].captions[].shadowOffsetY | Style parameter | finite number; limits depend on the caption renderer | -1 |
Adaptive Caption Animation
Scales the caption animation duration to match the caption duration.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timelines[].captionTracks[].captions[].enableSpeed | Feature switch | boolean; true or false | true |
timelines[].captionTracks[].captions[].fxParams[].key | Effect parameter name | string; defined by the SDK or package | Stretch Time |
timelines[].captionTracks[].captions[].fxParams[].type | Object or parameter type | string; allowed values depend on the containing object | bool |
timelines[].captionTracks[].captions[].fxParams[].value | Parameter value | string; logical numbers and booleans remain strings | true |
timelines[].captionTracks[].captions[].type | Object or parameter type | string; allowed values depend on the containing object | general |
Caption Position
Moves a caption within the output frame using translation values.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timelines[].captionTracks[].captions[].anchorPointX | Position or anchor point | finite number | 0 |
timelines[].captionTracks[].captions[].anchorPointY | Position or anchor point | finite number | 0 |
timelines[].captionTracks[].captions[].translationX | Position or anchor point | finite number | -195.92034912109375 |
timelines[].captionTracks[].captions[].translationY | Position or anchor point | finite number | 202.73561096191406 |
Multiline Caption and Line Spacing
Creates a multiline caption and adjusts its line spacing.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timelines[].captionTracks[].captions[].align | Text alignment | string; for example left-vCenter, center-vCenter, or right-vCenter | left-vCenter |
timelines[].captionTracks[].captions[].lineSpacing | Style parameter | finite number; limits depend on the caption renderer | -10 |
timelines[].captionTracks[].captions[].text | Caption text | string; line breaks are supported | Non-empty |
Vertical Caption
Sets the caption text direction to vertical.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timelines[].captionTracks[].captions[].align | Text alignment | string; for example left-vCenter, center-vCenter, or right-vCenter | left-vCenter |
timelines[].captionTracks[].captions[].direction | Text direction | string; horizontal or vertical | vertical |
timelines[].captionTracks[].captions[].text | Caption text | string; line breaks are supported | Non-empty |
Caption Rotation
Rotates a caption around its anchor point.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timelines[].captionTracks[].captions[].rotation | Rotation angle | number; direction follows the engine coordinate system | -90 |
timelines[].captionTracks[].captions[].translationX | Position or anchor point | finite number | 0 |
timelines[].captionTracks[].captions[].translationY | Position or anchor point | finite number | 0.026611328125 |