PipeWire  0.3.10
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"
48 #define PW_KEY_SEC_PID "pipewire.sec.pid"
49 #define PW_KEY_SEC_UID "pipewire.sec.uid"
50 #define PW_KEY_SEC_GID "pipewire.sec.gid"
51 #define PW_KEY_SEC_LABEL "pipewire.sec.label"
53 #define PW_KEY_LIBRARY_NAME_SYSTEM "library.name.system"
54 #define PW_KEY_LIBRARY_NAME_LOOP "library.name.loop"
55 #define PW_KEY_LIBRARY_NAME_DBUS "library.name.dbus"
57 #define PW_KEY_OBJECT_PATH "object.path"
58 #define PW_KEY_OBJECT_ID "object.id"
60 /* context */
61 #define PW_KEY_CONTEXT_PROFILE_MODULES "context.profile.modules"
62 #define PW_KEY_USER_NAME "context.user-name"
63 #define PW_KEY_HOST_NAME "context.host-name"
65 /* core */
66 #define PW_KEY_CORE_NAME "core.name"
69 #define PW_KEY_CORE_VERSION "core.version"
70 #define PW_KEY_CORE_DAEMON "core.daemon"
72 #define PW_KEY_CORE_ID "core.id"
73 #define PW_KEY_CORE_MONITORS "core.monitors"
75 /* cpu */
76 #define PW_KEY_CPU_MAX_ALIGN "cpu.max-align"
78 #define PW_KEY_CPU_CORES "cpu.cores"
80 /* priorities */
81 #define PW_KEY_PRIORITY_SESSION "priority.session"
82 #define PW_KEY_PRIORITY_DRIVER "priority.driver"
84 /* remote keys */
85 #define PW_KEY_REMOTE_NAME "remote.name"
88 #define PW_KEY_REMOTE_INTENTION "remote.intention"
92 #define PW_KEY_APP_NAME "application.name"
93 #define PW_KEY_APP_ID "application.id"
95 #define PW_KEY_APP_VERSION "application.version"
96 #define PW_KEY_APP_ICON "application.icon"
97 #define PW_KEY_APP_ICON_NAME "application.icon-name"
99 #define PW_KEY_APP_LANGUAGE "application.language"
102 #define PW_KEY_APP_PROCESS_ID "application.process.id"
103 #define PW_KEY_APP_PROCESS_BINARY "application.process.binary"
104 #define PW_KEY_APP_PROCESS_USER "application.process.user"
105 #define PW_KEY_APP_PROCESS_HOST "application.process.host"
106 #define PW_KEY_APP_PROCESS_MACHINE_ID "application.process.machine-id"
108 #define PW_KEY_APP_PROCESS_SESSION_ID "application.process.session-id"
112 #define PW_KEY_WINDOW_X11_DISPLAY "window.x11.display"
115 #define PW_KEY_CLIENT_ID "client.id"
116 #define PW_KEY_CLIENT_NAME "client.name"
117 #define PW_KEY_CLIENT_API "client.api"
121 #define PW_KEY_NODE_ID "node.id"
122 #define PW_KEY_NODE_NAME "node.name"
123 #define PW_KEY_NODE_NICK "node.nick"
124 #define PW_KEY_NODE_DESCRIPTION "node.description"
126 #define PW_KEY_NODE_PLUGGED "node.plugged"
129 #define PW_KEY_NODE_SESSION "node.session"
130 #define PW_KEY_NODE_GROUP "node.group"
133 #define PW_KEY_NODE_EXCLUSIVE "node.exclusive"
134 #define PW_KEY_NODE_AUTOCONNECT "node.autoconnect"
136 #define PW_KEY_NODE_TARGET "node.target"
138 #define PW_KEY_NODE_LATENCY "node.latency"
140 #define PW_KEY_NODE_DONT_RECONNECT "node.dont-reconnect"
141 #define PW_KEY_NODE_ALWAYS_PROCESS "node.always-process"
142 #define PW_KEY_NODE_PAUSE_ON_IDLE "node.pause-on-idle"
143 #define PW_KEY_NODE_DRIVER "node.driver"
144 #define PW_KEY_NODE_STREAM "node.stream"
147 #define PW_KEY_PORT_ID "port.id"
148 #define PW_KEY_PORT_NAME "port.name"
149 #define PW_KEY_PORT_DIRECTION "port.direction"
151 #define PW_KEY_PORT_ALIAS "port.alias"
152 #define PW_KEY_PORT_PHYSICAL "port.physical"
153 #define PW_KEY_PORT_TERMINAL "port.terminal"
154 #define PW_KEY_PORT_CONTROL "port.control"
155 #define PW_KEY_PORT_MONITOR "port.monitor"
158 #define PW_KEY_LINK_ID "link.id"
159 #define PW_KEY_LINK_INPUT_NODE "link.input.node"
160 #define PW_KEY_LINK_INPUT_PORT "link.input.port"
161 #define PW_KEY_LINK_OUTPUT_NODE "link.output.node"
162 #define PW_KEY_LINK_OUTPUT_PORT "link.output.port"
163 #define PW_KEY_LINK_PASSIVE "link.passive"
167 #define PW_KEY_DEVICE_ID "device.id"
168 #define PW_KEY_DEVICE_NAME "device.name"
169 #define PW_KEY_DEVICE_PLUGGED "device.plugged"
171 #define PW_KEY_DEVICE_NICK "device.nick"
172 #define PW_KEY_DEVICE_STRING "device.string"
174 #define PW_KEY_DEVICE_API "device.api"
176 #define PW_KEY_DEVICE_DESCRIPTION "device.description"
178 #define PW_KEY_DEVICE_BUS_PATH "device.bus-path"
180 #define PW_KEY_DEVICE_SERIAL "device.serial"
181 #define PW_KEY_DEVICE_VENDOR_ID "device.vendor.id"
182 #define PW_KEY_DEVICE_VENDOR_NAME "device.vendor.name"
183 #define PW_KEY_DEVICE_PRODUCT_ID "device.product.id"
184 #define PW_KEY_DEVICE_PRODUCT_NAME "device.product.name"
185 #define PW_KEY_DEVICE_CLASS "device.class"
186 #define PW_KEY_DEVICE_FORM_FACTOR "device.form-factor"
191 #define PW_KEY_DEVICE_BUS "device.bus"
194 #define PW_KEY_DEVICE_SUBSYSTEM "device.subsystem"
195 #define PW_KEY_DEVICE_ICON "device.icon"
197 #define PW_KEY_DEVICE_ICON_NAME "device.icon-name"
199 #define PW_KEY_DEVICE_INTENDED_ROLES "device.intended-roles"
205 #define PW_KEY_MODULE_ID "module.id"
206 #define PW_KEY_MODULE_NAME "module.name"
207 #define PW_KEY_MODULE_AUTHOR "module.author"
208 #define PW_KEY_MODULE_DESCRIPTION "module.description"
210 #define PW_KEY_MODULE_USAGE "module.usage"
212 #define PW_KEY_MODULE_VERSION "module.version"
215 #define PW_KEY_FACTORY_ID "factory.id"
216 #define PW_KEY_FACTORY_NAME "factory.name"
217 #define PW_KEY_FACTORY_USAGE "factory.usage"
218 #define PW_KEY_FACTORY_TYPE_NAME "factory.type.name"
219 #define PW_KEY_FACTORY_TYPE_VERSION "factory.type.version"
222 #define PW_KEY_STREAM_IS_LIVE "stream.is-live"
223 #define PW_KEY_STREAM_LATENCY_MIN "stream.latency.min"
224 #define PW_KEY_STREAM_LATENCY_MAX "stream.latency.max"
225 #define PW_KEY_STREAM_MONITOR "stream.monitor"
228 #define PW_KEY_STREAM_DONT_REMIX "stream.dont-remix"
231 #define PW_KEY_OBJECT_LINGER "object.linger"
235 #define PW_KEY_MEDIA_TYPE "media.type"
237 #define PW_KEY_MEDIA_CATEGORY "media.category"
239 #define PW_KEY_MEDIA_ROLE "media.role"
243 #define PW_KEY_MEDIA_CLASS "media.class"
244 #define PW_KEY_MEDIA_NAME "media.name"
245 #define PW_KEY_MEDIA_TITLE "media.title"
246 #define PW_KEY_MEDIA_ARTIST "media.artist"
247 #define PW_KEY_MEDIA_COPYRIGHT "media.copyright"
248 #define PW_KEY_MEDIA_SOFTWARE "media.software"
249 #define PW_KEY_MEDIA_LANGUAGE "media.language"
250 #define PW_KEY_MEDIA_FILENAME "media.filename"
251 #define PW_KEY_MEDIA_ICON "media.icon"
253 #define PW_KEY_MEDIA_ICON_NAME "media.icon-name"
257 #define PW_KEY_FORMAT_DSP "format.dsp"
260 #define PW_KEY_AUDIO_CHANNEL "audio.channel"
261 #define PW_KEY_AUDIO_RATE "audio.samplerate"
262 #define PW_KEY_AUDIO_CHANNELS "audio.channels"
263 #define PW_KEY_AUDIO_FORMAT "audio.format"
266 #define PW_KEY_VIDEO_RATE "video.framerate"
267 #define PW_KEY_VIDEO_FORMAT "video.format"
268 #define PW_KEY_VIDEO_SIZE "video.size"
270 #ifdef PW_ENABLE_DEPRECATED
271 #define PW_KEY_PRIORITY_MASTER "priority.master"
272 #endif /* PW_ENABLE_DEPRECATED */
273 
274 #ifdef __cplusplus
275 }
276 #endif
277 
278 #endif /* PIPEWIRE_KEYS_H */