PipeWire  1.2.6
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
9 extern "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_SEC_SOCKET "pipewire.sec.socket"
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"
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"
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"
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"
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"
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"
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"
90 #define PW_KEY_CORE_ID "core.id"
91 #define PW_KEY_CORE_MONITORS "core.monitors"
93 /* cpu */
94 #define PW_KEY_CPU_MAX_ALIGN "cpu.max-align"
96 #define PW_KEY_CPU_CORES "cpu.cores"
98 /* priorities */
99 #define PW_KEY_PRIORITY_SESSION "priority.session"
100 #define PW_KEY_PRIORITY_DRIVER "priority.driver"
102 /* remote keys */
103 #define PW_KEY_REMOTE_NAME "remote.name"
108 #define PW_KEY_REMOTE_INTENTION "remote.intention"
112 #define PW_KEY_APP_NAME "application.name"
113 #define PW_KEY_APP_ID "application.id"
115 #define PW_KEY_APP_VERSION "application.version"
116 #define PW_KEY_APP_ICON "application.icon"
117 #define PW_KEY_APP_ICON_NAME "application.icon-name"
119 #define PW_KEY_APP_LANGUAGE "application.language"
122 #define PW_KEY_APP_PROCESS_ID "application.process.id"
123 #define PW_KEY_APP_PROCESS_BINARY "application.process.binary"
124 #define PW_KEY_APP_PROCESS_USER "application.process.user"
125 #define PW_KEY_APP_PROCESS_HOST "application.process.host"
126 #define PW_KEY_APP_PROCESS_MACHINE_ID "application.process.machine-id"
128 #define PW_KEY_APP_PROCESS_SESSION_ID "application.process.session-id"
132 #define PW_KEY_WINDOW_X11_DISPLAY "window.x11.display"
135 #define PW_KEY_CLIENT_ID "client.id"
136 #define PW_KEY_CLIENT_NAME "client.name"
137 #define PW_KEY_CLIENT_API "client.api"
141 #define PW_KEY_NODE_ID "node.id"
142 #define PW_KEY_NODE_NAME "node.name"
143 #define PW_KEY_NODE_NICK "node.nick"
144 #define PW_KEY_NODE_DESCRIPTION "node.description"
146 #define PW_KEY_NODE_PLUGGED "node.plugged"
149 #define PW_KEY_NODE_SESSION "node.session"
150 #define PW_KEY_NODE_GROUP "node.group"
154 #define PW_KEY_NODE_SYNC_GROUP "node.sync-group"
158 #define PW_KEY_NODE_SYNC "node.sync"
159 #define PW_KEY_NODE_TRANSPORT "node.transport"
160 #define PW_KEY_NODE_EXCLUSIVE "node.exclusive"
161 #define PW_KEY_NODE_AUTOCONNECT "node.autoconnect"
163 #define PW_KEY_NODE_LATENCY "node.latency"
165 #define PW_KEY_NODE_MAX_LATENCY "node.max-latency"
167 #define PW_KEY_NODE_LOCK_QUANTUM "node.lock-quantum"
169 #define PW_KEY_NODE_FORCE_QUANTUM "node.force-quantum"
171 #define PW_KEY_NODE_RATE "node.rate"
173 #define PW_KEY_NODE_LOCK_RATE "node.lock-rate"
175 #define PW_KEY_NODE_FORCE_RATE "node.force-rate"
179 #define PW_KEY_NODE_DONT_RECONNECT "node.dont-reconnect"
183 #define PW_KEY_NODE_ALWAYS_PROCESS "node.always-process"
184 #define PW_KEY_NODE_WANT_DRIVER "node.want-driver"
186 #define PW_KEY_NODE_PAUSE_ON_IDLE "node.pause-on-idle"
187 #define PW_KEY_NODE_SUSPEND_ON_IDLE "node.suspend-on-idle"
188 #define PW_KEY_NODE_CACHE_PARAMS "node.cache-params"
189 #define PW_KEY_NODE_TRANSPORT_SYNC "node.transport.sync"
190 #define PW_KEY_NODE_DRIVER "node.driver"
193 #define PW_KEY_NODE_DRIVER_ID "node.driver-id"
195 #define PW_KEY_NODE_ASYNC "node.async"
196 #define PW_KEY_NODE_LOOP_NAME "node.loop.name"
197 #define PW_KEY_NODE_LOOP_CLASS "node.loop.class"
198 #define PW_KEY_NODE_STREAM "node.stream"
200 #define PW_KEY_NODE_VIRTUAL "node.virtual"
202 #define PW_KEY_NODE_PASSIVE "node.passive"
205 #define PW_KEY_NODE_LINK_GROUP "node.link-group"
208 #define PW_KEY_NODE_NETWORK "node.network"
209 #define PW_KEY_NODE_TRIGGER "node.trigger"
212 #define PW_KEY_NODE_CHANNELNAMES "node.channel-names"
214 #define PW_KEY_NODE_DEVICE_PORT_NAME_PREFIX \
215  "node.device-port-name-prefix"
221 #define PW_KEY_PORT_ID "port.id"
222 #define PW_KEY_PORT_NAME "port.name"
223 #define PW_KEY_PORT_DIRECTION "port.direction"
225 #define PW_KEY_PORT_ALIAS "port.alias"
226 #define PW_KEY_PORT_PHYSICAL "port.physical"
227 #define PW_KEY_PORT_TERMINAL "port.terminal"
228 #define PW_KEY_PORT_CONTROL "port.control"
229 #define PW_KEY_PORT_MONITOR "port.monitor"
230 #define PW_KEY_PORT_CACHE_PARAMS "port.cache-params"
231 #define PW_KEY_PORT_EXTRA "port.extra"
233 #define PW_KEY_PORT_PASSIVE "port.passive"
234 #define PW_KEY_PORT_IGNORE_LATENCY "port.ignore-latency"
235 #define PW_KEY_PORT_GROUP "port.group"
238 #define PW_KEY_LINK_ID "link.id"
239 #define PW_KEY_LINK_INPUT_NODE "link.input.node"
240 #define PW_KEY_LINK_INPUT_PORT "link.input.port"
241 #define PW_KEY_LINK_OUTPUT_NODE "link.output.node"
242 #define PW_KEY_LINK_OUTPUT_PORT "link.output.port"
243 #define PW_KEY_LINK_PASSIVE "link.passive"
246 #define PW_KEY_LINK_FEEDBACK "link.feedback"
249 #define PW_KEY_LINK_ASYNC "link.async"
252 #define PW_KEY_DEVICE_ID "device.id"
253 #define PW_KEY_DEVICE_NAME "device.name"
254 #define PW_KEY_DEVICE_PLUGGED "device.plugged"
256 #define PW_KEY_DEVICE_NICK "device.nick"
257 #define PW_KEY_DEVICE_STRING "device.string"
259 #define PW_KEY_DEVICE_API "device.api"
261 #define PW_KEY_DEVICE_DESCRIPTION "device.description"
263 #define PW_KEY_DEVICE_BUS_PATH "device.bus-path"
265 #define PW_KEY_DEVICE_SERIAL "device.serial"
266 #define PW_KEY_DEVICE_VENDOR_ID "device.vendor.id"
267 #define PW_KEY_DEVICE_VENDOR_NAME "device.vendor.name"
268 #define PW_KEY_DEVICE_PRODUCT_ID "device.product.id"
269 #define PW_KEY_DEVICE_PRODUCT_NAME "device.product.name"
270 #define PW_KEY_DEVICE_CLASS "device.class"
271 #define PW_KEY_DEVICE_FORM_FACTOR "device.form-factor"
276 #define PW_KEY_DEVICE_BUS "device.bus"
279 #define PW_KEY_DEVICE_SUBSYSTEM "device.subsystem"
280 #define PW_KEY_DEVICE_SYSFS_PATH "device.sysfs.path"
281 #define PW_KEY_DEVICE_ICON "device.icon"
283 #define PW_KEY_DEVICE_ICON_NAME "device.icon-name"
285 #define PW_KEY_DEVICE_INTENDED_ROLES "device.intended-roles"
289 #define PW_KEY_DEVICE_CACHE_PARAMS "device.cache-params"
292 #define PW_KEY_MODULE_ID "module.id"
293 #define PW_KEY_MODULE_NAME "module.name"
294 #define PW_KEY_MODULE_AUTHOR "module.author"
295 #define PW_KEY_MODULE_DESCRIPTION "module.description"
297 #define PW_KEY_MODULE_USAGE "module.usage"
299 #define PW_KEY_MODULE_VERSION "module.version"
300 #define PW_KEY_MODULE_DEPRECATED "module.deprecated"
303 #define PW_KEY_FACTORY_ID "factory.id"
304 #define PW_KEY_FACTORY_NAME "factory.name"
305 #define PW_KEY_FACTORY_USAGE "factory.usage"
306 #define PW_KEY_FACTORY_TYPE_NAME "factory.type.name"
307 #define PW_KEY_FACTORY_TYPE_VERSION "factory.type.version"
310 #define PW_KEY_STREAM_IS_LIVE "stream.is-live"
311 #define PW_KEY_STREAM_LATENCY_MIN "stream.latency.min"
312 #define PW_KEY_STREAM_LATENCY_MAX "stream.latency.max"
313 #define PW_KEY_STREAM_MONITOR "stream.monitor"
319 #define PW_KEY_STREAM_DONT_REMIX "stream.dont-remix"
320 #define PW_KEY_STREAM_CAPTURE_SINK "stream.capture.sink"
324 #define PW_KEY_MEDIA_TYPE "media.type"
326 #define PW_KEY_MEDIA_CATEGORY "media.category"
328 #define PW_KEY_MEDIA_ROLE "media.role"
332 #define PW_KEY_MEDIA_CLASS "media.class"
333 #define PW_KEY_MEDIA_NAME "media.name"
334 #define PW_KEY_MEDIA_TITLE "media.title"
335 #define PW_KEY_MEDIA_ARTIST "media.artist"
336 #define PW_KEY_MEDIA_ALBUM "media.album"
337 #define PW_KEY_MEDIA_COPYRIGHT "media.copyright"
338 #define PW_KEY_MEDIA_SOFTWARE "media.software"
339 #define PW_KEY_MEDIA_LANGUAGE "media.language"
340 #define PW_KEY_MEDIA_FILENAME "media.filename"
341 #define PW_KEY_MEDIA_ICON "media.icon"
343 #define PW_KEY_MEDIA_ICON_NAME "media.icon-name"
345 #define PW_KEY_MEDIA_COMMENT "media.comment"
346 #define PW_KEY_MEDIA_DATE "media.date"
347 #define PW_KEY_MEDIA_FORMAT "media.format"
350 #define PW_KEY_FORMAT_DSP "format.dsp"
353 #define PW_KEY_AUDIO_CHANNEL "audio.channel"
354 #define PW_KEY_AUDIO_RATE "audio.rate"
355 #define PW_KEY_AUDIO_CHANNELS "audio.channels"
356 #define PW_KEY_AUDIO_FORMAT "audio.format"
357 #define PW_KEY_AUDIO_ALLOWED_RATES "audio.allowed-rates"
361 #define PW_KEY_VIDEO_RATE "video.framerate"
362 #define PW_KEY_VIDEO_FORMAT "video.format"
363 #define PW_KEY_VIDEO_SIZE "video.size"
365 #define PW_KEY_TARGET_OBJECT "target.object"
368 #ifndef PW_REMOVE_DEPRECATED
369 # ifdef PW_ENABLE_DEPRECATED
370 # define PW_KEY_PRIORITY_MASTER "priority.master"
371 # define PW_KEY_NODE_TARGET "node.target"
372 # define PW_KEY_LOOP_RETRY_TIMEOUT "loop.retry-timeout"
373 # else
374 # define PW_KEY_PRIORITY_MASTER PW_DEPRECATED("priority.master")
375 # define PW_KEY_NODE_TARGET PW_DEPRECATED("node.target")
376 # define PW_KEY_LOOP_RETRY_TIMEOUT PW_DEPRECATED("loop.retry-timeout")
377 # endif /* PW_ENABLE_DEPRECATED */
378 #endif /* PW_REMOVE_DEPRECATED */
379 
383 #ifdef __cplusplus
384 }
385 #endif
386 
387 #endif /* PIPEWIRE_KEYS_H */