MyFavMirrors
/
owntone-server
mirror of https://github.com/owntone/owntone-server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[docs] Update README with new pipe features

This commit is contained in:
ejurgensen 2017-01-29 22:09:28 +01:00
parent f7018dc659
commit 3ba2fb741b
1 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -354,26 +354,32 @@ configuration file a rescan is required before the new setting will take effect.
Currently, this will not be done automatically, so you need to trigger the Currently, this will not be done automatically, so you need to trigger the
rescan as described below. rescan as described below.
Symlinks are supported and dereferenced, but it is best to use them for
directories only.
### Symlinks and pipes
Symlinks are supported and dereferenced. This does interact in tricky ways ### Pipes (for e.g. multiroom with Shairport-sync)
with the above monitoring and rescanning, so you've been warned. Changes to
symlinks themselves won't be taken into account, or not the way you'd expect.
If you use symlinks, do not move around the target of the symlink. Avoid Some programs, like for instance Shairport-sync, can be configured to output
linking files, as files themselves aren't monitored for changes individually, audio to a named pipe. If this pipe is placed in the library, forked-daapd will
so changes won't be noticed unless the file happens to be in a directory that automatically detect that it is there, and when there is audio being written to
is monitored. it, playback of the audio will be autostarted (and stopped).
Bottom line: symlinks are for directories only. Using this feature, forked-daapd can act as an AirPlay multiroom "router": You
can have an AirPlay source (e.g. your iPhone) send audio Shairport-sync, which
forwards it to forked-daapd through the pipe, which then plays it on whatever
speakers you have selected (through Remote).
Pipes made with mkfifo are also supported. This feature can be useful if you The format of the audio being written to the pipe must be PCM16.
have a program that can stream PCM16 audio to a pipe. Forked-daapd can then
forward the audio to one or more AirPlay speakers.
Pipes have no metadata, so they will be added with "Unknown artist" and "Unknown You can also start playback of pipes manually. You will find them in remotes
album". The name of the pipe will be used as the track title. listed under "Unknown artist" and "Unknown album". The track title will be the
name of the pipe.
Shairport-sync can write metadata to a pipe, and forked-daapd can read this.
This requires that the metadata pipe has the same filename as the audio pipe
plus a ".metadata" suffix. Say Shairport-sync is configured to write audio to
"/foo/bar/pipe", then the metadata pipe should be "/foo/bar/pipe.metadata".
### Libraries on network mounts ### Libraries on network mounts