From edb3968c5c6c3e2b00a04769b9b65a4c4cb3b040 Mon Sep 17 00:00:00 2001 From: Wim Taymans Date: Sun, 2 Aug 2020 20:13:29 +0200 Subject: [PATCH] docs: some small fixes and updates --- README.md | 6 +++++- doc/architecture.md | 13 ++++++++----- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d94932e57..b83637158 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,11 @@ applications: * `PIPEWIRE_DEBUG=` to increase the debug level * `PIPEWIRE_LOG=` to redirect log to filename -* `PIPEWIRE_LATENCY=` to configure latency +* `PIPEWIRE_LATENCY=` 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=` to request link to specified node ### Using tools diff --git a/doc/architecture.md b/doc/architecture.md index 07b9f35ce..4a10f254e 100644 --- a/doc/architecture.md +++ b/doc/architecture.md @@ -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. Other core methods and events are used internally for the object -life cycle management internally. +life cycle management. ### `struct pw_registry` @@ -193,10 +193,10 @@ do the connection for the client and then hands the connection socket to the client. All objects in PipeWire have per client permission bits, currently -READ, WRITE and EXECUTE. A client can not see an objects unless it -has READ permissions. Similarly, a client can only execute methods -on an object when the EXECUTE bit is set and to modify the state of -an object, the client needs WRITE permissions. +READ, WRITE, EXECUTE and METADATA. A client can not see an objects +unless it has READ permissions. Similarly, a client can only execute +methods on an object when the EXECUTE bit is set and to modify the +state of an object, the client needs WRITE permissions. A client (the portal after it makes a connection) can drop permissions 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 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 blocked mode and resume when perrmissions are assigned to them by a session manager or portal, for example.