LinuxCommandLibrary

pw-dump

TLDR

Print JSON representation of PipeWire's current state

$ pw-dump
copy
Print JSON representation of a specific object
$ pw-dump [object_id]
copy
Dump current state monitoring changes
$ pw-dump -m
copy
Dump state of remote instance to a file
$ pw-dump -r [remote_name] > [path/to/dump.json]
copy
Set color configuration
$ pw-dump -C [never|always|auto]
copy

SYNOPSIS

pw-dump [options] [id]

DESCRIPTION

pw-dump outputs PipeWire's current state as JSON, including nodes, devices, modules, ports, links, and other objects. This comprehensive dump is useful for debugging, scripting, and understanding the current audio/video configuration.
The output includes object properties, formats, parameters, and relationships between components. The monitor mode keeps running and outputs changes as they occur.

PARAMETERS

id

Dump only the specified object ID
-m, --monitor
Monitor for changes and dump again on updates
-r, --remote name
Connect to remote PipeWire instance
-C, --color mode
Color mode (never, always, auto)
-h, --help
Display help message

CAVEATS

Output can be very large on systems with many devices. Use object ID to filter to specific objects. JSON output is suitable for processing with jq or similar tools.

HISTORY

Part of PipeWire, providing introspection capabilities for the multimedia framework. Complements pw-cli for automated and scripted queries.

SEE ALSO

pw-cli(1), pw-dot(1), pw-mon(1)

Copied to clipboard