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

    Interface SvgClipOptions

    Options for creating an SVG clip.

    SVG clips always reference a library media item because the displayed texture is derived from that asset.

    interface SvgClipOptions {
        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;
                clipId: string;
                cornerRadius?: [number, number, number, number];
                crop: [number, number, number, number];
                cropOffset: [number, number];
                height?: number;
                mediaDataId?: string;
                position: [number, number];
                relativeCornerRadius: boolean;
                rotation: number;
                scale: [number, number];
                width?: number;
                zIndex: number;
                zoom: [number, number];
            },
        >;
        subtitlesId?: string;
        subtitlesOffset?: number;
        type?: string;
        wrapMode?: WrapModeEnum;
    }

    Hierarchy (View Summary)

    Index

    Properties

    blendMode? duration? effects? filters? fitStrategy? id? isVisible? leftTrim? mediaDataId name? rightTrim? startTime? style? subtitlesId? subtitlesOffset? 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;
            clipId: string;
            cornerRadius?: [number, number, number, number];
            crop: [number, number, number, number];
            cropOffset: [number, number];
            height?: number;
            mediaDataId?: string;
            position: [number, number];
            relativeCornerRadius: boolean;
            rotation: number;
            scale: [number, number];
            width?: number;
            zIndex: number;
            zoom: [number, number];
        },
    >
    subtitlesId?: string
    subtitlesOffset?: number
    type?: string
    wrapMode?: WrapModeEnum

    Settings

    Member Visibility

    On This Page

    Properties