Hoshimi Docs

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

hoshimisrc/classes/player/filters/DSPXPlugin.d.ts

Signature

export declare class DSPXPluginFilter

JSDoc

@classDSPXPluginFilter

Properties

manager

Methods

constructor setLowPass setHighPass setNormalization setEcho

Properties

manager

readonly manager: FilterManagerStructure;

The filter manager instance.

@type{FilterManagerStructure}@readonly

Methods

constructorConstructor

constructor(manager: FilterManagerStructure);

setLowPass

setLowPass(settings?: Partial<FilterPluginPassSettings>): Promise<FilterManagerStructure>;

Set the DSPX low-pass filter (idempotent).

Examples

await player.filterManager.dspx.setLowPass({ cutoffFrequency: 500, boostFactor: 1.5 });
await player.filterManager.clear(FilterType.DSPXLowpass);

setHighPass

setHighPass(settings?: Partial<FilterPluginPassSettings>): Promise<FilterManagerStructure>;

Set the DSPX high-pass filter (idempotent).

setNormalization

setNormalization(settings?: Partial<NormalizationSettings>): Promise<FilterManagerStructure>;

Set the DSPX normalization filter (idempotent).

setEcho

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

Set the DSPX echo filter (idempotent).