PipeWire: keys.h Source File

PipeWire 0.3.70

Loading...
Searching...
No Matches
src/pipewire/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"
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"
41#define PW_KEY_LIBRARY_NAME_SYSTEM "library.name.system"
42#define PW_KEY_LIBRARY_NAME_LOOP "library.name.loop"
43#define PW_KEY_LIBRARY_NAME_DBUS "library.name.dbus"
46#define PW_KEY_OBJECT_PATH "object.path"
47#define PW_KEY_OBJECT_ID "object.id"
48#define PW_KEY_OBJECT_SERIAL "object.serial"
52#define PW_KEY_OBJECT_LINGER "object.linger"
54#define PW_KEY_OBJECT_REGISTER "object.register"
57/* config */
58#define PW_KEY_CONFIG_PREFIX "config.prefix"
59#define PW_KEY_CONFIG_NAME "config.name"
60#define PW_KEY_CONFIG_OVERRIDE_PREFIX "config.override.prefix"
61#define PW_KEY_CONFIG_OVERRIDE_NAME "config.override.name"
63/* context */
64#define PW_KEY_CONTEXT_PROFILE_MODULES "context.profile.modules"
65#define PW_KEY_USER_NAME "context.user-name"
66#define PW_KEY_HOST_NAME "context.host-name"
68/* core */
69#define PW_KEY_CORE_NAME "core.name"
72#define PW_KEY_CORE_VERSION "core.version"
73#define PW_KEY_CORE_DAEMON "core.daemon"
75#define PW_KEY_CORE_ID "core.id"
76#define PW_KEY_CORE_MONITORS "core.monitors"
78/* cpu */
79#define PW_KEY_CPU_MAX_ALIGN "cpu.max-align"
81#define PW_KEY_CPU_CORES "cpu.cores"
83/* priorities */
84#define PW_KEY_PRIORITY_SESSION "priority.session"
85#define PW_KEY_PRIORITY_DRIVER "priority.driver"
87/* remote keys */
88#define PW_KEY_REMOTE_NAME "remote.name"
91#define PW_KEY_REMOTE_INTENTION "remote.intention"
95#define PW_KEY_APP_NAME "application.name"
96#define PW_KEY_APP_ID "application.id"
98#define PW_KEY_APP_VERSION "application.version"
99#define PW_KEY_APP_ICON "application.icon"
100#define PW_KEY_APP_ICON_NAME "application.icon-name"
102#define PW_KEY_APP_LANGUAGE "application.language"
105#define PW_KEY_APP_PROCESS_ID "application.process.id"
106#define PW_KEY_APP_PROCESS_BINARY "application.process.binary"
107#define PW_KEY_APP_PROCESS_USER "application.process.user"
108#define PW_KEY_APP_PROCESS_HOST "application.process.host"
109#define PW_KEY_APP_PROCESS_MACHINE_ID "application.process.machine-id"
111#define PW_KEY_APP_PROCESS_SESSION_ID "application.process.session-id"
115#define PW_KEY_WINDOW_X11_DISPLAY "window.x11.display"
118#define PW_KEY_CLIENT_ID "client.id"
119#define PW_KEY_CLIENT_NAME "client.name"
120#define PW_KEY_CLIENT_API "client.api"
124#define PW_KEY_NODE_ID "node.id"
125#define PW_KEY_NODE_NAME "node.name"
126#define PW_KEY_NODE_NICK "node.nick"
127#define PW_KEY_NODE_DESCRIPTION "node.description"
129#define PW_KEY_NODE_PLUGGED "node.plugged"
132#define PW_KEY_NODE_SESSION "node.session"
133#define PW_KEY_NODE_GROUP "node.group"
136#define PW_KEY_NODE_EXCLUSIVE "node.exclusive"
137#define PW_KEY_NODE_AUTOCONNECT "node.autoconnect"
139#define PW_KEY_NODE_LATENCY "node.latency"
141#define PW_KEY_NODE_MAX_LATENCY "node.max-latency"
143#define PW_KEY_NODE_LOCK_QUANTUM "node.lock-quantum"
145#define PW_KEY_NODE_FORCE_QUANTUM "node.force-quantum"
147#define PW_KEY_NODE_RATE "node.rate"
149#define PW_KEY_NODE_LOCK_RATE "node.lock-rate"
151#define PW_KEY_NODE_FORCE_RATE "node.force-rate"
155#define PW_KEY_NODE_DONT_RECONNECT "node.dont-reconnect"
159#define PW_KEY_NODE_ALWAYS_PROCESS "node.always-process"
160#define PW_KEY_NODE_WANT_DRIVER "node.want-driver"
162#define PW_KEY_NODE_PAUSE_ON_IDLE "node.pause-on-idle"
163#define PW_KEY_NODE_SUSPEND_ON_IDLE "node.suspend-on-idle"
164#define PW_KEY_NODE_CACHE_PARAMS "node.cache-params"
165#define PW_KEY_NODE_TRANSPORT_SYNC "node.transport.sync"
166#define PW_KEY_NODE_DRIVER "node.driver"
167#define PW_KEY_NODE_STREAM "node.stream"
169#define PW_KEY_NODE_VIRTUAL "node.virtual"
171#define PW_KEY_NODE_PASSIVE "node.passive"
174#define PW_KEY_NODE_LINK_GROUP "node.link-group"
176#define PW_KEY_NODE_NETWORK "node.network"
177#define PW_KEY_NODE_TRIGGER "node.trigger"
180#define PW_KEY_NODE_CHANNELNAMES "node.channel-names"
182#define PW_KEY_NODE_DEVICE_PORT_NAME_PREFIX "node.device-port-name-prefix"
187#define PW_KEY_PORT_ID "port.id"
188#define PW_KEY_PORT_NAME "port.name"
189#define PW_KEY_PORT_DIRECTION "port.direction"
191#define PW_KEY_PORT_ALIAS "port.alias"
192#define PW_KEY_PORT_PHYSICAL "port.physical"
193#define PW_KEY_PORT_TERMINAL "port.terminal"
194#define PW_KEY_PORT_CONTROL "port.control"
195#define PW_KEY_PORT_MONITOR "port.monitor"
196#define PW_KEY_PORT_CACHE_PARAMS "port.cache-params"
197#define PW_KEY_PORT_EXTRA "port.extra"
199#define PW_KEY_PORT_PASSIVE "port.passive"
202#define PW_KEY_LINK_ID "link.id"
203#define PW_KEY_LINK_INPUT_NODE "link.input.node"
204#define PW_KEY_LINK_INPUT_PORT "link.input.port"
205#define PW_KEY_LINK_OUTPUT_NODE "link.output.node"
206#define PW_KEY_LINK_OUTPUT_PORT "link.output.port"
207#define PW_KEY_LINK_PASSIVE "link.passive"
210#define PW_KEY_LINK_FEEDBACK "link.feedback"
215#define PW_KEY_DEVICE_ID "device.id"
216#define PW_KEY_DEVICE_NAME "device.name"
217#define PW_KEY_DEVICE_PLUGGED "device.plugged"
219#define PW_KEY_DEVICE_NICK "device.nick"
220#define PW_KEY_DEVICE_STRING "device.string"
222#define PW_KEY_DEVICE_API "device.api"
224#define PW_KEY_DEVICE_DESCRIPTION "device.description"
226#define PW_KEY_DEVICE_BUS_PATH "device.bus-path"
228#define PW_KEY_DEVICE_SERIAL "device.serial"
229#define PW_KEY_DEVICE_VENDOR_ID "device.vendor.id"
230#define PW_KEY_DEVICE_VENDOR_NAME "device.vendor.name"
231#define PW_KEY_DEVICE_PRODUCT_ID "device.product.id"
232#define PW_KEY_DEVICE_PRODUCT_NAME "device.product.name"
233#define PW_KEY_DEVICE_CLASS "device.class"
234#define PW_KEY_DEVICE_FORM_FACTOR "device.form-factor"
239#define PW_KEY_DEVICE_BUS "device.bus"
242#define PW_KEY_DEVICE_SUBSYSTEM "device.subsystem"
243#define PW_KEY_DEVICE_SYSFS_PATH "device.sysfs.path"
244#define PW_KEY_DEVICE_ICON "device.icon"
246#define PW_KEY_DEVICE_ICON_NAME "device.icon-name"
248#define PW_KEY_DEVICE_INTENDED_ROLES "device.intended-roles"
252#define PW_KEY_DEVICE_CACHE_PARAMS "device.cache-params"
255#define PW_KEY_MODULE_ID "module.id"
256#define PW_KEY_MODULE_NAME "module.name"
257#define PW_KEY_MODULE_AUTHOR "module.author"
258#define PW_KEY_MODULE_DESCRIPTION "module.description"
260#define PW_KEY_MODULE_USAGE "module.usage"
262#define PW_KEY_MODULE_VERSION "module.version"
265#define PW_KEY_FACTORY_ID "factory.id"
266#define PW_KEY_FACTORY_NAME "factory.name"
267#define PW_KEY_FACTORY_USAGE "factory.usage"
268#define PW_KEY_FACTORY_TYPE_NAME "factory.type.name"
269#define PW_KEY_FACTORY_TYPE_VERSION "factory.type.version"
272#define PW_KEY_STREAM_IS_LIVE "stream.is-live"
273#define PW_KEY_STREAM_LATENCY_MIN "stream.latency.min"
274#define PW_KEY_STREAM_LATENCY_MAX "stream.latency.max"
275#define PW_KEY_STREAM_MONITOR "stream.monitor"
278#define PW_KEY_STREAM_DONT_REMIX "stream.dont-remix"
279#define PW_KEY_STREAM_CAPTURE_SINK "stream.capture.sink"
283#define PW_KEY_MEDIA_TYPE "media.type"
285#define PW_KEY_MEDIA_CATEGORY "media.category"
287#define PW_KEY_MEDIA_ROLE "media.role"
291#define PW_KEY_MEDIA_CLASS "media.class"
292#define PW_KEY_MEDIA_NAME "media.name"
293#define PW_KEY_MEDIA_TITLE "media.title"
294#define PW_KEY_MEDIA_ARTIST "media.artist"
295#define PW_KEY_MEDIA_COPYRIGHT "media.copyright"
296#define PW_KEY_MEDIA_SOFTWARE "media.software"
297#define PW_KEY_MEDIA_LANGUAGE "media.language"
298#define PW_KEY_MEDIA_FILENAME "media.filename"
299#define PW_KEY_MEDIA_ICON "media.icon"
301#define PW_KEY_MEDIA_ICON_NAME "media.icon-name"
303#define PW_KEY_MEDIA_COMMENT "media.comment"
304#define PW_KEY_MEDIA_DATE "media.date"
305#define PW_KEY_MEDIA_FORMAT "media.format"
308#define PW_KEY_FORMAT_DSP "format.dsp"
311#define PW_KEY_AUDIO_CHANNEL "audio.channel"
312#define PW_KEY_AUDIO_RATE "audio.rate"
313#define PW_KEY_AUDIO_CHANNELS "audio.channels"
314#define PW_KEY_AUDIO_FORMAT "audio.format"
315#define PW_KEY_AUDIO_ALLOWED_RATES "audio.allowed-rates"
319#define PW_KEY_VIDEO_RATE "video.framerate"
320#define PW_KEY_VIDEO_FORMAT "video.format"
321#define PW_KEY_VIDEO_SIZE "video.size"
323#define PW_KEY_TARGET_OBJECT "target.object"
326#ifndef PW_REMOVE_DEPRECATED
327# ifdef PW_ENABLE_DEPRECATED
328# define PW_KEY_PRIORITY_MASTER "priority.master"
329# define PW_KEY_NODE_TARGET "node.target"
330# else
331# define PW_KEY_PRIORITY_MASTER PW_DEPRECATED("priority.master")
332# define PW_KEY_NODE_TARGET PW_DEPRECATED("node.target")
333# endif /* PW_ENABLE_DEPRECATED */
334#endif /* PW_REMOVE_DEPRECATED */
335
339#ifdef __cplusplus
340}
341#endif
342
343#endif /* PIPEWIRE_KEYS_H */
utils.h