mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-31 22:25:38 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: some small fixes and updates

Browse source
This commit is contained in:
Wim Taymans 2020-08-02 20:13:29 +02:00
parent be19e45ee1
commit edb3968c5c
2 changed files with 13 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -40,7 +40,11 @@ applications:
* `PIPEWIRE_DEBUG=<level>` to increase the debug level * `PIPEWIRE_DEBUG=<level>` to increase the debug level
* `PIPEWIRE_LOG=<filename>` to redirect log to filename * `PIPEWIRE_LOG=<filename>` to redirect log to filename
* `PIPEWIRE_LATENCY=<num/denom>` to configure latency * `PIPEWIRE_LATENCY=<num/denom>` to configure latency as a fraction. 10/1000
configures a 10ms latency. Usually this is
expressed with a denom of the samplerate,
like 256/48000, which uses 256 samples at a
samplerate of 48KHz for a latency of 5.33ms.
* `PIPEWIRE_NODE=<id>` to request link to specified node * `PIPEWIRE_NODE=<id>` to request link to specified node
### Using tools ### Using tools

13
doc/architecture.md
View file

@ -123,7 +123,7 @@ A core proxy can be used to receive errors from the remote daemon
or to perform a roundtrip message to flush out pending requests. or to perform a roundtrip message to flush out pending requests.
Other core methods and events are used internally for the object Other core methods and events are used internally for the object
life cycle management internally. life cycle management.
### `struct pw_registry` ### `struct pw_registry`
@ -193,10 +193,10 @@ do the connection for the client and then hands the connection socket
to the client. to the client.
All objects in PipeWire have per client permission bits, currently All objects in PipeWire have per client permission bits, currently
READ, WRITE and EXECUTE. A client can not see an objects unless it READ, WRITE, EXECUTE and METADATA. A client can not see an objects
has READ permissions. Similarly, a client can only execute methods unless it has READ permissions. Similarly, a client can only execute
on an object when the EXECUTE bit is set and to modify the state of methods on an object when the EXECUTE bit is set and to modify the
an object, the client needs WRITE permissions. state of an object, the client needs WRITE permissions.
A client (the portal after it makes a connection) can drop permissions A client (the portal after it makes a connection) can drop permissions
on an object. Once dropped, it can never reacquire the permission. on an object. Once dropped, it can never reacquire the permission.
@ -204,6 +204,9 @@ on an object. Once dropped, it can never reacquire the permission.
Clients with WRITE/EXECUTE permissions on another client can Clients with WRITE/EXECUTE permissions on another client can
add and remove permissions for the client at will. add and remove permissions for the client at will.
Clients with MODIFY permissions on another object can set or remove
metadata on that object.
Clients that need permissions assigned to them can be started in Clients that need permissions assigned to them can be started in
blocked mode and resume when perrmissions are assigned to them by blocked mode and resume when perrmissions are assigned to them by
a session manager or portal, for example. a session manager or portal, for example.