1libpipewire-module-exampMlies-cfeillltaenre(o7u)s InformlaitbipoinpeMwainruea-lmodule-example-filter(7)
2
3
4
6 libpipewire-module-example-filter - Example Filter
7
9 The example filter is a good starting point for writing a custom
10 filter.
11
12 We refer to the source code for more information.
13
15 libpipewire-module-example-filter
16
18 • node.description: a human readable name for the filter streams
19
20 • capture.props = {}: properties to be passed to the input stream
21
22 • playback.props = {}: properties to be passed to the output stream
23
25 Options with well-known behavior. Most options can be added to the
26 global configuration or the individual streams:
27
28 • remote.name
29
30 • audio.rate
31
32 • audio.channels
33
34 • audio.position
35
36 • media.name
37
38 • node.latency
39
40 • node.description
41
42 • node.group
43
44 • node.link.group
45
46 • node.virtual
47
48 • node.name: See notes below. If not specified, defaults to
49 'filter-<pid>-<module-id>'.
50
51 Stream only properties:
52
53 • media.class
54
55 • node.name: if not given per stream, the global node.name will be
56 prefixed with 'input.' and 'output.' to generate a capture and
57 playback stream node.name respectively.
58
60 context.modules = [
61 { name = libpipewire-module-example-filter
62 args = {
63 node.description = "Example Filter"
64 capture.props = {
65 audio.position = [ FL FR ]
66 node.passive = true
67 }
68 playback.props = {
69 node.name = "Example Filter"
70 media.class = "Audio/Source"
71 audio.position = [ FL FR ]
72 }
73 }
74 }
75 ]
76
77 pw-cli -m lm libpipewire-module-example-filter '{ audio.position=[FL FR] }'
78
79PipeWire 1.0.0libpipewire-module-example-filter(7)