React Native Api Reference
    Preparing search index...

    Interface VideoEffectsConfig

    interface VideoEffectsConfig {
        extra?: Record<string, unknown>;
        filter?: { lut?: "OFF" | "WARM" | "COOL" | "MONO"; strength?: number };
        framing?: { enabled?: boolean; maxZoom?: number };
        lighting?: { enabled?: boolean; strength?: number };
        pipeline?: "LEGACY" | "GRAPH";
        style?: {
            levels?: number;
            preset?: "OFF" | "POSTERIZE" | "VIVID";
            strength?: number;
        };
    }
    Index
    extra? filter? framing? lighting? pipeline? style?
    extra?: Record<string, unknown>

    Extra settings merged into the document as sent, for an effect this SDK version has no typed field for yet. An entry here overwrites the typed field with the same key.

    filter?: { lut?: "OFF" | "WARM" | "COOL" | "MONO"; strength?: number }

    A colour grade, applied last.

    Type Declaration

    • Optionallut?: "OFF" | "WARM" | "COOL" | "MONO"
      "OFF"
    • Optionalstrength?: number

      How much of the grade to mix in, 0.0..1.0.

      1.0
    framing?: { enabled?: boolean; maxZoom?: number }

    Auto-framing crop and zoom. Follows whatever a detector publishes through publishFramingSubject, and is a no-op when nothing does.

    Type Declaration

    • Optionalenabled?: boolean
      false
    • OptionalmaxZoom?: number

      Tightest crop allowed, as a zoom factor clamped to 1.0..4.0.

      2.0
    lighting?: { enabled?: boolean; strength?: number }

    Low-light correction.

    Type Declaration

    • Optionalenabled?: boolean
      false
    • Optionalstrength?: number

      How much of the correction to mix in, 0.0..1.0.

      1.0
    pipeline?: "LEGACY" | "GRAPH"

    Which capture pipeline processes camera frames. Effects only render on "GRAPH"; "LEGACY" is the default and doubles as off.

    style?: {
        levels?: number;
        preset?: "OFF" | "POSTERIZE" | "VIVID";
        strength?: number;
    }

    A stylised look applied to the whole picture.

    Type Declaration

    • Optionallevels?: number

      Steps per channel for "POSTERIZE", coerced to an odd number in 3..17.

      5
    • Optionalpreset?: "OFF" | "POSTERIZE" | "VIVID"
      "OFF"
    • Optionalstrength?: number

      How much of the look to mix in, 0.0..1.0.

      1.0

    Settings
    Member Visibility

    On This Page
    Properties