summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTill Zimmermann <tillz@tillz.net>2018-06-19 20:25:22 +0200
committerTill Zimmermann <tillz@tillz.net>2018-06-19 20:25:22 +0200
commitc445510d5a322bf395a09d8f9bce77a730fc52b6 (patch)
tree1fd95c668e9a405affe300d5b37d07718004beb7 /README.md
parent02694948f3e0229529e42102a817b35fd144bf63 (diff)
minor improvements on the mqtt feature
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7301968..20ef018 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,7 @@ What else?
* Metadata — Shairport Sync can deliver metadata supplied by the source, such as Album Name, Artist Name, Cover Art, etc. through a pipe or UDP socket to a recipient application program — see https://github.com/mikebrady/shairport-sync-metadata-reader for a sample recipient. Sources that supply metadata include iTunes and the Music app in iOS.
* Raw Audio — Shairport Sync can deliver raw PCM audio to standard output or to a pipe. This output is delivered synchronously with the source after the appropriate latency and is not interpolated or "stuffed" on its way through Shairport Sync.
* Autotools and Libtool Support — the Shairport Sync build process uses GNU `autotools` and `libtool` to examine and configure the build environment — important for portability and for cross compilation. Previous versions of Shairport looked at the current system to determine which packages were available, instead of looking at the target system for what packages were available.
+* A native mqtt interface for metadata and/or controls
Heritage
-------
@@ -124,6 +125,7 @@ The following libraries are required:
Optional:
* libsoxr
* libalac (This is a library containing the Apple ALAC decoder.)
+* libmosquitto (To enable the mqtt-metadata-interface)
Many Linux distributions have Avahi and OpenSSL already in place, so normally it probably makes sense to choose those options rather than tinysvcmdns or mbed TLS. The `libsoxr` library is available in recent Linux distributions, but it requires lots of processor power — chances are an embedded processor won't be able to keep up.
@@ -166,6 +168,7 @@ $ autoreconf -i -f
- `--with-soxr` for libsoxr-based resampling.
- `--with-piddir` for specifying where the PID file should be stored. This directory is normally chosen automatically. The directory must be writable. If you use this option, you may have to edit the init script to search for the PID file in your new location.
- `--with-metadata` to add support for Shairport Sync to pipe metadata to a compatible application of your choice. See https://github.com/mikebrady/shairport-sync-metadata-reader for a sample metadata reader.
+- `--with-mqtt-client` to add support for publishing metadata and remote control via [MQTT](https://en.wikipedia.org/wiki/MQTT)
- `--with-configfiles` to install a configuration file and a separate sample file at the `make install` stage. Default is to install. An existing `/etc/shairport-sync.conf` will not be overwritten.
- `--with-pkg-config` to use pkg-config to find libraries. Default is to use pkg-config — this option is for special purpose use.
- `--with-apple-alac` to include the Apple ALAC Decoder.