Filters

Table of Contents

• Class Definition
• Properties
• Constructor
• Methods

Class Definition

export class Filters {}

Properties

Property	Type	Description
bassBoostlevel	number	The bass boost level.
distortion	DistortionOptions | null	The distortion options or null.
equalizer	Band[]	The equalizer.
filtersStatus	Record<AvailableFilters, boolean>	The filters status.
karaoke	KaraokeOptions | null	The karaoke options or null.
player	Player	The player.
reverb	ReverbOptions | null	The reverb options or null.
rotation	RotationOptions | null	The rotation options or null.
timescale	TimescaleOptions | null	The timescale options or null.
vibrato	VibratoOptions | null	The vibrato options or null.
volume	number	The volume.

Constructor

new Filters(player: Player, manager: Manager)

Parameter	Type	Description	Optional
player	Player	The player.
manager	Manager	The manager.

Methods

bassBoost()

async bassBoost(stage: number): Promise<this>

Sets the bass boost level on the audio.

Parameters

Parameter	Type	Description	Optional
stage	number	The stage.

Returns

Type	Description
Promise<this>	The filters.

---

china()

async china(status: boolean): Promise<this>

Toggles the "China" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

chipmunk()

async chipmunk(status: boolean): Promise<this>

Toggles the "Chipmunk" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

clearFilters()

async clearFilters(): Promise<this>

Clears all filters on the audio.

Returns

Type	Description
Promise<this>	The filters.

---

darthvader()

async darthvader(status: boolean): Promise<this>

Toggles the "Darth Vader" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

daycore()

async daycore(status: boolean): Promise<this>

Toggles the "Daycore" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

demon()

async demon(status: boolean): Promise<this>

Toggles the "Demon" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

distort()

async distort(status: boolean): Promise<this>

Toggles the "Distort" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

doubletime()

async doubletime(status: boolean): Promise<this>

Toggles the "Doubletime" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

earrape()

async earrape(status: boolean): Promise<this>

Toggles the "Earrape" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

eightD()

async eightD(status: boolean): Promise<this>

Toggles the "EightD" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

electronic()

async electronic(status: boolean): Promise<this>

Toggles the "Electronic" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

getFilterStatus()

getFilterStatus(filter: AvailableFilters): boolean

Gets the filter status.

Parameters

Parameter	Type	Description	Optional
filter	AvailableFilters	The filter.

Returns

Type	Description
boolean	The filter status.

---

nightcore()

async nightcore(status: boolean): Promise<this>

Toggles the "Nightcore" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

party()

async party(status: boolean): Promise<this>

Toggles the "Party" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

pop()

async pop(status: boolean): Promise<this>

Toggles the "Pop" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

radio()

async radio(status: boolean): Promise<this>

Toggles the "Radio" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

setDistortion()

async setDistortion(distortion?: DistortionOptions): Promise<this>

Sets the distortion effect on the audio.

Parameters

Parameter	Type	Description	Optional
distortion	DistortionOptions	The distortion options.

Returns

Type	Description
Promise<this>	The filters.

---

setEqualizer()

async setEqualizer(bands?: Band[]): Promise<this>

Sets the equalizer on the audio.

Parameters

Parameter	Type	Description	Optional
bands	EqualizerBand[]	The equalizer bands.

Returns

Type	Description
Promise<this>	The filters.

---

setFilterStatus()

async setFilterStatus(filter: AvailableFilters, status: boolean): Promise<this>

Sets the filter status on the audio.

Parameters

Parameter	Type	Description	Optional
filter	AvailableFilters	The filter.
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

setKaraoke()

async setKaraoke(karaoke?: KaraokeOptions): Promise<this>

Sets the karaoke effect on the audio.

Parameters

Parameter	Type	Description	Optional
karaoke	KaraokeOptions	The karaoke options.

Returns

Type	Description
Promise<this>	The filters.

---

setRotation()

async setRotation(rotation?: RotationOptions): Promise<this>

Sets the rotation effect on the audio.

Parameters

Parameter	Type	Description	Optional
rotation	RotationOptions	The rotation options.

Returns

Type	Description
Promise<this>	The filters.

---

setTimescale()

async setTimescale(timescale?: TimescaleOptions): Promise<this>

Sets the timescale effect on the audio.

Parameters

Parameter	Type	Description	Optional
timescale	TimescaleOptions	The timescale options.

Returns

Type	Description
Promise<this>	The filters.

---

setVibrato()

async setVibrato(vibrato?: VibratoOptions): Promise<this>

Sets the vibrato effect on the audio.

Parameters

Parameter	Type	Description	Optional
vibrato	VibratoOptions	The vibrato options.

Returns

Type	Description
Promise<this>	The filters.

---

slowmo()

async slowmo(status: boolean): Promise<this>

Toggles the "Slowmo" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

soft()

async soft(status: boolean): Promise<this>

Toggles the "Soft" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

trebleBass()

async trebleBass(status: boolean): Promise<this>

Toggles the "Treble Bass" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

tremolo()

async tremolo(status: boolean): Promise<this>

Toggles the "Tremolo" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

tv()

async tv(status: boolean): Promise<this>

Toggles the "TV" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.

---

updateFilters()

async updateFilters(): Promise<this>

Updates the filters.

Returns

Type	Description
Promise<this>	The filters.

---

vaporwave()

async vaporwave(status: boolean): Promise<this>

Toggles the "Vaporwave" effect on the audio.

Parameters

Parameter	Type	Description	Optional
status	boolean	The status.

Returns

Type	Description
Promise<this>	The filters.