Stylized Captions
See JSON Examples Overview for shared project fields and general parameter rules.
Stylized Caption
Creates a stylized caption by referencing a style package and renderer.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timeline.captionTracks[].captions[].color | Color | string; #AARRGGBB | #ffffffff |
timeline.captionTracks[].captions[].contextId | Package, style, or animation ID | string; required when the referenced resource is used | Not set |
timeline.captionTracks[].captions[].fontSizeRatio | Font-size ratio | positive finite number | 0.1 |
timeline.captionTracks[].captions[].rendererId | Package, style, or animation ID | string; required when the referenced resource is used | Non-empty |
timeline.captionTracks[].captions[].spans[].type | Object or parameter type | string; allowed values depend on the containing object | fontFamily, weight |
timeline.captionTracks[].captions[].styleId | Package, style, or animation ID | string; required when the referenced resource is used | Not set |
timeline.captionTracks[].captions[].text | Caption text | string; line breaks are supported | Non-empty |
timeline.captionTracks[].captions[].type | Object or parameter type | string; allowed values depend on the containing object | modular |
Stylized Caption Opacity
Adjusts caption opacity through the alpha channel of the color value.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timeline.captionTracks[].captions[].color | Color | string; #AARRGGBB | #910c00ff |
timeline.captionTracks[].captions[].spans[].end | Rich-text character boundary | integer; half-open interval [start, end) | 26 |
timeline.captionTracks[].captions[].spans[].start | Rich-text character boundary | integer; half-open interval [start, end) | 0 |
timeline.captionTracks[].captions[].spans[].type | Object or parameter type | string; allowed values depend on the containing object | 7 values |
timeline.captionTracks[].captions[].spans[].value | Parameter value | string; logical numbers and booleans remain strings | 8 values |
timeline.captionTracks[].captions[].type | Object or parameter type | string; allowed values depend on the containing object | modular |
Stylized Caption Background
Configures the background color, opacity, and corner radius.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timeline.captionTracks[].captions[].bgColor | Color | string; #AARRGGBB | #ff060cff |
timeline.captionTracks[].captions[].bgRadius | Style parameter | finite number; limits depend on the caption renderer | 40 |
Stylized Caption Outline
Enables and configures the outline color and width.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timeline.captionTracks[].captions[].outline | Feature switch | boolean; true or false | true |
timeline.captionTracks[].captions[].outlineColor | Color | string; #AARRGGBB | #ff0176fd |
timeline.captionTracks[].captions[].outlineWidth | Style parameter | finite number; limits depend on the caption renderer | 100 |
Stylized Caption Shadow
Configures shadow color, feathering, and horizontal and vertical offsets.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timeline.captionTracks[].captions[].shadow | Feature switch | boolean; true or false | true |
timeline.captionTracks[].captions[].shadowColor | Color | string; #AARRGGBB | #f2808080 |
timeline.captionTracks[].captions[].shadowFeather | Style parameter | finite number; limits depend on the caption renderer | 46 |
timeline.captionTracks[].captions[].shadowOffsetX | Style parameter | finite number; limits depend on the caption renderer | 3 |
timeline.captionTracks[].captions[].shadowOffsetY | Style parameter | finite number; limits depend on the caption renderer | 5 |
Bubble Caption
Creates a bubble-style caption and adjusts its position and line spacing.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timeline.captionTracks[].captions[].contextId | Package, style, or animation ID | string; required when the referenced resource is used | Non-empty |
timeline.captionTracks[].captions[].lineSpacing | Style parameter | finite number; limits depend on the caption renderer | 50 |
timeline.captionTracks[].captions[].translationX | Position or anchor point | finite number | -2.8957557678222656 |
timeline.captionTracks[].captions[].translationY | Position or anchor point | finite number | 0.1332542896270752 |
Caption In and Out Animations
Configures caption entrance and exit animation packages and durations.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timeline.captionTracks[].captions[].inAnimationDuration | Animation period or duration | integer, milliseconds; normally >= 0 | 5472 |
timeline.captionTracks[].captions[].inAnimationId | Package, style, or animation ID | string; required when the referenced resource is used | Non-empty |
timeline.captionTracks[].captions[].outAnimationDuration | Animation period or duration | integer, milliseconds; normally >= 0 | 2801 |
timeline.captionTracks[].captions[].outAnimationId | Package, style, or animation ID | string; required when the referenced resource is used | Non-empty |
Caption Loop Animation
Configures a caption loop animation package and animation period.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timeline.captionTracks[].captions[].animationId | Package, style, or animation ID | string; required when the referenced resource is used | Non-empty |
timeline.captionTracks[].captions[].animationPeroid | Animation period or duration | integer, milliseconds; normally >= 0 | 7789 |
Caption Letter Spacing
Uses absolute-value mode to configure letter spacing.
Complete JSON
Key Parameters
| Field path | Purpose | Type and constraints | Example value |
|---|---|---|---|
timeline.captionTracks[].captions[].letterSpacing | Style parameter | finite number; limits depend on the caption renderer | 20 |
timeline.captionTracks[].captions[].letterSpacingType | Letter-spacing mode | integer; 0 for percentage-like values, 1 for absolute values | 1 |