pw-cli - The PipeWire Command Line Interface

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

send-commandobject-idSendacommandtoanobject.

       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.

       Note that pw-cli also creates a local PipeWire instance. Some commands operate on the current (remote)
       instance and some on the local instance, such as module loading.

       Use the 'help' command to list the available commands.

create-devicefactory-name[properties...]Createadevicefromafactoryinthecurrentinstance.

           Properties are key=value pairs separated by whitespace.

           This command returns a devicevariable.

help|h
           Show a quick help on the commands available. It also lists the aliases for many commands.

       quit|q
           Exit from pw-cli

destroyobject-idDestroyaglobalobject.

create-linknode-idport-idnode-idport-id[properties...]Createalinkbetween2nodesandports.

           Port ids and Node ids can be set to - to automatically select a node or a port.

           Port ids can be * to automatically link matching ports ids in the nodes.

           Properties are key=value pairs separated by whitespace.

           This command returns one or more linkvariables.

       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.

       load-modulename[arguments...]Loadamodulespecifiedbyitsnameandargumentsinthelocalinstance.FormostmodulesitisOKtobeloadedmorethanonce.

           This command returns a module variable that can be used to unload the module.

           The locally module is not visible in the remote instance. It is not possible in PipeWire to load
           modules in a remote instance.

       unload-modulemodule-varUnloadamodule,specifiedeitherbyitsvariable.

       pw-cli - The PipeWire Command Line Interface

create-nodefactory-name[properties...]Createanodefromafactoryinthecurrentinstance.

           Properties are key=value pairs separated by whitespace.

           This command returns a nodevariable.

       export-nodenode-id[remote-var]Exportanodefromthelocalinstancetothespecifiedinstance.Whennoinstanceisspecified,thenodewillbeexportedtothecurrentinstance.

list-objects
           List the objects of the current instance.

       Objects are listed with their id, type and version.

       infoid|allGetinformationaboutaspecificobjectorallobjects.

       Requesting info about an object will also notify you of changes.

enum-paramsobject-idparam-idEnumerateparamsofanobject.param-id can also be given as the param short name.

       set-paramobject-idparam-idparam-jsonSetparamofanobject.param-id can also be given as the param short name.

permissionsclient-idobject-idpermissionSetpermissionsforaclient.object-id can be -1 to set the default permissions.

       get-permissionsclient-idGetpermissionsofaclient.

pipewire(1), pw-mon(1),

PipeWire                                              1.2.7                                            pw-cli(1)

pw-cli [command]

connect[remote-name]Connecttoaremoteinstanceandmakethisthenewcurrentinstance.

           If no remote name is specified, a connection is made to the default remote instance, usually
           pipewire-0.

           The special remote name called internal can be used to connect to the local pw-cli PipeWire instance.

           This command returns a remote var that can be used to disconnect or switch remotes.

       disconnect[remote-var]Disconnectfromaremoteinstance.

           If no remote name is specified, the current instance is disconnected.

       list-remotes
           List all remoteinstances.

       switch-remote[remote-var]Makethespecifiedremotethecurrentinstance.

           If no remote name is specified, the first instance is made current.