Skip to main content

Interface: EqualizerStorage

Defined in: packages/player/src/equalizer-storage.ts:52

Where an equaliser is written. Injected, structurally typed, and never depended on — the same two-method shape as @afkcodes/timbre-media-session's MediaSessionStorage, deliberately, so an app can hand both libraries the same object.

Both methods may be synchronous or return a promise; useEqualizer handles either.

Example

import AsyncStorage from '@react-native-async-storage/async-storage'
useEqualizer(player, { storage: AsyncStorage }) // async

const mmkv = createMMKV({ id: 'eq' })
useEqualizer(player, { // sync
storage: {
getItem: (k) => mmkv.getString(k) ?? null,
setItem: (k, v) => mmkv.set(k, v),
},
})

Methods

getItem()

getItem(key: string): string | Promise<string | null> | null;

Defined in: packages/player/src/equalizer-storage.ts:54

null (not undefined) for "nothing stored" — AsyncStorage's contract.

Parameters

ParameterType
keystring

Returns

string | Promise<string | null> | null


setItem()

setItem(key: string, value: string): void | Promise<void>;

Defined in: packages/player/src/equalizer-storage.ts:55

Parameters

ParameterType
keystring
valuestring

Returns

void | Promise<void>