🎛️FilterOptions

Audio filter options types

PropertyDescriptionType

channelMix

This filter mixes both channels (left and right), with a configurable factor on how much each channel affects the other. With the defaults, both channels are kept independent from each other. Setting all factors to 0.5 means both channels get the same audio.

distortion

Distortion effect

equalizer

The equalizer band gains

karaoke

Uses equalization to eliminate part of a band, usually targeting vocals.

lowPass

Higher frequencies get suppressed, while lower frequencies pass through this filter, thus the name low pass.

rotation

This filter simulates an audio source rotating around the listener.

timescale

Change time stretch and pitch scale

tremolo

Trembling effect.

vibrato

A musical effect consisting of a regular, pulsating change of pitch. It is used to add expression to vocal and instrumental music

volume

The volume between 0 and 500

ChannelMixOptions

PropertyDescription

leftToLeft

Number (optional)

leftToRight

Number (optional)

rightToLeft

Number (optional)

rightToRight

Number (optional)

DistortionOptions

PropertyDescription

sinOffset

Number (optional)

sinScale

Number (optional)

tanOffset

Number (optional)

tanScale

Number (optional)

cosOffset

Number (optional)

cosScale

Number (optional)

offset

Number (optional)

scale

Number (optional)

Equalizer bands reference:

There are 15 bands [0-14] 25 Hz, 40 Hz, 63 Hz, 100 Hz, 160 Hz, 250 Hz, 400 Hz, 630 Hz, 1 kHz, 1.6 kHz, 2.5 kHz, 4 kHz, 6.3 kHz, 10 kHz, 16 kHz

The meaningful range for the values is -0.25 to 0.5, -0.25 means you're completely wiping out that frequency, 0.25 means you're doubling it

KaraokeOptions

PropertyDescription

level

Number (optional)

monoLevel

Number (optional)

filterBand

Number (optional)

filterWidth

Number (optional)

LowPassOptions

PropertyDescription

smoothing

Number (optional)

RotationOptions

PropertyDescription

rotationHz

Number (optional) The rotation speed in Hertz

TimescaleOptions

PropertyDescription

speed

Number (optional) Changes the sound to play at faster or slower tempo than originally without affecting the sound pitch.

pitch

Number (optional) Changes the sound pitch or key while keeping the original tempo (speed).

rate

Number (optional) Changes both tempo and pitch together as if a vinyl disc was played at different RPM rate.

TremoloOptions

PropertyDescription

frequency

Number (optional) 0 < f ≤ 14

depth

Number (optional) 0 < d ≤ 1

VibratoOptions

PropertyDescription

frequency

Number (optional) 0 < f ≤ 14

depth

Number (optional) 0 < d ≤ 1

P.S.: Some audio filter descriptions stolen from https://github.com/natanbc/lavadsp

Last updated