1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
<?xml version="1.0"?><!--*-nxml-*-->
<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
<!--
This file is part of PipeWire.
-->
<manpage name="pw-cli" section="1" desc="The PipeWire Command Line Interface">
<synopsis>
<cmd>pw-cli [<arg>command</arg>]</cmd>
</synopsis>
<description>
<p>Interact with a PipeWire instance.</p>
<p>When a command is given, <manref name="pw-cli" section="1"/>
will execute the command and exit</p>
<p>When no command is given, <manref name="pw-cli" section="1"/>
starts an interactive session with the default pipewire instance
pipewire-0.</p>
<p>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.</p>
<p>Use the 'help' command to list the available commands.</p>
</description>
<section name="General commands">
<option>
<p><opt>help</opt></p>
<optdesc><p>Show a quick help on the commands available.</p></optdesc>
</option>
</section>
<section name="Module Management">
<p>Modules are loaded and unloaded in the local instance and can add
functionality or objects to the local instance.</p>
<option>
<p><opt>load-module</opt> <arg>name</arg> [<arg>arguments...</arg>]</p>
<optdesc><p>Load a module specified by its name and arguments. For most
modules it is OK to be loaded more than once.</p>
<p>This command returns a module variable that can be used
to unload the module.</p></optdesc>
</option>
<option>
<p><opt>unload-module</opt> <arg>module-var</arg></p>
<optdesc><p>Unload a module, specified either by its variable.</p></optdesc>
</option>
</section>
<section name="Object Introspection">
<option>
<p><opt>list-objects</opt></p>
<optdesc><p>List the objects of the current instance.</p>
<p>Objects are listed with their id, type and version.</p></optdesc>
</option>
<option>
<p><opt>info</opt> <arg>id|all</arg></p>
<optdesc><p>Get information about a specific object or all objects.</p>
<p>Requesting info about an object will also notify you of changes.</p>
</optdesc>
</option>
</section>
<section name="Working with remotes">
<option>
<p><opt>connect</opt> [<arg>remote-name</arg>]</p>
<optdesc><p>Connect to a remote instance and make this the new current
instance.</p><p>If no remote name is specified, a connection is made to
the default remote instance, usually pipewire-0</p>
<p>This command returns a remote var that can be used to disconnect or
switch remotes</p></optdesc>
</option>
<option>
<p><opt>disconnect</opt> [<arg>remote-var</arg>]</p>
<optdesc><p>Disconnect from a remote instance.</p>
<p>If no remote name is specified, the current instance is disconnected.
</p></optdesc>
</option>
<option>
<p><opt>list-remotes</opt></p>
<optdesc><p>List all remote instances.</p></optdesc>
</option>
<option>
<p><opt>switch-remote</opt> [<arg>remote-var</arg>]</p>
<optdesc><p>Make the specified remote the current instance.</p>
<p>If no remote name is specified, the local instance is made current.
</p></optdesc>
</option>
</section>
<section name="Node management">
<option>
<p><opt>create-node</opt> <arg>factory-name</arg> [<arg>properties...</arg>]</p>
<optdesc><p>Create a node from a factory in the current instance.</p>
<p>Properties are key=value pairs separated by whitespace</p>
<p>This command returns a node variable.</p></optdesc>
</option>
<option>
<p><opt>destroy-node</opt> <arg>node-var</arg></p>
<optdesc><p>Destroy a node</p></optdesc>
</option>
<option>
<p><opt>export-node</opt> <arg>node-id</arg> [<arg>remote-var</arg>]</p>
<optdesc><p>Export a node from the local instance to the specified instance.
When no instance is specified, the node will be exported to the current
instance.</p></optdesc>
</option>
</section>
<section name="Link management">
<option>
<p><opt>create-link</opt>
<arg>node-id</arg> <arg>port-id</arg>
<arg>node-id</arg> <arg>port-id</arg> [<arg>properties...</arg>]</p>
<optdesc><p>Create a link between 2 nodes and ports.</p>
<p>Port ids can be -1 to automatically select an available port.</p>
<p>Properties are key=value pairs separated by whitespace</p>
<p>This command returns a link variable.</p></optdesc>
</option>
<option>
<p><opt>destroy-link</opt> <arg>link-var</arg></p>
<optdesc><p>Destroy a link</p></optdesc>
</option>
</section>
<section name="Examples">
<p></p>
</section>
<section name="Authors">
<p>The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from <url href="@PACKAGE_URL@"/></p>
</section>
<section name="See also">
<p>
<manref name="pipewire" section="1"/>,
<manref name="pw-mon" section="1"/>,
</p>
</section>
</manpage>
|
