FilterManager

Defined in: src/structures/Filters.ts:9

The FilterManager for each player

Constructors

Constructor

new FilterManager(player: Player): FilterManager;

Defined in: src/structures/Filters.ts:107

The Constructor for the FilterManager

Parameters

Parameter	Type
player	Player

Returns

FilterManager

Properties

Property	Modifier	Type	Default value	Description	Defined in
data	public	FilterData	undefined	The Filter Data sent to Lavalink, only if the filter is enabled (ofc.)	src/structures/Filters.ts:38
equalizerBands	public	EQBand[]	[]	The Equalizer bands currently applied to the Lavalink Server	src/structures/Filters.ts:11
filters	public	PlayerFilters	undefined	All “Active” / “disabled” Player Filters	src/structures/Filters.ts:15
filterUpdatedState	public	boolean	false	Private Util for the instaFix Filters option	src/structures/Filters.ts:13
lavalinkFilterPlugin	public	object	undefined	-	src/structures/Filters.ts:548
lavalinkFilterPlugin.toggleEcho	public	(delay: number, decay: number) => Promise<boolean>	undefined	Enables / Disables the Echo effect, IMPORTANT! Only works with the correct Lavalink Plugin installed. (Optional: provide your Own Data)	src/structures/Filters.ts:555
lavalinkFilterPlugin.toggleReverb	public	(delays: number[], gains: number[]) => Promise<boolean>	undefined	Enables / Disables the Echo effect, IMPORTANT! Only works with the correct Lavalink Plugin installed. (Optional: provide your Own Data)	src/structures/Filters.ts:579
lavalinkLavaDspxPlugin	public	object	undefined	-	src/structures/Filters.ts:442
lavalinkLavaDspxPlugin.toggleEcho	public	(decay?: number, echoLength?: number) => Promise<boolean>	undefined	Enables / Disables the Echo effect, IMPORTANT! Only works with the correct Lavalink Plugin installed. (Optional: provide your Own Data)	src/structures/Filters.ts:528
lavalinkLavaDspxPlugin.toggleHighPass	public	(boostFactor: number, cutoffFrequency: number) => Promise<boolean>	undefined	Enables / Disables the HighPass effect, (Optional: provide your Own Data)	src/structures/Filters.ts:476
lavalinkLavaDspxPlugin.toggleLowPass	public	(boostFactor: number, cutoffFrequency: number) => Promise<boolean>	undefined	Enables / Disables the LowPass effect, (Optional: provide your Own Data)	src/structures/Filters.ts:450
lavalinkLavaDspxPlugin.toggleNormalization	public	(maxAmplitude?: number, adaptive?: boolean) => Promise<boolean>	undefined	Enables / Disables the Normalization effect.	src/structures/Filters.ts:502
player	public	Player	undefined	The Player assigned to this Filter Manager	src/structures/Filters.ts:105

Methods

applyPlayerFilters()

applyPlayerFilters(): Promise<void>;

Defined in: src/structures/Filters.ts:115

Apply Player filters for lavalink filter sending data, if the filter is enabled / not

Returns

Promise<void>

---

checkFiltersState()

checkFiltersState(oldFilterTimescale?: Partial<TimescaleFilter>): boolean;

Defined in: src/structures/Filters.ts:174

Checks if the filters are correctly stated (active / not-active)

Parameters

Parameter	Type	Description
oldFilterTimescale?	Partial<TimescaleFilter>

Returns

boolean

---

clearEQ()

clearEQ(): Promise<FilterManager>;

Defined in: src/structures/Filters.ts:688

Clears the equalizer bands.

Returns

Promise<FilterManager>

---

isCustomFilterActive()

isCustomFilterActive(): boolean;

Defined in: src/structures/Filters.ts:654

Function to find out if currently there is a custom timescamle etc. filter applied

Returns

boolean

---

resetFilters()

resetFilters(): Promise<PlayerFilters>;

Defined in: src/structures/Filters.ts:202

Reset all Filters

Returns

Promise<PlayerFilters>

---

setAudioOutput()

setAudioOutput(type: AudioOutputs): Promise<AudioOutputs>;

Defined in: src/structures/Filters.ts:302

Set the AudioOutput Filter

Parameters

Parameter	Type	Description
type	AudioOutputs

Returns

Promise<AudioOutputs>

---

setEQ()

setEQ(bands:
  | EQBand
| EQBand[]): Promise<FilterManager>;

Defined in: src/structures/Filters.ts:662

Sets the players equalizer band on-top of the existing ones.

Parameters

Parameter	Type	Description
bands	| EQBand | EQBand[]

Returns

Promise<FilterManager>

---

setPitch()

setPitch(pitch: number): Promise<boolean>;

Defined in: src/structures/Filters.ts:339

Set custom filter.timescale#pitch . This method disabled both: nightcore & vaporwave. use 1 to reset it to normal

Parameters

Parameter	Type	Default value
pitch	number	1

Returns

Promise<boolean>

---

setRate()

setRate(rate: number): Promise<boolean>;

Defined in: src/structures/Filters.ts:364

Set custom filter.timescale#rate . This method disabled both: nightcore & vaporwave. use 1 to reset it to normal

Parameters

Parameter	Type	Default value
rate	number	1

Returns

Promise<boolean>

---

setSpeed()

setSpeed(speed: number): Promise<boolean>;

Defined in: src/structures/Filters.ts:315

Set custom filter.timescale#speed . This method disabled both: nightcore & vaporwave. use 1 to reset it to normal

Parameters

Parameter	Type	Default value	Description
speed	number	1

Returns

Promise<boolean>

---

setVolume()

setVolume(volume: number): Promise<boolean>;

Defined in: src/structures/Filters.ts:287

Set the Filter Volume

Parameters

Parameter	Type	Description
volume	number

Returns

Promise<boolean>

---

toggleKaraoke()

toggleKaraoke(
   level: number,
   monoLevel: number,
   filterBand: number,
filterWidth: number): Promise<boolean>;

Defined in: src/structures/Filters.ts:640

Enable / Disables a Karaoke like Filter Effect

Parameters

Parameter	Type	Default value	Description
level	number	1
monoLevel	number	1
filterBand	number	220
filterWidth	number	100

Returns

Promise<boolean>

---

toggleLowPass()

toggleLowPass(smoothing: number): Promise<boolean>;

Defined in: src/structures/Filters.ts:433

Enables / Disables the LowPass effect, (Optional: provide your Own Data)

Parameters

Parameter	Type	Default value	Description
smoothing	number	20

Returns

Promise<boolean>

---

toggleNightcore()

toggleNightcore(
   speed: number,
   pitch: number,
rate: number): Promise<boolean>;

Defined in: src/structures/Filters.ts:601

Enables / Disables a Nightcore-like filter Effect. Disables/Overrides both: custom and Vaporwave Filter

Parameters

Parameter	Type	Default value	Description
speed	number	1.289999523162842
pitch	number	1.289999523162842
rate	number	0.9365999523162842

Returns

Promise<boolean>

---

toggleRotation()

toggleRotation(rotationHz: number): Promise<boolean>;

Defined in: src/structures/Filters.ts:387

Enables / Disables the rotation effect, (Optional: provide your Own Data)

Parameters

Parameter	Type	Default value	Description
rotationHz	number	0.2

Returns

Promise<boolean>

---

toggleTremolo()

toggleTremolo(frequency: number, depth: number): Promise<boolean>;

Defined in: src/structures/Filters.ts:419

Enables / Disables the Tremolo effect, (Optional: provide your Own Data)

Parameters

Parameter	Type	Default value	Description
frequency	number	4
depth	number	0.8

Returns

Promise<boolean>

---

toggleVaporwave()

toggleVaporwave(
   speed: number,
   pitch: number,
rate: number): Promise<boolean>;

Defined in: src/structures/Filters.ts:620

Enables / Disables a Vaporwave-like filter Effect. Disables/Overrides both: custom and nightcore Filter

Parameters

Parameter	Type	Default value	Description
speed	number	0.8500000238418579
pitch	number	0.800000011920929
rate	number	1

Returns

Promise<boolean>

---

toggleVibrato()

toggleVibrato(frequency: number, depth: number): Promise<boolean>;

Defined in: src/structures/Filters.ts:404

Enables / Disables the Vibrato effect, (Optional: provide your Own Data)

Parameters

Parameter	Type	Default value	Description
frequency	number	10
depth	number	1

Returns

Promise<boolean>