Skip to main content

Interface: AudioFilter

Defined in: packages/player/src/filters.ts:72

One entry of an mpv audio filter chain.

Build these with the AudioFilters factories, which validate against the underlying filter's documented ranges. AudioFilters.custom makes arbitrary (including future) libavfilter filters reachable without a release.

Properties​

enabled?​

readonly optional enabled?: boolean;

Defined in: packages/player/src/filters.ts:90

false emits mpv's ! disable marker, keeping the entry in the chain but bypassed. Defaults to true.

label?​

readonly optional label?: string;

Defined in: packages/player/src/filters.ts:85

Optional mpv filter label (@name:filter=…). Labels let mpv's af add / af toggle commands address a single entry; this library never needs one, but the escape hatch stays open.

name​

readonly name: string;

Defined in: packages/player/src/filters.ts:77

The filter name as mpv/libavfilter knows it — e.g. equalizer, superequalizer, or an mpv builtin such as format.

options​

readonly options: readonly AudioFilterOption[];

Defined in: packages/player/src/filters.ts:79

Sub-options, in emission order.