mirror of
https://gitlab.freedesktop.org/pipewire/pipewire
synced 2024-09-19 16:01:45 +00:00
media-session: document the access-flatpak module
This commit is contained in:
parent
83ed6e0be3
commit
55f01ae679
|
@ -37,6 +37,22 @@
|
|||
#include "media-session.h"
|
||||
|
||||
/** \page page_media_session_module_access_flatpak Media Session Module: Access Flatpak
|
||||
*
|
||||
* The Access Flatpak module manages permissions for flatpak clients. It
|
||||
* monitors clients with a \ref PW_KEY_ACCESS value of `"flatpak"` and
|
||||
* restricts those clients to the \ref PW_PERM_R and \ref PW_PERM_X
|
||||
* permissions.
|
||||
*
|
||||
* Clients of \ref PW_KEY_MEDIA_CATEGORY type "Manager" are permitted full
|
||||
* access (\ref PW_PERM_ALL).
|
||||
*
|
||||
* The value "flatpak" is typically assigned by the \ref page_module_access.
|
||||
*
|
||||
* ## Module Properties
|
||||
*
|
||||
* This module requires the following properties on the client object:
|
||||
* - \ref PW_KEY_ACCESS
|
||||
* - \ref PW_KEY_MEDIA_CATEGORY (optional, only matters for "Manager" objects)
|
||||
*/
|
||||
#define NAME "access-flatpak"
|
||||
#define SESSION_KEY "access-flatpak"
|
||||
|
|
Loading…
Reference in a new issue