summaryrefslogtreecommitdiffstats
path: root/man/pw-metadata.1.rst.in
blob: f83618b272d851fa29e44c2d7f1d56014fd969e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
pw-metadata
###########

---------------------
The PipeWire metadata
---------------------

:Manual section: 1
:Manual group: General Commands Manual

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.

-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

AUTHORS
=======

The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@

SEE ALSO
========

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