pw-metadata: Monitor, set, and delete PipeWire metadata

pw-metadata

Monitor, set, and delete metadata on PipeWire objects. This tool lets you view metadata, list all objects, monitor changes, and modify values.

Quick start: what you can do

  • View the default metadata: pw-metadata
  • List all metadata objects: pw-metadata -l or pw-metadata --list
  • Keep an eye on changes: pw-metadata -m or pw-metadata --monitor
  • Delete all metadata: pw-metadata -d or pw-metadata --delete
  • Inspect a specific object by name and ID: pw-metadata -n settings 0 (then drill into keys)
  • Set a value: pw-metadata -n settings 0 log.level 1 (sets log.level to 1 on the object named settings with ID 0)
  • Show help: pw-metadata -h or pw-metadata --help

Note: If you’re just getting started, try listing objects first to understand what metadata is available.

Examples in practice

1) Show metadata for the default object

pw-metadata

This prints the metadata stored under the default (unnamed) object, helping you verify what’s currently present.

2) List all available metadata objects

pw-metadata -l
# or
pw-metadata --list

Useful when you want to discover which objects exist (e.g., settings, streams).

3) Monitor metadata changes in real time

pw-metadata -m

Great for debugging when something is changing dynamically or when a configuration is updated by another process.

4) Delete all metadata

pw-metadata -d

Be careful: this wipes all metadata. You’ll likely need to recreate or reconfigure objects afterward.

5) Inspect and set a specific value

# Inspect the object named 'settings' with ID 0
pw-metadata -n settings 0

# Set log.level to 1 on the same object
pw-metadata -n settings 0 log.level 1

Common pitfall: ensure you target the right object by name and ID. If you mix up IDs, you may modify the wrong metadata.

6) Help and quick references

pw-metadata -h

This prints usage and available options.

Quick tips

  • If the CLI returns no output, PipeWire or the metadata subsystem might not be running. Check pw-core or PipeWire services.
  • Some environments require root or your user to be in the appropriate group to modify certain metadata.
  • Use -m to confirm that your changes take effect in real time.

Common workflow snapshots

  • Discover objects: pw-metadata -l
  • Inspect: pw-metadata -n settings 0
  • Change a value: pw-metadata -n settings 0 log.level 1
  • Verify: re-run an inspect or watch with -m to see updates

References

See Also