pw-metadata - Man Page
The PipeWire metadata
Examples (TL;DR)
- Show metadata in
default
name:pw-metadata
- Show metadata with ID 0 in
settings
:pw-metadata -n|--name settings 0
- List all available metadata objects:
pw-metadata -l|--list
- Keep running and log the changes to the metadata:
pw-metadata -m|--monitor
- Delete all metadata:
pw-metadata -d|--delete
- Set
log.level
to 1 insettings
:pw-metadata --name settings 0 log.level 1
- Display help:
pw-metadata --help
Synopsis
pw-metadata [options] [id [key [value [type ] ] ] ]
Description
Monitor, set and delete metadata on PipeWire objects.
Metadata are key/type/value triplets attached to objects identified by id. The metadata is shared between all applications binding to the same metadata object. When an object is destroyed, all its metadata is automatically removed.
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.
When value is given, pw-metadata will set the metadata for id and key to value and an optional type.
Options
- -r | --remote=NAME
The name the remote instance to use. If left unspecified, a connection is made to the default PipeWire instance.
- -h | --help
Show help.
- --version
Show version information.
- -l | --list
List available metadata objects
- -m | --monitor
Keeps running and log the changes to the metadata.
- -d | --delete
Delete all metadata for id or for the specified key of object id. Without any option, all metadata is removed.
- -n | --name
Metadata name (Default: 'default').
Examples
pw-metadata
Show metadata in default name.
pw-metadata -n settings 0
Display settings.
pw-metadata -n settings 0 clock.quantum 1024
Change clock.quantum to 1024.
Authors
The PipeWire Developers <https://gitlab.freedesktop.org/pipewire/pipewire/issues>; PipeWire is available from <https://pipewire.org>
See Also
Referenced By
pipewire(1), pipewire-props(7).