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

    Interface AdjustmentClipOptions

    Options used to create an adjustment clip.

    Adjustment clips reuse the generic ClipStyle surface because they render the composited pixels from lower layers rather than their own media source.

    interface AdjustmentClipOptions {
        autoResize?: boolean;
        bakeSize?: [number, number];
        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;
        renderSourceClips?: boolean;
        rightTrim?: number;
        sampleSpace?: AdjustmentSampleSpaceEnum;
        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

    autoResize? bakeSize? blendMode? duration? effects? filters? fitStrategy? id? isVisible? leftTrim? mediaDataId? name? renderSourceClips? rightTrim? sampleSpace? startTime? style? subtitlesId? subtitlesOffset? type? wrapMode?

    Properties

    autoResize?: boolean
    bakeSize?: [number, number]
    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
    renderSourceClips?: boolean
    rightTrim?: number
    sampleSpace?: AdjustmentSampleSpaceEnum
    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