IUseWaveformOptions

interface
Audio

Options accepted by `useWaveform()` to configure how the audio file is fetched and decoded into waveform peak data.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

bins
number
Number of amplitude buckets (bars) to downsample the decoded audio into. A higher value produces a finer-grained waveform but costs more processing time.
crossOrigin
MaybeRefOrGetter<string | undefined>
CORS credentials mode forwarded to `fetch()`. - `'use-credentials'` — include cookies / auth headers. - any other value (or `undefined`) — `'same-origin'` semantics.