Filters

Constructor

Filters : options

new Magmastream.Filters(player: Player)

Parameter	Type	Description
player	Player	The guild player.

Table of contents

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

Properties

distortion

Get the distortion filter options

Returns: distortionOptions{} | null

equalizer

Get the equalizer filter options

Returns: Band[]

karaoke

Get the karaoke filter options

Returns: karaokeOptions{} | null

player

The guild player

Returns: Player

rotation

Get the rotation filter options

Returns: rotationOptions{} | null

timescale

Get the timescale filter options

Returns: timescaleOptions{} | null

vibrato

Get the vibrato filter options

Returns: vibratoOptions{} | null

volume

Get the volume the player

Returns: number

Methods

bassBoost()

Apply the bass boost audio effect.

This filter sets the equalizer bands to the values defined in the bassBoostEqualizer array.

Returns: this

clearFilters()

Removes the audio effects and resets the filter status.

This method is useful for removing all audio effects and resetting the filter status to its default state.
It is also a convenient way to disable all audio effects without having to manually reset each filter individually.

Returns: Promise<this>

distort()

Applies the distortion audio effect to the player.

This filter applies a distortion effect to the audio by applying a sine, cosine, and tangent
transformation to the audio signal.

Returns: this

eightD()

Applies the eight dimension audio effect.

This filter applies a rotationHz of 0.2 to the player.

Returns: this

getFilterStatus()

Returns the status of the specified filter.

Returns: boolean

Parameter	Type	Description
filter	availableFilters''	The filter to get the status of.

nightcore()

Applies the nightcore audio effect.

This filter sets the timescale of the player to 1.1 speed, 1.125 pitch, and 1.05 rate.

Returns: this

setDistortion()

Applies the distortion audio effect to the player.

This method takes an optional distortionOptions object as a parameter, which can be used to customize the distortion effect. If no options are provided, the filter will be reset and the distortion effect will be disabled.

Returns: this

Parameter	Type	Description
distortion	distortionOptions{}	The distortion options to apply.

setEqualizer()

Sets the equalizer bands and updates the filters on the player.

This method updates the player's equalizer settings by applying the provided bands configuration. The equalizer is an array of Band objects, each containing a band number and a gain value. The method ensures that the filters are updated after setting the equalizer, to reflect the changes in audio output.

Returns: this

Parameter	Type	Description
bands	Band[]	The equalizer bands to apply. Each band includes a band number and a gain value. If no bands are provided, the equalizer is reset.

setKaraoke()

Applies the karaoke options specified by the filter.

This method takes an optional karaokeOptions object as a parameter, which can be used to customize the karaoke effect. If no options are provided, the filter will be reset and the karaoke effect will be disabled.

Returns: this

Parameter	Type	Description
karaoke	karaokeOptions{}	The karaoke options to apply.

setRotation()

Applies the karaoke options specified by the filter.

This method takes an optional karaokeOptions object as a parameter, which can be used to customize the karaoke effect. If no options are provided, the filter will be reset and the karaoke effect will be disabled.

Returns: this

Parameter	Type	Description
rotation	rotationOptions{}	The rotation options to apply.

setTimescale()

Applies the timescale options specified by the filter.

This method sets the timescale of the audio player using the provided timescale options. Timescale options may include speed, pitch, and rate adjustments to modify the playback characteristics of the audio.

Returns: this

Parameter	Type	Description
timescale	timescaleOptions{}	The timescale options to apply.

setVibrato()

Applies the vibrato options specified by the filter.

This method takes an optional vibratoOptions object as a parameter, which can be used to customize the vibrato effect. If no options are provided, the filter will be reset and the vibrato effect will be disabled.

Returns: this

Parameter	Type	Description
timescale	timescaleOptions{}	The timescale options to apply.

slowmo()

Applies the slow motion audio effect.

This filter sets the timescale of the player to 0.7 speed, 1.0 pitch, and 0.8 rate.

Returns: this

soft()

Applies the soft audio effect to the player.

This method sets the equalizer bands to the values defined in the softEqualizer array, which is designed to create a softer sound effect by reducing the gain of certain frequency bands.

Returns: this

trebleBass()

Applies the treble bass audio effect.

This filter applies a treble boost and a bass boost to the audio.

Returns: this

tv()

Applies the television audio effect.

This filter applies a equalizer effect designed to make the audio sound like it is coming from a television.

Returns: this

vaporwave()

Applies the vaporwave audio effect.

This filter applies a timescale effect with a pitch of 0.55 and an equalizer effect designed to create a vaporwave sound effect.

Returns: this