From 264141b31b3f6b4306f15408404e035dc8c3dcc8 Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Tue, 21 Sep 2021 18:40:18 +1000 Subject: [PATCH] media-session: add a doc blurb for the restore-stream module --- src/media-session/restore-stream.c | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/src/media-session/restore-stream.c b/src/media-session/restore-stream.c index e4f6cdb26..bccdf337d 100644 --- a/src/media-session/restore-stream.c +++ b/src/media-session/restore-stream.c @@ -46,6 +46,25 @@ #include "media-session.h" /** \page page_media_session_module_restore_stream Media Session Module: Restore Stream + * + * The Restore Stream modules monitors \ref pw_node + * of media class `"Stream/..."` and `"Audio/..."` and saves the \ref + * SPA_PROP_volume, \ref SPA_PROP_mute, and \ref SPA_PROP_channelMap + * parameters to the `route-settings` state file and the `route-settings` + * metadata objects. + * + * When a stream re-appears and matches a saved state, the parameters are + * restored to their respective values. Additionally, the target node is saved + * so the stream can be re-associated with that node, if possible. + * + * To match a stream with a previously saved state, this module uses one of + * \ref PW_KEY_MEDIA_ROLE, \ref PW_KEY_APP_ID, + * \ref PW_KEY_APP_NAME, \ref PW_KEY_MEDIA_NAME, and \ref PW_KEY_NODE_NAME, + * whichever applies. + * + * The state file is `$XDG_STATE_HOME/pipewire/media-session.d/restore-stream`. + * + * The `route-settings` metadata object is owned by this module. */ #define NAME "restore-stream"