.TH "pw-metadata" 1 "1.0.5" "PipeWire" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pw-metadata \- The PipeWire metadata
.PP
.SH "SYNOPSIS"
.PP
.PP
\fBpw-metadata\fP [\fIoptions\fP] [\fIid\fP [\fIkey\fP [\fIvalue\fP [\fItype\fP ] ] ] ]
.PP
.SH "DESCRIPTION"
.PP
.PP
Monitor, set and delete metadata on PipeWire objects\&.
.PP
Metadata are key/type/value triplets attached to objects identified by \fIid\fP\&. The metadata is shared between all applications binding to the same metadata object\&. When an object is destroyed, all its metadata is automatically removed\&.
.PP
When no \fIvalue\fP is given, \fBpw-metadata\fP will query and log the metadata matching the optional arguments \fIid\fP and \fIkey\fP\&. Without any arguments, all metadata is displayed\&.
.PP
When \fIvalue\fP is given, \fBpw-metadata\fP will set the metadata for \fIid\fP and \fIkey\fP to \fIvalue\fP and an optional \fItype\fP\&.
.PP
.SH "OPTIONS"
.PP
.PP
\fB-r | --remote=NAME\fP
.RS 4
The name the remote instance to use\&. If left unspecified, a connection is made to the default PipeWire instance\&.
.RE
.PP
\fB-h | --help\fP
.RS 4
Show help\&.
.RE
.PP
\fB--version\fP
.RS 4
Show version information\&.
.RE
.PP
\fB-l | --list\fP
.RS 4
List available metadata objects
.RE
.PP
\fB-m | --monitor\fP
.RS 4
Keeps running and log the changes to the metadata\&.
.RE
.PP
\fB-d | --delete\fP
.RS 4
Delete all metadata for \fIid\fP or for the specified \fIkey\fP of object \fIid\fP\&. Without any option, all metadata is removed\&.
.RE
.PP
\fB-n | --name\fP
.RS 4
Metadata name (Default: 'default')\&.
.RE
.PP
.SH "EXAMPLES"
.PP
.PP
\fBpw-metadata\fP
.PP
Show metadata in default name\&.
.PP
\fBpw-metadata\fP -n settings 0
.PP
Display settings\&.
.PP
\fBpw-metadata\fP -n settings 0 clock\&.quantum 1024
.PP
Change clock\&.quantum to 1024\&.
.PP
.SH "AUTHORS"
.PP
.PP
The PipeWire Developers <https://gitlab.freedesktop.org/pipewire/pipewire/issues>; PipeWire is available from <https://pipewire.org>
.PP
.SH "SEE ALSO"
.PP
.PP
\fBpipewire(1)\fP, \fBpw-mon(1)\fP, \fBpw-cli(1)\fP,