|
a/doc/upmpdcli.txt |
|
b/doc/upmpdcli.txt |
|
... |
|
... |
| 2 |
|
2 |
|
| 3 |
|
3 |
|
| 4 |
*upmpdcli* is an UPnP Media Renderer front-end to *MPD*, the Music Player
|
4 |
*upmpdcli* is an UPnP Media Renderer front-end to *MPD*, the Music Player
|
| 5 |
Daemon. It supports both pure UPnP and the OpenHome ohMedia services.
|
5 |
Daemon. It supports both pure UPnP and the OpenHome ohMedia services.
|
| 6 |
|
6 |
|
| 7 |
In OpenHome mode, it supports radio streams and has the ability to
|
7 |
In OpenHome mode, it supports radio streams.
|
| 8 |
interface to Linn Songcast for multiroom synchronized playing either of
|
8 |
|
|
|
9 |
It has the ability to interface to Linn Songcast for multiroom synchronized
|
| 9 |
audio captured on Windows or Mac OS X or of its own stream.
|
10 |
playing either of audio captured on Windows or Mac OS X or of its own
|
|
|
11 |
stream.
|
|
|
12 |
|
|
|
13 |
As of version 1.2.0, the software includes a Media Server gateway to
|
|
|
14 |
streaming music services, with initial support for Google Play Music, Qobuz
|
|
|
15 |
and Tidal.
|
| 10 |
|
16 |
|
| 11 |
[[upmpdcli.security]]
|
17 |
[[upmpdcli.security]]
|
| 12 |
== Security
|
18 |
== Security
|
| 13 |
|
19 |
|
| 14 |
*upmpdcli* is not audited for security issues, and, as far as I
|
20 |
*upmpdcli* is not audited for security issues, and, as far as I
|
|
... |
|
... |
| 28 |
way to transfer these parameters to *MPD* (this is a limitation of the
|
34 |
way to transfer these parameters to *MPD* (this is a limitation of the
|
| 29 |
client protocol). There is actually little reason to use raw PCM, and, for
|
35 |
client protocol). There is actually little reason to use raw PCM, and, for
|
| 30 |
example, WAV streams, which have an identification header, will be handled
|
36 |
example, WAV streams, which have an identification header, will be handled
|
| 31 |
just fine.
|
37 |
just fine.
|
| 32 |
|
38 |
|
| 33 |
However, recent versions do support audio/L16, but only with the
|
39 |
There is an exception: recent versions of upmpdcli do support audio/L16,
|
| 34 |
development version of MPD (0.20) and there are conditions on the Media
|
40 |
but only with the development version of MPD (0.20) and there are
|
| 35 |
Server (it must output the audio formats parameters with the MIME
|
41 |
conditions on the Media Server (it must output the audio formats parameters
|
| 36 |
type). See this Github issue for more details:
|
42 |
with the MIME type). See this Github issue for more details:
|
| 37 |
https://github.com/medoc92/upmpdcli/issues/36#issuecomment-227761220
|
43 |
https://github.com/medoc92/upmpdcli/issues/36#issuecomment-227761220
|
| 38 |
|
44 |
|
| 39 |
[[upmpdcli.streaming]]
|
45 |
[[upmpdcli.streaming]]
|
| 40 |
== Streaming services support
|
46 |
== Streaming services support
|
| 41 |
|
47 |
|
| 42 |
Upmpdcli versions 1.4 (not released yet) and later offer support for
|
48 |
Upmpdcli versions 1.2.0 and later offer support for accessing music on some
|
| 43 |
accessing music on some streaming services (where you will need a valid
|
49 |
streaming services. You will need a valid account on the services you want
|
| 44 |
account).
|
50 |
to use. The initial release supports Google Play Music, Qobuz and Tidal.
|
| 45 |
|
|
|
| 46 |
The initial version only supports the http://www.tidal.com[Tidal] music
|
|
|
| 47 |
service.
|
|
|
| 48 |
|
51 |
|
| 49 |
When the function is activated, upmpdcli creates a separate auxiliary Media
|
52 |
When the function is activated, upmpdcli creates a separate auxiliary Media
|
| 50 |
Server, with the sole purpose of presenting the streaming server catalog
|
53 |
Server, with the sole purpose of presenting the streaming server
|
| 51 |
(and proxying the streams when necessary). You will see it appear on the
|
54 |
catalog. You will see it appear on the network if streaming service
|
| 52 |
network if streaming service parameters are present in the configuration
|
55 |
parameters are present in the configuration file. The Media Server name is
|
| 53 |
file. The Media Server name is the one for the upmpdcli instance, with
|
56 |
the one for the upmpdcli instance, with "-mediaserver" appended.
|
| 54 |
"-mediaserver" appended.
|
|
|
| 55 |
|
57 |
|
| 56 |
Streaming is not limited to the local upmpdcli renderer, and the Media
|
58 |
Streaming is not limited to the local upmpdcli renderer, and the Media
|
| 57 |
Server should happily send music to other renderers.
|
59 |
Server should happily send music to other renderers.
|
| 58 |
|
60 |
|
| 59 |
=== Notes on the Tidal interface
|
61 |
=== Notes on the Tidal interface
|
| 60 |
|
62 |
|
| 61 |
The software is not officialy supported by Tidal, and may just stop to
|
63 |
The software is not officialy supported by Tidal, and may just stop to
|
|
|
64 |
work one day...
|
|
|
65 |
|
| 62 |
work one day... It only works with a valid Tidal subscription.
|
66 |
It only works with a valid Tidal subscription.
|
| 63 |
|
67 |
|
| 64 |
The configuration parameters are described
|
68 |
The configuration parameters are described
|
| 65 |
link:#_tidal_streaming_service_parameters[further down].
|
69 |
link:#_tidal_streaming_service_parameters[further down].
|
| 66 |
|
70 |
|
| 67 |
=== Notes on the Qobuz interface
|
71 |
=== Notes on the Qobuz interface
|
| 68 |
|
72 |
|
| 69 |
As for Tidal, the software is not officialy supported by Qobuz, and may
|
73 |
The WEB API is not officialy supported by Qobuz, and may just stop to work
|
| 70 |
just stop to work one day.
|
74 |
one day.
|
| 71 |
|
75 |
|
| 72 |
You need a valid Qobuz subscription.
|
76 |
You need a valid Qobuz subscription.
|
| 73 |
|
77 |
|
| 74 |
Qobuz search does not allow specifying what field to search (e.g. are we
|
78 |
Qobuz search does not allow specifying what field to search (e.g. are we
|
| 75 |
searching artist names or track titles). This is a bad match with UPnP
|
79 |
searching artist names or track titles). This is a bad match with UPnP
|
| 76 |
searches supported by upmpdcli and results in a weird interface and mixed
|
80 |
searches supported by upmpdcli and results in a weird interface and mixed
|
| 77 |
up results.
|
81 |
up results.
|
| 78 |
|
82 |
|
| 79 |
The configuration parameters are described
|
83 |
The configuration parameters are described
|
| 80 |
link:#_qobuz_streaming_service_parameters[further down].
|
84 |
link:#_qobuz_streaming_service_parameters[further down].
|
|
|
85 |
|
|
|
86 |
[[upmpdcli.googlemusicnotes]]
|
|
|
87 |
=== Notes on the Google Music interface
|
|
|
88 |
|
|
|
89 |
As for the other services, the API used is not officially supported and may
|
|
|
90 |
stop to work one day.
|
|
|
91 |
|
|
|
92 |
This requires the installation of the external *gmusicapi* Python
|
|
|
93 |
package.
|
|
|
94 |
link:http://unofficial-google-music-api.readthedocs.io/en/latest/usage.html#usage[See the installation notes here].
|
|
|
95 |
|
|
|
96 |
You will need a valid subscription for most functions.
|
|
|
97 |
|
|
|
98 |
|
|
|
99 |
|
| 81 |
|
100 |
|
| 82 |
[[upmpdcli.config]]
|
101 |
[[upmpdcli.config]]
|
| 83 |
== Configuration
|
102 |
== Configuration
|
| 84 |
|
103 |
|
| 85 |
See the man page for command line details. In most situations, *upmpdcli*
|
104 |
See the man page for command line details. In most situations, *upmpdcli*
|