Repository navigation
Using the TUI
sendspin-cli tui opens a terminal screen for the player running on this host: what is
playing, the keys you would otherwise type as pause and vol, and a large pairing code when
a server wants to pair.
$ sendspin-cli tuiIt is a remote, not a player. It attaches to the running player over the control socket, never opens audio and has no identity of its own, so quitting it changes nothing about the player. Several can be open at once.
It finds the player exactly as sendspin-cli status does: the same --port,
--control-socket and config file. A player on another port needs the same flag here, and
the rules are in Finding the socket.
Under the Linux system service the socket belongs to the sendspin-cli service account,
mode 0600, so only that account and root, which ignores the mode, can open it. Run the TUI
as root:
$ sudo sendspin-cli tui --control-socket /run/sendspin-cli/control.sockIt needs a terminal on both ends. Piped or redirected, it exits 1 with
error: sendspin-cli tui needs a terminal.
The panels stack in one column on a terminal narrower than 80 columns.
-
Now Playing is the title, artist and album, with the previous, play or pause, and next
keys. With nothing loaded it says
Press <space> to play. -
Volume is the group and this player's own level, each with
[MUTED]when it is. -
Progress is a bar with the position and length. The position moves between polls on its
own, and says
(live)for a stream with no length. - Playback is repeat and shuffle. Stream is the codec, the format and the output delay. Server is the connected server, its trust, the group, and a prompt to pair when this player has no pairing yet.
-
The footer carries the
ptoken line and short notices, such asNo server is connected, which clear after 3 seconds.
A value nobody has reported shows as --, not as a zero. The screen polls the player about
twice a second, so a change made elsewhere appears within that.
| Key | What it does | Same as |
|---|---|---|
space |
play, or pause while playing |
play, pause
|
| left, right | previous, next track |
prev, next
|
| up, down | this player's volume, 5 a step | player-vol |
m |
mute or unmute this player | player-mute |
], [
|
group volume, 5 a step | vol |
M |
mute or unmute the group | mute |
r |
repeat: off, all, one | repeat |
x |
shuffle on or off | shuffle |
g |
switch group | switch |
,, .
|
output delay, 10 ms a step | delay |
p |
show or hide the pairing token | pair-token |
q, Ctrl-C |
quit |
The group keys and this player's own keys are different things; that split is explained in Three that are easy to misread. The group keys do nothing until the server has sent the group's state. A key the player or server refuses shows as a notice rather than an error.
p shows the pairing token, so treat it like a password. It is fetched when you show it
and forgotten when you hide it again. It works on the main screen only, the one with the
footer it shows in; on a pairing screen or a screen with no player, p does nothing.
Start pairing in Music Assistant, with the TUI open on the player's host. The screen is taken over so the code cannot be missed:
- A dynamic code fills the screen in large digits, with the server's name above it. Type it into the server. On a terminal too narrow for the large digits, or too short, it is the same code as plain spaced digits.
-
A pairing attempt waiting for you to allow it shows
A server wants to pair. Y to allow, N to refuse. That is every static-code attempt, and a dynamic one the player holds back after repeated wrong codes.yispair confirmandnispair cancel; see the pairing window. Afterythe screen saysAllowed -- waiting for the server...until the attempt moves on (a dynamic attempt shows its code next), andyandndo nothing more. -
The outcome takes over the screen for 3 seconds:
Paired with <server>,Pairing failed: <reason>, orThe server stopped pairing, and then the main screen returns. An attempt that ended before you opened the TUI is not replayed.
While a pairing screen is up, only y and n (when asked) and q do anything; the
playback keys wait until it is over.
These screens recheck every half second, so starting or fixing the player brings the main
screen up by itself. q still quits.
-
No sendspin-cli player is running here, or it did not answer. Nothing listens on the socket, the port is not the player's, or the player took longer than 3 seconds to answer, which counts as not answering. The line below the heading says which. Start the player, or pass the same
--portor--control-socketit uses.Once the TUI has reached the player, a poll that goes unanswered does not bring this screen up: the last screen stays, with the notice
The player did not answer -- retrying, until the player answers again or its socket goes away. -
A sendspin-cli player is running, but this user may not connect to it. The socket refused you, which is the normal case under the system service. The screen prints the command to run,
sudo sendspin-cli tui --control-socket <the path it tried>. -
The running sendspin-cli player is too old for the TUI. It predates
status-kv. Restart it on this version.
-
Controlling the Player -- the subcommands the keys stand for, and
status-kv - Pairing a Player
-
Troubleshooting -- what exit
3usually means - Running as a Service -- who owns the socket there
Get it running
Use it
- Configuration
- Pairing a Player
- Controlling the Player
- Using the TUI
- Running as a Service
- Advanced Usage
When it misbehaves