From 8158bd218c49f724245540c4b47f107c1bbe61ca Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Mon, 18 Mar 2019 18:05:18 +0100 Subject: doc/plugins.rst: add filter plugin reference --- doc/plugins.rst | 35 ++++++++++++++++++++++++++++++++++- doc/user.rst | 3 +++ 2 files changed, 37 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/plugins.rst b/doc/plugins.rst index 08d4d1345..21f8f1f2d 100644 --- a/doc/plugins.rst +++ b/doc/plugins.rst @@ -1039,8 +1039,41 @@ The "Solaris" plugin runs only on SUN Solaris, and plays via /dev/audio. * - **device PATH** - Sets the path of the audio device, defaults to /dev/audio. + +.. _filter_plugins: + +Filter plugins +-------------- + +normalize +~~~~~~~~~ + +Normalize the volume during playback (at the expensve of quality). + + +null +~~~~ + +A no-op filter. Audio data is returned as-is. + + +route +~~~~~ + +Reroute channels. + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Setting + - Description + * - **routes "0>0, 1>1, ..."** + - Specifies the channel mapping. + + .. _playlist_plugins: - + Playlist plugins ---------------- diff --git a/doc/user.rst b/doc/user.rst index cdcb94bd5..ea65442b2 100644 --- a/doc/user.rst +++ b/doc/user.rst @@ -465,6 +465,9 @@ The following table lists the filter options valid for all plugins: * - **name** - The name of the filter +More information can be found in the :ref:`filter_plugins` reference. + + Configuring playlist plugins ---------------------------- -- cgit v1.2.3