Skip to content
WaveformPlayer

Notes

Notes & gotchas

Section titled “Notes & gotchas”
  • No DOM, no events, no CSS. WaveformGen produces JSON only. Async results come back exclusively via the generatePeaks() Promise.
  • Multi-channel audio is mono-summed: each peak is the max amplitude across all channels for that bin.
  • inline ignores bpm and markers — it emits only the raw peaks array.
  • Logs are prefixed [WaveformGen] and can be fully silenced with --quiet.
Section titled “Related”
  • Installation — install the player itself.
  • Player options — the waveform, bpm, and markers options this JSON feeds.
  • Markers — how the markers array renders.
  • WaveformBar — consuming the JSON via data-wb-waveform.