VidStudio SDK reference
    Preparing search index...

    Interface CaptionStyle

    The resolved, non-partial caption style bundle. This is what the frontend stores in state, passes to export({ captionStyle }), and feeds to renderCaptionFrame. Defined here so frontend and backend import one definition (backend/13-caption-styling.md).

    interface CaptionStyle {
        animationStyle: "static" | "karaoke";
        highlightColor: string;
        maxCharsPerLine: number;
        maxLinesPerCue: number;
        textStyle: TextProperties;
    }
    Index
    animationStyle highlightColor maxCharsPerLine maxLinesPerCue textStyle
    animationStyle: "static" | "karaoke"
    highlightColor: string

    Honored only when animationStyle === 'karaoke'.

    maxCharsPerLine: number

    0 = no wrap.

    maxLinesPerCue: number

    Max wrapped lines shown at once (0 = whole paragraph, no chunking).

    textStyle: TextProperties

    Settings
    Member Visibility

    On This Page
    Properties