pw-metadata(1)

✨ pw-metadata(1) ✨

so bestie, welcome to pw-metadata β€” it's a General Commands Manual page, and it's literally all about The PipeWire metadata. it's giving "tiny command, huge power" energy and i am obsessed. πŸ’–


🌸 NAME 🌸

pw-metadata β€” The PipeWire metadata πŸ‘‘


πŸŽ€ SYNOPSIS πŸŽ€

pw-metadata [options] [id [key [value [type ] ] ] ]
okay so like, those brackets are nesting besties. every layer inside is optional, and they all stack. πŸͺ†

πŸ¦‹ DESCRIPTION πŸ¦‹

Monitor, set and delete metadata on PipeWire objects. that's the whole vibe. 🫢

Metadata are key/type/value triplets attached to objects identified by id. and here's the tea: the metadata is shared between all applications binding to the same metadata object. so like, everybody sees the same thing, no cap. and when an object is destroyed, all its metadata is automatically removed β€” it takes itself out, iconic behaviour honestly. πŸ’…

When no value is given, pw-metadata will query and log the metadata matching the optional arguments id and key. Without any arguments, all metadata is displayed. the whole entire list. a full reveal. ✨

When value is given, pw-metadata will set the metadata for id and key to value and an optional type. so yeah you can write stuff too, not just peek. πŸ‘‘


πŸ’… OPTIONS πŸ’…

  • -r | --remote=NAME β€” the name of the remote instance to use. if you leave it unspecified, a connection is made to the default PipeWire instance. (so like, no name = you get the default one, easy.) 🌈
  • -h | --help β€” Show help. bestie behaviour, always there for you. 🫢
  • --version β€” Show version information. πŸ“Œ
  • -l | --list β€” List available metadata objects. window shopping but make it metadata. πŸ›οΈ
  • -m | --monitor β€” Keeps running and log the changes to the metadata. it just... stays. watching. forever. main character energy honestly. πŸ‘€
  • -d | --delete β€” Delete all metadata for id or for the specified key of object id. Without any option, all metadata is removed. > ⚠️ bestie this one is permanent, there's no undo button, so like... be sure. 😭
  • -n | --name β€” Metadata name (Default: "default"). 🏷️

🌟 EXAMPLES 🌟

pw-metadata

Show metadata in default name. simple. clean. iconic. ✨

pw-metadata

pw-metadata -n settings 0

Display settings. πŸ‘‘

pw-metadata -n settings 0

pw-metadata -n settings 0 clock.quantum 1024

Change clock.quantum to 1024. look at you, setting values like a legend. πŸ”₯

pw-metadata -n settings 0 clock.quantum 1024

πŸ’œ AUTHORS πŸ’œ

The PipeWire Developers <https://gitlab.freedesktop.org/pipewire/pipewire/issues>; PipeWire is available from <https://pipewire.org>

(yeah, the whole dev team, they ate. πŸ’–)


🧚 SEE ALSO 🧚

iykyk, go read those next bestie πŸ¦‹


and that's the page!! this one ships as PipeWire 1.6.11, page pw-metadata(1) β€” so like, that's the version, that's the source, that's the date stamp, we love a documented queen. slay, go touch some metadata, periodt πŸ’…βœ¨πŸŽ€

πŸ“¦ where this page comes from