PipeWire: pipewire/keys.h Source File

PipeWire 1.4.0 |

Loading...
Searching...
No Matches
keys.h
Go to the documentation of this file.
1/* PipeWire */
2/* SPDX-FileCopyrightText: Copyright © 2019 Wim Taymans */
3/* SPDX-License-Identifier: MIT */
4
5#ifndef PIPEWIRE_KEYS_H
6#define PIPEWIRE_KEYS_H
7
8#ifdef __cplusplus
9extern "C" {
10#endif
11
12#include <pipewire/utils.h>
28#define PW_KEY_PROTOCOL "pipewire.protocol"
29#define PW_KEY_ACCESS "pipewire.access"
30#define PW_KEY_CLIENT_ACCESS "pipewire.client.access"
32
36#define PW_KEY_SEC_PID "pipewire.sec.pid"
37#define PW_KEY_SEC_UID "pipewire.sec.uid"
38#define PW_KEY_SEC_GID "pipewire.sec.gid"
39#define PW_KEY_SEC_LABEL "pipewire.sec.label"
40
41#define PW_KEY_SEC_SOCKET "pipewire.sec.socket"
42
43#define PW_KEY_SEC_ENGINE "pipewire.sec.engine"
46#define PW_KEY_SEC_APP_ID "pipewire.sec.app-id"
47#define PW_KEY_SEC_INSTANCE_ID "pipewire.sec.instance-id"
48
49#define PW_KEY_LIBRARY_NAME_SYSTEM "library.name.system"
50#define PW_KEY_LIBRARY_NAME_LOOP "library.name.loop"
51#define PW_KEY_LIBRARY_NAME_DBUS "library.name.dbus"
52
54#define PW_KEY_OBJECT_PATH "object.path"
55#define PW_KEY_OBJECT_ID "object.id"
56#define PW_KEY_OBJECT_SERIAL "object.serial"
60#define PW_KEY_OBJECT_LINGER "object.linger"
62#define PW_KEY_OBJECT_REGISTER "object.register"
63#define PW_KEY_OBJECT_EXPORT "object.export"
65
66/* config */
67#define PW_KEY_CONFIG_PREFIX "config.prefix"
68#define PW_KEY_CONFIG_NAME "config.name"
69#define PW_KEY_CONFIG_OVERRIDE_PREFIX "config.override.prefix"
70#define PW_KEY_CONFIG_OVERRIDE_NAME "config.override.name"
71
72/* loop */
73#define PW_KEY_LOOP_NAME "loop.name"
74#define PW_KEY_LOOP_CLASS "loop.class"
75#define PW_KEY_LOOP_RT_PRIO "loop.rt-prio"
76#define PW_KEY_LOOP_CANCEL "loop.cancel"
77
78/* context */
79#define PW_KEY_CONTEXT_PROFILE_MODULES "context.profile.modules"
80#define PW_KEY_USER_NAME "context.user-name"
81#define PW_KEY_HOST_NAME "context.host-name"
82
83/* core */
84#define PW_KEY_CORE_NAME "core.name"
87#define PW_KEY_CORE_VERSION "core.version"
88#define PW_KEY_CORE_DAEMON "core.daemon"
89
90#define PW_KEY_CORE_ID "core.id"
91#define PW_KEY_CORE_MONITORS "core.monitors"
92
93/* cpu */
94#define PW_KEY_CPU_MAX_ALIGN "cpu.max-align"
96#define PW_KEY_CPU_CORES "cpu.cores"
97
98/* priorities */
99#define PW_KEY_PRIORITY_SESSION "priority.session"
100#define PW_KEY_PRIORITY_DRIVER "priority.driver"
101
102/* remote keys */
103#define PW_KEY_REMOTE_NAME "remote.name"
110#define PW_KEY_REMOTE_INTENTION "remote.intention"
112
114#define PW_KEY_APP_NAME "application.name"
115#define PW_KEY_APP_ID "application.id"
117#define PW_KEY_APP_VERSION "application.version"
118#define PW_KEY_APP_ICON "application.icon"
119#define PW_KEY_APP_ICON_NAME "application.icon-name"
121#define PW_KEY_APP_LANGUAGE "application.language"
123
124#define PW_KEY_APP_PROCESS_ID "application.process.id"
125#define PW_KEY_APP_PROCESS_BINARY "application.process.binary"
126#define PW_KEY_APP_PROCESS_USER "application.process.user"
127#define PW_KEY_APP_PROCESS_HOST "application.process.host"
128#define PW_KEY_APP_PROCESS_MACHINE_ID "application.process.machine-id"
130#define PW_KEY_APP_PROCESS_SESSION_ID "application.process.session-id"
134#define PW_KEY_WINDOW_X11_DISPLAY "window.x11.display"
135
137#define PW_KEY_CLIENT_ID "client.id"
138#define PW_KEY_CLIENT_NAME "client.name"
139#define PW_KEY_CLIENT_API "client.api"
141
143#define PW_KEY_NODE_ID "node.id"
144#define PW_KEY_NODE_NAME "node.name"
145#define PW_KEY_NODE_NICK "node.nick"
146#define PW_KEY_NODE_DESCRIPTION "node.description"
148#define PW_KEY_NODE_PLUGGED "node.plugged"
150
151#define PW_KEY_NODE_SESSION "node.session"
152#define PW_KEY_NODE_GROUP "node.group"
156#define PW_KEY_NODE_SYNC_GROUP "node.sync-group"
160#define PW_KEY_NODE_SYNC "node.sync"
161#define PW_KEY_NODE_TRANSPORT "node.transport"
162#define PW_KEY_NODE_EXCLUSIVE "node.exclusive"
163#define PW_KEY_NODE_AUTOCONNECT "node.autoconnect"
165#define PW_KEY_NODE_LATENCY "node.latency"
167#define PW_KEY_NODE_MAX_LATENCY "node.max-latency"
169#define PW_KEY_NODE_LOCK_QUANTUM "node.lock-quantum"
171#define PW_KEY_NODE_FORCE_QUANTUM "node.force-quantum"
173#define PW_KEY_NODE_RATE "node.rate"
175#define PW_KEY_NODE_LOCK_RATE "node.lock-rate"
177#define PW_KEY_NODE_FORCE_RATE "node.force-rate"
180
181#define PW_KEY_NODE_DONT_RECONNECT "node.dont-reconnect"
185#define PW_KEY_NODE_ALWAYS_PROCESS "node.always-process"
186#define PW_KEY_NODE_WANT_DRIVER "node.want-driver"
188#define PW_KEY_NODE_PAUSE_ON_IDLE "node.pause-on-idle"
189#define PW_KEY_NODE_SUSPEND_ON_IDLE "node.suspend-on-idle"
190#define PW_KEY_NODE_CACHE_PARAMS "node.cache-params"
191#define PW_KEY_NODE_TRANSPORT_SYNC "node.transport.sync"
192#define PW_KEY_NODE_DRIVER "node.driver"
195#define PW_KEY_NODE_SUPPORTS_LAZY "node.supports-lazy"
200#define PW_KEY_NODE_SUPPORTS_REQUEST "node.supports-request"
204#define PW_KEY_NODE_DRIVER_ID "node.driver-id"
206#define PW_KEY_NODE_ASYNC "node.async"
207#define PW_KEY_NODE_LOOP_NAME "node.loop.name"
208#define PW_KEY_NODE_LOOP_CLASS "node.loop.class"
209#define PW_KEY_NODE_STREAM "node.stream"
211#define PW_KEY_NODE_VIRTUAL "node.virtual"
213#define PW_KEY_NODE_PASSIVE "node.passive"
216#define PW_KEY_NODE_LINK_GROUP "node.link-group"
219#define PW_KEY_NODE_NETWORK "node.network"
220#define PW_KEY_NODE_TRIGGER "node.trigger"
223#define PW_KEY_NODE_CHANNELNAMES "node.channel-names"
225#define PW_KEY_NODE_DEVICE_PORT_NAME_PREFIX \
226 "node.device-port-name-prefix"
232#define PW_KEY_PORT_ID "port.id"
233#define PW_KEY_PORT_NAME "port.name"
234#define PW_KEY_PORT_DIRECTION "port.direction"
236#define PW_KEY_PORT_ALIAS "port.alias"
237#define PW_KEY_PORT_PHYSICAL "port.physical"
238#define PW_KEY_PORT_TERMINAL "port.terminal"
239#define PW_KEY_PORT_CONTROL "port.control"
240#define PW_KEY_PORT_MONITOR "port.monitor"
241#define PW_KEY_PORT_CACHE_PARAMS "port.cache-params"
242#define PW_KEY_PORT_EXTRA "port.extra"
244#define PW_KEY_PORT_PASSIVE "port.passive"
245#define PW_KEY_PORT_IGNORE_LATENCY "port.ignore-latency"
246#define PW_KEY_PORT_GROUP "port.group"
247
249#define PW_KEY_LINK_ID "link.id"
250#define PW_KEY_LINK_INPUT_NODE "link.input.node"
251#define PW_KEY_LINK_INPUT_PORT "link.input.port"
252#define PW_KEY_LINK_OUTPUT_NODE "link.output.node"
253#define PW_KEY_LINK_OUTPUT_PORT "link.output.port"
254#define PW_KEY_LINK_PASSIVE "link.passive"
257#define PW_KEY_LINK_FEEDBACK "link.feedback"
260#define PW_KEY_LINK_ASYNC "link.async"
261
263#define PW_KEY_DEVICE_ID "device.id"
264#define PW_KEY_DEVICE_NAME "device.name"
265#define PW_KEY_DEVICE_PLUGGED "device.plugged"
267#define PW_KEY_DEVICE_NICK "device.nick"
268#define PW_KEY_DEVICE_STRING "device.string"
270#define PW_KEY_DEVICE_API "device.api"
272#define PW_KEY_DEVICE_DESCRIPTION "device.description"
274#define PW_KEY_DEVICE_BUS_PATH "device.bus-path"
276#define PW_KEY_DEVICE_SERIAL "device.serial"
277#define PW_KEY_DEVICE_VENDOR_ID "device.vendor.id"
278#define PW_KEY_DEVICE_VENDOR_NAME "device.vendor.name"
279#define PW_KEY_DEVICE_PRODUCT_ID "device.product.id"
280#define PW_KEY_DEVICE_PRODUCT_NAME "device.product.name"
281#define PW_KEY_DEVICE_CLASS "device.class"
282#define PW_KEY_DEVICE_FORM_FACTOR "device.form-factor"
287#define PW_KEY_DEVICE_BUS "device.bus"
290#define PW_KEY_DEVICE_SUBSYSTEM "device.subsystem"
291#define PW_KEY_DEVICE_SYSFS_PATH "device.sysfs.path"
292#define PW_KEY_DEVICE_ICON "device.icon"
294#define PW_KEY_DEVICE_ICON_NAME "device.icon-name"
296#define PW_KEY_DEVICE_INTENDED_ROLES "device.intended-roles"
300#define PW_KEY_DEVICE_CACHE_PARAMS "device.cache-params"
301
303#define PW_KEY_MODULE_ID "module.id"
304#define PW_KEY_MODULE_NAME "module.name"
305#define PW_KEY_MODULE_AUTHOR "module.author"
306#define PW_KEY_MODULE_DESCRIPTION "module.description"
308#define PW_KEY_MODULE_USAGE "module.usage"
310#define PW_KEY_MODULE_VERSION "module.version"
311#define PW_KEY_MODULE_DEPRECATED "module.deprecated"
312
314#define PW_KEY_FACTORY_ID "factory.id"
315#define PW_KEY_FACTORY_NAME "factory.name"
316#define PW_KEY_FACTORY_USAGE "factory.usage"
317#define PW_KEY_FACTORY_TYPE_NAME "factory.type.name"
318#define PW_KEY_FACTORY_TYPE_VERSION "factory.type.version"
319
321#define PW_KEY_STREAM_IS_LIVE "stream.is-live"
322#define PW_KEY_STREAM_LATENCY_MIN "stream.latency.min"
323#define PW_KEY_STREAM_LATENCY_MAX "stream.latency.max"
324#define PW_KEY_STREAM_MONITOR "stream.monitor"
327 * ignored when calculating the latency of their peer
328 * ports (since 0.3.71).
329 */
330#define PW_KEY_STREAM_DONT_REMIX "stream.dont-remix"
331#define PW_KEY_STREAM_CAPTURE_SINK "stream.capture.sink"
333
335#define PW_KEY_MEDIA_TYPE "media.type"
337#define PW_KEY_MEDIA_CATEGORY "media.category"
339#define PW_KEY_MEDIA_ROLE "media.role"
343#define PW_KEY_MEDIA_CLASS "media.class"
344#define PW_KEY_MEDIA_NAME "media.name"
345#define PW_KEY_MEDIA_TITLE "media.title"
346#define PW_KEY_MEDIA_ARTIST "media.artist"
347#define PW_KEY_MEDIA_ALBUM "media.album"
348#define PW_KEY_MEDIA_COPYRIGHT "media.copyright"
349#define PW_KEY_MEDIA_SOFTWARE "media.software"
350#define PW_KEY_MEDIA_LANGUAGE "media.language"
351#define PW_KEY_MEDIA_FILENAME "media.filename"
352#define PW_KEY_MEDIA_ICON "media.icon"
354#define PW_KEY_MEDIA_ICON_NAME "media.icon-name"
356#define PW_KEY_MEDIA_COMMENT "media.comment"
357#define PW_KEY_MEDIA_DATE "media.date"
358#define PW_KEY_MEDIA_FORMAT "media.format"
359
361#define PW_KEY_FORMAT_DSP "format.dsp"
364#define PW_KEY_AUDIO_CHANNEL "audio.channel"
365#define PW_KEY_AUDIO_RATE "audio.rate"
366#define PW_KEY_AUDIO_CHANNELS "audio.channels"
367#define PW_KEY_AUDIO_FORMAT "audio.format"
368#define PW_KEY_AUDIO_ALLOWED_RATES "audio.allowed-rates"
370
372#define PW_KEY_VIDEO_RATE "video.framerate"
373#define PW_KEY_VIDEO_FORMAT "video.format"
374#define PW_KEY_VIDEO_SIZE "video.size"
375
376#define PW_KEY_TARGET_OBJECT "target.object"
378
379#ifndef PW_REMOVE_DEPRECATED
380# ifdef PW_ENABLE_DEPRECATED
381# define PW_KEY_PRIORITY_MASTER "priority.master"
382# define PW_KEY_NODE_TARGET "node.target"
383# define PW_KEY_LOOP_RETRY_TIMEOUT "loop.retry-timeout"
384# else
385# define PW_KEY_PRIORITY_MASTER PW_DEPRECATED("priority.master")
386# define PW_KEY_NODE_TARGET PW_DEPRECATED("node.target")
387# define PW_KEY_LOOP_RETRY_TIMEOUT PW_DEPRECATED("loop.retry-timeout")
388# endif /* PW_ENABLE_DEPRECATED */
389#endif /* PW_REMOVE_DEPRECATED */
390
393
394#ifdef __cplusplus
395}
396#endif
397
398#endif /* PIPEWIRE_KEYS_H */
utils.h