PipeWire: keys.h Source File

PipeWire 0.3.37

pipewire/src/pipewire/keys.h
Go to the documentation of this file.
1/* PipeWire
2 *
3 * Copyright © 2019 Wim Taymans
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 */
24
25#ifndef PIPEWIRE_KEYS_H
26#define PIPEWIRE_KEYS_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
47#define PW_KEY_PROTOCOL "pipewire.protocol"
48#define PW_KEY_ACCESS "pipewire.access"
49#define PW_KEY_CLIENT_ACCESS "pipewire.client.access"
55#define PW_KEY_SEC_PID "pipewire.sec.pid"
56#define PW_KEY_SEC_UID "pipewire.sec.uid"
57#define PW_KEY_SEC_GID "pipewire.sec.gid"
58#define PW_KEY_SEC_LABEL "pipewire.sec.label"
60#define PW_KEY_LIBRARY_NAME_SYSTEM "library.name.system"
61#define PW_KEY_LIBRARY_NAME_LOOP "library.name.loop"
62#define PW_KEY_LIBRARY_NAME_DBUS "library.name.dbus"
65#define PW_KEY_OBJECT_PATH "object.path"
66#define PW_KEY_OBJECT_ID "object.id"
67#define PW_KEY_OBJECT_LINGER "object.linger"
69#define PW_KEY_OBJECT_REGISTER "object.register"
72/* config */
73#define PW_KEY_CONFIG_PREFIX "config.prefix"
74#define PW_KEY_CONFIG_NAME "config.name"
76/* context */
77#define PW_KEY_CONTEXT_PROFILE_MODULES "context.profile.modules"
78#define PW_KEY_USER_NAME "context.user-name"
79#define PW_KEY_HOST_NAME "context.host-name"
81/* core */
82#define PW_KEY_CORE_NAME "core.name"
85#define PW_KEY_CORE_VERSION "core.version"
86#define PW_KEY_CORE_DAEMON "core.daemon"
88#define PW_KEY_CORE_ID "core.id"
89#define PW_KEY_CORE_MONITORS "core.monitors"
91/* cpu */
92#define PW_KEY_CPU_MAX_ALIGN "cpu.max-align"
94#define PW_KEY_CPU_CORES "cpu.cores"
96/* priorities */
97#define PW_KEY_PRIORITY_SESSION "priority.session"
98#define PW_KEY_PRIORITY_DRIVER "priority.driver"
100/* remote keys */
101#define PW_KEY_REMOTE_NAME "remote.name"
104#define PW_KEY_REMOTE_INTENTION "remote.intention"
108#define PW_KEY_APP_NAME "application.name"
109#define PW_KEY_APP_ID "application.id"
111#define PW_KEY_APP_VERSION "application.version"
112#define PW_KEY_APP_ICON "application.icon"
113#define PW_KEY_APP_ICON_NAME "application.icon-name"
115#define PW_KEY_APP_LANGUAGE "application.language"
118#define PW_KEY_APP_PROCESS_ID "application.process.id"
119#define PW_KEY_APP_PROCESS_BINARY "application.process.binary"
120#define PW_KEY_APP_PROCESS_USER "application.process.user"
121#define PW_KEY_APP_PROCESS_HOST "application.process.host"
122#define PW_KEY_APP_PROCESS_MACHINE_ID "application.process.machine-id"
124#define PW_KEY_APP_PROCESS_SESSION_ID "application.process.session-id"
128#define PW_KEY_WINDOW_X11_DISPLAY "window.x11.display"
131#define PW_KEY_CLIENT_ID "client.id"
132#define PW_KEY_CLIENT_NAME "client.name"
133#define PW_KEY_CLIENT_API "client.api"
137#define PW_KEY_NODE_ID "node.id"
138#define PW_KEY_NODE_NAME "node.name"
139#define PW_KEY_NODE_NICK "node.nick"
140#define PW_KEY_NODE_DESCRIPTION "node.description"
142#define PW_KEY_NODE_PLUGGED "node.plugged"
145#define PW_KEY_NODE_SESSION "node.session"
146#define PW_KEY_NODE_GROUP "node.group"
149#define PW_KEY_NODE_EXCLUSIVE "node.exclusive"
150#define PW_KEY_NODE_AUTOCONNECT "node.autoconnect"
152#define PW_KEY_NODE_TARGET "node.target"
154#define PW_KEY_NODE_LATENCY "node.latency"
156#define PW_KEY_NODE_MAX_LATENCY "node.max-latency"
158#define PW_KEY_NODE_LOCK_QUANTUM "node.lock-quantum"
160#define PW_KEY_NODE_RATE "node.rate"
162#define PW_KEY_NODE_LOCK_RATE "node.lock-rate"
165#define PW_KEY_NODE_DONT_RECONNECT "node.dont-reconnect"
166#define PW_KEY_NODE_ALWAYS_PROCESS "node.always-process"
167#define PW_KEY_NODE_WANT_DRIVER "node.want-driver"
169#define PW_KEY_NODE_PAUSE_ON_IDLE "node.pause-on-idle"
170#define PW_KEY_NODE_CACHE_PARAMS "node.cache-params"
171#define PW_KEY_NODE_DRIVER "node.driver"
172#define PW_KEY_NODE_STREAM "node.stream"
174#define PW_KEY_NODE_VIRTUAL "node.virtual"
176#define PW_KEY_NODE_PASSIVE "node.passive"
179#define PW_KEY_NODE_LINK_GROUP "node.link-group"
183#define PW_KEY_PORT_ID "port.id"
184#define PW_KEY_PORT_NAME "port.name"
185#define PW_KEY_PORT_DIRECTION "port.direction"
187#define PW_KEY_PORT_ALIAS "port.alias"
188#define PW_KEY_PORT_PHYSICAL "port.physical"
189#define PW_KEY_PORT_TERMINAL "port.terminal"
190#define PW_KEY_PORT_CONTROL "port.control"
191#define PW_KEY_PORT_MONITOR "port.monitor"
192#define PW_KEY_PORT_CACHE_PARAMS "port.cache-params"
193#define PW_KEY_PORT_EXTRA "port.extra"
197#define PW_KEY_LINK_ID "link.id"
198#define PW_KEY_LINK_INPUT_NODE "link.input.node"
199#define PW_KEY_LINK_INPUT_PORT "link.input.port"
200#define PW_KEY_LINK_OUTPUT_NODE "link.output.node"
201#define PW_KEY_LINK_OUTPUT_PORT "link.output.port"
202#define PW_KEY_LINK_PASSIVE "link.passive"
205#define PW_KEY_LINK_FEEDBACK "link.feedback"
210#define PW_KEY_DEVICE_ID "device.id"
211#define PW_KEY_DEVICE_NAME "device.name"
212#define PW_KEY_DEVICE_PLUGGED "device.plugged"
214#define PW_KEY_DEVICE_NICK "device.nick"
215#define PW_KEY_DEVICE_STRING "device.string"
217#define PW_KEY_DEVICE_API "device.api"
219#define PW_KEY_DEVICE_DESCRIPTION "device.description"
221#define PW_KEY_DEVICE_BUS_PATH "device.bus-path"
223#define PW_KEY_DEVICE_SERIAL "device.serial"
224#define PW_KEY_DEVICE_VENDOR_ID "device.vendor.id"
225#define PW_KEY_DEVICE_VENDOR_NAME "device.vendor.name"
226#define PW_KEY_DEVICE_PRODUCT_ID "device.product.id"
227#define PW_KEY_DEVICE_PRODUCT_NAME "device.product.name"
228#define PW_KEY_DEVICE_CLASS "device.class"
229#define PW_KEY_DEVICE_FORM_FACTOR "device.form-factor"
234#define PW_KEY_DEVICE_BUS "device.bus"
237#define PW_KEY_DEVICE_SUBSYSTEM "device.subsystem"
238#define PW_KEY_DEVICE_ICON "device.icon"
240#define PW_KEY_DEVICE_ICON_NAME "device.icon-name"
242#define PW_KEY_DEVICE_INTENDED_ROLES "device.intended-roles"
246#define PW_KEY_DEVICE_CACHE_PARAMS "device.cache-params"
249#define PW_KEY_MODULE_ID "module.id"
250#define PW_KEY_MODULE_NAME "module.name"
251#define PW_KEY_MODULE_AUTHOR "module.author"
252#define PW_KEY_MODULE_DESCRIPTION "module.description"
254#define PW_KEY_MODULE_USAGE "module.usage"
256#define PW_KEY_MODULE_VERSION "module.version"
259#define PW_KEY_FACTORY_ID "factory.id"
260#define PW_KEY_FACTORY_NAME "factory.name"
261#define PW_KEY_FACTORY_USAGE "factory.usage"
262#define PW_KEY_FACTORY_TYPE_NAME "factory.type.name"
263#define PW_KEY_FACTORY_TYPE_VERSION "factory.type.version"
266#define PW_KEY_STREAM_IS_LIVE "stream.is-live"
267#define PW_KEY_STREAM_LATENCY_MIN "stream.latency.min"
268#define PW_KEY_STREAM_LATENCY_MAX "stream.latency.max"
269#define PW_KEY_STREAM_MONITOR "stream.monitor"
272#define PW_KEY_STREAM_DONT_REMIX "stream.dont-remix"
273#define PW_KEY_STREAM_CAPTURE_SINK "stream.capture.sink"
277#define PW_KEY_MEDIA_TYPE "media.type"
279#define PW_KEY_MEDIA_CATEGORY "media.category"
281#define PW_KEY_MEDIA_ROLE "media.role"
285#define PW_KEY_MEDIA_CLASS "media.class"
286#define PW_KEY_MEDIA_NAME "media.name"
287#define PW_KEY_MEDIA_TITLE "media.title"
288#define PW_KEY_MEDIA_ARTIST "media.artist"
289#define PW_KEY_MEDIA_COPYRIGHT "media.copyright"
290#define PW_KEY_MEDIA_SOFTWARE "media.software"
291#define PW_KEY_MEDIA_LANGUAGE "media.language"
292#define PW_KEY_MEDIA_FILENAME "media.filename"
293#define PW_KEY_MEDIA_ICON "media.icon"
295#define PW_KEY_MEDIA_ICON_NAME "media.icon-name"
297#define PW_KEY_MEDIA_COMMENT "media.comment"
298#define PW_KEY_MEDIA_DATE "media.date"
299#define PW_KEY_MEDIA_FORMAT "media.format"
302#define PW_KEY_FORMAT_DSP "format.dsp"
305#define PW_KEY_AUDIO_CHANNEL "audio.channel"
306#define PW_KEY_AUDIO_RATE "audio.rate"
307#define PW_KEY_AUDIO_CHANNELS "audio.channels"
308#define PW_KEY_AUDIO_FORMAT "audio.format"
311#define PW_KEY_VIDEO_RATE "video.framerate"
312#define PW_KEY_VIDEO_FORMAT "video.format"
313#define PW_KEY_VIDEO_SIZE "video.size"
315#ifdef PW_ENABLE_DEPRECATED
316#define PW_KEY_PRIORITY_MASTER "priority.master"
317#endif /* PW_ENABLE_DEPRECATED */
318
322#ifdef __cplusplus
323}
324#endif
325
326#endif /* PIPEWIRE_KEYS_H */