mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-12-14 08:56:37 -05:00
doc updates
This commit is contained in:
Wim Taymans
parent
dd9721ee46
commit
48fdc1d37c
1 changed files with 94 additions and 4 deletions
|
|
@ -34,7 +34,7 @@ First a client needs to register with pinos by calling
|
||||||
org.pinos.Daemon1.ConnectClient(). This creates a new Client1 object that
|
org.pinos.Daemon1.ConnectClient(). This creates a new Client1 object that
|
||||||
the client must use for further communication.
|
the client must use for further communication.
|
||||||
|
|
||||||
A client can then do org.pinos.Client1.CreateSourceInput() to create a
|
A client can then do org.pinos.Client1.CreateSourceOutput() to create a
|
||||||
new SourceOutput1 to retrieve data from a source. It can specify a source
|
new SourceOutput1 to retrieve data from a source. It can specify a source
|
||||||
explicitly or let the server choose a source. The client must provide a list
|
explicitly or let the server choose a source. The client must provide a list
|
||||||
of formats it can handle along with extra properties that can help with
|
of formats it can handle along with extra properties that can help with
|
||||||
|
|
@ -55,11 +55,29 @@ Wire
|
||||||
|
|
||||||
Fixed header
|
Fixed header
|
||||||
|
|
||||||
<version> : 4 bytes : message version
|
|
||||||
<length> : 4 bytes : total message length
|
0 1 2 3
|
||||||
|
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| Version |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| Length |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
|
||||||
|
Version : 4 bytes : message version
|
||||||
|
Length : 4 bytes : total message length
|
||||||
|
|
||||||
|
|
||||||
Followed by 1 or more type-length-data sections
|
Followed by 1 or more type-length-data sections
|
||||||
|
|
||||||
|
0 1 2 3
|
||||||
|
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| Type | Len ... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| Data .... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
|
||||||
<type> : 1 byte
|
<type> : 1 byte
|
||||||
<length> : variable length, 7 bits, high bit is continuation marker
|
<length> : variable length, 7 bits, high bit is continuation marker
|
||||||
<data> : <length> bytes, see below for contents based on <type>
|
<data> : <length> bytes, see below for contents based on <type>
|
||||||
|
|
@ -68,6 +86,18 @@ Types:
|
||||||
|
|
||||||
1: continuation section
|
1: continuation section
|
||||||
|
|
||||||
|
0 1 2 3
|
||||||
|
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| Offset ... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| .... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| Size ... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| .... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
|
||||||
Rest of the commands can be found in the shared memory region at
|
Rest of the commands can be found in the shared memory region at
|
||||||
@offset and @size. A shared memory region is negotiated when the client
|
@offset and @size. A shared memory region is negotiated when the client
|
||||||
connects to the server.
|
connects to the server.
|
||||||
|
|
@ -79,6 +109,23 @@ Types:
|
||||||
|
|
||||||
Header for payload
|
Header for payload
|
||||||
|
|
||||||
|
0 1 2 3
|
||||||
|
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| flags |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| seq |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| PTS ... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| .... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| DTS-offset ... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| .... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
|
||||||
|
|
||||||
<flags> : 4 bytes : buffer flags
|
<flags> : 4 bytes : buffer flags
|
||||||
<seq> : 4 bytes : sequence number
|
<seq> : 4 bytes : sequence number
|
||||||
<pts> : 8 bytes : presentation time
|
<pts> : 8 bytes : presentation time
|
||||||
|
|
@ -89,6 +136,22 @@ Types:
|
||||||
Used to send a block of data between client and server. The type of fd and
|
Used to send a block of data between client and server. The type of fd and
|
||||||
the possible operations on it are negotiated when the client connects.
|
the possible operations on it are negotiated when the client connects.
|
||||||
|
|
||||||
|
0 1 2 3
|
||||||
|
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| id |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| offset ... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| .... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| size ... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| .... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| fd-index |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
|
||||||
<id> : 4 bytes : id of the fd-payload
|
<id> : 4 bytes : id of the fd-payload
|
||||||
<offset> : 8 bytes : offset
|
<offset> : 8 bytes : offset
|
||||||
<size> : 8 bytes : size
|
<size> : 8 bytes : size
|
||||||
|
|
@ -98,6 +161,12 @@ Types:
|
||||||
|
|
||||||
Release a fd-payload with <id>
|
Release a fd-payload with <id>
|
||||||
|
|
||||||
|
0 1 2 3
|
||||||
|
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| id |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
|
||||||
<id> : 4 bytes : the id number of the released fd-payload
|
<id> : 4 bytes : the id number of the released fd-payload
|
||||||
|
|
||||||
5: format change
|
5: format change
|
||||||
|
|
@ -105,6 +174,14 @@ Types:
|
||||||
Perform an in-band format change. The following data blocks will be in this
|
Perform an in-band format change. The following data blocks will be in this
|
||||||
new format.
|
new format.
|
||||||
|
|
||||||
|
0 1 2 3
|
||||||
|
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| id | format ..... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| ...... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
|
||||||
<format-id> : 1 byte : format id
|
<format-id> : 1 byte : format id
|
||||||
<format> : 0-terminated : contains serialized format
|
<format> : 0-terminated : contains serialized format
|
||||||
|
|
||||||
|
|
@ -112,9 +189,22 @@ Types:
|
||||||
|
|
||||||
Notify a property change.
|
Notify a property change.
|
||||||
|
|
||||||
|
0 1 2 3
|
||||||
|
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| key .... .. |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| ...... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| value .... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
| ...... |
|
||||||
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
||||||
|
|
||||||
<key> : 0-terminated : key
|
<key> : 0-terminated : key
|
||||||
<value> : 0-terminated : value
|
<value> : 0-terminated : value
|
||||||
... : more key/values to fill length, 0 key is end
|
... : more key/values to fill length, 0 key or
|
||||||
|
message length is end
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue