LavalinkPluginFilter

Thin facade over the `lavalink-filter-plugin` filters. Each setter delegates to {@link FilterManager.set}; validation, envelope routing, and node-capability checks are handled by the {@link FilterRegistry}.

Signature

export declare class LavalinkPluginFilter

Private types

NonLengthEchoSettingsTypeAlias
type NonLengthEchoSettings = Omit<EchoSettings, "echoLength">;

JSDoc

@classLavalinkPluginFilter

Properties

private readonly manager;

The filter manager instance.

@type{FilterManagerStructure}@private@readonly

Methods

setEcho(settings?: Partial<NonLengthEchoSettings>): Promise<FilterManagerStructure>;

Set the echo filter (idempotent).

Parameters

settings
Echo settings.

Returns

The filter manager.

Examples

await player.filterManager.plugin.setEcho({ decay: 0.5, delay: 200 });
// To turn off:
await player.filterManager.clear(FilterType.Echo);
setReverb(settings?: Partial<LavalinkFilterPluginReverbSettings>): Promise<FilterManagerStructure>;

Set the reverb filter (idempotent).

Parameters

settings
Reverb settings.

Returns

The filter manager.

Examples

await player.filterManager.plugin.setReverb({ delays: [50, 100], gains: [0.5, 0.3] });
// To turn off:
await player.filterManager.clear(FilterType.Reverb);