Add documentation, manual and screenshots preview
This commit is contained in:
+37
@@ -0,0 +1,37 @@
|
||||
# BPM-kilder
|
||||
|
||||
## Manual
|
||||
|
||||
- Endpoint: `POST /api/v1/bpm/manual?bpm=<tal>`
|
||||
- UI: knapper og direkte værdisætning
|
||||
- Status: fuldt implementeret i simulator/runtime
|
||||
|
||||
## Tap
|
||||
|
||||
- Endpoint: `POST /api/v1/bpm/tap`
|
||||
- UI: `Tap tempo`
|
||||
- Algoritme: median af de seneste tap-intervaller inden for et kort vindue
|
||||
- Status: implementeret og verificerbar lokalt
|
||||
|
||||
## Audio input
|
||||
|
||||
- Endpoints:
|
||||
- `POST /api/v1/bpm/audio/start?device=<navn>`
|
||||
- `POST /api/v1/bpm/audio/stop`
|
||||
- `GET /api/v1/bpm/devices`
|
||||
- Devices i denne leverance:
|
||||
- `synthetic-click-track`
|
||||
- `jack:auto`
|
||||
- `alsa:default`
|
||||
- Status: simuleret/delvist implementeret. API og UI findes, men ægte audioanalyse mod aubio/JACK/ALSA er ikke implementeret endnu i denne kodebase.
|
||||
|
||||
## External
|
||||
|
||||
- Endpoint: `POST /api/v1/bpm/external?bpm=<tal>`
|
||||
- Status: implementeret som simpel ekstern BPM-injektion
|
||||
|
||||
## Verifikation uden hardware
|
||||
|
||||
- Manual og tap kan verificeres direkte i UI eller via API.
|
||||
- Audio-mode kan verificeres som simulator-flow og device-API, men ikke som ægte beat detection uden videre implementation.
|
||||
|
||||
Reference in New Issue
Block a user