PipeWire: keys.h Source File

PipeWire 0.3.26

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
29 extern "C" {
30 #endif
31
42 #define PW_KEY_PROTOCOL "pipewire.protocol"
43 #define PW_KEY_ACCESS "pipewire.access"
44 #define PW_KEY_CLIENT_ACCESS "pipewire.client.access"
50 #define PW_KEY_SEC_PID "pipewire.sec.pid"
51 #define PW_KEY_SEC_UID "pipewire.sec.uid"
52 #define PW_KEY_SEC_GID "pipewire.sec.gid"
53 #define PW_KEY_SEC_LABEL "pipewire.sec.label"
55 #define PW_KEY_LIBRARY_NAME_SYSTEM "library.name.system"
56 #define PW_KEY_LIBRARY_NAME_LOOP "library.name.loop"
57 #define PW_KEY_LIBRARY_NAME_DBUS "library.name.dbus"
59 #define PW_KEY_OBJECT_PATH "object.path"
60 #define PW_KEY_OBJECT_ID "object.id"
62 /* config */
63 #define PW_KEY_CONFIG_PREFIX "config.prefix"
64 #define PW_KEY_CONFIG_NAME "config.name"
66 /* context */
67 #define PW_KEY_CONTEXT_PROFILE_MODULES "context.profile.modules"
68 #define PW_KEY_USER_NAME "context.user-name"
69 #define PW_KEY_HOST_NAME "context.host-name"
71 /* core */
72 #define PW_KEY_CORE_NAME "core.name"
75 #define PW_KEY_CORE_VERSION "core.version"
76 #define PW_KEY_CORE_DAEMON "core.daemon"
78 #define PW_KEY_CORE_ID "core.id"
79 #define PW_KEY_CORE_MONITORS "core.monitors"
81 /* cpu */
82 #define PW_KEY_CPU_MAX_ALIGN "cpu.max-align"
84 #define PW_KEY_CPU_CORES "cpu.cores"
86 /* priorities */
87 #define PW_KEY_PRIORITY_SESSION "priority.session"
88 #define PW_KEY_PRIORITY_DRIVER "priority.driver"
90 /* remote keys */
91 #define PW_KEY_REMOTE_NAME "remote.name"
94 #define PW_KEY_REMOTE_INTENTION "remote.intention"
98 #define PW_KEY_APP_NAME "application.name"
99 #define PW_KEY_APP_ID "application.id"
101 #define PW_KEY_APP_VERSION "application.version"
102 #define PW_KEY_APP_ICON "application.icon"
103 #define PW_KEY_APP_ICON_NAME "application.icon-name"
105 #define PW_KEY_APP_LANGUAGE "application.language"
108 #define PW_KEY_APP_PROCESS_ID "application.process.id"
109 #define PW_KEY_APP_PROCESS_BINARY "application.process.binary"
110 #define PW_KEY_APP_PROCESS_USER "application.process.user"
111 #define PW_KEY_APP_PROCESS_HOST "application.process.host"
112 #define PW_KEY_APP_PROCESS_MACHINE_ID "application.process.machine-id"
114 #define PW_KEY_APP_PROCESS_SESSION_ID "application.process.session-id"
118 #define PW_KEY_WINDOW_X11_DISPLAY "window.x11.display"
121 #define PW_KEY_CLIENT_ID "client.id"
122 #define PW_KEY_CLIENT_NAME "client.name"
123 #define PW_KEY_CLIENT_API "client.api"
127 #define PW_KEY_NODE_ID "node.id"
128 #define PW_KEY_NODE_NAME "node.name"
129 #define PW_KEY_NODE_NICK "node.nick"
130 #define PW_KEY_NODE_DESCRIPTION "node.description"
132 #define PW_KEY_NODE_PLUGGED "node.plugged"
135 #define PW_KEY_NODE_SESSION "node.session"
136 #define PW_KEY_NODE_GROUP "node.group"
139 #define PW_KEY_NODE_EXCLUSIVE "node.exclusive"
140 #define PW_KEY_NODE_AUTOCONNECT "node.autoconnect"
142 #define PW_KEY_NODE_TARGET "node.target"
144 #define PW_KEY_NODE_LATENCY "node.latency"
146 #define PW_KEY_NODE_MAX_LATENCY "node.max-latency"
148 #define PW_KEY_NODE_DONT_RECONNECT "node.dont-reconnect"
149 #define PW_KEY_NODE_ALWAYS_PROCESS "node.always-process"
150 #define PW_KEY_NODE_PAUSE_ON_IDLE "node.pause-on-idle"
151 #define PW_KEY_NODE_CACHE_PARAMS "node.cache-params"
152 #define PW_KEY_NODE_DRIVER "node.driver"
153 #define PW_KEY_NODE_STREAM "node.stream"
155 #define PW_KEY_NODE_VIRTUAL "node.virtual"
158 #define PW_KEY_PORT_ID "port.id"
159 #define PW_KEY_PORT_NAME "port.name"
160 #define PW_KEY_PORT_DIRECTION "port.direction"
162 #define PW_KEY_PORT_ALIAS "port.alias"
163 #define PW_KEY_PORT_PHYSICAL "port.physical"
164 #define PW_KEY_PORT_TERMINAL "port.terminal"
165 #define PW_KEY_PORT_CONTROL "port.control"
166 #define PW_KEY_PORT_MONITOR "port.monitor"
167 #define PW_KEY_PORT_CACHE_PARAMS "port.cache-params"
168 #define PW_KEY_PORT_EXTRA "port.extra"
172 #define PW_KEY_LINK_ID "link.id"
173 #define PW_KEY_LINK_INPUT_NODE "link.input.node"
174 #define PW_KEY_LINK_INPUT_PORT "link.input.port"
175 #define PW_KEY_LINK_OUTPUT_NODE "link.output.node"
176 #define PW_KEY_LINK_OUTPUT_PORT "link.output.port"
177 #define PW_KEY_LINK_PASSIVE "link.passive"
180 #define PW_KEY_LINK_FEEDBACK "link.feedback"
185 #define PW_KEY_DEVICE_ID "device.id"
186 #define PW_KEY_DEVICE_NAME "device.name"
187 #define PW_KEY_DEVICE_PLUGGED "device.plugged"
189 #define PW_KEY_DEVICE_NICK "device.nick"
190 #define PW_KEY_DEVICE_STRING "device.string"
192 #define PW_KEY_DEVICE_API "device.api"
194 #define PW_KEY_DEVICE_DESCRIPTION "device.description"
196 #define PW_KEY_DEVICE_BUS_PATH "device.bus-path"
198 #define PW_KEY_DEVICE_SERIAL "device.serial"
199 #define PW_KEY_DEVICE_VENDOR_ID "device.vendor.id"
200 #define PW_KEY_DEVICE_VENDOR_NAME "device.vendor.name"
201 #define PW_KEY_DEVICE_PRODUCT_ID "device.product.id"
202 #define PW_KEY_DEVICE_PRODUCT_NAME "device.product.name"
203 #define PW_KEY_DEVICE_CLASS "device.class"
204 #define PW_KEY_DEVICE_FORM_FACTOR "device.form-factor"
209 #define PW_KEY_DEVICE_BUS "device.bus"
212 #define PW_KEY_DEVICE_SUBSYSTEM "device.subsystem"
213 #define PW_KEY_DEVICE_ICON "device.icon"
215 #define PW_KEY_DEVICE_ICON_NAME "device.icon-name"
217 #define PW_KEY_DEVICE_INTENDED_ROLES "device.intended-roles"
221 #define PW_KEY_DEVICE_CACHE_PARAMS "device.cache-params"
224 #define PW_KEY_MODULE_ID "module.id"
225 #define PW_KEY_MODULE_NAME "module.name"
226 #define PW_KEY_MODULE_AUTHOR "module.author"
227 #define PW_KEY_MODULE_DESCRIPTION "module.description"
229 #define PW_KEY_MODULE_USAGE "module.usage"
231 #define PW_KEY_MODULE_VERSION "module.version"
234 #define PW_KEY_FACTORY_ID "factory.id"
235 #define PW_KEY_FACTORY_NAME "factory.name"
236 #define PW_KEY_FACTORY_USAGE "factory.usage"
237 #define PW_KEY_FACTORY_TYPE_NAME "factory.type.name"
238 #define PW_KEY_FACTORY_TYPE_VERSION "factory.type.version"
241 #define PW_KEY_STREAM_IS_LIVE "stream.is-live"
242 #define PW_KEY_STREAM_LATENCY_MIN "stream.latency.min"
243 #define PW_KEY_STREAM_LATENCY_MAX "stream.latency.max"
244 #define PW_KEY_STREAM_MONITOR "stream.monitor"
247 #define PW_KEY_STREAM_DONT_REMIX "stream.dont-remix"
248 #define PW_KEY_STREAM_CAPTURE_SINK "stream.capture.sink"
252 #define PW_KEY_OBJECT_LINGER "object.linger"
256 #define PW_KEY_MEDIA_TYPE "media.type"
258 #define PW_KEY_MEDIA_CATEGORY "media.category"
260 #define PW_KEY_MEDIA_ROLE "media.role"
264 #define PW_KEY_MEDIA_CLASS "media.class"
265 #define PW_KEY_MEDIA_NAME "media.name"
266 #define PW_KEY_MEDIA_TITLE "media.title"
267 #define PW_KEY_MEDIA_ARTIST "media.artist"
268 #define PW_KEY_MEDIA_COPYRIGHT "media.copyright"
269 #define PW_KEY_MEDIA_SOFTWARE "media.software"
270 #define PW_KEY_MEDIA_LANGUAGE "media.language"
271 #define PW_KEY_MEDIA_FILENAME "media.filename"
272 #define PW_KEY_MEDIA_ICON "media.icon"
274 #define PW_KEY_MEDIA_ICON_NAME "media.icon-name"
276 #define PW_KEY_MEDIA_COMMENT "media.comment"
277 #define PW_KEY_MEDIA_DATE "media.date"
278 #define PW_KEY_MEDIA_FORMAT "media.format"
281 #define PW_KEY_FORMAT_DSP "format.dsp"
284 #define PW_KEY_AUDIO_CHANNEL "audio.channel"
285 #define PW_KEY_AUDIO_RATE "audio.samplerate"
286 #define PW_KEY_AUDIO_CHANNELS "audio.channels"
287 #define PW_KEY_AUDIO_FORMAT "audio.format"
290 #define PW_KEY_VIDEO_RATE "video.framerate"
291 #define PW_KEY_VIDEO_FORMAT "video.format"
292 #define PW_KEY_VIDEO_SIZE "video.size"
294 #ifdef PW_ENABLE_DEPRECATED
295 #define PW_KEY_PRIORITY_MASTER "priority.master"
296 #endif /* PW_ENABLE_DEPRECATED */
297
298 #ifdef __cplusplus
299 }
300 #endif
301
302 #endif /* PIPEWIRE_KEYS_H */