snapclient(1)

SNAPCLIENT(1)

General Commands Manual

SNAPCLIENT(1)

NAME

snapclient - Snapcast client

SYNOPSIS

snapclient [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.

Usage: snapclient [options...] [url]

With 'url' = <tcp|ws|wss>://<snapserver host or IP or mDNS service name>[:port]
For example: 'tcp://192.168.1.1:1704', or 'ws://)homeserver.local' or 'wss://_snapcast-https._tcp'
If 'url' is not configured, snapclient defaults to 'tcp://_snapcast._tcp' :

--help: Produce help message
-v, --version: Show version number
-h, --host arg: (deprecated, use [url]) Server hostname or ip address
-p, --port arg (=1704): (deprecated, use [url]) Server port
-i, --instance arg (=1): Instance id when running multiple instances on the same host
--hostID arg: Unique host id, default is MAC address
--cert arg (=""): Client certificate file (PEM format)
--cert-key arg (=""): Client private key file (PEM format)
--key-password arg: Key password (for encrypted private key)
--server-cert [=arg(="default certificates")]: Verify server with CA certificate (PEM format)
-l, --list: List PCM devices
-s, --soundcard arg (=default): Index or name of the PCM device
--latency arg (=0): Latency of the PCM device
--sampleformat arg: Resample audio stream to <rate>:<bits>:<channels>
--player arg (=alsa): alsa|pipewire|file[:<options>|?]
--mixer arg (=software): software|hardware|script|none|?[:<options>]
-d, --daemon [=arg(=-3)]: Daemonize, optional process priority [-20..19]
--user arg: The user[:group] to run snapclient as when daemonized
--logsink arg: Log sink [null,system,stdout,stderr,file:<filename>]
--logfilter arg (=*:info): Log filter <tag>:<level>[,<tag>:<level>]* with tag = * or <log tag> and level = [trace,debug,info,notice,warning,error,fatal]

FILES

/etc/default/snapclient: the daemon default configuration file

COPYRIGHT

Copyright (C) 2014-2025 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.