@rendley/sdk - v1.16.1
    Preparing search index...

    Interface TextClipOptions

    Constructor payload for text clips, including the initial source text that will be rendered and serialized.

    text seeds both the stored clip content and the first rendered value before any text animation overrides are applied.

    interface TextClipOptions {
        blendMode?: BlendModeEnum;
        duration?: number;
        effects?: {
            clipId?: string;
            effectId: string;
            id: string;
            properties: [string, any][];
            provider: string;
        }[];
        filters?: {
            clipId?: string;
            filterId: string;
            id: string;
            intensity: number;
            provider: string;
        }[];
        fitStrategy?: MediaFitStrategy;
        id?: string;
        isVisible?: boolean;
        leftTrim?: number;
        mediaDataId?: string;
        name?: string;
        rightTrim?: number;
        startTime?: number;
        style?: Partial<
            {
                alpha: number;
                backgroundColor: null
                | string;
                clipId: string;
                color: string;
                cornerRadius?: [number, number, number, number];
                crop: [number, number, number, number];
                cropOffset: [number, number];
                dropShadow: boolean;
                dropShadowAlpha: number;
                dropShadowAngle: number;
                dropShadowBlur: number;
                dropShadowColor: string;
                dropShadowDistance: number;
                fontFamily: string;
                fontSize: number;
                fontStyle: "normal" | "italic" | "oblique";
                fontWeight:
                    | "normal"
                    | "bold"
                    | "bolder"
                    | "lighter"
                    | "100"
                    | "200"
                    | "300"
                    | "400"
                    | "500"
                    | "600"
                    | "700"
                    | "800"
                    | "900";
                height?: number;
                letterSpacing: number;
                lineHeight: number;
                mediaDataId?: string;
                padding: number[];
                position: [number, number];
                relativeCornerRadius: boolean;
                rotation: number;
                scale: [number, number];
                strokeColor: string;
                strokeThickness: number;
                textAlign: "left" | "center" | "right" | "justify";
                width?: number;
                wordWrapWidth: null | number;
                zIndex: number;
                zoom: [number, number];
            },
        >;
        subtitlesId?: string;
        subtitlesOffset?: number;
        text?: string;
        type?: string;
        wrapMode?: WrapModeEnum;
    }

    Hierarchy (View Summary)

    Index

    Properties

    blendMode? duration? effects? filters? fitStrategy? id? isVisible? leftTrim? mediaDataId? name? rightTrim? startTime? style? subtitlesId? subtitlesOffset? text? type? wrapMode?

    Properties

    blendMode?: BlendModeEnum
    duration?: number
    effects?: {
        clipId?: string;
        effectId: string;
        id: string;
        properties: [string, any][];
        provider: string;
    }[]
    filters?: {
        clipId?: string;
        filterId: string;
        id: string;
        intensity: number;
        provider: string;
    }[]
    fitStrategy?: MediaFitStrategy

    Per-clip fit strategy applied when the media behind the clip changes. Overrides the media's own fitStrategy; omitted fields inherit from it. Explicit replace call options still win over both.

    id?: string
    isVisible?: boolean
    leftTrim?: number
    mediaDataId?: string
    name?: string
    rightTrim?: number
    startTime?: number
    style?: Partial<
        {
            alpha: number;
            backgroundColor: null
            | string;
            clipId: string;
            color: string;
            cornerRadius?: [number, number, number, number];
            crop: [number, number, number, number];
            cropOffset: [number, number];
            dropShadow: boolean;
            dropShadowAlpha: number;
            dropShadowAngle: number;
            dropShadowBlur: number;
            dropShadowColor: string;
            dropShadowDistance: number;
            fontFamily: string;
            fontSize: number;
            fontStyle: "normal" | "italic" | "oblique";
            fontWeight:
                | "normal"
                | "bold"
                | "bolder"
                | "lighter"
                | "100"
                | "200"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "800"
                | "900";
            height?: number;
            letterSpacing: number;
            lineHeight: number;
            mediaDataId?: string;
            padding: number[];
            position: [number, number];
            relativeCornerRadius: boolean;
            rotation: number;
            scale: [number, number];
            strokeColor: string;
            strokeThickness: number;
            textAlign: "left" | "center" | "right" | "justify";
            width?: number;
            wordWrapWidth: null | number;
            zIndex: number;
            zoom: [number, number];
        },
    >
    subtitlesId?: string
    subtitlesOffset?: number

    Optionaltext

    text?: string
    type?: string
    wrapMode?: WrapModeEnum

    Settings

    Member Visibility

    On This Page

    Properties