Class LavalinkPluginFilter

Class representing Lavalink plugin filters. LavalinkPluginFilter

Index

Constructors

Methods

setEcho setReverb

Constructors

constructor

new LavalinkPluginFilter(filters: FilterManager): LavalinkPluginFilter
Creates an instance of LavalinkPluginFilter.
Parameters
- filters: FilterManager
  The filter manager instance.
Returns LavalinkPluginFilter
- Defined in hoshimi/src/classes/player/filters/LavalinkPlugin.ts:28

Methods

setEcho

setEcho(
settings?: Partial<NonLengthEchoSettings>,
): Promise<LavalinkPluginFilter>
Set the echo filter with the given settings.
Parameters
- Optionalsettings: Partial<NonLengthEchoSettings> = DefaultFilterPreset.PluginEcho
  The settings for the echo filter.
Returns Promise<LavalinkPluginFilter>
The instance of the filter manager.
Throws
If the node does not have the required plugin or filter enabled.
Example
```
// Set the echo filter with custom settings
await player.filterManager.lavalinkPlugin.setEcho({ decay: 0.5, delay: 200 });
// Disable the echo filter
await player.filterManager.lavalinkPlugin.setEcho();
```
- Defined in hoshimi/src/classes/player/filters/LavalinkPlugin.ts:46

setReverb

setReverb(
settings?: Partial<LavalinkFilterPluginReverbSettings>,
): Promise<LavalinkPluginFilter>
Set the reverb filter with the given settings.
Parameters
- Optionalsettings: Partial<LavalinkFilterPluginReverbSettings> = DefaultFilterPreset.PluginReverb
  The settings for the reverb filter.
Returns Promise<LavalinkPluginFilter>
The instance of the filter manager.
Throws
If the node does not have the required plugin or filter enabled.
Example
```
// Set the reverb filter with custom settings
await player.filterManager.lavalinkPlugin.setReverb({ delays: [50, 100, 150], gains: [0.5, 0.3, 0.2] });
// Disable the reverb filter
await player.filterManager.lavalinkPlugin.setReverb();
```
- Defined in hoshimi/src/classes/player/filters/LavalinkPlugin.ts:87