From 2306124f49a7333f110ddea271307427bbaefaf9 Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Mon, 6 Sep 2021 19:50:06 +1000 Subject: [PATCH] doc: fix listing of the new No DSP media-session module And copy the text from the comment into the public documentation, better than just having an empty page there. --- doc/media-session.dox | 1 + src/examples/media-session/alsa-no-dsp.c | 18 ++++++++---------- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/doc/media-session.dox b/doc/media-session.dox index ed8c49dfa..91343711f 100644 --- a/doc/media-session.dox +++ b/doc/media-session.dox @@ -39,6 +39,7 @@ List of Media Session modules: - \subpage page_media_session_module_libcamera_monitor - \subpage page_media_session_module_logind - \subpage page_media_session_module_metadata +- \subpage page_media_session_module_no_dsp - \subpage page_media_session_module_policy_endpoint - \subpage page_media_session_module_policy_node - \subpage page_media_session_module_restore_stream diff --git a/src/examples/media-session/alsa-no-dsp.c b/src/examples/media-session/alsa-no-dsp.c index ac78d101b..b990e0a40 100644 --- a/src/examples/media-session/alsa-no-dsp.c +++ b/src/examples/media-session/alsa-no-dsp.c @@ -22,16 +22,6 @@ * DEALINGS IN THE SOFTWARE. */ -/* - * Instruct policy-node to not configure audio adapter nodes in DSP mode. - * Device nodes will always be configured in passthrough mode. If a client node - * wants to be linked with a device node that has a different format, then the - * policy will configure the client node in convert mode so that both nodes - * have the same format. - * - * This is done by just setting a session property flag, and policy-node does the rest. - */ - #include "config.h" #include "pipewire/pipewire.h" @@ -40,6 +30,14 @@ #include "media-session.h" /** \page page_media_session_module_no_dsp Media Session Module: No DSP + * + * Instruct \ref page_media_session_module_policy_node to not configure audio + * adapter nodes in DSP mode. Device nodes will always be configured in + * passthrough mode. If a client node wants to be linked with a device node + * that has a different format, then the policy will configure the client node + * in convert mode so that both nodes have the same format. + * + * This is done by just setting a session property flag, and policy-node does the rest. */ #define KEY_NAME "policy-node.alsa-no-dsp"