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|-i|-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
17

DESCRIPTION

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

COMMON OPTIONS

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

LISTING PORTS AND LINKS

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

CONNECTING PORTS

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

DISCONNECTING PORTS

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

EXAMPLES

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

AUTHORS

120       The                PipeWire                Developers                <‐
121       https://gitlab.freedesktop.org/pipewire/pipewire/issues>;  PipeWire  is
122       available from https://pipewire.org
123