Class : Filters
Constructor
- Filters : options
new Magmastream.Filters(player: Player)
| Parameter | Type | Description |
|---|---|---|
player | Player | The guild player. |
Table of contents
Properties
distortion
Get the distortion filter options
Return:
distortionOptions{}| null
equalizer
Get the equalizer filter options
Return:
Band[]
karaoke
Get the karaoke filter options
Return:
karaokeOptions{}| null
player
The guild player
Return:
Player
rotation
Get the rotation filter options
Return:
rotationOptions{}| null
timescale
Get the timescale filter options
Return:
timescaleOptions{}| null
vibrato
Get the vibrato filter options
Return:
vibratoOptions{}| null
volume
Get the volume the player
Return: number
Methods
bassBoost()
Applies the bass boost effect by setting an equalizer with boosted bass frequencies.
This method enhances the lower frequencies of the audio, giving the audio a deep and powerful bass response.Return: this
china()
Apply the china audio effect.
Return: this
chipmunk()
Apply the chipmunk audio effect.
Return: this
clearFilters()
Clears all filters applied to the audio.
This method resets all filter settings to their default values and removes any active filters from the player.
darthvader()
Applies the darthvader effect to the audio.
Return: this
daycore()
Applies the daycore effect to the audio.
Return: this
distort()
Applies a distortion effect to the audio.
This method applies a distortion effect by adjusting various distortion parameters.
It can make the audio sound rougher and more intense.Return: this
doubletime()
Applies the doubletime effect to the audio.
Return: this
earrape()
Applies the earrape effect to the audio.
Return: this
eightD()
Applies the "8D audio" effect by setting a rotation filter.
This method creates the "8D audio" effect, which gives the illusion of sound moving around the listener's head. It applies a subtle rotation effect to the audio.Return: this
getFilterStatus(filter)
Retrieves the status of a specific filter.
This method returns whether a specific filter is currently applied or not.Return: boolean
Parameter Type Description Optional filteravailableFilters''The filter to check.
nightcore()
Applies the nightcore effect by adjusting the speed and pitch of the audio.
This method increases the tempo and pitch of the audio, giving it a faster and higher-pitched sound, characteristic of the nightcore genre.Return: this
party()
Applies the party effect to the audio.
Return: this
pop()
Applies the pop effect to the audio.
Return: this
radio()
Applies the radio effect to the audio.
Return: this
setDistortion(distortion)
Sets the distortion effect on the audio.
This method applies a distortion effect to the audio, which adds an aggressive, rough texture to the sound.Return: this
Parameter Type Description Optional distortiondistortionOptions{}The distortion options to apply. If nothing are provided, the distortion is reset.
setEqualizer(bands)
Sets the equalizer bands for 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.Return: this
Parameter Type Description Optional bandsBand[]The equalizer bands to apply. Each band includes a band number and a gain value. If nothing are provided, the equalizer is reset.
setKaraoke(karaoke)
Sets the karaoke effect on the audio.
This method adjusts the player's audio output to apply a karaoke effect, which may include filtering out vocals or adjusting levels for optimal karaoke performance.Return: this
Parameter Type Description Optional karaokekaraokeOptions{}The karaoke settings to apply (level, mono level, filter band, etc.). If nothing are provided, the karaoke is reset.
setRotation(rotation)
Sets the rotation effect on the audio.
This method applies a rotation effect to the audio, creating the illusion of sound moving around the listener's head.Return: this
Parameter Type Description Optional rotationrotationOptions{}The rotation settings (rotationHz). If nothing are provided, the rotation is reset.
setTimescale(timescale)
Sets the timescale (speed, pitch, rate) for the audio.
This method adjusts the speed, pitch, and rate of the audio, allowing for effects such as faster or slower playback, pitch shifts, and time dilation.Return: this
Parameter Type Description Optional timescaletimescaleOptions{}The timescale settings to apply (speed, pitch, rate). If nothing are provided, the timescale is reset.
setVibrato(timescale)
Sets the vibrato effect on the audio.
This method applies a vibrato effect to the audio, which creates a wobble in the pitch by modulating it at a specified frequency and depth.Return: this
Parameter Type Description Optional timescaletimescaleOptions{}The vibrato settings to apply (frequency and depth).
setVolume(volume)
Sets the volume effect on the audio.
Return: this
Parameter Type Description Optional volumenumber Number of volume for the audio
slowmo()
Applies the slow-motion effect by reducing the speed and pitch of the audio.
This method slows down the audio, giving it a slower and more relaxed feel.Return: this
soft()
Applies a soft equalizer to give the audio a smoother sound.
This method adjusts the equalizer settings to soften the frequencies and give the audio a more mellow tone.Return: this
tremolo()
Applies the doubletime effect to the audio.
Return: this
trebleBass()
Applies the "treble and bass boost" effect to the audio.
This method adjusts the equalizer to boost both the treble (high frequencies) and bass (low frequencies), giving the audio a more balanced and enhanced sound.Return: this
tv()
Applies a TV-like equalizer effect to the audio.
This method adjusts the equalizer to give the audio a "TV" effect, which may simulate the audio quality heard from television speakers.Return: this
vaporwave()
Applies the vaporwave effect by adjusting the equalizer and pitch.
This method applies a vaporwave-style equalizer, with softer tones, and adjusts the pitch to give the audio a dreamy, nostalgic feel.Return: this