Document single-p argument in docstrings
This commit is contained in:
parent
dd4c2728a5
commit
22d02e5b7f
12
pw-ui.el
12
pw-ui.el
@ -297,7 +297,9 @@ object. Otherwise apply it on the default audio sink."
|
|||||||
VOLUME must be a number in the range 0-100.
|
VOLUME must be a number in the range 0-100.
|
||||||
If OBJECT is given (only Nodes and Ports are allowed) or if on a Node
|
If OBJECT is given (only Nodes and Ports are allowed) or if on a Node
|
||||||
or Port in a PipeWire buffer, apply it on the given object.
|
or Port in a PipeWire buffer, apply it on the given object.
|
||||||
Otherwise apply it on the default audio sink."
|
Otherwise apply it on the default audio sink.
|
||||||
|
If SINGLE-P is nil, apply it on all related channels, otherwise on the
|
||||||
|
corresponding object only."
|
||||||
(interactive "nVolume: ")
|
(interactive "nVolume: ")
|
||||||
(setq volume (max 0 (min 100 volume)))
|
(setq volume (max 0 (min 100 volume)))
|
||||||
(unless object
|
(unless object
|
||||||
@ -317,8 +319,8 @@ Otherwise apply it on the default audio sink."
|
|||||||
"Increase volume of an audio output or input.
|
"Increase volume of an audio output or input.
|
||||||
The volume is increased by `pipewire-volume-step'.
|
The volume is increased by `pipewire-volume-step'.
|
||||||
If on a Node or Port in a PipeWire buffer, apply it on all the
|
If on a Node or Port in a PipeWire buffer, apply it on all the
|
||||||
channels of the given object. Otherwise apply it on the default audio
|
channels of the given object, unless SINGLE-P is non-nil.
|
||||||
sink."
|
Otherwise apply it on the default audio sink."
|
||||||
(interactive)
|
(interactive)
|
||||||
(pw-ui--change-volume pipewire-volume-step single-p))
|
(pw-ui--change-volume pipewire-volume-step single-p))
|
||||||
|
|
||||||
@ -336,8 +338,8 @@ object. Otherwise apply it on the default audio sink."
|
|||||||
"Decrease volume of an audio output or input.
|
"Decrease volume of an audio output or input.
|
||||||
The volume is decreased by `pipewire-volume-step'.
|
The volume is decreased by `pipewire-volume-step'.
|
||||||
If on a Node or Port in a PipeWire buffer, apply it on all the
|
If on a Node or Port in a PipeWire buffer, apply it on all the
|
||||||
channels of the given object. Otherwise apply it on the default audio
|
channels of the given object, unless SINGLE-P is non-nil.
|
||||||
sink."
|
Otherwise apply it on the default audio sink."
|
||||||
(interactive)
|
(interactive)
|
||||||
(pw-ui--change-volume (- pipewire-volume-step) single-p))
|
(pw-ui--change-volume (- pipewire-volume-step) single-p))
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user