Skip to main content

Interface: UseWaveformOptions

Defined in: useWaveform.ts:28

Properties​

analysis?​

analysis?: Omit<AnalyzeOptions, "signal" | "onProgress">;

Defined in: useWaveform.ts:41

Analysis options. Changing them runs a new analysis.

barCount?​

barCount?: number;

Defined in: useWaveform.ts:33

Number of values in bars. Fractional values are rounded down, so width / barSlot can be passed as is. Leave undefined to only get peaks.

enabled?​

enabled?: boolean;

Defined in: useWaveform.ts:43

Set to false to skip analysis (e.g. while the source is not known yet). Default true.

metric?​

metric?: Metric;

Defined in: useWaveform.ts:35

Metric of bars. Default 'rms'.

normalize?​

normalize?: false | WaveformNormalizeOptions;

Defined in: useWaveform.ts:37

Scaling of bars, or false for raw levels (0…1 of full scale). Default { scale: 'linear' }.

view?​

view?: RangeOptions;

Defined in: useWaveform.ts:39

Time range and channel shown in bars. Changing it never decodes again.