Online documentation update.
Merge branch 'development' of github.com:aillwee/shairport-sync into development
This commit is contained in:
Mike Brady
+3
-6
@@ -65,10 +65,7 @@ Download, install and start/enable `nqptp` from [here](https://github.com/mikebr
|
||||
***Note:*** At present, Shairport Sync expects the `nqptp` repository folder to be in the same directory as the `shairport-sync` repository folder, as it will look for a header file at `../nqptp/nqptp-shm-structures.h`.
|
||||
|
||||
The `nqptp` service monitors PTP clocks. It provides a POSIX Shared Memory Interface (SMI) at `/nqptp`. A shared
|
||||
pthread mutex is contained within the interface, and to use it you need write access. This is available
|
||||
to the `root` user and also to members of the unix group `nqptp`, which is created by the `nqptp` installer.
|
||||
|
||||
You should include the relevant users in the `nqptp` group -- including the `shairport-sync` user if you are using the standard Shairport Sync installer.
|
||||
pthread mutex is contained within the interface, and to use it you need write access.
|
||||
|
||||
Next, download Shairport Sync, configure it, compile and install it:
|
||||
```
|
||||
@@ -118,11 +115,11 @@ You may wish to run Shairport Sync from the command line (but remember to ensure
|
||||
```
|
||||
$ shairport-sync -vu --statistics
|
||||
```
|
||||
The user doesn't need to be privileged, but should be a member of the `nqptp` group for access to the `nqptp` service, and it should also be a member of the `audio` group for access to the `alsa` subsystem.
|
||||
The user doesn't need to be privileged, but should be a member of the `audio` group for access to the `alsa` subsystem.
|
||||
|
||||
### Using Shairport Sync ###
|
||||
|
||||
The Shairport Sync AirPlay service should appear on the network with a service name made from the machine's hostname with the first letter capitalised, e.g. hostname `ubuntu` gives a service name `Ububntu`. You can change the service name in the configuration file.
|
||||
The Shairport Sync AirPlay service should appear on the network with a service name made from the machine's hostname with the first letter capitalised, e.g. hostname `ubuntu` gives a service name `Ubuntu`. You can change the service name in the configuration file.
|
||||
|
||||
Connect and enjoy...
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ AirPlay 2 Matters
|
||||
* The AirPlay 2 build requires a good deal of extra library support and may not fit into smaller devices. It also requires more CPU power and more RAM -- the minimum recommended device is a Raspberry Pi 3.
|
||||
* **AirPlay 2 support is experimental and incomplete.** The focus of the development effort has been on getting the best possible audio performance. Many features outside that focus are missing or broken. So, for example, integration with Apple's Home app is missing; remote control doesn't work.
|
||||
* For AirPlay 2, Shairport Sync requires the services of another application called [`NQPTP`](https://github.com/mikebrady/nqptp) ("Not Quite PTP") for timing and synchronisation. NQPTP must run as `root` and must have exclusive access to ports `319` and `320`.
|
||||
* AirPlay 2 support is only available on recent Linux and FreeBSD builds. The FreeBSD implementation has not been extensively tested. OpenBSD and Cygwin are not supported. AirPlay 2 support will definitely not work on Mac OS X. The reason is that Shairport Sync needs to use [`NQPTP`](https://github.com/mikebrady/nqptp), which uses ports `319` and `320`. These ports are used by Mac OS X to support its implementation of AirPlay 2.
|
||||
* AirPlay 2 support is only available on recent Linux and FreeBSD builds. The FreeBSD implementation has not been extensively tested. OpenBSD and Cygwin are not supported. AirPlay 2 support will definitely not work on Mac OS X. The reason is that Shairport Sync needs to use [`NQPTP`](https://github.com/mikebrady/nqptp), which uses ports `319` and `320`. These ports are already used by Mac OS X to support its implementation of AirPlay 2.
|
||||
|
||||
Did we mention AirPlay 2 support is experimental? You should also note that it is possible that changes could be made that would stop AirPlay 2 support from working. Let's hope that doesn't happen -- due to its limitations, there seems little prospect of it having any kind of commercial significance.
|
||||
|
||||
@@ -26,6 +26,9 @@ What Does Not Work
|
||||
* You can not run multiple instances of Shairport Sync on one device. This is because an instance of Shairport Sync requires exclusive access to [`NQPTP`](https://github.com/mikebrady/nqptp), and only one instance of that can run on a processor. (Docker may offer a workaround, but this has not been tested.)
|
||||
* Remote Control from Shairport Sync back to the player doesn't work. The `D-Bus` and `MPRIS` interfaces are working, but anything requiring sending commands to the player doesn't work.
|
||||
* Artwork is not downloaded.
|
||||
* Playing from certain Apple devices to Shairport Sync does not work as expected. For example:
|
||||
* When using a service with the ability to play directly on HomePod (e.g. Apple Music). If the music starts on the HomePod, or is the first device selected from the AirPlay list on iOS, when Shairport Sync is then selected iOS shows it as not connected (even though it is). Therefore the expected volume controls are not displayed. A workaround for this is to force an AirPlay stream to the HomePod (rather than just acting as a remote controller), this can be done by selected Shairport Sync _before_ the HomePod. Note, this issue is not present for other services such as SoundCloud which do not integrate into the HomePod like Apple Music does.
|
||||
* The above example is true also when trying to select Shairport Sync from the AirPlay menu on the HomePod from the Home app.
|
||||
|
||||
More About What Works
|
||||
---
|
||||
@@ -36,7 +39,7 @@ More About What Works
|
||||
What You Need
|
||||
---
|
||||
* A Raspberry Pi 3 or better is needed. At present, Shairport Sync will not run successfully on an original Pi or a Pi Zero.
|
||||
* [`NQPTP`](https://github.com/mikebrady/nqptp) is needed and must be run as `root`. It will use ports `319` and `320`, normally reserved for PTP clocks. If you are using PTP clock services for something else, you can't install [`NQPTP`](https://github.com/mikebrady/nqptp) and so you can't use Shairport Sync.
|
||||
* [`NQPTP`](https://github.com/mikebrady/nqptp) is needed and must be run as `root`. It will use ports `319` and `320`, normally reserved for [PTP](https://standards.ieee.org/standard/1588-2008.html) clocks. If you are using PTP clock services for something else, you can't install [`NQPTP`](https://github.com/mikebrady/nqptp) and so you can't use Shairport Sync.(FYI, most computers do not have a PTP clock running -- instead, they may use a [Network Timing Protocol (NTP)](http://www.ntp.org) service to keep the system clock synchronised with world time. However, as noted above, macOS _does_ use a PTP clock to support AirPlay 2.)
|
||||
|
||||
Guides
|
||||
---
|
||||
|
||||
+1
-1
@@ -6,7 +6,7 @@ Available at: https://hub.docker.com/r/mikebrady/shairport-sync
|
||||
|
||||
TODO: remove `--ssh` when going public as this is only for private repos.
|
||||
```
|
||||
docker buildx build --ssh github=$SSH_AUTH_SOCK --platform linux/arm/v7 -f ./docker/Dockerfile --build-arg SHAIRPORT_SYNC_BRANCH=development -t registry.nova.do/shairport-sync:unstable-development .
|
||||
docker buildx build --ssh default=$SSH_AUTH_SOCK --platform linux/arm/v7 -f ./docker/Dockerfile --build-arg SHAIRPORT_SYNC_BRANCH=development -t registry.nova.do/shairport-sync:unstable-development .
|
||||
```
|
||||
|
||||
`SHAIRPORT_SYNC_BRANCH` is required to ensure the image is built using the expected branch.
|
||||
Reference in New Issue
Block a user