2025-03-14 21:59:59 -06:00
|
|
|
# wpctl
|
|
|
|
|
|
|
|
|
|
> Manage WirePlumber, a session and policy manager for PipeWire.
|
2025-05-08 12:26:01 -06:00
|
|
|
> Note: You can use the special name `@DEFAULT_SINK@` in place of `id` to operate on the default sink.
|
2025-07-24 22:27:13 -06:00
|
|
|
> See also: `pw-cli`.
|
2025-03-14 21:59:59 -06:00
|
|
|
> More information: <https://pipewire.pages.freedesktop.org/wireplumber/>.
|
|
|
|
|
|
|
|
|
|
- List all objects managed by WirePlumber:
|
|
|
|
|
|
|
|
|
|
`wpctl status`
|
|
|
|
|
|
|
|
|
|
- Print all properties of an object:
|
|
|
|
|
|
|
|
|
|
`wpctl inspect {{id}}`
|
|
|
|
|
|
|
|
|
|
- Set an object to be the default in its group:
|
|
|
|
|
|
|
|
|
|
`wpctl set-default {{id}}`
|
|
|
|
|
|
|
|
|
|
- Get the volume of a sink:
|
|
|
|
|
|
|
|
|
|
`wpctl get-volume {{id}}`
|
|
|
|
|
|
|
|
|
|
- Set the volume of a sink to `n` percent:
|
|
|
|
|
|
|
|
|
|
`wpctl set-volume {{id}} {{n}}%`
|
|
|
|
|
|
|
|
|
|
- Increase/Decrease the volume of a sink by `n` percent:
|
|
|
|
|
|
|
|
|
|
`wpctl set-volume {{id}} {{n}}%{{+|-}}`
|
|
|
|
|
|
2025-04-25 19:33:51 -06:00
|
|
|
- Increase the volume of a sink by `n` percent but limit the volume below 100%:
|
|
|
|
|
|
|
|
|
|
`wpctl set-volume {{[-l|--limit]}} 1 {{id}} {{n}}%-`
|
|
|
|
|
|
2025-03-14 21:59:59 -06:00
|
|
|
- Mute/Unmute a sink (1 is mute, 0 is unmute):
|
|
|
|
|
|
|
|
|
|
`wpctl set-mute {{id}} {{1|0|toggle}}`
|
