1libpipewire-module-protoMcioslc-eslilmapnleeo(u7s)InforlmiabtpiiopnewMiarneu-amlodule-protocol-simple(7)
2
3
4

NAME

6       libpipewire-module-protocol-simple - Protocol Simple
7

DESCRIPTION

9       The simple protocol provides a bidirectional audio stream on a network
10       socket.
11
12       It is meant to be used with the simple protocol player app, available
13       on Android to play and record a stream.
14
15       Each client that connects will create a capture and/or playback stream,
16       depending on the configuration options.
17

MODULE NAME

19       libpipewire-module-protocol-simple
20

MODULE OPTIONS

22       • capture: boolean if capture is enabled. This will create a capture
23         stream for each connected client.
24
25       • playback: boolean if playback is enabled. This will create a playback
26         stream for each connected client.
27
28       • capture.node: an optional node serial or name to use for capture.
29
30       • playback.node: an optional node serial or name to use for playback.
31
32       • server.address = []: an array of server addresses to listen on as
33         tcp:(<ip>:)<port>.
34

GENERAL OPTIONS

36       Options with well-known behavior.
37
38       • remote.name
39
40       • audio.rate
41
42       • audio.format
43
44       • audio.channels
45
46       • audio.position
47
48       • node.latency
49
50       • node.rate
51
52       • stream.capture.sink
53
54       By default the server will work with stereo 16 bits samples at 44.1KHz.
55

EXAMPLE CONFIGURATION

57       context.modules = [
58       {   name = libpipewire-module-protocol-simple
59           args = {
60               # Provide capture stream, clients can capture data from PipeWire
61               capture = true
62               #
63               # Provide playback stream, client can send data to PipeWire for playback
64               playback = true
65               #
66               # The node name or id to use for capture.
67               #capture.node = null
68               #
69               # To make the capture stream capture the monitor ports
70               #stream.capture.sink = false
71               #
72               # The node name or id to use for playback.
73               #playback.node = null
74               #
75               #audio.rate = 44100
76               #audio.format = S16
77               #audio.channels = 2
78               #audio.position = [ FL FR ]
79               #
80               # The addresses this server listens on for new
81               # client connections
82               server.address = [
83                   "tcp:4711"
84               ]
85           }
86       }
87       ]
88
89PipeWire                             1.0.0libpipewire-module-protocol-simple(7)