docs(visualizer): document the six visualiser modes

This commit is contained in:
beefcarver committed 2026-11-01 09:58:59 -05:00
1 parent a42678ef30
commit 4bed90b489
2 files changed
+8 -3

No files matched your search

+4 -2
View File
@@ -19,7 +19,9 @@ implemented here from the public SomaFM endpoints and open protocols.
- **Live spectrum analyser** — 72 log-spaced bands with peak caps, a moving
gradient taken from your terminal's ANSI palette and a symmetric mirrored
spectrum; or a full-height oscilloscope. Three modes (`v`).
spectrum. Six modes (`v`): mirrored bars, plain bars, oscilloscope,
scrolling waterfall spectrogram, a radial spectrum wrapped around the
centre, and a high-resolution braille oscilloscope (2×4 dots per cell).
- **Synced spectrum, not a guess** — by default the analyser records your
actual audio output, so the bars follow what you hear (`SYNC`): the
PulseAudio/PipeWire monitor via `parec` on Linux, and a native Core Audio
@@ -191,7 +193,7 @@ The UI wants roughly **84×24**; it also works smaller, just less pretty.
| `f` | favourite (favourites sort to the top) |
| `/` | filter by title, genre, description |
| `esc` | clear filter / close search |
| `v` | visualiser: mirrored bars → bars → wave |
| `v` | visualiser: mirror → bars → wave → waterfall → radial → braille |
| `r` | refresh channels + song history |
| `g` / `G` | top / bottom |
| `?` | help |
+4 -1
View File
@@ -25,7 +25,10 @@ HELP_ROWS: tuple[tuple[str, str], ...] = (
("f", "favourite — favourites float to the top"),
("/", "filter stations by title, genre or description"),
("esc", "clear the filter / close overlays"),
("v", "cycle visualiser: mirrored bars → bars → wave"),
(
"v",
"cycle visualiser: mirror → bars → wave → waterfall → radial → braille",
),
("r", "refresh station list and song history"),
("g / G", "jump to the top / bottom of the list"),
("? ", "this help"),