pw-cli(1)                   General Commands Manual                  pw-cli(1)

<?><?><?> (NAME)
       pw-cli - <?><?><?><?> <?><?> <?><?><?><?><?> PipeWire


<?><?><?><?><?> <?><?><?><?><?> (SYNOPSIS)
       pw-cli [command]


<?><?><?><?><?><?><?> (DESCRIPTION)
       <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?> PipeWire.


       <?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?> <?><?><?><?>
       <?><?><?><?> pw-cli <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?>
       <?> <?><?><?><?> <?><?><?><?><?><?>.


       <?><?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> pw-cli <?><?>
       <?><?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?><?> PipeWire <?><?><?><?> pipewire-0 <?><?><?><?>
       <?><?><?><?><?><?>.


       <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?> (remote)
       <?><?><?> <?><?><?><?> <?><?><?><?>. <?><?><?> <?><?><?><?><?><?>
       <?><?><?><?> <?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?>.


       <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?> pw-cli
       <?><?><?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?>
       PipeWire <?><?><?><?><?> <?><?><?><?><?><?>. <?><?><?><?>
       <?><?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?><?> <?><?><?><?>
       (<?><?><?><?><?><?>) <?> <?><?><?><?> <?><?><?><?> <?><?><?>
       <?><?><?><?><?><?> <?><?><?><?> <?><?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>.


       <?><?> <?><?><?><?><?> 'help' <?><?><?><?> <?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?><?>.


<?><?><?><?><?><?><?><?> <?><?><?><?><?> (GENERAL COMMANDS)
       help | h
           <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
           <?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?>.
           <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?><?>
           <?><?><?><?><?><?> (alias) <?><?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?><?>.

       quit | q
           <?><?><?><?> <?><?> pw-cli.

       list-vars
           <?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
           <?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?> <?> <?><?><?>
           <?><?><?><?><?>. <?><?><?><?> <?><?><?><?><?><?><?>
           <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?>
           <?><?> <?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?>.

<?><?><?><?><?><?> <?><?><?><?><?><?><?><?> (MODULE MANAGEMENT)
       <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?>
       (<?><?><?><?> <?><?><?> <?><?><?><?><?><?> pw-cli)
       <?><?><?><?><?><?><?><?> <?> <?><?><?><?><?> <?><?><?><?><?><?><?> <?>
       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?><?>. <?><?> PipeWire <?><?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?>.


       load-module name [arguments...]
           <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?> <?><?><?>
           <?> <?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
           <?><?> <?><?><?><?><?><?> <?><?><?><?>. <?><?><?><?><?><?><?><?>
           <?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>
           <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?>.


           <?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?>
           <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?> <?><?><?>.


           <?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?>
           <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?>.
           <?><?> PipeWire <?><?><?><?><?> <?><?><?><?><?><?><?><?>
           <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?><?> <?><?><?><?><?>.

       unload-module module-var
           <?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?> <?><?><?><?>
           <?><?><?><?> <?><?><?><?><?> <?><?>.

<?><?><?><?><?><?><?><?><?> <?><?><?><?><?> (OBJECT INTROSPECTION)
       list-objects
           <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?><?>.

       <?><?><?><?><?> <?><?> <?><?><?><?><?> id<?> type <?> version <?><?><?>
       <?><?><?><?><?> <?><?><?><?><?><?><?>.


       info id | all
           <?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
           <?><?> <?><?><?> <?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?>
           (all).

       <?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
       <?><?> <?><?><?> <?><?><?><?><?><?> <?><?><?> <?><?> <?><?>
       <?><?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?>.


<?><?><?> <?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?> (WORKING WITH
       REMOTES)
       connect [remote-name]
           <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
           <?> <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?>.


           <?><?><?> <?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
           <?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?><?>
           <?><?><?><?><?><?> <?><?><?><?><?><?><?> (<?><?><?><?><?><?><?>
           pipewire-0) <?><?><?><?><?><?> <?><?><?><?><?><?>.


           <?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?> internal
           <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?>
           <?><?><?><?><?><?> <?><?><?><?> PipeWire <?><?> pw-cli <?><?>
           <?><?><?> <?><?><?>.


           <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?><?>
           (remote var) <?><?><?><?><?><?><?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?> <?><?><?><?><?>
           <?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?><?><?><?><?> <?><?><?>.

       disconnect [remote-var]
           <?><?><?> <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?>
           <?><?><?><?><?><?>.


           <?><?><?> <?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
           <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?>
           <?><?><?> <?><?><?><?><?><?>.

       list-remotes
           <?><?><?><?><?> <?><?><?><?> <?><?><?><?>
           <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>.

       switch-remote [remote-var]
           <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?>.


           <?><?><?> <?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
           <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?> <?><?>
           <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?>
           <?><?><?><?><?> <?><?><?><?><?><?>.

<?><?><?><?><?><?> <?><?><?><?><?><?> (NODE MANAGEMENT)
       create-node factory-name [properties...]
           <?><?><?><?><?> <?><?> <?><?><?> (node) <?><?> <?><?> factory
           <?><?> <?><?><?><?><?><?> <?><?><?><?>.


           <?><?><?><?><?><?><?><?> (properties) <?><?><?><?><?><?><?>
           key=value <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?>
           <?><?><?><?><?> <?><?><?> <?><?><?><?><?><?><?>.


           <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?>
           <?><?><?><?><?><?><?><?><?><?><?>.

       export-node node-id [remote-var]
           <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?> <?><?>
           <?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?>
           <?><?><?><?><?><?><?><?>. <?><?> <?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?>
           <?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?>
           <?><?>.

<?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?> (DEVICE MANAGEMENT)
       create-device factory-name [properties...]
           <?><?><?><?><?> <?><?> <?><?><?><?><?><?> (device) <?><?> <?><?>
           factory <?><?> <?><?><?><?><?><?> <?><?><?><?>.


           <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> key=value
           <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?><?>
           <?><?><?> <?><?><?><?><?><?><?>.


           <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?><?><?><?><?><?><?><?><?>.

<?><?><?><?><?><?> <?><?><?><?><?><?><?> (LINK MANAGEMENT)
       create-link node-id port-id node-id port-id [properties...]
           <?><?><?><?><?> <?><?> <?><?><?><?><?> (link) <?><?><?><?> <?>
           <?><?><?> <?> <?><?><?><?><?> (port).


           <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> (port-id) <?>
           <?><?><?><?><?><?><?><?><?> <?><?><?> (node-id) <?><?>
           <?><?><?><?><?><?><?> <?><?><?> - <?><?><?><?><?> <?><?><?> <?><?>
           <?><?> <?><?><?> <?><?> <?><?><?><?><?> <?><?> <?><?><?>
           <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?>.


           <?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?><?><?> * <?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
           <?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?><?> <?><?>
           <?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?>.


           <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> key=value
           <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?><?>
           <?><?><?> <?><?><?><?><?><?><?>.


           <?><?><?> <?><?><?><?><?> <?><?> <?><?> <?><?><?> <?><?><?><?><?>
           <?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?>.

<?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?> (GLOBALS MANAGEMENT)
       destroy object-id
           <?><?> <?><?><?> <?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?><?>
           (global).

<?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?> (PARAMETER MANAGEMENT)
       enum-params object-id param-id
           <?><?><?><?><?> <?> <?><?><?><?><?><?>
           <?><?><?><?><?><?><?><?><?><?> <?><?> <?><?><?>.


           param-id <?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?>
           <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?>
           <?><?><?><?> <?><?><?>.

       set-param object-id param-id param-json
           <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?>.


           param-id <?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?>
           <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?>
           <?><?><?><?> <?><?><?>.

<?><?><?><?><?><?> <?><?><?><?><?><?> (PERMISSION MANAGEMENT)
       permissions client-id object-id permission
           <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?>
           <?><?><?><?><?><?> (client).


           object-id <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?> -1
           <?><?><?><?>.

       get-permissions client-id
           <?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?>.

<?><?><?><?><?><?> <?><?><?><?><?><?><?> (COMMAND MANAGEMENT)
       send-command object-id
           <?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?> <?><?> <?><?><?>.

<?><?><?><?><?><?><?><?><?> (AUTHORS)
       <?><?><?><?><?><?><?><?><?><?><?><?><?> PipeWire
       <https://gitlab.freedesktop.org/pipewire/pipewire/issues><?> PipeWire
       <?><?> <https://pipewire.org> <?><?> <?><?><?><?><?> <?><?><?>


<?><?><?><?><?><?> <?><?><?><?><?><?> (SEE ALSO)
       pipewire(1), pw-mon(1),

PipeWire                             1.6.8                           pw-cli(1)