From 4c57647203cc0b65993a964b73a1acb6d554e36b Mon Sep 17 00:00:00 2001 From: James Calligeros Date: Sat, 6 Apr 2024 16:25:11 +1000 Subject: [PATCH] docs: document filter-path property of software DSP policy Signed-off-by: James Calligeros --- docs/rst/policies/software_dsp.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/rst/policies/software_dsp.rst b/docs/rst/policies/software_dsp.rst index a49566a1..61567cfd 100644 --- a/docs/rst/policies/software_dsp.rst +++ b/docs/rst/policies/software_dsp.rst @@ -53,6 +53,17 @@ Configurable properties The ``target.object`` property of the virtual node should be configured statically to point to the node matched by the rule. +.. describe:: filter-path + + Absolute path to a file on disk storing a SPA-JSON object as plain text. This will be + parsed by WirePlumber into a WpConf object with a single section called + ``node.software-dsp.graph``, then passed as-is into ``libpipewire-module-filter-chain``. + + .. note:: + + ``filter-graph`` and ``filter-path`` are mutually exclusive, with the former taking + precedence if both are present in the matched rule. + .. describe:: hide-parent Boolean indicating whether or not the matched node should be hidden from @@ -77,6 +88,7 @@ Examples actions = { create-filter = { filter-graph = {} # Virtual node goes here + filter-path = "/path/to/spa.json" hide-parent = true } }