Developer
Log in

Reference

Effect settings

Every effect type's settings, for filter.set. Each type is a JSON Schema in catalog.list under filter_settings.

velum.filter.ambientAmbient match

  • blendnumberBlend width

    by_position: how wide the zone where two colors meet is, as a share of the canvas's width (0 a hard edge).

    0 to 1 · Default 0.25

  • ceilingnumberBrightness ceiling

    Nothing in the layer gets lighter than this (0.15 is a 15% gray), whatever it follows.

    0 to 1 · Default 0.15

  • easenumberEase

    How long it takes to drift to a new color. It never snaps.

    0.1 to 60 s · Default 3

  • followarrayFollows

    The sources or scenes whose color it takes on (capture cards, a game, a camera; a scene by whatever's showing in it). Ids or names.

    No repeats · Default []

  • pickchoiceColor from

    vivid: the picture's most colorful parts count most; average: all of it alike.

    One of "vivid" "average" · Default "vivid"

  • saturationnumberSaturation cap

    The most colorful the tint may be.

    0 to 1 · Default 0.6

  • spreadchoiceSpread

    average: what it follows is averaged into one color all over; by_position: each one colors the part of the layer nearest where it is on the canvas (a split screen's two sides).

    One of "average" "by_position" · Default "average"

  • strengthnumberStrength

    How much of the way to the followed color: 0 leaves the picture as it is.

    0 to 1 · Default 0.6

velum.filter.bg_removalBackground removal

  • backgroundchoiceBackground

    What takes the background's place: nothing, the background blurred, or a color.

    One of "transparent" "blur" "color" · Default "transparent"

  • blur_radiusnumberBackground blur

    How blurred the background is, when it's blurred.

    0 to 400 px · Default 24

  • colorcolorBackground color

    The color behind you, when the background is a color.

    Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#00b040"

  • edgeschoiceEdges

    detailed: follows your own edges (hair, shoulders) closely; fast: a smooth outline.

    One of "detailed" "fast" · Default "detailed"

  • intervalnumberEvery

    Finds you every so many frames and keeps the last outline between (higher costs less).

    1 to 30 frames · Default 1

  • qualitychoiceQuality

    standard: the lighter network; high: a larger network that finds your outline more closely (arms, hands), at a few times the graphics cost.

    One of "standard" "high" · Default "standard"

  • softnessnumberEdge softness

    How far below the threshold the edge fades in.

    0.001 to 1 · Default 0.1

  • thresholdnumberThreshold

    How sure Studio must be that a pixel is you. Higher removes more.

    0 to 1 · Default 0.5

velum.filter.blurBlur

  • anglenumberAngle

    A line blur's direction: 0 across, 90 down.

    -180 to 180 ° · Default 0

  • center_xnumberCenter across

    A spin or zoom blur's center: 0 the left edge, 1 the right.

    0 to 1 · Default 0.5

  • center_ynumberCenter down

    A spin or zoom blur's center: 0 the top, 1 the bottom.

    0 to 1 · Default 0.5

  • directionchoiceDirection

    all: every way; line: along angle, like motion; spin: around the center; zoom: out from the center.

    One of "all" "line" "spin" "zoom" · Default "all"

  • edgeschoiceEdges

    At the picture's edges: carry the edge outward, or fade out.

    One of "extend" "fade" · Default "extend"

  • feathernumberFeather

    How softly the box's edge blends, as a share of the picture.

    0 to 0.5 · Default 0

  • feather_shiftnumberFeather shift

    Moves the soft edge out (above 0) or in, in feather widths.

    -1 to 1 · Default 0

  • inverton or offInvert

    Blur everything but the box.

    Default false

  • kindchoiceKind

    gaussian: soft; box: every pixel within reach counts the same.

    One of "gaussian" "box" · Default "gaussian"

  • radiusnumberRadius

    How far the softness reaches, in the picture's pixels (a line or zoom blur's length).

    0 to 400 px · Default 12

  • regionon or offOnly a box

    Blur only a box of the picture (or everything but it, with invert).

    Default false

  • region_bottomnumberBox bottom

    How far up from the bottom edge the box ends.

    0 to 1 · Default 0

  • region_leftnumberBox left

    How far in from the left edge the box starts.

    0 to 1 · Default 0

  • region_rightnumberBox right

    How far in from the right edge the box ends.

    0 to 1 · Default 0

  • region_topnumberBox top

    How far down from the top edge the box starts.

    0 to 1 · Default 0

  • spinnumberSpin

    How far a spin blur turns each way.

    0 to 180 ° · Default 5

velum.filter.chroma_keyRemove background

  • keychoiceBackground

    The background color to remove: found automatically, green, blue, magenta, or key_color.

    One of "auto" "green" "blue" "magenta" "custom" · Default "green"

  • key_colorcolorBackground color

    The color removed when key is custom.

    Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#00ff00"

  • opacitynumberOpacity

    0 (invisible) to 1 (solid).

    0 to 1 · Default 1

  • similaritynumberTolerance

    How far from the background color still counts as background. Higher removes more.

    0.001 to 1 · Default 0.4

  • smoothnessnumberEdge softness

    How gradually the edge fades. Higher is softer.

    0.001 to 1 · Default 0.08

  • spillnumberSpill cleanup

    Removes the background's color tint from edges and reflections.

    0.001 to 1 · Default 0.1

velum.filter.color_correctionColor correction

  • brightnessnumberBrightness

    -1 to 1; 0 leaves it as it is.

    -1 to 1 · Default 0

  • color_addcolorAdd

    This is added to each color (black leaves it as it is).

    Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#000000"

  • color_multiplycolorMultiply

    Each color is multiplied by this (white leaves it as it is).

    Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#ffffff"

  • contrastnumberContrast

    -4 to 4; 0 leaves it as it is.

    -4 to 4 · Default 0

  • gammanumberGamma

    -3 to 3; 0 leaves it as it is.

    -3 to 3 · Default 0

  • hue_shiftnumberHue

    Turns every color around the color wheel.

    -180 to 180 ° · Default 0

  • opacitynumberOpacity

    0 (invisible) to 1 (solid).

    0 to 1 · Default 1

  • saturationnumberSaturation

    -1 is black and white; 0 leaves it as it is.

    -1 to 5 · Default 0

velum.filter.color_gradeColor grading

  • contrastnumberContrast

    Around middle gray; 1 leaves it.

    0 to 10 · Default 1

  • gainnumberGain

    Multiplies every value (1 leaves it).

    -10 to 10 · Default 1

  • gain_bnumberGain (blue)

    Gain for blue only.

    -10 to 10 · Default 1

  • gain_gnumberGain (green)

    Gain for green only.

    -10 to 10 · Default 1

  • gain_rnumberGain (red)

    Gain for red only.

    -10 to 10 · Default 1

  • gammanumberGamma

    Brightens (above 0) or darkens the middle tones.

    -10 to 10 · Default 0

  • gamma_bnumberGamma (blue)

    Gamma for blue only.

    -10 to 10 · Default 0

  • gamma_gnumberGamma (green)

    Gamma for green only.

    -10 to 10 · Default 0

  • gamma_rnumberGamma (red)

    Gamma for red only.

    -10 to 10 · Default 0

  • huenumberHue

    Turns every color around the color wheel.

    -180 to 180 ° · Default 0

  • liftnumberLift

    Raises the darkest parts toward white (StreamFX's lift, 1 = 100%).

    -10 to 1 · Default 0

  • lift_bnumberLift (blue)

    Lift for blue only.

    -10 to 1 · Default 0

  • lift_gnumberLift (green)

    Lift for green only.

    -10 to 1 · Default 0

  • lift_rnumberLift (red)

    Lift for red only.

    -10 to 1 · Default 0

  • lightnessnumberLightness

    Multiplies brightness; 1 leaves it.

    0 to 10 · Default 1

  • offsetnumberOffset

    Adds to every value.

    -10 to 10 · Default 0

  • offset_bnumberOffset (blue)

    Offset for blue only.

    -10 to 10 · Default 0

  • offset_gnumberOffset (green)

    Offset for green only.

    -10 to 10 · Default 0

  • offset_rnumberOffset (red)

    Offset for red only.

    -10 to 10 · Default 0

  • saturationnumberSaturation

    0 is black and white; 1 leaves it.

    0 to 10 · Default 1

  • tint_detectionchoiceTint by

    How brightness picks shadows, midtones and highlights: HSV value, HSL lightness, or luma.

    One of "hsv" "hsl" "luma" · Default "luma"

  • tint_exponentnumberTint exponent

    The exp and exp2 curves' strength.

    0 to 10 · Default 1.5

  • tint_highlight_bnumberHighlights tint (blue)

    How much blue the highlights keep (1 leaves it).

    0 to 10 · Default 1

  • tint_highlight_gnumberHighlights tint (green)

    How much green the highlights keep (1 leaves it).

    0 to 10 · Default 1

  • tint_highlight_rnumberHighlights tint (red)

    How much red the highlights keep (1 leaves it).

    0 to 10 · Default 1

  • tint_midtone_bnumberMidtones tint (blue)

    How much blue the midtones keep (1 leaves it).

    0 to 10 · Default 1

  • tint_midtone_gnumberMidtones tint (green)

    How much green the midtones keep (1 leaves it).

    0 to 10 · Default 1

  • tint_midtone_rnumberMidtones tint (red)

    How much red the midtones keep (1 leaves it).

    0 to 10 · Default 1

  • tint_modechoiceTint curve

    How brightness spreads across shadows, midtones and highlights.

    One of "linear" "exp" "exp2" "log" "log10" · Default "linear"

  • tint_shadow_bnumberShadows tint (blue)

    How much blue the shadows keep (1 leaves it).

    0 to 10 · Default 1

  • tint_shadow_gnumberShadows tint (green)

    How much green the shadows keep (1 leaves it).

    0 to 10 · Default 1

  • tint_shadow_rnumberShadows tint (red)

    How much red the shadows keep (1 leaves it).

    0 to 10 · Default 1

velum.filter.cropCrop

  • absoluteon or offBox

    Crop to a box (left, top, width, height) instead of cutting each side.

    Default false

  • bottomnumberBottom

    Pixels cut from this side; below zero adds empty space.

    -4096 to 8192 px · Default 0

  • heightnumberHeight

    The box's height.

    1 to 8192 px · Default 1080

  • leftnumberLeft

    Pixels cut from this side; below zero adds empty space.

    -4096 to 8192 px · Default 0

  • rightnumberRight

    Pixels cut from this side; below zero adds empty space.

    -4096 to 8192 px · Default 0

  • topnumberTop

    Pixels cut from this side; below zero adds empty space.

    -4096 to 8192 px · Default 0

  • widthnumberWidth

    The box's width.

    1 to 8192 px · Default 1920

velum.filter.developInstant film

  • delaynumberStarts after

    How long it stays blank first, such as while a Toss & land plays, so it lands and then develops.

    0 to 30 s · Default 0

  • durationnumberDevelops in

    How long from blank to the picture.

    0.2 to 60 s · Default 3

  • hazenumberStarts blank

    How milky it starts: 1 shows nothing at first.

    0 to 1 · Default 0.9

  • triggerchoiceDevelops when

    on_air: each time it comes on air; shown: in any picture Studio draws, the Studio-mode preview too.

    One of "on_air" "shown" · Default "on_air"

  • warmthnumberWarmth

    How warm and rich the color is while it comes in.

    0 to 1 · Default 0.5

velum.filter.effectEffect

  • amountnumberAmount

    How strongly the look shows over the original.

    0 to 1 · Default 1

  • colorcolorColor

    Duotone's shadows, Tint's color, Shine's light.

    Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#000000"

  • color2colorSecond color

    Duotone's highlights.

    Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#000000"

  • effectchoiceLook

    Which look.

    One of "bw" "sepia" "duotone" "tint" "invert" "thermal" "posterize" "pixelate" "fisheye" "vhs" "hologram" "ghost" "glitch" "vignette" "anaglyph" "sketch" "shine" "wave" "shake" "flicker" "pulse" "rainbow" "reveal" · Default "bw"

  • sizenumberSize

    Pixelate: block size (2 to 96 px). Posterize: shades (2 to 16). Fisheye, Wave: strength (0 to 1). Shake: reach (1 to 40 px). Shine, Pulse, Rainbow, Reveal: seconds per cycle.

    0 to 96 · Default 0

velum.filter.freezeFreeze frame

    velum.filter.gainGain

    • dbnumberGain

      A fixed boost or cut, before the fader.

      -30 to 30 dB · Default 0

    velum.filter.glowGlow

    • colorcolorColor

      The glow's color.

      Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#ffebb3"

    • placementchoicePlacement

      outer: around the picture, behind it; inner: in from the edge, over the picture.

      One of "outer" "inner" · Default "outer"

    • sizenumberSize

      How far the glow reaches, in the picture's pixels.

      0 to 200 px · Default 16

    • strengthnumberStrength

      How bright it is.

      0 to 1 · Default 0.8

    velum.filter.maskImage mask

    • colorcolorColor

      Tints the source first (white leaves it as it is).

      Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#ffffff"

    • filefilePicture

      The mask picture: a full path to an image file.

      At least 1 character · A full path on Studio's computer

    • kindchoiceKind

      alpha: the picture's transparency cuts; color: its brightness cuts; or blend it by multiply, add or subtract.

      One of "alpha" "color" "multiply" "add" "subtract" · Default "alpha"

    • opacitynumberOpacity

      0 (invisible) to 1 (solid).

      0 to 1 · Default 1

    • stretchon or offStretch

      Stretch the picture over the source instead of fitting it inside.

      Default false

    velum.filter.noise_gateNoise gate

    • attack_msnumberAttack

      How fast it opens.

      0 to 10000 ms · Default 25

    • close_dbnumberCloses below

      Keep this lower than open_db so quiet words don't flutter.

      -96 to 0 dB · Default -32

    • hold_msnumberHold

      How long it stays open after you stop.

      0 to 10000 ms · Default 200

    • open_dbnumberOpens above

      Sound louder than this opens the gate.

      -96 to 0 dB · Default -26

    • release_msnumberRelease

      How fast it fades shut.

      0 to 10000 ms · Default 150

    velum.filter.noise_suppressNoise suppression

      velum.filter.outlineOutline

      • colorcolorColor

        The outline's color; with an alpha (#rrggbbaa) it's see-through.

        Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#ffffff"

      • modechoicePosition

        outer: around the shape; inner: inside its edge; both: centered on the edge, half each way.

        One of "outer" "inner" "both" · Default "outer"

      • opacitynumberOpacity

        0 (invisible) to 1 (solid).

        0 to 1 · Default 1

      • softnessnumberSoftness

        Feathers the outline's edge; 0 is crisp.

        0 to 24 px · Default 0

      • widthnumberWidth

        How thick the outline is, in the picture's pixels (it scales with the layer).

        0 to 96 px · Default 4

      velum.filter.scrollScroll

      • cxnumberWidth

        The layer's width in pixels, when limit_cx is on.

        1 to 8192 · Default 100

      • cynumberHeight

        The layer's height in pixels, when limit_cy is on.

        1 to 8192 · Default 100

      • limit_cxon or offLimit width

        Make the layer cx pixels wide instead of the picture's width, showing that much of it at 1:1.

        Default false

      • limit_cyon or offLimit height

        Make the layer cy pixels high instead of the picture's height, showing that much of it at 1:1.

        Default false

      • loopon or offLoop

        Wrap around seamlessly (a tiling background). Off, the picture slides away once, leaving transparency, each time it comes on.

        Default true

      • speed_xnumberHorizontal speed

        How fast the picture moves across, in its own pixels per second: above 0 to the left, below 0 to the right.

        -500 to 500 px/s · Default 0

      • speed_ynumberVertical speed

        How fast the picture moves up and down, in its own pixels per second: above 0 up, below 0 down.

        -500 to 500 px/s · Default 0

      velum.filter.shaderShader

      • amountnumberAmount

        How strongly it covers the picture.

        0 to 1 · Default 0.6

      • anglenumberAngle

        0 lines run across; 90 they run down.

        -180 to 180 ° · Default 0

      • bluexnumberBlue across

        The shader's Blue across setting.

        -10 to 10 · Default -2

      • blueynumberBlue down

        The shader's Blue down setting.

        -10 to 10 · Default 0

      • border_colorcolorBorder color

        The shader's Border color setting.

        Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#ffffff"

      • border_thicknessnumberBorder

        A border drawn around the outside of the picture.

        0 to 200 px · Default 0

      • center_xnumberCenter across

        0 left edge, 1 right edge.

        0 to 1 · Default 0.5

      • center_ynumberCenter down

        0 top, 1 bottom.

        0 to 1 · Default 0.5

      • corner_radiusnumberCorner radius

        How round the corners are, in the picture's pixels.

        0 to 1000 px · Default 16

      • darknessnumberDarkness

        How dark the lines are.

        0 to 1 · Default 0.5

      • end_colorcolorEnd

        The shader's End setting.

        Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#00c8ff"

      • filefileShader file

        Your own shader, a full path to a .wgsl file, when shader is file.

        At least 1 character · A full path on Studio's computer

      • greenxnumberGreen across

        The shader's Green across setting.

        -10 to 10 · Default 0

      • greenynumberGreen down

        The shader's Green down setting.

        -10 to 10 · Default 0

      • keep_darkon or offFollow brightness

        Darker parts of the picture stay darker under it.

        Default true

      • lowestnumberFaintest

        How see-through it gets at its faintest (0 gone, 1 never fades).

        0 to 1 · Default 0

      • max_growth_pixelsnumberLargest

        How much it grows at its largest.

        0 to 1000 px · Default 200

      • middle_colorcolorMiddle

        The shader's Middle setting.

        Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#7a3cff"

      • min_growth_pixelsnumberSmallest

        How much it grows at its smallest.

        0 to 1000 px · Default 0

      • multiplyon or offTint the picture

        Multiply the picture by the wash, only where it isn't see-through, instead of covering it.

        Default false

      • only_coloron or offOnly one color

        Color only the parts of the picture that are this color.

        Default false

      • periodnumberSpacing

        Pixels from one line to the next.

        2 to 200 px · Default 10

      • powernumberZoom

        1 shows the whole picture; 2 is twice as close.

        1 to 20 · Default 1

      • radiusnumberReach

        How far out the twist goes, as a share of the picture's height.

        0 to 2 · Default 0.5

      • redxnumberRed across

        How far red moves, in percent of the picture (obs-shaderfilter's units).

        -10 to 10 · Default 2

      • redynumberRed down

        The shader's Red down setting.

        -10 to 10 · Default 0

      • shaderchoiceShader

        One of Studio's shaders, or file for your own WGSL file.

        One of "rounded_rect" "pulse" "border" "blink" "rgb_split" "scan_lines" "gradient" "zoom" "swirl" "simple_gradient" "file" · Default "rounded_rect"

      • speednumberSpeed

        How fast it pulses (OBS's units: radians per second).

        0 to 100 · Default 1

      • start_colorcolorStart

        The shader's Start setting.

        Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#ff2d95"

      • target_colorcolorColor to replace

        The shader's Color to replace setting.

        Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#ffffff"

      • thicknessnumberThickness

        The shader's Thickness setting.

        0 to 200 px · Default 8

      • turnsnumberTurns

        How far the middle turns (1 is a full turn).

        -4 to 4 · Default 0.5

      Also takes the settings a shader file declares.

      velum.filter.shadowDrop shadow

      • anglenumberDirection

        Where the shadow falls: 0 right, 90 down, 180 left, 270 up.

        0 to 359 ° · Default 45

      • colorcolorColor

        The shadow's color.

        Matches ^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$ · A color, #rrggbb or #rrggbbaa · Default "#000000"

      • distancenumberDistance

        How far the shadow falls from the picture, in its pixels.

        0 to 400 px · Default 10

      • opacitynumberOpacity

        0 (invisible) to 1 (solid).

        0 to 1 · Default 0.6

      • placementchoicePlacement

        outer: falls behind the picture, past its edges; inner: cast by the edge into the shape, over the picture.

        One of "outer" "inner" · Default "outer"

      • softnessnumberSoftness

        How soft its edge is.

        0 to 200 px · Default 12

      to open · ↑ ↓ to move · Esc to close