pw-dump(1)

πŸ’– pw-dump β€” the PipeWire state dumper πŸ’–

okay bestie, welcome to the pw-dump(1) manual page, aka the general commands manual's most underrated girlie 🌸 she's little, she's powerful, and she will literally hand you the entire state of your PipeWire setup as JSON. no cap.


✨ NAME ✨

pw-dump β€” The PipeWire state dumper πŸ‘‘


πŸ¦‹ SYNOPSIS πŸ¦‹

pw-dump [options]

that's it. that's the whole vibe. options go in, JSON comes out πŸ’…


🌈 DESCRIPTION 🌈

okay so listen πŸ‘‚ the pw-dump program produces a representation of the current PipeWire state as JSON. and when we say state, we mean the state β€” it's giving the information on nodes, devices, modules, ports, and other objects. all of it. every object. no crumbs left behind πŸ“

like, imagine your entire PipeWire graph just ✨ manifested ✨ as a big beautiful JSON blob. that's her. that's the program. iconic behaviour honestly.


πŸŽ€ OPTIONS πŸŽ€

  • -h | --help β€” Show help. she'll tell you how to use her 🫢
  • -r | --remote=NAME β€” The name of the remote instance to dump. if you leave it unspecified, a connection is made to the default PipeWire instance. so like, don't worry about it unless you're being fancy πŸ’…
  • -m | --monitor β€” Monitor PipeWire state changes, and output JSON arrays describing changes. this one is the main character fr fr β€” she just sits there and watches, streaming you every lil change as it happens πŸ‘€ not a one-and-done dump, a whole live feed
  • -N | --no-colors β€” Disable color output. for when you want the plain unseasoned version πŸ₯²
  • -C | --color=WHEN β€” Whether to enable color support. and WHEN is one of never, always, or auto. pick your fighter 🌈

πŸ‘‘ AUTHORS πŸ‘‘

The PipeWire Developers β€” you can find them over at <https://gitlab.freedesktop.org/pipewire/pipewire/issues> πŸ’œ and PipeWire itself is available from <https://pipewire.org> ⭐


🌸 SEE ALSO 🌸

pipewire(1), pw-cli(1), pw-top(1)


okay and that's the whole page bestie!! πŸ’– this was the pw-dump manual, from the General Commands Manual, and it's brought to you by PipeWire version 1.6.11 β€” so if you're out here reading this in some other era, check your version, iykyk πŸ¦‹βœ¨ stay hydrated, dump your state responsibly, periodt πŸ’…πŸŽ€

πŸ“¦ where this page comes from