Skip to content

Filters#

Filters #

Filters.

The base class for filter.

Lavalink Reference

volume property #

volume: float | None

Volume.

The volume of the player.

equalizer property #

Equalizer.

15 bands with different gains.

karaoke property #

karaoke: Karaoke | None

Karaoke.

Eliminates part of a band, usually targeting vocals.

timescale property #

timescale: Timescale | None

Timescale.

The speed, pitch, and rate.

tremolo property #

tremolo: Tremolo | None

Tremolo.

Creates a shuddering effect, where the volume quickly oscillates.

vibrato property #

vibrato: Vibrato | None

Vibrato.

Creates a shuddering effect, where the pitch quickly oscillates.

rotation property #

rotation: Rotation | None

Rotation.

Rotates the audio around the stereo channels/user headphones (aka Audio Panning).

distortion property #

distortion: Distortion | None

Distortion.

Distorts the audio.

channel_mix property #

channel_mix: ChannelMix | None

Channel Mix.

Mixes both channels (left and right).

low_pass property #

low_pass: LowPass | None

Low Pass.

Filters higher frequencies.

plugin_filters property #

plugin_filters: typing.Mapping[str, typing.Any]

Plugin Filters.

Filter plugin configurations.

Equalizer #

Equalizer.

There are 15 bands (0-14) that can be changed. "gain" is the multiplier for the given band. The default value is 0. Valid values range from -0.25 to 1.0, where -0.25 means the given band is completely muted, and 0.25 means it is doubled. Modifying the gain could also change the volume of the output.

Lavalink Reference

band property #

band: BandType

The band (0 to 14).

gain property #

gain: float

The gain (-0.25 to 1.0).

Karaoke #

Karaoke.

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

Lavalink Reference

level property #

level: float | None

The level (0 to 1.0 where 0.0 is no effect and 1.0 is full effect).

mono_level property #

mono_level: float | None

The mono level (0 to 1.0 where 0.0 is no effect and 1.0 is full effect).

filter_band property #

filter_band: float | None

The filter band (in Hz).

filter_width property #

filter_width: float | None

The filter width.

Timescale #

Timescale.

Changes the speed, pitch, and rate. All default to 1.0.

Lavalink Reference

speed property #

speed: float | None

The playback speed 0.0 ≤ x.

pitch property #

pitch: float | None

The pitch 0.0 ≤ x.

rate property #

rate: float | None

The rate 0.0 ≤ x.

Tremolo #

Tremolo.

Uses amplification to create a shuddering effect, where the volume quickly oscillates.

Lavalink Reference

frequency property #

frequency: float | None

The frequency 0.0 < x.

depth property #

depth: float | None

The tremolo depth 0.0 < x ≤ 1.0.

Vibrato #

Vibrato.

Similar to tremolo. While tremolo oscillates the volume, vibrato oscillates the pitch.

Lavalink Reference

frequency property #

frequency: float | None

The frequency 0.0 < x ≤ 14.0.

depth property #

depth: float | None

The vibrato depth 0.0 < x ≤ 1.0.

Rotation #

Rotation.

Rotates the sound around the stereo channels/user headphones (aka Audio Panning).

Lavalink Reference

rotation_hz property #

rotation_hz: float | None

The frequency of the audio rotating around the listener in Hz.

Distortion #

Distortion.

Distortion effect. It can generate some pretty unique audio effects.

Lavalink Reference

sin_offset property #

sin_offset: float | None

The sin offset.

sin_scale property #

sin_scale: float | None

The sin scale.

cos_offset property #

cos_offset: float | None

The cos offset.

cos_scale property #

cos_scale: float | None

The cos scale.

tan_offset property #

tan_offset: float | None

The tan offset.

tan_scale property #

tan_scale: float | None

The tan scale.

offset property #

offset: float | None

The offset.

scale property #

scale: float | None

The scale.

ChannelMix #

Channel Mix.

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 of each other. Setting all factors to 0.5 means both channels get the same audio.

Lavalink Reference

left_to_left property #

left_to_left: float | None

The left to left channel mix factor (0.0 ≤ x ≤ 1.0).

left_to_right property #

left_to_right: float | None

The left to right channel mix factor (0.0 ≤ x ≤ 1.0).

right_to_left property #

right_to_left: float | None

The right to left channel mix factor (0.0 ≤ x ≤ 1.0).

right_to_right property #

right_to_right: float | None

The right to right channel mix factor (0.0 ≤ x ≤ 1.0).

LowPass #

Low Pass.

Higher frequencies get suppressed, while lower frequencies pass through this filter, thus the name low pass. Any smoothing values equal to or less than 1.0 will disable the filter.

Lavalink Reference

smoothing property #

smoothing: float | None

The smoothing factor (1.0 < x).

BandType #

Bases: enum.IntEnum

Band Type.

All the available band types.

HZ25 class-attribute instance-attribute #

HZ25 = 0

25 Hz

HZ40 class-attribute instance-attribute #

HZ40 = 1

40 Hz

HZ63 class-attribute instance-attribute #

HZ63 = 2

63 Hz

HZ100 class-attribute instance-attribute #

HZ100 = 3

100 Hz

HZ160 class-attribute instance-attribute #

HZ160 = 4

160 Hz

HZ250 class-attribute instance-attribute #

HZ250 = 5

250 Hz

HZ400 class-attribute instance-attribute #

HZ400 = 6

400 Hz

HZ630 class-attribute instance-attribute #

HZ630 = 7

630 Hz

HZ1000 class-attribute instance-attribute #

HZ1000 = 8

1000 Hz

HZ1600 class-attribute instance-attribute #

HZ1600 = 9

1600 Hz

HZ2500 class-attribute instance-attribute #

HZ2500 = 10

2500 Hz

HZ4000 class-attribute instance-attribute #

HZ4000 = 11

4000 Hz

HZ6300 class-attribute instance-attribute #

HZ6300 = 12

6300 Hz

HZ10000 class-attribute instance-attribute #

HZ10000 = 13

10000 Hz

HZ16000 class-attribute instance-attribute #

HZ16000 = 14

16000 Hz