Skip to content

Compound Captions

See JSON Examples Overview for shared project fields and general parameter rules.

Compound Caption

Creates a compound caption containing multiple text items.

Complete JSON

Key Parameters

Field pathPurposeType and constraintsExample value
timelines[].captionTracks[].compoundCaptions[].captionItems[].colorColorstring; #AARRGGBB#ffffffff
timelines[].captionTracks[].compoundCaptions[].captionItems[].fontFont familystring; should match a font asset mappingNon-empty
timelines[].captionTracks[].compoundCaptions[].captionItems[].indexObject indexinteger; unique or ordered within the containing collection0 to 1
timelines[].captionTracks[].compoundCaptions[].captionItems[].textCaption textstring; line breaks are supported2 non-empty values
timelines[].captionTracks[].compoundCaptions[].durationTimeline position or durationinteger, microseconds; normally >= 048680000
timelines[].captionTracks[].compoundCaptions[].inPointTimeline position or durationinteger, microseconds; normally >= 0520000
timelines[].captionTracks[].compoundCaptions[].styleIdPackage, style, or animation IDstring; required when the referenced resource is usedNon-empty

Per-item Caption Styling

Configures text, font, and color separately for compound-caption items.

Complete JSON

Key Parameters

Field pathPurposeType and constraintsExample value
timelines[].captionTracks[].compoundCaptions[].captionItems[].colorColorstring; #AARRGGBB#ffd0021b
timelines[].captionTracks[].compoundCaptions[].captionItems[].fontFont familystring; should match a font asset mapping2 non-empty values
timelines[].captionTracks[].compoundCaptions[].captionItems[].indexObject indexinteger; unique or ordered within the containing collection0 to 1
timelines[].captionTracks[].compoundCaptions[].captionItems[].textCaption textstring; line breaks are supported2 non-empty values

Compound Caption Rotation

Rotates a compound caption while retaining per-item styling.

Complete JSON

Key Parameters

Field pathPurposeType and constraintsExample value
timelines[].captionTracks[].compoundCaptions[].rotationRotation anglenumber; direction follows the engine coordinate system-90
timelines[].captionTracks[].compoundCaptions[].translationXPosition or anchor pointfinite number-0.39221668243408203
timelines[].captionTracks[].compoundCaptions[].translationYPosition or anchor pointfinite number0

Compound Caption with Multiple Items

Creates a compound caption containing three independently styled text items.

Complete JSON

Key Parameters

Field pathPurposeType and constraintsExample value
timelines[].captionTracks[].compoundCaptions[].captionItems[].colorColorstring; #AARRGGBB#ff535353, #fff0911d
timelines[].captionTracks[].compoundCaptions[].captionItems[].fontFont familystring; should match a font asset mappingNon-empty
timelines[].captionTracks[].compoundCaptions[].captionItems[].indexObject indexinteger; unique or ordered within the containing collection0 to 2
timelines[].captionTracks[].compoundCaptions[].captionItems[].textCaption textstring; line breaks are supported3 non-empty values
timelines[].captionTracks[].compoundCaptions[].styleIdPackage, style, or animation IDstring; required when the referenced resource is usedNon-empty