Filters

ruvyrias

---

ruvyrias / Filters

Class: Filters

Defined in: src/Filters.ts:156

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:176

Parameters

player

Player

options?

FiltersOptions

Returns

Filters

Properties

_8d

_8d: null | boolean

Defined in: src/Filters.ts:174

---

bassBoost

bassBoost: number

Defined in: src/Filters.ts:168

---

channelMix

channelMix: null | ChannelMixOptions

Defined in: src/Filters.ts:166

---

chipmunk

chipmunk: null | boolean

Defined in: src/Filters.ts:173

---

daycore

daycore: null | boolean

Defined in: src/Filters.ts:171

---

distortion

distortion: null | DistortionOptions

Defined in: src/Filters.ts:165

---

equalizer

equalizer: Band[]

Defined in: src/Filters.ts:159

---

karaoke

karaoke: null | KaraokeOptions

Defined in: src/Filters.ts:160

---

lowPass

lowPass: null | LowPassOptions

Defined in: src/Filters.ts:167

---

nightcore

nightcore: null | boolean

Defined in: src/Filters.ts:170

---

player

player: Player

Defined in: src/Filters.ts:157

---

rotation

rotation: null | RotationOptions

Defined in: src/Filters.ts:164

---

slowMode

slowMode: null | boolean

Defined in: src/Filters.ts:169

---

timescale

timescale: null | TimescaleOptions

Defined in: src/Filters.ts:161

---

tremolo

tremolo: null | TremoloOptions

Defined in: src/Filters.ts:162

---

vaporwave

vaporwave: null | boolean

Defined in: src/Filters.ts:172

---

vibrato

vibrato: null | VibratoOptions

Defined in: src/Filters.ts:163

---

volume

volume: number

Defined in: src/Filters.ts:158

Methods

clearFilters()

clearFilters(): Promise<Filters>

Defined in: src/Filters.ts:450

Clear all filters for the player.

Returns

Promise<Filters>

• Returns the current instance of the filters.

---

set8D()

set8D(value, options?): Promise<Filters>

Defined in: src/Filters.ts:424

Sets the 8D filter for the player.

Parameters

value

boolean

Boolean value indicating whether to enable or disable the 8D filter.

options?

RotationOptions

Optional custom parameters.

Returns

Promise<Filters>

• Returns the current instance of the filters.

---

setBassboost()

setBassboost(value): Promise<Filters>

Defined in: src/Filters.ts:310

Sets the Bass boost value for the player.

Parameters

value

number

The value of the Bass boost, it should be between 0 to 5.

Returns

Promise<Filters>

• Returns the current instance of the filters.

---

setChannelMix()

setChannelMix(mix): Promise<Filters>

Defined in: src/Filters.ts:286

Changes the channel mix options applied to the currently player.

Parameters

mix

ChannelMixOptions

An object that conforms to the ChannelMixOptions type, defining the channel mix to apply.

Returns

Promise<Filters>

• Returns the current Filters instance for method chaining.

---

setChipmunk()

setChipmunk(value, options?): Promise<Filters>

Defined in: src/Filters.ts:438

Sets the Chipmunk filter for the player.

Parameters

value

boolean

Boolean value indicating whether to enable or disable the Chipmunk filter.

options?

TimescaleOptions

Optional custom parameters.

Returns

Promise<Filters>

• Returns the current instance of the filters.

---

setDaycore()

setDaycore(value, options?): Promise<Filters>

Defined in: src/Filters.ts:367

Sets the Daycore filter for the player.

Parameters

value

boolean

Boolean value indicating whether to enable or disable Daycore.

options?

Omit<TimescaleOptions, "speed">

Optional custom parameters.

Returns

Promise<Filters>

• Returns the current instance of the filters.

---

setDistortion()

setDistortion(distortion): Promise<Filters>

Defined in: src/Filters.ts:274

Changes the distortion options applied to the currently player.

Parameters

distortion

DistortionOptions

An object that conforms to the DistortionOptions type, defining the distortion to apply.

Returns

Promise<Filters>

• Returns the current Filters instance for method chaining.

---

setEqualizer()

setEqualizer(bands): Promise<Filters>

Defined in: src/Filters.ts:202

Sets the equalizer bands for the currently player.

Parameters

bands

Band[]

An array of bands to set the equalizer to.

Returns

Promise<Filters>

• Returns the Filters instance for method chaining.

---

setKaraoke()

setKaraoke(karaoke?): Promise<Filters>

Defined in: src/Filters.ts:214

Changes the karaoke options applied to the currently player.

Parameters

karaoke?

KaraokeOptions

An object that conforms to the KaraokeOptions type, defining a range of frequencies to mute.

Returns

Promise<Filters>

• Returns the current Filters instance for method chaining.

---

setLowPass()

setLowPass(pass): Promise<Filters>

Defined in: src/Filters.ts:298

Changes the low pass options applied to the currently player.

Parameters

pass

LowPassOptions

An object that conforms to the LowPassOptions type, defining the low pass to apply.

Returns

Promise<Filters>

• Returns the current Filters instance for method chaining.

---

setNightcore()

setNightcore(value, options?): Promise<Filters>

Defined in: src/Filters.ts:347

Sets the Nightcore filter for the player.

Parameters

value

boolean

Boolean value indicating whether to enable or disable Nightcore.

options?

TimescaleOptions

Optional custom parameters.

Returns

Promise<Filters>

• Returns the current instance of the filters.

---

setRotation()

setRotation(rotation?): Promise<Filters>

Defined in: src/Filters.ts:262

Changes the rotation options applied to the currently player.

Parameters

rotation?

An object that conforms to the RotationOptions type, defining the rotation to apply.

null | RotationOptions

Returns

Promise<Filters>

• Returns the current Filters instance for method chaining.

---

setSlowmode()

setSlowmode(value, options?): Promise<Filters>

Defined in: src/Filters.ts:333

Sets the Slowmode filter for the player.

Parameters

value

boolean

The value to enable or disable Slowmode.

options?

TimescaleOptions

Optional custom parameters.

Returns

Promise<Filters>

• Returns the current instance of the filters.

---

setTimescale()

setTimescale(timescale?): Promise<Filters>

Defined in: src/Filters.ts:226

Changes the timescale options applied to the currently player.

Parameters

timescale?

An object that conforms to the TimescaleOptions type, defining the timescale to apply.

null | TimescaleOptions

Returns

Promise<Filters>

• Returns the current Filters instance for method chaining.

---

setTremolo()

setTremolo(tremolo?): Promise<Filters>

Defined in: src/Filters.ts:238

Changes the tremolo options applied to the currently player.

Parameters

tremolo?

An object that conforms to the TremoloOptions type, defining the tremolo to apply.

null | TremoloOptions

Returns

Promise<Filters>

• Returns the current Filters instance for method chaining.

---

setVaporwave()

setVaporwave(value, options?): Promise<Filters>

Defined in: src/Filters.ts:404

Sets the Vaporwave filter for the player.

Parameters

value

boolean

Boolean value indicating whether to enable or disable Vaporwave.

options?

TimescaleOptions

Optional custom parameters.

Returns

Promise<Filters>

• Returns the current instance of the filters.

---

setVibrato()

setVibrato(vibrato?): Promise<Filters>

Defined in: src/Filters.ts:250

Changes the vibrato options applied to the currently player.

Parameters

vibrato?

An object that conforms to the VibratoOptions type, defining the vibrato to apply.

null | VibratoOptions

Returns

Promise<Filters>

• Returns the current Filters instance for method chaining.

---

updateFilters()

updateFilters(): Promise<Filters>

Defined in: src/Filters.ts:463

Updates the filters applied to the currently player on the lavalink node.

Returns

Promise<Filters>

• Returns the current Filters instance with updated filters.