PipeWire 1.0.5

Loading...
Searching...
No Matches
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_LIBRARY_NAME_SYSTEM "library.name.system"
44#define PW_KEY_LIBRARY_NAME_LOOP "library.name.loop"
45#define PW_KEY_LIBRARY_NAME_DBUS "library.name.dbus"
48#define PW_KEY_OBJECT_PATH "object.path"
49#define PW_KEY_OBJECT_ID "object.id"
50#define PW_KEY_OBJECT_SERIAL "object.serial"
54#define PW_KEY_OBJECT_LINGER "object.linger"
56#define PW_KEY_OBJECT_REGISTER "object.register"
57#define PW_KEY_OBJECT_EXPORT "object.export"
60/* config */
61#define PW_KEY_CONFIG_PREFIX "config.prefix"
62#define PW_KEY_CONFIG_NAME "config.name"
63#define PW_KEY_CONFIG_OVERRIDE_PREFIX "config.override.prefix"
64#define PW_KEY_CONFIG_OVERRIDE_NAME "config.override.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"
96#define PW_KEY_REMOTE_INTENTION "remote.intention"
100#define PW_KEY_APP_NAME "application.name"
101#define PW_KEY_APP_ID "application.id"
103#define PW_KEY_APP_VERSION "application.version"
104#define PW_KEY_APP_ICON "application.icon"
105#define PW_KEY_APP_ICON_NAME "application.icon-name"
107#define PW_KEY_APP_LANGUAGE "application.language"
110#define PW_KEY_APP_PROCESS_ID "application.process.id"
111#define PW_KEY_APP_PROCESS_BINARY "application.process.binary"
112#define PW_KEY_APP_PROCESS_USER "application.process.user"
113#define PW_KEY_APP_PROCESS_HOST "application.process.host"
114#define PW_KEY_APP_PROCESS_MACHINE_ID "application.process.machine-id"
116#define PW_KEY_APP_PROCESS_SESSION_ID "application.process.session-id"
120#define PW_KEY_WINDOW_X11_DISPLAY "window.x11.display"
123#define PW_KEY_CLIENT_ID "client.id"
124#define PW_KEY_CLIENT_NAME "client.name"
125#define PW_KEY_CLIENT_API "client.api"
129#define PW_KEY_NODE_ID "node.id"
130#define PW_KEY_NODE_NAME "node.name"
131#define PW_KEY_NODE_NICK "node.nick"
132#define PW_KEY_NODE_DESCRIPTION "node.description"
134#define PW_KEY_NODE_PLUGGED "node.plugged"
137#define PW_KEY_NODE_SESSION "node.session"
138#define PW_KEY_NODE_GROUP "node.group"
142#define PW_KEY_NODE_EXCLUSIVE "node.exclusive"
143#define PW_KEY_NODE_AUTOCONNECT "node.autoconnect"
145#define PW_KEY_NODE_LATENCY "node.latency"
147#define PW_KEY_NODE_MAX_LATENCY "node.max-latency"
149#define PW_KEY_NODE_LOCK_QUANTUM "node.lock-quantum"
151#define PW_KEY_NODE_FORCE_QUANTUM "node.force-quantum"
153#define PW_KEY_NODE_RATE "node.rate"
155#define PW_KEY_NODE_LOCK_RATE "node.lock-rate"
157#define PW_KEY_NODE_FORCE_RATE "node.force-rate"
161#define PW_KEY_NODE_DONT_RECONNECT "node.dont-reconnect"
165#define PW_KEY_NODE_ALWAYS_PROCESS "node.always-process"
166#define PW_KEY_NODE_WANT_DRIVER "node.want-driver"
168#define PW_KEY_NODE_PAUSE_ON_IDLE "node.pause-on-idle"
169#define PW_KEY_NODE_SUSPEND_ON_IDLE "node.suspend-on-idle"
170#define PW_KEY_NODE_CACHE_PARAMS "node.cache-params"
171#define PW_KEY_NODE_TRANSPORT_SYNC "node.transport.sync"
172#define PW_KEY_NODE_DRIVER "node.driver"
173#define PW_KEY_NODE_STREAM "node.stream"
175#define PW_KEY_NODE_VIRTUAL "node.virtual"
177#define PW_KEY_NODE_PASSIVE "node.passive"
180#define PW_KEY_NODE_LINK_GROUP "node.link-group"
183#define PW_KEY_NODE_NETWORK "node.network"
184#define PW_KEY_NODE_TRIGGER "node.trigger"
187#define PW_KEY_NODE_CHANNELNAMES "node.channel-names"
189#define PW_KEY_NODE_DEVICE_PORT_NAME_PREFIX "node.device-port-name-prefix"
194#define PW_KEY_PORT_ID "port.id"
195#define PW_KEY_PORT_NAME "port.name"
196#define PW_KEY_PORT_DIRECTION "port.direction"
198#define PW_KEY_PORT_ALIAS "port.alias"
199#define PW_KEY_PORT_PHYSICAL "port.physical"
200#define PW_KEY_PORT_TERMINAL "port.terminal"
201#define PW_KEY_PORT_CONTROL "port.control"
202#define PW_KEY_PORT_MONITOR "port.monitor"
203#define PW_KEY_PORT_CACHE_PARAMS "port.cache-params"
204#define PW_KEY_PORT_EXTRA "port.extra"
206#define PW_KEY_PORT_PASSIVE "port.passive"
207#define PW_KEY_PORT_IGNORE_LATENCY "port.ignore-latency"
210#define PW_KEY_LINK_ID "link.id"
211#define PW_KEY_LINK_INPUT_NODE "link.input.node"
212#define PW_KEY_LINK_INPUT_PORT "link.input.port"
213#define PW_KEY_LINK_OUTPUT_NODE "link.output.node"
214#define PW_KEY_LINK_OUTPUT_PORT "link.output.port"
215#define PW_KEY_LINK_PASSIVE "link.passive"
218#define PW_KEY_LINK_FEEDBACK "link.feedback"
223#define PW_KEY_DEVICE_ID "device.id"
224#define PW_KEY_DEVICE_NAME "device.name"
225#define PW_KEY_DEVICE_PLUGGED "device.plugged"
227#define PW_KEY_DEVICE_NICK "device.nick"
228#define PW_KEY_DEVICE_STRING "device.string"
230#define PW_KEY_DEVICE_API "device.api"
232#define PW_KEY_DEVICE_DESCRIPTION "device.description"
234#define PW_KEY_DEVICE_BUS_PATH "device.bus-path"
236#define PW_KEY_DEVICE_SERIAL "device.serial"
237#define PW_KEY_DEVICE_VENDOR_ID "device.vendor.id"
238#define PW_KEY_DEVICE_VENDOR_NAME "device.vendor.name"
239#define PW_KEY_DEVICE_PRODUCT_ID "device.product.id"
240#define PW_KEY_DEVICE_PRODUCT_NAME "device.product.name"
241#define PW_KEY_DEVICE_CLASS "device.class"
242#define PW_KEY_DEVICE_FORM_FACTOR "device.form-factor"
247#define PW_KEY_DEVICE_BUS "device.bus"
250#define PW_KEY_DEVICE_SUBSYSTEM "device.subsystem"
251#define PW_KEY_DEVICE_SYSFS_PATH "device.sysfs.path"
252#define PW_KEY_DEVICE_ICON "device.icon"
254#define PW_KEY_DEVICE_ICON_NAME "device.icon-name"
256#define PW_KEY_DEVICE_INTENDED_ROLES "device.intended-roles"
260#define PW_KEY_DEVICE_CACHE_PARAMS "device.cache-params"
263#define PW_KEY_MODULE_ID "module.id"
264#define PW_KEY_MODULE_NAME "module.name"
265#define PW_KEY_MODULE_AUTHOR "module.author"
266#define PW_KEY_MODULE_DESCRIPTION "module.description"
268#define PW_KEY_MODULE_USAGE "module.usage"
270#define PW_KEY_MODULE_VERSION "module.version"
273#define PW_KEY_FACTORY_ID "factory.id"
274#define PW_KEY_FACTORY_NAME "factory.name"
275#define PW_KEY_FACTORY_USAGE "factory.usage"
276#define PW_KEY_FACTORY_TYPE_NAME "factory.type.name"
277#define PW_KEY_FACTORY_TYPE_VERSION "factory.type.version"
280#define PW_KEY_STREAM_IS_LIVE "stream.is-live"
281#define PW_KEY_STREAM_LATENCY_MIN "stream.latency.min"
282#define PW_KEY_STREAM_LATENCY_MAX "stream.latency.max"
283#define PW_KEY_STREAM_MONITOR "stream.monitor"
289#define PW_KEY_STREAM_DONT_REMIX "stream.dont-remix"
290#define PW_KEY_STREAM_CAPTURE_SINK "stream.capture.sink"
294#define PW_KEY_MEDIA_TYPE "media.type"
296#define PW_KEY_MEDIA_CATEGORY "media.category"
298#define PW_KEY_MEDIA_ROLE "media.role"
302#define PW_KEY_MEDIA_CLASS "media.class"
303#define PW_KEY_MEDIA_NAME "media.name"
304#define PW_KEY_MEDIA_TITLE "media.title"
305#define PW_KEY_MEDIA_ARTIST "media.artist"
306#define PW_KEY_MEDIA_COPYRIGHT "media.copyright"
307#define PW_KEY_MEDIA_SOFTWARE "media.software"
308#define PW_KEY_MEDIA_LANGUAGE "media.language"
309#define PW_KEY_MEDIA_FILENAME "media.filename"
310#define PW_KEY_MEDIA_ICON "media.icon"
312#define PW_KEY_MEDIA_ICON_NAME "media.icon-name"
314#define PW_KEY_MEDIA_COMMENT "media.comment"
315#define PW_KEY_MEDIA_DATE "media.date"
316#define PW_KEY_MEDIA_FORMAT "media.format"
319#define PW_KEY_FORMAT_DSP "format.dsp"
322#define PW_KEY_AUDIO_CHANNEL "audio.channel"
323#define PW_KEY_AUDIO_RATE "audio.rate"
324#define PW_KEY_AUDIO_CHANNELS "audio.channels"
325#define PW_KEY_AUDIO_FORMAT "audio.format"
326#define PW_KEY_AUDIO_ALLOWED_RATES "audio.allowed-rates"
330#define PW_KEY_VIDEO_RATE "video.framerate"
331#define PW_KEY_VIDEO_FORMAT "video.format"
332#define PW_KEY_VIDEO_SIZE "video.size"
334#define PW_KEY_TARGET_OBJECT "target.object"
337#ifndef PW_REMOVE_DEPRECATED
338# ifdef PW_ENABLE_DEPRECATED
339# define PW_KEY_PRIORITY_MASTER "priority.master"
340# define PW_KEY_NODE_TARGET "node.target"
341# else
342# define PW_KEY_PRIORITY_MASTER PW_DEPRECATED("priority.master")
343# define PW_KEY_NODE_TARGET PW_DEPRECATED("node.target")
344# endif /* PW_ENABLE_DEPRECATED */
345#endif /* PW_REMOVE_DEPRECATED */
346
350#ifdef __cplusplus
351}
352#endif
353
354#endif /* PIPEWIRE_KEYS_H */
utils.h