Filters

Table of contents

Constructors

• constructor

Accessors

• active
• enabled

Methods

• apply
• clear
• set
• setChannelMix
• setDistortion
• setEqualizer
• setKaraoke
• setLowPass
• setRotation
• setTimescale
• setTremolo
• setVibrato
• setVolume

Constructors

constructor

• new Filters(player)

Creates an instance of filters

Parameters

Name	Type
player	Player

Defined in

lib/Filters.ts:24

Accessors

active

• get active(): FilterOptions

Gets a copy of active filters object

Returns

FilterOptions

Defined in

lib/Filters.ts:35

---

enabled

• get enabled(): boolean

Checks if some filter is enabled

Returns

boolean

Defined in

lib/Filters.ts:30

Methods

apply

▸ apply(): void

Sends filters payload to Lavalink Node

Returns

void

Defined in

lib/Filters.ts:245

---

clear

▸ clear(): void

Clears all active filters

Returns

void

Defined in

lib/Filters.ts:238

---

set

▸ set(filters): void

Sets all filters

Parameters

Name	Type
filters	FilterOptions

Returns

void

Defined in

lib/Filters.ts:224

---

setChannelMix

▸ setChannelMix(options, apply?): Filters

Sets ChannelMix filter

Parameters

Name	Type	Default value	Description
options	null | ChannelMixOptions	undefined	The channel mix options
apply	boolean	true	Whether to send filter payload to Lavalink or not

Returns

Filters

The filters instance, for chaining calls

Defined in

lib/Filters.ts:49

---

setDistortion

▸ setDistortion(options, apply?): Filters

Sets Distortion filter

Parameters

Name	Type	Default value	Description
options	null | DistortionOptions	undefined	The distortion options
apply	boolean	true	Whether to send filter payload to Lavalink or not

Returns

Filters

The filters instance, for chaining calls

Defined in

lib/Filters.ts:72

---

setEqualizer

▸ setEqualizer(options, apply?): Filters

Sets Equalizer filter

Parameters

Name	Type	Default value	Description
options	null | number[]	undefined	The equalizer band array
apply	boolean	true	Whether to send filter payload to Lavalink or not

Returns

Filters

The filters instance, for chaining calls

Defined in

lib/Filters.ts:87

---

setKaraoke

▸ setKaraoke(options, apply?): Filters

Sets Karaoke filter

Parameters

Name	Type	Default value	Description
options	null | KaraokeOptions	undefined	The karaoke options
apply	boolean	true	Whether to send filter payload to Lavalink or not

Returns

Filters

The filters instance, for chaining calls

Defined in

lib/Filters.ts:113

---

setLowPass

▸ setLowPass(options, apply?): Filters

Sets LowPass filter

Parameters

Name	Type	Default value	Description
options	null | LowPassOptions	undefined	The lowpass options
apply	boolean	true	Whether to send filter payload to Lavalink or not

Returns

Filters

The filters instance, for chaining calls

Defined in

lib/Filters.ts:129

---

setRotation

▸ setRotation(options, apply?): Filters

Sets Rotation filter

Parameters

Name	Type	Default value	Description
options	null | RotationOptions	undefined	The rotation options
apply	boolean	true	Whether to send filter payload to Lavalink or not

Returns

Filters

The filters instance, for chaining calls

Defined in

lib/Filters.ts:145

---

setTimescale

▸ setTimescale(options, apply?): Filters

Sets Timescale filter

Parameters

Name	Type	Default value	Description
options	null | TimescaleOptions	undefined	The timescale options
apply	boolean	true	Whether to send filter payload to Lavalink or not

Returns

Filters

The filters instance, for chaining calls

Defined in

lib/Filters.ts:163

---

setTremolo

▸ setTremolo(options, apply?): Filters

Sets Tremolo filter

Parameters

Name	Type	Default value	Description
options	null | TremoloOptions	undefined	The tremolo options
apply	boolean	true	Whether to send filter payload to Lavalink or not

Returns

Filters

The filters instance, for chaining calls

Defined in

lib/Filters.ts:180

---

setVibrato

▸ setVibrato(options, apply?): Filters

Sets Vibrato filter

Parameters

Name	Type	Default value	Description
options	null | VibratoOptions	undefined	The vibrato options
apply	boolean	true	Whether to send filter payload to Lavalink or not

Returns

Filters

The filters instance, for chaining calls

Defined in

lib/Filters.ts:197

---

setVolume

▸ setVolume(vol, apply?): Filters

Sets the volume

Parameters

Name	Type	Default value	Description
vol	number	undefined	The volume to set [0,500]
apply	boolean	true	Whether to send filter payload to Lavalink or not

Returns

Filters

The filters instance, for chaining calls

Defined in

lib/Filters.ts:212