Skip to main content

Function: equalizerBandLabel()

function equalizerBandLabel(index: number): string;

Defined in: packages/player/src/equalizer-presets.ts:338

mpv filter label of one band of an editable chain (EqualizerPresetChainOptions.editable) — rnmedia_eq_1000 for the 1 kHz band.

The label is how Player.setAudioFilterParam addresses a single band while it runs. It is derived from the band's centre frequency rather than its index because that is what makes a getAudioFilters() read-back legible on a device; the band set is fixed and frozen, so the two are equivalent.

Parameters

ParameterTypeDescription
indexnumberPosition in EQUALIZER_BANDS.

Returns

string

Throws

PlayerErrorException with code invalid-state when index is not a band.