Skip to content

features/equalizer ​

onEqualizerChanged ​

ts
const onEqualizerChanged: NativeUpdatedValue<EqualizerSettings>;

Subscribes to equalizer settings changes (Android only).

Param ​

Called when equalizer settings change

Returns ​

Cleanup function to unsubscribe


setEqualizerEnabled() ​

ts
function setEqualizerEnabled(enabled): void;

Enables or disables the equalizer (Android only).

Parameters ​

ParameterTypeDescription
enabledbooleanWhether to enable the equalizer

Returns ​

void


setEqualizerLevels() ​

ts
function setEqualizerLevels(levels): void;

Sets custom equalizer band levels (Android only).

Parameters ​

ParameterTypeDescription
levelsnumber[]Array of level values for each band (in millibels)

Returns ​

void


setEqualizerPreset() ​

ts
function setEqualizerPreset(preset): void;

Sets the equalizer to a preset (Android only).

Parameters ​

ParameterTypeDescription
presetstringThe name of the preset to apply

Returns ​

void


useEqualizerSettings() ​

ts
function useEqualizerSettings(): EqualizerSettings | undefined;

Hook that returns the current equalizer settings and updates when they change (Android only).

Returns ​

EqualizerSettings | undefined

Current equalizer settings, or undefined if not available


getEqualizerSettings() ​

ts
function getEqualizerSettings(): EqualizerSettings | undefined;

Gets the current equalizer settings (Android only).

Returns ​

EqualizerSettings | undefined

Equalizer settings, or undefined if not available


EqualizerSettings ​

ts
type EqualizerSettings = object;

Properties ​

activePreset? ​

ts
optional activePreset: string;

bandCount ​

ts
bandCount: number;

bandLevels ​

ts
bandLevels: number[];

centerBandFrequencies ​

ts
centerBandFrequencies: number[];

enabled ​

ts
enabled: boolean;

lowerBandLevelLimit ​

ts
lowerBandLevelLimit: number;

presets ​

ts
presets: string[];

upperBandLevelLimit ​

ts
upperBandLevelLimit: number;