Filters

The Filters class represents a collection of audio filters that can be applied to audio playback.

Constructor

new Filters(player: Player)

Properties

Parameter	Type
player	Player

Overview

Methods	Type	Returns	Description
eightD		this	Enable eight-dimension audio.
bassBoost		this	Enable bass boost filter.
nightcore		this	Enable nightcore filter.
slowmo		this	Enable slowmo filter.
soft		this	Enable soft filter.
tv		this	Enable tv filter.
trebleBass		this	Enable treble bass filter.
vaporwave		this	Enable vaporwave filter.
distort		this	Enable distortion filter.
setEqualizer	Band[]	this	Set custom equalizer bands.
setKaraoke	KaraokeOptions	this	Set karaoke filter.
setTimescale	TimescaleOptions	this	Set the timescale.
setVibrato	VibratoOptions	this	Set the vibrato effect.
setRotation	RotationOptions	this	Set the rotation effect.
setDistortion	DistortionOptions	this	Set the distortion effect.
clearFilters		Promise<this>	Clear the filters.
updateFilters		Promise<this>	Update the filters.
getFilterStatus	availableFilters	boolean	The status of the specified filter.

Band

Properties	Type	Description
band	number	The index of the equalizer band.
gain	number	The gain value of the equalizer band.

KaraokeOptions

Properties	Type	Description
level	number	The level of karaoke effect.
monoLevel	number	The mono level of karaoke effect.
filterBand	number	The filter band of karaoke effect.
filterWidth	number	The filter width of karaoke effect.

TimescaleOptions

Properties	Type	Description
speed	number	The speed factor for the timescale.
pitch	number	The pitch factor for the timescale.
rate	number	The rate factor for the timescale.

VibratoOptions

Properties	Type	Description
speed	number	The speed factor for the timescale.
pitch	number	The pitch factor for the timescale.
rate	number	The rate factor for the timescale.

RotationOptions

Properties	Type	Description
rotationHz	number	The rotation speed in Hertz (Hz).

DistortionOptions

Properties	Type
sinOffset	number
sinScale	number
cosOffset	number
cosScale	number
tanOffset	number
tanScale	number
offset	number
scale	number

availableFilters

Properties
bassboost
distort
eightD
karaoke
nightcore
slowmo
soft
treblebass
tv
vaporwave