🎛️Filters

Represents a filter structure for one Player

Adding a filter can have adverse effects on lavalink performance. These filters force Lavaplayer to decode all audio to PCM, even if the input was already in the Opus format that Discord uses. This means decoding and encoding audio that would normally require very little processing. This is often the case with YouTube videos.

Properties

Name	Description	Type
enabled	Checks if some filter is enabled	Boolean
active	Gets a copy of active filters object	FilterOptions

Methods

apply()

Sends the filter payload to Lavalink Node applying all active filters

clear()

Clears all active filters

set()

Sets the filters (this function will override all active filters)

Property	Description
options	FilterOptions

setChannelMix()

Configs the channel mix filter

Property	Description
options	ChannelMixOptions | null The filter options, null to disable
apply	Boolean (optional) Whether to send filter payload to Lavalink or not, default is true. Set it to false if you set multiple filters at the same time

Returns	Description
Filters	This instance, for chaining calls

setDistortion()

Configs the distortion filter

Property	Description
options	DistortionOptions | null The filter options, null to disable
apply	Boolean (optional) Whether to send filter payload to Lavalink or not, default is true. Set it to false if you set multiple filters at the same time

Returns	Description
Filters	This instance, for chaining calls

setEqualizer()

Configs the equalizer filter. Learn more

Property	Description
options	Array<Number> | null An array of the band gains, null to disable
apply	Boolean (optional) Whether to send filter payload to Lavalink or not, default is true. Set it to false if you set multiple filters at the same time

Returns	Description
Filters	This instance, for chaining calls

setKaraoke()

Configs the karaoke filter

Property	Description
options	KaraokeOptions | null The filter options, null to disable
apply	Boolean (optional) Whether to send filter payload to Lavalink or not, default is true. Set it to false if you set multiple filters at the same time

Returns	Description
Filters	This instance, for chaining calls

setLowPass()

Configs the low pass filter

Property	Description
options	LowPassOptions | null The filter options, null to disable
apply	Boolean (optional) Whether to send filter payload to Lavalink or not, default is true. Set it to false if you set multiple filters at the same time

Returns	Description
Filters	This instance, for chaining calls

setRotation()

Configs the rotation filter

Property	Description
options	RotationOptions | null The filter options, null to disable
apply	Boolean (optional) Whether to send filter payload to Lavalink or not, default is true. Set it to false if you set multiple filters at the same time

Returns	Description
Filters	This instance, for chaining calls

setTimescale()

Configs the timescale filter

Property	Description
options	TimescaleOptions | null The filter options, null to disable
apply	Boolean (optional) Whether to send filter payload to Lavalink or not, default is true. Set it to false if you set multiple filters at the same time

Returns	Description
Filters	This instance, for chaining calls

setTremolo()

Configs the tremolo filter

Property	Description
options	TremoloOptions | null The filter options, null to disable
apply	Boolean (optional) Whether to send filter payload to Lavalink or not, default is true. Set it to false if you set multiple filters at the same time

Returns	Description
Filters	This instance, for chaining calls

setVolume()

Property	Description
volume	Number The volume between 0-500 Default is 100
apply	Boolean (optional) Whether to send filter payload to Lavalink or not, default is true. Set it to false if you set multiple filters at the same time

Returns	Description
Filters	This instance, for chaining calls

setVibrato()

Configs the vibrato filter

Property	Description
options	VibratoOptions | null The filter options, null to disable
apply	Boolean (optional) Whether to send filter payload to Lavalink or not, default is true. Set it to false if you set multiple filters at the same time

Returns	Description
Filters	This instance, for chaining calls