VideoUltra API
    Preparing search index...

    Interface ItemPatch

    Fields that updateItem may change. Timing and media references have their own operations.

    interface ItemPatch {
        adjust?: {
            brightness?: number;
            contrast?: number;
            highlights?: number;
            saturation?: number;
            shadows?: number;
            sharpen?: number;
            tint?: number;
            vignette?: number;
            warmth?: number;
        };
        amount?: number;
        audioFx?: | {
            compress?: number;
            denoise?: number;
            eq?: { high: number; low: number; mid: number };
            keepPitch?: boolean;
            pitch?: number;
        }
        | null;
        blend?: | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "soft-light"
        | "add"
        | "lighten"
        | "darken"
        | "difference"
        | null;
        crop?: { bottom: number; left: number; right: number; top: number };
        cutout?: { assetId: string } | null;
        duck?: number;
        effect?: "blur" | "pixelate";
        emoji?: string | null;
        fadeIn?: number;
        fadeOut?: number;
        filter?: { id: string; intensity: number } | null;
        fit?: "fit" | "fill";
        height?: number;
        key?:
            | { color: string; softness: number; spill: number; tolerance: number }
            | null;
        lut?: { assetId: string; intensity: number } | null;
        mask?: { feather: number; invert?: boolean; shape: string } | null;
        maxWidth?: number | null;
        muted?: boolean;
        name?: string;
        shape?: "rectangle" | "ellipse";
        style?: {
            align: "left" | "right" | "center";
            background: { color: string; padding: number; radius: number } | null;
            color: string;
            fontFamily: string;
            fontWeight: number;
            italic: boolean;
            letterSpacing: number;
            lineHeight: number;
            outline: { color: string; width: number } | null;
            shadow: { blur: number; color: string; x: number; y: number } | null;
            size: number;
        };
        text?: string;
        transform?: {
            flipX: boolean;
            flipY: boolean;
            opacity: number;
            rotation: number;
            scale: number;
            x: number;
            y: number;
        };
        volume?: number;
        width?: number;
    }
    Index
    adjust?: {
        brightness?: number;
        contrast?: number;
        highlights?: number;
        saturation?: number;
        shadows?: number;
        sharpen?: number;
        tint?: number;
        vignette?: number;
        warmth?: number;
    }
    amount?: number
    audioFx?:
        | {
            compress?: number;
            denoise?: number;
            eq?: { high: number; low: number; mid: number };
            keepPitch?: boolean;
            pitch?: number;
        }
        | null

    Sound effects (EQ, compressor, pitch); null removes them.

    Type Declaration

    • {
          compress?: number;
          denoise?: number;
          eq?: { high: number; low: number; mid: number };
          keepPitch?: boolean;
          pitch?: number;
      }
      • Optionalcompress?: number

        Compressor ("even out"): 0 = off … 1 = strong; quiet parts come up, loud ones go down.

      • Optionaldenoise?: number

        Clean up noise: 0 = off … 1 = strong; steady background noise (hiss, hum, fans) goes down.

      • Optionaleq?: { high: number; low: number; mid: number }

        Three-band equaliser, dB each (−12…12): bass (shelf, 120 Hz), middle (1 kHz), treble (shelf, 8 kHz).

      • OptionalkeepPitch?: boolean

        Keep the original pitch when the clip is sped up or slowed down (speeds 0.5×…2×).

      • Optionalpitch?: number

        Pitch shift in semitones (−12…12), the speed unchanged.

    • null
    blend?:
        | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "soft-light"
        | "add"
        | "lighten"
        | "darken"
        | "difference"
        | null

    Lane items; 'normal' (or null) removes the field.

    crop?: { bottom: number; left: number; right: number; top: number }

    Type Declaration

    • bottom: number
    • left: number

      Fractions of the source cut from each edge.

    • right: number
    • top: number
    cutout?: { assetId: string } | null

    Photos and image stickers: background removed (an image asset); null restores it.

    duck?: number

    Lower under voice, 0…1 of the volume taken away while someone speaks; 0 = off.

    effect?: "blur" | "pixelate"

    Blurred areas.

    emoji?: string | null
    fadeIn?: number
    fadeOut?: number
    filter?: { id: string; intensity: number } | null

    Type Declaration

    • { id: string; intensity: number }
      • id: string

        Preset id, e.g. 'warm'.

      • intensity: number
    • null
    fit?: "fit" | "fill"
    height?: number
    key?:
        | { color: string; softness: number; spill: number; tolerance: number }
        | null

    Green screen; null turns it off.

    Type Declaration

    • { color: string; softness: number; spill: number; tolerance: number }
      • color: string

        The colour to remove, #rrggbb.

      • softness: number
      • spill: number
      • tolerance: number
    • null
    lut?: { assetId: string; intensity: number } | null

    LUT look (the asset must be a lut); null removes it.

    mask?: { feather: number; invert?: boolean; shape: string } | null

    Pictures: shape mask (the shape must be one of SHAPE_PRESETS); null removes it.

    Type Declaration

    • { feather: number; invert?: boolean; shape: string }
      • feather: number

        Soft edge, 0 (sharp) … 1 (very soft).

      • Optionalinvert?: boolean

        Show the outside of the shape instead.

      • shape: string

        Shape preset id (SHAPE_PRESETS), e.g. 'circle', 'star-5', 'heart'.

    • null
    maxWidth?: number | null

    Texts: wrap width as a fraction of the canvas width at scale 1 (clamped to 0.05…1); null removes it (lines break only where the text does).

    muted?: boolean
    name?: string
    shape?: "rectangle" | "ellipse"
    style?: {
        align: "left" | "right" | "center";
        background: { color: string; padding: number; radius: number } | null;
        color: string;
        fontFamily: string;
        fontWeight: number;
        italic: boolean;
        letterSpacing: number;
        lineHeight: number;
        outline: { color: string; width: number } | null;
        shadow: { blur: number; color: string; x: number; y: number } | null;
        size: number;
    }

    Type Declaration

    • align: "left" | "right" | "center"
    • background: { color: string; padding: number; radius: number } | null
    • color: string
    • fontFamily: string
    • fontWeight: number
    • italic: boolean
    • letterSpacing: number
    • lineHeight: number
    • outline: { color: string; width: number } | null
    • shadow: { blur: number; color: string; x: number; y: number } | null
    • size: number

      Font size as a fraction of canvas height.

    text?: string
    transform?: {
        flipX: boolean;
        flipY: boolean;
        opacity: number;
        rotation: number;
        scale: number;
        x: number;
        y: number;
    }

    Type Declaration

    • flipX: boolean
    • flipY: boolean
    • opacity: number
    • rotation: number

      Degrees, clockwise.

    • scale: number

      1 = fits inside the canvas (contain).

    • x: number

      Centre, as a fraction of canvas width (0.5 = centred).

    • y: number

      Centre, as a fraction of canvas height.

    volume?: number
    width?: number