<section name="Commands">
<option>
- <p><opt>stat</opt></p>
- <optdesc><p>Dump a few statistics about the memory usage of the PulseAudio daemon.</p></optdesc>
+ <p><opt>stat</opt> [<arg>short</arg>]</p>
+ <optdesc><p>Dump a few statistics about the memory usage of the PulseAudio daemon. (Note: for backwards
+ compatibility, we also show the output of the <arg>info</arg> command. In order to only show
+ statistics, use the optional <arg>short</arg> argument. In a future version of PA we will
+ make this the default)</p></optdesc>
</option>
<option>
</option>
<option>
- <p><opt>list</opt> [
short] [<arg>TYPE</arg>]</p>
+ <p><opt>list</opt> [
<arg>short</arg>] [<arg>TYPE</arg>]</p>
<optdesc><p>Dump all currently loaded modules, available sinks, sources, streams, etc. <arg>TYPE</arg> must be one of:
modules, sinks, sources, sink-inputs, source-outputs, clients, samples, cards. If not specified, all info is listed. If
short is given, output is in a tabular format, for easy parsing by scripts.</p></optdesc>
</option>
<option>
- <p><opt>unload-module</opt> <arg>ID</arg></p>
- <optdesc><p>Unload the module instance identified by the specified numeric index.</p></optdesc>
+ <p><opt>unload-module</opt> <arg>ID|NAME</arg></p>
+ <optdesc><p>Unload the module instance identified by the specified numeric index or unload all modules by the specified name.</p></optdesc>
</option>
<option>
<optdesc><p>Set the specified card (identified by its symbolic name or numerical index) to the specified profile (identified by its symbolic name).</p></optdesc>
</option>
+ <option>
+ <p><opt>set-default-sink</opt> <arg>SINK</arg></p>
+ <optdesc><p>Make the specified sink (identified by its symbolic name) the default sink.</p></optdesc>
+ </option>
+
<option>
<p><opt>set-sink-port</opt> <arg>SINK</arg> <arg>PORT</arg></p>
<optdesc><p>Set the specified sink (identified by its symbolic name or numerical index) to the specified port (identified by its symbolic name).</p></optdesc>
</option>
+ <option>
+ <p><opt>set-default-source</opt> <arg>SOURCE</arg></p>
+ <optdesc><p>Make the specified source (identified by its symbolic name) the default source.</p></optdesc>
+ </option>
+
<option>
<p><opt>set-source-port</opt> <arg>SOURCE</arg> <arg>PORT</arg></p>
<optdesc><p>Set the specified source (identified by its symbolic name or numerical index) to the specified port (identified by its symbolic name).</p></optdesc>
</option>
<option>
- <p><opt>set-sink-volume</opt> <arg>SINK</arg> <arg>VOLUME</arg></p>
+ <p><opt>set-port-latency-offset</opt> <arg>CARD</arg> <arg>PORT</arg> <arg>OFFSET</arg></p>
+ <optdesc><p>Set a latency offset to a specified port (identified by its symbolic name) that belongs to a card (identified by its symbolic name or numerical index).
+ <arg>OFFSET</arg> is a number which represents the latency offset in microseconds</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>set-sink-volume</opt> <arg>SINK</arg> <arg>VOLUME [VOLUME ...]</arg></p>
<optdesc><p>Set the volume of the specified sink (identified by its symbolic name or numerical index).
<arg>VOLUME</arg> can be specified as an integer (e.g. 2000, 16384), a linear factor (e.g. 0.4, 1.100), a percentage
(e.g. 10%, 100%) or a decibel value (e.g. 0dB, 20dB). If the volume specification start with a + or - the volume
- adjustment will be relative to the current sink volume.</p></optdesc>
+ adjustment will be relative to the current sink volume. A single volume value affects all channels; if multiple
+ volume values are given their number has to match the sink's number of channels.</p></optdesc>
</option>
<option>
- <p><opt>set-source-volume</opt> <arg>SOURCE</arg> <arg>VOLUME</arg></p>
+ <p><opt>set-source-volume</opt> <arg>SOURCE</arg> <arg>VOLUME [VOLUME ...]</arg></p>
<optdesc><p>Set the volume of the specified source (identified by its symbolic name or numerical index).
<arg>VOLUME</arg> can be specified as an integer (e.g. 2000, 16384), a linear factor (e.g. 0.4, 1.100), a percentage
(e.g. 10%, 100%) or a decibel value (e.g. 0dB, 20dB). If the volume specification start with a + or - the volume
- adjustment will be relative to the current source volume.</p></optdesc> </option>
+ adjustment will be relative to the current source volume. A single volume value affects all channels; if multiple
+ volume values are given their number has to match the source's number of channels.</p></optdesc> </option>
<option>
- <p><opt>set-sink-input-volume</opt> <arg>INPUT</arg> <arg>VOLUME</arg></p>
+ <p><opt>set-sink-input-volume</opt> <arg>INPUT</arg> <arg>VOLUME [VOLUME ...]</arg></p>
<optdesc><p>Set the volume of the specified sink input (identified by its numerical index).
<arg>VOLUME</arg> can be specified as an integer (e.g. 2000, 16384), a linear factor (e.g. 0.4, 1.100), a percentage
(e.g. 10%, 100%) or a decibel value (e.g. 0dB, 20dB). If the volume specification start with a + or - the volume
- adjustment will be relative to the current sink input volume.</p></optdesc> </option>
+ adjustment will be relative to the current sink input volume. A single volume value affects all channels; if multiple
+ volume values are given their number has to match the sink input's number of channels.</p></optdesc> </option>
<option>
- <p><opt>set-source-output-volume</opt> <arg>OUTPUT</arg> <arg>VOLUME</arg></p>
+ <p><opt>set-source-output-volume</opt> <arg>OUTPUT</arg> <arg>VOLUME [VOLUME ...]</arg></p>
<optdesc><p>Set the volume of the specified source output (identified by its numerical index).
<arg>VOLUME</arg> can be specified as an integer (e.g. 2000, 16384), a linear factor (e.g. 0.4, 1.100), a percentage
(e.g. 10%, 100%) or a decibel value (e.g. 0dB, 20dB). If the volume specification start with a + or - the volume
- adjustment will be relative to the current source output volume.</p></optdesc>
+ adjustment will be relative to the current source output volume. A single volume value affects all channels; if multiple
+ volume values are given their number has to match the source output's number of channels.</p></optdesc>
</option>
<option>
- <p><opt>set-sink-mute</opt> <arg>SINK</arg> <arg>1|0</arg></p>
+ <p><opt>set-sink-mute</opt> <arg>SINK</arg> <arg>1|0|toggle</arg></p>
<optdesc><p>Set the mute status of the specified sink (identified by its symbolic name or numerical index).</p></optdesc>
</option>
<option>
- <p><opt>set-source-mute</opt> <arg>SOURCE</arg> <arg>1|0</arg></p>
+ <p><opt>set-source-mute</opt> <arg>SOURCE</arg> <arg>1|0|toggle</arg></p>
<optdesc><p>Set the mute status of the specified source (identified by its symbolic name or numerical index).</p></optdesc>
</option>
<option>
- <p><opt>set-sink-input-mute</opt> <arg>INPUT</arg> <arg>1|0</arg></p>
+ <p><opt>set-sink-input-mute</opt> <arg>INPUT</arg> <arg>1|0|toggle</arg></p>
<optdesc><p>Set the mute status of the specified sink input (identified by its numerical index).</p></optdesc>
</option>
+ <option>
+ <p><opt>set-source-output-mute</opt> <arg>INPUT</arg> <arg>1|0|toggle</arg></p>
+ <optdesc><p>Set the mute status of the specified source output (identified by its numerical index).</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>set-sink-formats</opt> <arg>SINK</arg> <arg>FORMATS</arg></p>
+ <optdesc><p>Set the supported formats of the specified sink (identified by its numerical index) if supported by the sink.
+ <arg>FORMATS</arg> is specified as a semi-colon (;) separated list of formats in the form
+ 'encoding[, key1=value1, key2=value2, ...]' (for example, AC3 at 32000, 44100 and 48000 Hz would be specified as
+ 'ac3-iec61937, format.rate = "[ 32000, 44100, 48000 ]"').
+ </p></optdesc> </option>
+
<option>
<p><opt>subscribe</opt></p>
<optdesc><p>Subscribe to events, pactl does not exit by itself, but keeps waiting for new events.</p></optdesc>
<seealso>
<p>
- <manref name="pulseaudio" section="1"/>, <manref name="pacmd" section="1"/>
+ <manref name="pulseaudio" section="1"/>,
+ <manref name="pacmd" section="1"/>
</p>
</seealso>