snapserver(1)

Snapcast server

Section 1 snapserver bookworm source

Summary

snapserver is the server component of Snapcast, a multiroom audio system that keeps all connected clients time-synchronized so they play perfectly in sync. It reads audio from a named pipe (/tmp/snapfifo) and streams it to clients; it isn't a standalone player but extends an existing player like MPD or Mopidy. Use it to build a Sonos-like whole-home audio setup.

Tip: snapserver doesn't play files itself; configure your music player (such as MPD or Mopidy) to output to the named pipe /tmp/snapfifo, which is the server's audio input.

Description

SNAPSERVER

NAME

snapserver - Snapcast server

SYNOPSIS

snapserver [OPTION]...

DESCRIPTION

Snapcast is a multiroom client-server audio player, where all clients are time synchronized with the server to play perfectly synced audio. It’s not a standalone player, but an extension that turns your existing audio player into a Sonos-like multiroom solution.
The server’s audio input is a named pipe ‘/tmp/snapfifo‘. All data that is fed into this file will be send to the connected clients. One of the most generic ways to use Snapcast is in conjunction with the music player daemon or Mopidy, which can be configured to use a named pipe as audio output.

Allowed options:

-h, --help

Produce help message, use -hh to show options from config file

-v, --version

Show version number

-d, --daemon [=arg(=0)]

Daemonize optional process priority [-20..19]

-c, --config arg (=/etc/snapserver.conf)

path to the configuration file

FILES

/tmp/snapfifo

PCM input fifo file

/etc/default/snapserver

the daemon default configuration file

/etc/snapserver.conf

the snapserver configuration file

˜/.config/snapcast/server.json or (if $HOME is not set)
/var/lib/snapcast/server.json

persistent server data file

COPYRIGHT

Copyright (C) 2014-2020 Johannes Pohl (snapcast@badaix.de). License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

SEE ALSO

snapclient(1)

Examples

snapserver

Start the Snapcast server with default settings.

snapserver -c /etc/snapserver.conf

Start the server using a specific configuration file.

snapserver -d

Run the server daemonized (in the background).

snapserver -hh

Show the help message including options available from the config file.

See Also