mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-11 13:30:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: sync with master branch

Browse source 
Update doc/ from master branch.

tutorial: fix s16 scale and add some docs
doc: add 'Configuration' page
doc: disable deprecated list
doc: fix some doxygen warnings
doc: put new pulse modules to right place
doc: filter some constructs that confuse doxygen
doc: Fix typo 'statis' -> 'static'
doc: include pipewire-pulse modules explanations also on man page
doc: add pw-v4l2.1 and spa-*.1
doc: add pw-reserve.1
doc: internals/access: update documentation vs current state
This commit is contained in:
Pauli Virtanen 2024-02-16 21:47:51 +02:00
parent 4a04d59c52
commit de617697be
22 changed files with 536 additions and 149 deletions
Download patch file Download diff file Expand all files Collapse all files

16
doc/dox/internals/access.dox
View file

@ -82,15 +82,14 @@ module does nothing.
If the property is not set it will go through a set of checks to determine
the permissions for a client. See the \ref page_module_access documentation
for details, particularly on the values documented below. Depending on the
value of the \ref PW_KEY_ACCESS property one the following happens:
for details.
- `"allowed"`, `"unrestricted"`: ALL permissions are set on the core
Depending on the resolution, it grants permissions to the client as follows:
- `"unrestricted"`: ALL permissions are set on the core
object and the client will be able to resume.
- `"restricted"`, `"flatpak"`, `"$access.force"`: No permissions are set on
the core object and the client will be suspended.
- `"rejected"`: An error is sent to the client and the client is
suspended.
- any other value: No permissions are set on the core object
and the client will be suspended.
As detailed above, the client may be suspended. In that case the session
manager or another client is required to configure permissions on the object
@ -101,8 +100,7 @@ for it to resume.
The session manager listens for new clients to appear. It will use the
\ref PW_KEY_ACCESS property to determine what to do.
For clients that are suspended with `"restricted"`, `"flatpak"` or
`"$access.force"` access, the session manager needs to set permissions on the
For clients that are not unrestricted, the session manager needs to set permissions on the
client for the various PipeWire objects in the graph that it is allowed to
interact with. To resume a client, the session manager needs to set
permission `R` on the core object for the client.

2
doc/dox/internals/design.dox
View file

@ -51,7 +51,7 @@ See \ref page_module_protocol_native for details.
The functionality of the server is implemented and extended with modules and
extensions. Modules are server side bits of logic that hook into various
places to provide extra features. This mostly means controlling the processing
graph in some way. See \ref page_pipewire_modules for a list of current
graph in some way. See \ref page_modules for a list of current
modules.
Extensions are the client side version of the modules. Most extensions provide