Class: Filters
The Filters class that is used to apply filters to the currently player
Table of contents
Constructors
Properties
- _8d
- bassBoost
- channelMix
- chipmunk
- daycore
- distortion
- equalizer
- karaoke
- lowPass
- nightcore
- player
- rotation
- slowMode
- timescale
- tremolo
- vaporwave
- vibrato
- volume
Methods
- clearFilters
- set8D
- setBassboost
- setChannelMix
- setChipmunk
- setDaycore
- setDistortion
- setEqualizer
- setKaraoke
- setLowPass
- setNightcore
- setRotation
- setSlowmode
- setTimescale
- setTremolo
- setVaporwave
- setVibrato
- updateFilters
Constructors
constructor
• new Filters(player, options?): Filters
Parameters
| Name | Type |
|---|---|
player | Player |
options? | FiltersOptions |
Returns
Defined in
Properties
_8d
• _8d: null | boolean
Defined in
bassBoost
• bassBoost: number
Defined in
channelMix
• channelMix: null | ChannelMixOptions
Defined in
chipmunk
• chipmunk: null | boolean
Defined in
daycore
• daycore: null | boolean
Defined in
distortion
• distortion: null | DistortionOptions
Defined in
equalizer
• equalizer: Band[]
Defined in
karaoke
• karaoke: null | KaraokeOptions
Defined in
lowPass
• lowPass: null | LowPassOptions
Defined in
nightcore
• nightcore: null | boolean
Defined in
player
• player: Player
Defined in
rotation
• rotation: null | RotationOptions
Defined in
slowMode
• slowMode: null | boolean
Defined in
timescale
• timescale: null | TimescaleOptions
Defined in
tremolo
• tremolo: null | TremoloOptions
Defined in
vaporwave
• vaporwave: null | boolean
Defined in
vibrato
• vibrato: null | VibratoOptions
Defined in
volume
• volume: number
Defined in
Methods
clearFilters
▸ clearFilters(): Promise<Filters>
Clear all filters for the player.
Returns
Promise<Filters>
- Returns the current instance of the filters.
Defined in
set8D
▸ set8D(value, options?): Promise<Filters>
Sets the 8D filter for the player.
Parameters
| Name | Type | Description |
|---|---|---|
value | boolean | Boolean value indicating whether to enable or disable the 8D filter. |
options? | RotationOptions | Optional custom parameters. |
Returns
Promise<Filters>
- Returns the current instance of the filters.
Defined in
setBassboost
▸ setBassboost(value): Promise<Filters>
Sets the Bass boost value for the player.
Parameters
| Name | Type | Description |
|---|---|---|
value | number | The value of the Bass boost, it should be between 0 to 5. |
Returns
Promise<Filters>
- Returns the current instance of the filters.
Defined in
setChannelMix
▸ setChannelMix(mix): Promise<Filters>
Changes the channel mix options applied to the currently player.
Parameters
| Name | Type | Description |
|---|---|---|
mix | ChannelMixOptions | An object that conforms to the ChannelMixOptions type, defining the channel mix to apply. |
Returns
Promise<Filters>
- Returns the current Filters instance for method chaining.
Defined in
setChipmunk
▸ setChipmunk(value, options?): Promise<Filters>
Sets the Chipmunk filter for the player.
Parameters
| Name | Type | Description |
|---|---|---|
value | boolean | Boolean value indicating whether to enable or disable the Chipmunk filter. |
options? | TimescaleOptions | Optional custom parameters. |
Returns
Promise<Filters>
- Returns the current instance of the filters.
Defined in
setDaycore
▸ setDaycore(value, options?): Promise<Filters>
Sets the Daycore filter for the player.
Parameters
| Name | Type | Description |
|---|---|---|
value | boolean | Boolean value indicating whether to enable or disable Daycore. |
options? | Omit<TimescaleOptions, "speed"> | Optional custom parameters. |
Returns
Promise<Filters>
- Returns the current instance of the filters.
Defined in
setDistortion
▸ setDistortion(distortion): Promise<Filters>
Changes the distortion options applied to the currently player.
Parameters
| Name | Type | Description |
|---|---|---|
distortion | DistortionOptions | An object that conforms to the DistortionOptions type, defining the distortion to apply. |
Returns
Promise<Filters>
- Returns the current Filters instance for method chaining.
Defined in
setEqualizer
▸ setEqualizer(bands): Promise<Filters>
Sets the equalizer bands for the currently player.
Parameters
| Name | Type | Description |
|---|---|---|
bands | Band[] | An array of bands to set the equalizer to. |
Returns
Promise<Filters>
- Returns the Filters instance for method chaining.
Defined in
setKaraoke
▸ setKaraoke(karaoke?): Promise<Filters>
Changes the karaoke options applied to the currently player.
Parameters
| Name | Type | Description |
|---|---|---|
karaoke? | KaraokeOptions | An object that conforms to the KaraokeOptions type, defining a range of frequencies to mute. |
Returns
Promise<Filters>
- Returns the current Filters instance for method chaining.
Defined in
setLowPass
▸ setLowPass(pass): Promise<Filters>
Changes the low pass options applied to the currently player.
Parameters
| Name | Type | Description |
|---|---|---|
pass | LowPassOptions | An object that conforms to the LowPassOptions type, defining the low pass to apply. |
Returns
Promise<Filters>
- Returns the current Filters instance for method chaining.
Defined in
setNightcore
▸ setNightcore(value, options?): Promise<Filters>
Sets the Nightcore filter for the player.
Parameters
| Name | Type | Description |
|---|---|---|
value | boolean | Boolean value indicating whether to enable or disable Nightcore. |
options? | TimescaleOptions | Optional custom parameters. |
Returns
Promise<Filters>
- Returns the current instance of the filters.
Defined in
setRotation
▸ setRotation(rotation?): Promise<Filters>
Changes the rotation options applied to the currently player.
Parameters
| Name | Type | Description |
|---|---|---|
rotation? | null | RotationOptions | An object that conforms to the RotationOptions type, defining the rotation to apply. |
Returns
Promise<Filters>
- Returns the current Filters instance for method chaining.
Defined in
setSlowmode
▸ setSlowmode(value, options?): Promise<Filters>
Sets the Slowmode filter for the player.
Parameters
| Name | Type | Description |
|---|---|---|
value | boolean | The value to enable or disable Slowmode. |
options? | TimescaleOptions | Optional custom parameters. |
Returns
Promise<Filters>
- Returns the current instance of the filters.
Defined in
setTimescale
▸ setTimescale(timescale?): Promise<Filters>
Changes the timescale options applied to the currently player.
Parameters
| Name | Type | Description |
|---|---|---|
timescale? | null | TimescaleOptions | An object that conforms to the TimescaleOptions type, defining the timescale to apply. |
Returns
Promise<Filters>
- Returns the current Filters instance for method chaining.
Defined in
setTremolo
▸ setTremolo(tremolo?): Promise<Filters>
Changes the tremolo options applied to the currently player.
Parameters
| Name | Type | Description |
|---|---|---|
tremolo? | null | TremoloOptions | An object that conforms to the TremoloOptions type, defining the tremolo to apply. |
Returns
Promise<Filters>
- Returns the current Filters instance for method chaining.
Defined in
setVaporwave
▸ setVaporwave(value, options?): Promise<Filters>
Sets the Vaporwave filter for the player.
Parameters
| Name | Type | Description |
|---|---|---|
value | boolean | Boolean value indicating whether to enable or disable Vaporwave. |
options? | TimescaleOptions | Optional custom parameters. |
Returns
Promise<Filters>
- Returns the current instance of the filters.
Defined in
setVibrato
▸ setVibrato(vibrato?): Promise<Filters>
Changes the vibrato options applied to the currently player.
Parameters
| Name | Type | Description |
|---|---|---|
vibrato? | null | VibratoOptions | An object that conforms to the VibratoOptions type, defining the vibrato to apply. |
Returns
Promise<Filters>
- Returns the current Filters instance for method chaining.
Defined in
updateFilters
▸ updateFilters(): Promise<Filters>
Updates the filters applied to the currently player on the lavalink node.
Returns
Promise<Filters>
- Returns the current Filters instance with updated filters.