Skip to main content

Interface: ShelfOptions

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

AudioFilters.bass / AudioFilters.treble options.

Extends​

  • BiquadShapingOptions

Properties​

frequency?​

readonly optional frequency?: number;

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

Centre frequency in Hz (f), 0–999999.

Inherited from​

BiquadShapingOptions.frequency

gain​

readonly gain: number;

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

Gain in dB (g), −900…+900.

Inherited from​

BiquadShapingOptions.gain

poles?​

readonly optional poles?: 2 | 1;

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

Shelf slope: 1 or 2 poles (p). Defaults to ffmpeg's 2 (af_biquads.c:1546-1547, :1572-1573).

width?​

readonly optional width?: number;

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

Band width, 0–99999, interpreted per widthType (w). ffmpeg defaults to 1.0 for equalizer and 0.5 for the shelves.

Inherited from​

BiquadShapingOptions.width

widthType?​

readonly optional widthType?: BiquadWidthType;

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

How width is read (t). Defaults to 'q' (Q-factor), as ffmpeg does.

Inherited from​

BiquadShapingOptions.widthType