mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-10-29 05:40:27 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: clarify writefd in transport

Browse source
This commit is contained in:
Wim Taymans 2023-06-06 11:02:43 +02:00
parent c3b01eee97
commit f9b2df25c7
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/pipewire-protocol.dox
View file

@ -1253,7 +1253,8 @@ transfer this to the client with the Transport event.
) )
``` ```
- readfd: the eventfd to start processing - readfd: the eventfd to start processing
- writefd: the eventfd to signal driver start - writefd: the eventfd to signal when the driver completes and profiling is
enabled.
- memfd: the index of the memfd of the activation record - memfd: the index of the memfd of the activation record
- offset: the offset in memfd of the start of the activation record - offset: the offset in memfd of the start of the activation record
- size: the size of the activation record - size: the size of the activation record
@ -1261,6 +1262,11 @@ transfer this to the client with the Transport event.
The activation record is currently an internal data structure that is The activation record is currently an internal data structure that is
not yet ABI stable. not yet ABI stable.
The writefd is meant to wake up the server after the driver completes so
that the profiler can collect the information. The profiler is active
when the pw_node_activation::flags fields has PW_NODE_ACTIVATION_FLAG_PROFILER
set. When the profiler is disabled (or when the node is not driving), this
eventfd should not be signaled.
### ClientNode::SetParam (Opcode 1) ### ClientNode::SetParam (Opcode 1)