Filters

danger

🚨 THIS DOCUMENTATION IS FOR VERSION =<2.6.1. WE RECOMMEND USING THE LATEST VERSION FOR SUPPORT REASONS. WE ALSO WARN THAT THIS OLDER DOCUMENTATION MAY NOT BE COMPLETE OR POORLY READABLE.

Constructor

Filters

new Magmastream.Filters(player: Player)

Properties

Parameter	Type	Description
player	Player	The guild player

Table of Contents

Properties	Methods
distortion	bassBoost()
equalizer	clearFilters()
karaoke	distort()
player	eightD()
rotation	getFilterStatus()
timescale	setDistortion()
vibrato	setEqualizer()
volume	setKaraoke()
	setRotation()
	setTimescale()
	setVibrato()
	slowmo()
	soft()
	trebleBass()
	tv()
	vaporwave()

Properties

distortion

Get distortion settings

Returns: DistortionOptions{} | null

equalizer

Get equalizer settings

Returns: Band[]

karaoke

Get karaoke settings

Returns: KaraokeOptions{} | null

player

Get player

Returns: Player

rotation

Get rotation settings

Returns: RotationOptions{} | null

timescale

Get timescale settings

Returns: TimescaleOptions{} | null

vibrato

Get vibrato settings

Returns: VibratoOptions{} | null

volume

Get volume

Returns: number

Methods

bassBoost()

Applies the bass boost effect.

Returns: this

clearFilters()

Removes the audio effects and resets the filters status.

Returns: Promise<this>

distort()

Applies the distortion audio effect.

Returns: this

eightD()

Applies the eight dimension audio effect.

Returns: this

getFilterStatus()

Returns the status of the specified filter.

Returns: this

Parameter	Type	Optional
filter	AvailableFilters

nightcore()

Applies the nightcore effect.

Returns: this

setDistortion()

Applies the distortion options specified by the filter.

Returns: this

Parameter	Type	Optional
distortion	DistortionOptions{}

setEqualizer()

Sets the equalizer bands and updates the filters.

Returns: this

Parameter	Type	Optional
bands	Band[]

setKaraoke()

Applies the karaoke options specified by the filter.

Returns: this

Parameter	Type	Optional
karaoke	KaraokeOptions{}

setTimescale()

Applies the timescale options specified by the filter.

Returns: this

Parameter	Type	Optional
timescale	TimescaleOptions{}

setVibrato()

Applies the vibrato options specified by the filter.

Returns: this

Parameter	Type	Optional
vibrato	VibratoOptions{}

slowmo()

Applies the slow motion audio effect.

Returns: this

soft()

Applies the soft audio effect.

Returns: this

trebleBass()

Applies the treble bass effect.

Returns: this

tv()

Applies the television audio effect.

Returns: this

vaporwave()

Applies the vaporwave effect.

Returns: this

Filter Options

AvailableFilters

bassboost distort eightD karaoke nightcore slowmo soft trebleBass tv vaporwave

DistortionOptions

Options for applying distortion effect to audio.

Properties	Type	Description
sinOffset	number	The offset value for the sine wave distortion.
sinScale	number	The scale factor for the sine wave distortion.
cosOffset	number	The offset value for the cosine wave distortion.
cosScale	number	The scale factor for the cosine wave distortion.
tanOffset	number	The offset value for the tangent wave distortion.
tanScale	number	The scale factor for the tangent wave distortion.
offset	number	The general offset applied to the distortion effect.
scale	number	The general scale factor applied to the distortion effect.

KaraokeOptions

Options for applying karaoke effect to audio.

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.

RotationOptions

Options for applying rotation effect to audio.

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

TimescaleOptions

Options for adjusting the timescale of audio.

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

Options for applying vibrato effect to audio.

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.