.TH "pw-link" 1 "1.0.5" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pw-link \- The PipeWire Link Command
.PP
.SH "SYNOPSIS"
.PP
.PP
\fBpw-link\fP [\fIoptions\fP] -o-l [\fIout-pattern\fP] [\fIin-pattern\fP]
.PP
\fBpw-link\fP [\fIoptions\fP] \fIoutput\fP \fIinput\fP
.PP
\fBpw-link\fP [\fIoptions\fP] -d \fIoutput\fP \fIinput\fP
.PP
\fBpw-link\fP [\fIoptions\fP] -d \fIlink-id\fP
.PP
.SH "DESCRIPTION"
.PP
.PP
List, create and destroy links between PipeWire ports\&.
.PP
.SH "COMMON OPTIONS"
.PP
.PP
\fB-r | --remote=NAME\fP
.RS 4
The name the \fIremote\fP instance to monitor\&. If left unspecified, a connection is made to the default PipeWire instance\&.
.RE
.PP
\fB-h | --help\fP
.RS 4
Show help\&.
.RE
.PP
\fB--version\fP
.RS 4
Show version information\&.
.RE
.PP
.SH "LISTING PORTS AND LINKS"
.PP
.PP
Specify one of -o, -i or -l to list the matching optional input and output ports and their links\&.
.PP
\fB-o | --output\fP
.RS 4
List output ports
.RE
.PP
\fB-i | --input\fP
.RS 4
List output ports
.RE
.PP
\fB-l | --links\fP
.RS 4
List links
.RE
.PP
\fB-m | --monitor\fP
.RS 4
Monitor links and ports\&. \fBpw-link\fP will not exit but monitor and print new and destroyed ports or links\&.
.RE
.PP
\fB-I | --id\fP
.RS 4
List IDs\&. Also list the unique link and port ids\&.
.RE
.PP
\fB-v | --verbose\fP
.RS 4
Verbose port properties\&. Also list the port-object-path and the port-alias\&.
.RE
.PP
.SH "CONNECTING PORTS"
.PP
.PP
Without any list option (-i, -o or -l), the given ports will be linked\&. Valid port specifications are:
.PP
\fIport-id\fP
.PP
As obtained with the -I option when listing ports\&.
.PP
\fInode-name:port-name\fP
.PP
As obtained when listing ports\&.
.PP
\fIport-object-path\fP
.PP
As obtained from the first alternative name for the port when listing them with the -v option\&.
.PP
\fIport-alias\fP
.PP
As obtained from the second alternative name for the ports when listing them with the -v option\&.
.PP
Extra options when linking can be given:
.PP
\fB-L | --linger\fP
.RS 4
Linger\&. Will create a link that exists after \fBpw-link\fP is destroyed\&. This is the default behaviour, unless the -m option is given\&.
.RE
.PP
\fB-P | --passive\fP
.RS 4
Passive link\&. A passive link will keep both nodes it links inactive unless another non-passive link is activating the nodes\&. You can use this to link a sink to a filter and have them both suspended when nothing else is linked to either of them\&.
.RE
.PP
\fB-p | --props=PROPS\fP
.RS 4
Properties as JSON object\&. Give extra properties when creaing the link\&.
.RE
.PP
.SH "DISCONNECTING PORTS"
.PP
.PP
When the -d option is given, an existing link between port is destroyed\&.
.PP
To disconnect port, a single \fIlink-id\fP, as obtained when listing links with the -I option, or two port specifications can be given\&. See the connecting ports section for valid port specifications\&.
.PP
\fB-d | --disconnect\fP
.RS 4
Disconnect ports
.RE
.PP
.SH "EXAMPLES"
.PP
.PP
\fBpw-link\fP -iol
.PP
List all port and their links\&.
.PP
\fBpw-link\fP -lm
.PP
List all links and monitor changes until \fBpw-link\fP is stopped\&.
.PP
\fBpw-link\fP paplay:output_FL alsa_output\&.pci-0000_00_1b\&.0\&.analog-stereo:playback_FL
.PP
Link the given output port to the input port\&.
.PP
\fBpw-link\fP -lI
.PP
List links and their Id\&.
.PP
\fBpw-link\fP -d 89
.PP
Destroy the link with id 89\&.
.PP
.SH "AUTHORS"
.PP
.PP
The PipeWire Developers <https://gitlab.freedesktop.org/pipewire/pipewire/issues>; PipeWire is available from <https://pipewire.org>
.PP
.SH "SEE ALSO"
.PP
.PP
\fBpipewire(1)\fP, \fBpw-cli(1)\fP