skip to content

Filter

A single-band filter effect. Important for coloring sound.

class
Filter
extends
Box
tag
<filter-blam>
see

Props

name type default description
freq number 1000

The frequency for the filter, in hertz. The role of this frequency depends on the type.

q number 1

The quality factor (often relating to resonance).

type string lowpass

The type of filter. This can only be one of ‘lowpass’, ‘highpass’, ‘bandpass’, or ‘notch’.

mix number 0

How much wet, versus dry, signal should come through. In most cases, this is a proportion of 1. If mix is set to 0.75, 75% of the signal will be wet and 25% dry.

bypass boolean false

Whether to send just the dry signal. If set, the dry signal is sent using the wet signal’s gain value, for parity.

Examples

Examples that use the Filter element: