summaryrefslogtreecommitdiff
path: root/doc/plugins.rst
diff options
context:
space:
mode:
authorckdo <chrisrodri@free.fr>2019-07-16 12:55:53 +0200
committerMax Kellermann <max@musicpd.org>2019-08-03 13:03:05 +0200
commitd305f187d5268a040aca6df62849c33b05308963 (patch)
tree68e50184084ef9c51316f40c0c137a99d0339de8 /doc/plugins.rst
parent4f6a713b3212a176ef133b08fbd708fe8729e0cc (diff)
Add the ability to specify media.role for pulse output plugin
This is useful in multiple mpd instances scenario, or multiple pulse outputs defined on the same mpd instance. It is actually a more flexible way to route flows than the "sink" parameter, letting the PulseAudio routing do its job, but with the ability to isolate routing for each output. If not specified, the role remains like it was before this commit, ie "music"
Diffstat (limited to 'doc/plugins.rst')
-rw-r--r--doc/plugins.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/plugins.rst b/doc/plugins.rst
index 55a914011..d5815585e 100644
--- a/doc/plugins.rst
+++ b/doc/plugins.rst
@@ -1002,6 +1002,8 @@ The pulse plugin connects to a `PulseAudio <http://www.freedesktop.org/wiki/Soft
- Sets the host name of the PulseAudio server. By default, :program:`MPD` connects to the local PulseAudio server.
* - **sink NAME**
- Specifies the name of the PulseAudio sink :program:`MPD` should play on.
+ * - **media_role ROLE**
+ - Specifies a custom media role that :program:`MPD` reports to PulseAudio. Default is "music". (optional).
* - **scale_volume FACTOR**
- Specifies a linear scaling coefficient (ranging from 0.5 to 5.0) to apply when adjusting volume through :program:`MPD`. For example, chosing a factor equal to ``"0.7"`` means that setting the volume to 100 in :program:`MPD` will set the PulseAudio volume to 70%, and a factor equal to ``"3.5"`` means that volume 100 in :program:`MPD` corresponds to a 350% PulseAudio volume.