pw-link(1)

1pw-link(1)                  General Commands Manual                 pw-link(1)
2
3
4

NAME

6       pw-link - The PipeWire Link Command
7

SYNOPSIS

9       pw-link [options] -o-l [out-pattern] [in-pattern]
10
11       pw-link [options] output input
12
13       pw-link [options] -d output input
14
15       pw-link [options] -d link-id
16

DESCRIPTION

18       List, create and destroy links between PipeWire ports.
19

COMMON OPTIONS

21       -r | --remote=NAME
22           The name the remote instance to monitor. If left unspecified, a
23           connection is made to the default PipeWire instance.
24
25       -h | --help
26           Show help.
27
28       --version
29           Show version information.
30

LISTING PORTS AND LINKS

32       Specify one of -o, -i or -l to list the matching optional input and
33       output ports and their links.
34
35       -o | --output
36           List output ports
37
38       -i | --input
39           List output ports
40
41       -l | --links
42           List links
43
44       -m | --monitor
45           Monitor links and ports. pw-link will not exit but monitor and
46           print new and destroyed ports or links.
47
48       -I | --id
49           List IDs. Also list the unique link and port ids.
50
51       -v | --verbose
52           Verbose port properties. Also list the port-object-path and the
53           port-alias.
54

CONNECTING PORTS

56       Without any list option (-i, -o or -l), the given ports will be linked.
57       Valid port specifications are:
58
59       port-id
60
61       As obtained with the -I option when listing ports.
62
63       node-name:port-name
64
65       As obtained when listing ports.
66
67       port-object-path
68
69       As obtained from the first alternative name for the port when listing
70       them with the -v option.
71
72       port-alias
73
74       As obtained from the second alternative name for the ports when listing
75       them with the -v option.
76
77       Extra options when linking can be given:
78
79       -L | --linger
80           Linger. Will create a link that exists after pw-link is destroyed.
81           This is the default behaviour, unless the -m option is given.
82
83       -P | --passive
84           Passive link. A passive link will keep both nodes it links inactive
85           unless another non-passive link is activating the nodes. You can
86           use this to link a sink to a filter and have them both suspended
87           when nothing else is linked to either of them.
88
89       -p | --props=PROPS
90           Properties as JSON object. Give extra properties when creaing the
91           link.
92

DISCONNECTING PORTS

94       When the -d option is given, an existing link between port is
95       destroyed.
96
97       To disconnect port, a single link-id, as obtained when listing links
98       with the -I option, or two port specifications can be given. See the
99       connecting ports section for valid port specifications.
100
101       -d | --disconnect
102           Disconnect ports
103

EXAMPLES

105       pw-link -iol
106
107       List all port and their links.
108
109       pw-link -lm
110
111       List all links and monitor changes until pw-link is stopped.
112
113       pw-link paplay:output_FL alsa_output.pci-0000_00_1b.0.analog-
114       stereo:playback_FL
115
116       Link the given output port to the input port.
117
118       pw-link -lI
119
120       List links and their Id.
121
122       pw-link -d 89
123
124       Destroy the link with id 89.
125

AUTHORS

127       The PipeWire Developers
128       <https://gitlab.freedesktop.org/pipewire/pipewire/issues>; PipeWire is
129       available from <https://pipewire.org>
130