Skip to content

Commit

Permalink
Update documentation to replace vollibrespot with spotifyd (#504)
Browse files Browse the repository at this point in the history
* Change spotifyd to vollibrespot in doc/services.md

HifiberryOS now uses spotifyd instead of vollibrespot. This
commit updates the documentation to reflect this.

* Replace spotifyd with vollibrespot in README.md

* Update dbus and mpris docs to clarify that spotifyd is non-default
  • Loading branch information
niklasdewally authored Jan 15, 2024
1 parent 3c65ae9 commit b6cebc7
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The user interface is based on the [Bang & Olufsen Beocreate project](https://gi

At the moment, the following services are supported:

- Spotify (using [a fork of Spotifyd](https://github.com/hifiberry/spotifyd)) - requires a paid Spotify subscription
- Spotify (using a fork of [vollibrespot](https://github.com/hifiberry/vollibrespot)) - requires a paid Spotify subscription
- Airplay (using [shairport](https://github.com/mikebrady/shairport-sync))
- Squeezebox (using [squeezelite](https://github.com/ralph-irving/squeezelite))
- Bluetooth A2DP sink (using [BlueZ 5](http://www.bluez.org/))
Expand Down
4 changes: 3 additions & 1 deletion doc/dbus.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

## Play/Pause

### Spotify
### Spotifyd

*By default, hifiberry uses `volllibrespot` not `spotifyd` to provide Spotify playback. `vollibrespot` does not support `dbus`.*

dbus-send --system --print-reply --type=method_call --dest=org.mpris.MediaPlayer2.spotifyd /org/mpris/MediaPlayer2 org.mpris.MediaPlayer2.Player.Pause

Expand Down
6 changes: 5 additions & 1 deletion doc/mpris.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,15 @@ Today not all applications support MPRIS. This is the current state of MPRIS imp

| Player | MPRIS supported | MPRIS metadata | Implemented
| --- | --- | --- | --- |
| spotifyd | yes | yes | yes |
| spotifyd[^1] | yes | yes | yes |
| vollibrespot[^1] | no | no | no |
| shairport-sync | yes | yes | yes |
| squeezelite | [lmsmpris](https://github.com/hifiberry/lmsmpris) | yes | yes |
| bluez-alsa | [mpris-proxy](https://github.com/Vudentz/BlueZ/blob/master/tools/mpris-proxy.c) | yes | yes |
| raat | yes | yes | yes |
| mpd | [mpd mpris](https://github.com/natsukagami/mpd-mpris) | yes | yes |
| alsaloop | via | no | yes |
| gmediarender | [dlna-mpris](https://github.com/hifiberry/dlna-mpris) | yes | yes |


[^1]: The default Spotify provider is `vollibrespot`.
6 changes: 3 additions & 3 deletions doc/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ MPRIS is implemented using mpd-mpris.

Roon is a high-end music player. It uses a proprietary protocol. Therefore, the sources for this player are not included.

## Spotifyd
## Vollibrespot

Spotifyd implements a Spotify connect receiver.
Vollibrespot implements a Spotify connect receiver.

## Squeezelite

Expand All @@ -55,6 +55,6 @@ A snapcast player is included, but is still experimental.
|mpd|/etc/mpd.conf|mpd.service, mpd-mpris.service|
|roon|/etc/hifiberry_raat.conf|raat.service|
|shairport-sync|/etc/shairport-sync.conf|shairport-sync.service|
|spotifyd|/etc/spotifyd.conf|spotify.service|
||/etc/vollibrespot.conf|vollibrespot.service|
|squeezelite|/var/squeezelite/squeezelite.name|squeezelite.service, lmsmpris.service|
|snapcast|/etc/snapcastmpris.conf|snapcastmpris.service|

0 comments on commit b6cebc7

Please sign in to comment.