Bitmovin Player React Native SDK - v1.25.0
    Preparing search index...

    Interface SubtitleCueLayout

    Cue-box geometry converted to the shared React Native event shape.

    Platform-specific SDK values are converted to shared JS units/enums when the native cue exposes them. Fields with automatic or unset values, values not applicable to a cue, or values not exposed by the active native subtitle pipeline are omitted.

    interface SubtitleCueLayout {
        line?: SubtitleCueLayoutLine;
        lineAlign?: "start" | "end" | "center";
        position?: number;
        positionAlign?: "center" | "line-left" | "line-right";
        size?: number;
        textAlign?: "start" | "end" | "center" | "left" | "right";
        writingMode?: "vertical-lr" | "vertical-rl";
    }
    Index

    Properties

    Cue position on the axis perpendicular to the text flow.

    For horizontal captions this controls vertical placement:

    • { value: 85, unit: 'percent' } — 85% down the viewport.
    • { value: 12, unit: 'line' } — 12 rendered text-line slots from the edge.
    • undefined — the underlying subtitle renderer determines line placement automatically.

    For vertical captions this controls horizontal placement.

    lineAlign?: "start" | "end" | "center"

    Which edge of the cue box is anchored at line.

    Does not control text alignment inside the box; see textAlign for that.

    position?: number

    Cue box position as a percentage of the viewport on the axis orthogonal to line.

    When omitted, the underlying subtitle renderer determines cue box position automatically.

    positionAlign?: "center" | "line-left" | "line-right"

    Which edge of the cue box is anchored at position.

    size?: number

    Width of the cue box as a percentage of the viewport dimension in the writing direction.

    textAlign?: "start" | "end" | "center" | "left" | "right"

    Text alignment inside the cue box.

    writingMode?: "vertical-lr" | "vertical-rl"

    Vertical writing direction of the cue text.

    When omitted, consumers should treat the cue as using the default horizontal writing direction. This affects how line, position, and size are interpreted.