Man page - pw-metadata(1)

Packages contains this manual

Manual

pw-metadata

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
EXAMPLES
AUTHORS
SEE ALSO

NAME

pw-metadata - The PipeWire metadata

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

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