API Reference
API Reference
Functions
| Function | Description |
|---|---|
| getBiquadFilter | Creates a biquad lowpass filter for audio processing. |
| analyzeFullBuffer | Analyzes a complete audio buffer to detect the BPM (tempo) synchronously. |
| createRealtimeBpmAnalyzer | Creates a real-time BPM analyzer for live audio streams. |
Classes
| Class | Description |
|---|---|
| BpmAnalyzer | Real-time BPM analyzer with typed event listeners. |
| Core analyzer class for real-time BPM detection. |
Type Aliases
| Type Alias | Description |
|---|---|
| Threshold | Threshold value for peak detection (0.0 to 1.0) |
| Peaks | Array of peak positions in audio samples |
| BpmCandidates | BPM analysis results with tempo candidates |
| BpmProgress | Progress toward the first BPM result of the realtime analyzer |
| Tempo | Detected tempo with confidence metrics |
| TempoRange | Tempo range, in BPM, that every detected tempo is folded into by doubling or halving. |
| AnalyzeFullBufferOptions | Options for analyzeFullBuffer: lowpass filter settings plus the tempo range |
| RealTimeBpmAnalyzerParameters | Configuration options for the real-time BPM analyzer |
| CreateRealtimeBpmAnalyzerOptions | Options accepted by createRealtimeBpmAnalyzer: the analyzer parameters plus where to load the worklet from. |
| BiquadFilterOptions | Configuration options for biquad filter creation |
Events
| Type Alias | Description |
|---|---|
| ProcessorOutputEvent | Events emitted by the BPM analyzer processor (Processor → Main Thread) |
| ProcessorInputEvent | Control events sent to the processor (Main Thread → Processor) |
| BpmAnalyzerEventMap | Type-safe event listener map for BPM analyzer events |