Filters

class pomice.filters.ChannelMix(*, tag: str, left_to_left: float = 1, right_to_right: float = 1, left_to_right: float = 0, right_to_left: float = 0)

Bases: Filter

Filter which manually adjusts the panning of the audio, which can make for some cool effects when done correctly.

left_to_left: float

left_to_right: float

right_to_left: float

right_to_right: float

class pomice.filters.Distortion(*, tag: str, sin_offset: float = 0, sin_scale: float = 1, cos_offset: float = 0, cos_scale: float = 1, tan_offset: float = 0, tan_scale: float = 1, offset: float = 0, scale: float = 1)

Bases: Filter

Filter which generates a distortion effect. Useful for certain filter implementations where distortion is needed.

cos_offset: float

cos_scale: float

offset: float

scale: float

sin_offset: float

sin_scale: float

tan_offset: float

tan_scale: float

class pomice.filters.Equalizer(*, tag: str, levels: list)

Bases: Filter

Filter which represents a 15 band equalizer. You can adjust the dynamic of the sound using this filter. i.e: Applying a bass boost filter to emphasize the bass in a song. The format for the levels is: List[Tuple[int, float]]

classmethod boost() → Equalizer

Equalizer preset which boosts the sound of a track, making it sound fun and energetic by increasing the bass and the highs.

eq

classmethod flat() → Equalizer

Equalizer preset which represents a flat EQ board, with all levels set to their default values.

classmethod metal() → Equalizer

Equalizer preset which increases the mids of a track, preferably one of the metal genre, to make it sound more full and concert-like.

classmethod piano() → Equalizer

Equalizer preset which increases the mids and highs of a track, preferably a piano based one, to make it stand out.

raw

class pomice.filters.Filter(*, tag: str)

Bases: object

The base class for all filters. You can use these filters if you have the latest Lavalink version installed. If you do not have the latest Lavalink version, these filters will not work.

You must specify a tag for each filter you put on. This is necessary for the removal of filters.

payload: Dict | None

preload: bool

set_preload() → bool

Internal method to set whether or not the filter was preloaded.

tag: str

class pomice.filters.Karaoke(*, tag: str, level: float = 1.0, mono_level: float = 1.0, filter_band: float = 220.0, filter_width: float = 100.0)

Bases: Filter

Filter which filters the vocal track from any song and leaves the instrumental. Best for karaoke as the filter implies.

filter_band: float

filter_width: float

level: float

mono_level: float

class pomice.filters.LowPass(*, tag: str, smoothing: float = 20)

Bases: Filter

Filter which supresses higher frequencies and allows lower frequencies to pass. You can also do this with the Equalizer filter, but this is an easier way to do it.

payload: Dict | None

smoothing: float

class pomice.filters.Rotation(*, tag: str, rotation_hertz: float = 5)

Bases: Filter

Filter which produces a stereo-like panning effect, which sounds like the audio is being rotated around the listener’s head

rotation_hertz: float

class pomice.filters.Timescale(*, tag: str, speed: float = 1.0, pitch: float = 1.0, rate: float = 1.0)

Bases: Filter

Filter which changes the speed and pitch of a track. You can make some very nice effects with this filter, i.e: a vaporwave-esque filter which slows the track down a certain amount to produce said effect.

classmethod nightcore() → Timescale

Timescale preset which speeds up the currently playing track, which matches up to nightcore, a genre of sped-up music

This preset will assign the tag ‘nightcore’.

pitch: float

rate: float

speed: float

classmethod vaporwave() → Timescale

Timescale preset which slows down the currently playing track, giving it the effect of a half-speed record/casette playing.

This preset will assign the tag ‘vaporwave’.

class pomice.filters.Tremolo(*, tag: str, frequency: float = 2.0, depth: float = 0.5)

Bases: Filter

Filter which produces a wavering tone in the music, causing it to sound like the music is changing in volume rapidly.

depth: float

frequency: float

class pomice.filters.Vibrato(*, tag: str, frequency: float = 2.0, depth: float = 0.5)

Bases: Filter

Filter which produces a wavering tone in the music, similar to the Tremolo filter, but changes in pitch rather than volume.

depth: float

frequency: float