PW-CLI(1) | General Commands Manual | PW-CLI(1) |
pw-cli - The PipeWire Command Line Interface
pw-cli [command]
Interact with a PipeWire instance.
When a command is given, pw-cli will execute the command and exit
When no command is given, pw-cli starts an interactive session with the default PipeWire instance pipewire-0.
Connections to other, remote instances can be made. The current instance name is displayed at the prompt. Some commands operate on the current instance and some on the local instance.
Use the 'help' command to list the available commands.
Modules are loaded and unloaded in the local instance, thus the pw-cli binary itself and can add functionality or objects to the local instance. It is not possible in PipeWire to load modules in another instance.
This command returns a module variable that can be used to unload the module.
Objects are listed with their id, type and version.
Requesting info about an object will also notify you of changes.
If no remote name is specified, a connection is made to the default remote instance, usually pipewire-0.
This command returns a remote var that can be used to disconnect or switch remotes.
If no remote name is specified, the current instance is disconnected.
If no remote name is specified, the local instance is made current.
Properties are key=value pairs separated by whitespace.
This command returns a node variable.
Properties are key=value pairs separated by whitespace.
This command returns a device variable.
Port ids can be -1 to automatically select an available port.
Properties are key=value pairs separated by whitespace.
This command returns a link variable.
param-id can also be given as the param short name.
param-id can also be given as the param short name.
object-id can be -1 to set the default permissions.
The PipeWire Developers <https://gitlab.freedesktop.org/pipewire/pipewire/issues>; PipeWire is available from https://pipewire.org