Filters
ruvyrias / Filters
Class: Filters
Defined in: src/Filters.ts:18
The Filters class that is used to apply filters to the currently player
Constructors
Constructor
new Filters(
player,options?):Filters
Defined in: src/Filters.ts:38
Parameters
player
options?
Returns
Filters
Properties
_8d
_8d:
null|boolean
Defined in: src/Filters.ts:36
bassBoost
bassBoost:
number
Defined in: src/Filters.ts:30
channelMix
channelMix:
null|ChannelMixOptions
Defined in: src/Filters.ts:28
chipmunk
chipmunk:
null|boolean
Defined in: src/Filters.ts:35
daycore
daycore:
null|boolean
Defined in: src/Filters.ts:33
distortion
distortion:
null|DistortionOptions
Defined in: src/Filters.ts:27
equalizer
equalizer:
Band[]
Defined in: src/Filters.ts:21
karaoke
karaoke:
null|KaraokeOptions
Defined in: src/Filters.ts:22
lowPass
lowPass:
null|LowPassOptions
Defined in: src/Filters.ts:29
nightcore
nightcore:
null|boolean
Defined in: src/Filters.ts:32
player
readonlyplayer:Player
Defined in: src/Filters.ts:19
rotation
rotation:
null|RotationOptions
Defined in: src/Filters.ts:26
slowMode
slowMode:
null|boolean
Defined in: src/Filters.ts:31
timescale
timescale:
null|TimescaleOptions
Defined in: src/Filters.ts:23
tremolo
tremolo:
null|TremoloOptions
Defined in: src/Filters.ts:24
vaporwave
vaporwave:
null|boolean
Defined in: src/Filters.ts:34
vibrato
vibrato:
null|VibratoOptions
Defined in: src/Filters.ts:25
volume
readonlyvolume:number
Defined in: src/Filters.ts:20
Methods
clearFilters()
clearFilters():
Promise<Filters>
Defined in: src/Filters.ts:313
Clears all filters applied to the player.
Returns
Promise<Filters>
The Filters instance after clearing filters.
set8D()
set8D(
value,options?):Promise<Filters>
Defined in: src/Filters.ts:287
Enables or disables the 8D effect.
Parameters
value
boolean
Whether to enable 8D effect.
options?
Optional rotation settings.
Returns
Promise<Filters>
The Filters instance for chaining.
setBassboost()
setBassboost(
value):Promise<Filters>
Defined in: src/Filters.ts:173
Sets the bass boost level on the player.
Parameters
value
number
Bass boost value (0-5).
Returns
Promise<Filters>
The Filters instance for chaining.
Throws
If value is outside allowed range.
setChannelMix()
setChannelMix(
mix):Promise<Filters>
Defined in: src/Filters.ts:148
Sets the channel mix effect on the player.
Parameters
mix
Channel mix filter settings.
Returns
Promise<Filters>
The Filters instance for chaining.
setChipmunk()
setChipmunk(
value,options?):Promise<Filters>
Defined in: src/Filters.ts:301
Enables or disables the Chipmunk effect.
Parameters
value
boolean
Whether to enable Chipmunk effect.
options?
Optional custom timescale settings.
Returns
Promise<Filters>
The Filters instance for chaining.
setDaycore()
setDaycore(
value,options?):Promise<Filters>
Defined in: src/Filters.ts:230
Enables or disables the Daycore effect.
Parameters
value
boolean
Whether to enable Daycore.
options?
Omit<TimescaleOptions, "speed">
Optional custom timescale settings.
Returns
Promise<Filters>
The Filters instance for chaining.
setDistortion()
setDistortion(
distortion):Promise<Filters>
Defined in: src/Filters.ts:136
Sets the distortion effect on the player.
Parameters
distortion
Distortion filter settings.
Returns
Promise<Filters>
The Filters instance for chaining.
setEqualizer()
setEqualizer(
bands):Promise<Filters>
Defined in: src/Filters.ts:64
Sets the equalizer bands for the player.
Parameters
bands
Band[]
Array of equalizer bands to apply.
Returns
Promise<Filters>
The Filters instance for chaining.
setKaraoke()
setKaraoke(
karaoke?):Promise<Filters>
Defined in: src/Filters.ts:76
Sets the karaoke effect on the player.
Parameters
karaoke?
Karaoke filter settings or null to disable.
Returns
Promise<Filters>
The Filters instance for chaining.
setLowPass()
setLowPass(
pass):Promise<Filters>
Defined in: src/Filters.ts:160
Sets the low pass filter on the player.
Parameters
pass
Low pass filter settings.
Returns
Promise<Filters>
The Filters instance for chaining.
setNightcore()
setNightcore(
value,options?):Promise<Filters>
Defined in: src/Filters.ts:210
Enables or disables the Nightcore effect.
Parameters
value
boolean
Whether to enable Nightcore.
options?
Optional custom timescale settings.
Returns
Promise<Filters>
The Filters instance for chaining.
setRotation()
setRotation(
rotation?):Promise<Filters>
Defined in: src/Filters.ts:124
Sets the rotation effect on the player.
Parameters
rotation?
Rotation filter settings or null to disable.
null | RotationOptions
Returns
Promise<Filters>
The Filters instance for chaining.
setSlowmode()
setSlowmode(
value,options?):Promise<Filters>
Defined in: src/Filters.ts:196
Enables or disables the Slowmode effect.
Parameters
value
boolean
Whether to enable Slowmode.
options?
Optional custom timescale settings.
Returns
Promise<Filters>
The Filters instance for chaining.
setTimescale()
setTimescale(
timescale?):Promise<Filters>
Defined in: src/Filters.ts:88
Sets the timescale effect on the player.
Parameters
timescale?
Timescale filter settings or null to disable.
null | TimescaleOptions
Returns
Promise<Filters>
The Filters instance for chaining.
setTremolo()
setTremolo(
tremolo?):Promise<Filters>
Defined in: src/Filters.ts:100
Sets the tremolo effect on the player.
Parameters
tremolo?
Tremolo filter settings or null to disable.
null | TremoloOptions
Returns
Promise<Filters>
The Filters instance for chaining.
setVaporwave()
setVaporwave(
value,options?):Promise<Filters>
Defined in: src/Filters.ts:267
Enables or disables the Vaporwave effect.
Parameters
value
boolean
Whether to enable Vaporwave.
options?
Optional custom timescale settings.
Returns
Promise<Filters>
The Filters instance for chaining.
setVibrato()
setVibrato(
vibrato?):Promise<Filters>
Defined in: src/Filters.ts:112
Sets the vibrato effect on the player.
Parameters
vibrato?
Vibrato filter settings or null to disable.
null | VibratoOptions
Returns
Promise<Filters>
The Filters instance for chaining.
updateFilters()
updateFilters():
Promise<Filters>
Defined in: src/Filters.ts:326
Updates the player's filters on the Lavalink node.
Returns
Promise<Filters>
The Filters instance after updating filters.