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 widthby_position: how wide the zone where two colors meet is, as a share of the canvas's width (0 a hard edge).
ceilingnumberBrightness ceilingNothing in the layer gets lighter than this (0.15 is a 15% gray), whatever it follows.
easenumberEaseHow long it takes to drift to a new color. It never snaps.
followarrayFollowsThe 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.
pickchoiceColor fromvivid: the picture's most colorful parts count most; average: all of it alike.
saturationnumberSaturation capThe most colorful the tint may be.
spreadchoiceSpreadaverage: 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).
strengthnumberStrengthHow much of the way to the followed color: 0 leaves the picture as it is.
velum.filter.bg_removalBackground removal
backgroundchoiceBackgroundWhat takes the background's place: nothing, the background blurred, or a color.
blur_radiusnumberBackground blurHow blurred the background is, when it's blurred.
colorcolorBackground colorThe color behind you, when the background is a color.
edgeschoiceEdgesdetailed: follows your own edges (hair, shoulders) closely; fast: a smooth outline.
intervalnumberEveryFinds you every so many frames and keeps the last outline between (higher costs less).
qualitychoiceQualitystandard: the lighter network; high: a larger network that finds your outline more closely (arms, hands), at a few times the graphics cost.
softnessnumberEdge softnessHow far below the threshold the edge fades in.
thresholdnumberThresholdHow sure Studio must be that a pixel is you. Higher removes more.
velum.filter.blurBlur
anglenumberAngleA line blur's direction: 0 across, 90 down.
center_xnumberCenter acrossA spin or zoom blur's center: 0 the left edge, 1 the right.
center_ynumberCenter downA spin or zoom blur's center: 0 the top, 1 the bottom.
directionchoiceDirectionall: every way; line: along angle, like motion; spin: around the center; zoom: out from the center.
edgeschoiceEdgesAt the picture's edges: carry the edge outward, or fade out.
feathernumberFeatherHow softly the box's edge blends, as a share of the picture.
feather_shiftnumberFeather shiftMoves the soft edge out (above 0) or in, in feather widths.
inverton or offInvertBlur everything but the box.
kindchoiceKindgaussian: soft; box: every pixel within reach counts the same.
radiusnumberRadiusHow far the softness reaches, in the picture's pixels (a line or zoom blur's length).
regionon or offOnly a boxBlur only a box of the picture (or everything but it, with invert).
region_bottomnumberBox bottomHow far up from the bottom edge the box ends.
region_leftnumberBox leftHow far in from the left edge the box starts.
region_rightnumberBox rightHow far in from the right edge the box ends.
region_topnumberBox topHow far down from the top edge the box starts.
spinnumberSpinHow far a spin blur turns each way.
velum.filter.chroma_keyRemove background
keychoiceBackgroundThe background color to remove: found automatically, green, blue, magenta, or key_color.
key_colorcolorBackground colorThe color removed when key is custom.
opacitynumberOpacity0 (invisible) to 1 (solid).
similaritynumberToleranceHow far from the background color still counts as background. Higher removes more.
smoothnessnumberEdge softnessHow gradually the edge fades. Higher is softer.
spillnumberSpill cleanupRemoves the background's color tint from edges and reflections.
velum.filter.color_correctionColor correction
brightnessnumberBrightness-1 to 1; 0 leaves it as it is.
color_addcolorAddThis is added to each color (black leaves it as it is).
color_multiplycolorMultiplyEach color is multiplied by this (white leaves it as it is).
contrastnumberContrast-4 to 4; 0 leaves it as it is.
gammanumberGamma-3 to 3; 0 leaves it as it is.
hue_shiftnumberHueTurns every color around the color wheel.
opacitynumberOpacity0 (invisible) to 1 (solid).
saturationnumberSaturation-1 is black and white; 0 leaves it as it is.
velum.filter.color_gradeColor grading
contrastnumberContrastAround middle gray; 1 leaves it.
gainnumberGainMultiplies every value (1 leaves it).
gain_bnumberGain (blue)Gain for blue only.
gain_gnumberGain (green)Gain for green only.
gain_rnumberGain (red)Gain for red only.
gammanumberGammaBrightens (above 0) or darkens the middle tones.
gamma_bnumberGamma (blue)Gamma for blue only.
gamma_gnumberGamma (green)Gamma for green only.
gamma_rnumberGamma (red)Gamma for red only.
huenumberHueTurns every color around the color wheel.
liftnumberLiftRaises the darkest parts toward white (StreamFX's lift, 1 = 100%).
lift_bnumberLift (blue)Lift for blue only.
lift_gnumberLift (green)Lift for green only.
lift_rnumberLift (red)Lift for red only.
lightnessnumberLightnessMultiplies brightness; 1 leaves it.
offsetnumberOffsetAdds to every value.
offset_bnumberOffset (blue)Offset for blue only.
offset_gnumberOffset (green)Offset for green only.
offset_rnumberOffset (red)Offset for red only.
saturationnumberSaturation0 is black and white; 1 leaves it.
tint_detectionchoiceTint byHow brightness picks shadows, midtones and highlights: HSV value, HSL lightness, or luma.
tint_exponentnumberTint exponentThe exp and exp2 curves' strength.
tint_highlight_bnumberHighlights tint (blue)How much blue the highlights keep (1 leaves it).
tint_highlight_gnumberHighlights tint (green)How much green the highlights keep (1 leaves it).
tint_highlight_rnumberHighlights tint (red)How much red the highlights keep (1 leaves it).
tint_midtone_bnumberMidtones tint (blue)How much blue the midtones keep (1 leaves it).
tint_midtone_gnumberMidtones tint (green)How much green the midtones keep (1 leaves it).
tint_midtone_rnumberMidtones tint (red)How much red the midtones keep (1 leaves it).
tint_modechoiceTint curveHow brightness spreads across shadows, midtones and highlights.
tint_shadow_bnumberShadows tint (blue)How much blue the shadows keep (1 leaves it).
tint_shadow_gnumberShadows tint (green)How much green the shadows keep (1 leaves it).
tint_shadow_rnumberShadows tint (red)How much red the shadows keep (1 leaves it).
velum.filter.cropCrop
absoluteon or offBoxCrop to a box (left, top, width, height) instead of cutting each side.
bottomnumberBottomPixels cut from this side; below zero adds empty space.
heightnumberHeightThe box's height.
leftnumberLeftPixels cut from this side; below zero adds empty space.
rightnumberRightPixels cut from this side; below zero adds empty space.
topnumberTopPixels cut from this side; below zero adds empty space.
widthnumberWidthThe box's width.
velum.filter.developInstant film
delaynumberStarts afterHow long it stays blank first, such as while a Toss & land plays, so it lands and then develops.
durationnumberDevelops inHow long from blank to the picture.
hazenumberStarts blankHow milky it starts: 1 shows nothing at first.
triggerchoiceDevelops whenon_air: each time it comes on air; shown: in any picture Studio draws, the Studio-mode preview too.
warmthnumberWarmthHow warm and rich the color is while it comes in.
velum.filter.effectEffect
amountnumberAmountHow strongly the look shows over the original.
colorcolorColorDuotone's shadows, Tint's color, Shine's light.
color2colorSecond colorDuotone's highlights.
effectchoiceLookWhich look.
sizenumberSizePixelate: 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.
velum.filter.freezeFreeze frame
velum.filter.gainGain
dbnumberGainA fixed boost or cut, before the fader.
velum.filter.glowGlow
colorcolorColorThe glow's color.
placementchoicePlacementouter: around the picture, behind it; inner: in from the edge, over the picture.
sizenumberSizeHow far the glow reaches, in the picture's pixels.
strengthnumberStrengthHow bright it is.
velum.filter.maskImage mask
colorcolorColorTints the source first (white leaves it as it is).
filefilePictureThe mask picture: a full path to an image file.
kindchoiceKindalpha: the picture's transparency cuts; color: its brightness cuts; or blend it by multiply, add or subtract.
opacitynumberOpacity0 (invisible) to 1 (solid).
stretchon or offStretchStretch the picture over the source instead of fitting it inside.
velum.filter.noise_gateNoise gate
attack_msnumberAttackHow fast it opens.
close_dbnumberCloses belowKeep this lower than open_db so quiet words don't flutter.
hold_msnumberHoldHow long it stays open after you stop.
open_dbnumberOpens aboveSound louder than this opens the gate.
release_msnumberReleaseHow fast it fades shut.
velum.filter.noise_suppressNoise suppression
velum.filter.outlineOutline
colorcolorColorThe outline's color; with an alpha (#rrggbbaa) it's see-through.
modechoicePositionouter: around the shape; inner: inside its edge; both: centered on the edge, half each way.
opacitynumberOpacity0 (invisible) to 1 (solid).
softnessnumberSoftnessFeathers the outline's edge; 0 is crisp.
widthnumberWidthHow thick the outline is, in the picture's pixels (it scales with the layer).
velum.filter.scrollScroll
cxnumberWidthThe layer's width in pixels, when limit_cx is on.
cynumberHeightThe layer's height in pixels, when limit_cy is on.
limit_cxon or offLimit widthMake the layer cx pixels wide instead of the picture's width, showing that much of it at 1:1.
limit_cyon or offLimit heightMake the layer cy pixels high instead of the picture's height, showing that much of it at 1:1.
loopon or offLoopWrap around seamlessly (a tiling background). Off, the picture slides away once, leaving transparency, each time it comes on.
speed_xnumberHorizontal speedHow fast the picture moves across, in its own pixels per second: above 0 to the left, below 0 to the right.
speed_ynumberVertical speedHow fast the picture moves up and down, in its own pixels per second: above 0 up, below 0 down.
velum.filter.shaderShader
amountnumberAmountHow strongly it covers the picture.
anglenumberAngle0 lines run across; 90 they run down.
bluexnumberBlue acrossThe shader's Blue across setting.
blueynumberBlue downThe shader's Blue down setting.
border_colorcolorBorder colorThe shader's Border color setting.
border_thicknessnumberBorderA border drawn around the outside of the picture.
center_xnumberCenter across0 left edge, 1 right edge.
center_ynumberCenter down0 top, 1 bottom.
corner_radiusnumberCorner radiusHow round the corners are, in the picture's pixels.
darknessnumberDarknessHow dark the lines are.
end_colorcolorEndThe shader's End setting.
filefileShader fileYour own shader, a full path to a .wgsl file, when shader is file.
greenxnumberGreen acrossThe shader's Green across setting.
greenynumberGreen downThe shader's Green down setting.
keep_darkon or offFollow brightnessDarker parts of the picture stay darker under it.
lowestnumberFaintestHow see-through it gets at its faintest (0 gone, 1 never fades).
max_growth_pixelsnumberLargestHow much it grows at its largest.
middle_colorcolorMiddleThe shader's Middle setting.
min_growth_pixelsnumberSmallestHow much it grows at its smallest.
multiplyon or offTint the pictureMultiply the picture by the wash, only where it isn't see-through, instead of covering it.
only_coloron or offOnly one colorColor only the parts of the picture that are this color.
periodnumberSpacingPixels from one line to the next.
powernumberZoom1 shows the whole picture; 2 is twice as close.
radiusnumberReachHow far out the twist goes, as a share of the picture's height.
redxnumberRed acrossHow far red moves, in percent of the picture (obs-shaderfilter's units).
redynumberRed downThe shader's Red down setting.
shaderchoiceShaderOne of Studio's shaders, or file for your own WGSL file.
speednumberSpeedHow fast it pulses (OBS's units: radians per second).
start_colorcolorStartThe shader's Start setting.
target_colorcolorColor to replaceThe shader's Color to replace setting.
thicknessnumberThicknessThe shader's Thickness setting.
turnsnumberTurnsHow far the middle turns (1 is a full turn).
velum.filter.shadowDrop shadow
anglenumberDirectionWhere the shadow falls: 0 right, 90 down, 180 left, 270 up.
colorcolorColorThe shadow's color.
distancenumberDistanceHow far the shadow falls from the picture, in its pixels.
opacitynumberOpacity0 (invisible) to 1 (solid).
placementchoicePlacementouter: falls behind the picture, past its edges; inner: cast by the edge into the shape, over the picture.
softnessnumberSoftnessHow soft its edge is.

