PipeWire  0.3.33
build-12683127/doc/spa/utils/keys.h
Go to the documentation of this file.
1 /* Simple Plugin API
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 SPA_UTILS_KEYS_H
26 #define SPA_UTILS_KEYS_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
41 #define SPA_KEY_OBJECT_PATH "object.path"
44 #define SPA_KEY_MEDIA_CLASS "media.class"
47 #define SPA_KEY_MEDIA_ROLE "media.role"
52 #define SPA_KEY_API_UDEV "api.udev"
53 #define SPA_KEY_API_UDEV_MATCH "api.udev.match"
56 #define SPA_KEY_API_ALSA "api.alsa"
57 #define SPA_KEY_API_ALSA_PATH "api.alsa.path"
60 #define SPA_KEY_API_ALSA_CARD "api.alsa.card"
61 #define SPA_KEY_API_ALSA_USE_UCM "api.alsa.use-ucm"
62 #define SPA_KEY_API_ALSA_IGNORE_DB "api.alsa.ignore-dB"
63 #define SPA_KEY_API_ALSA_OPEN_UCM "api.alsa.open.ucm"
66 #define SPA_KEY_API_ALSA_CARD_ID "api.alsa.card.id"
67 #define SPA_KEY_API_ALSA_CARD_COMPONENTS \
68  "api.alsa.card.components"
69 #define SPA_KEY_API_ALSA_CARD_DRIVER "api.alsa.card.driver"
70 #define SPA_KEY_API_ALSA_CARD_NAME "api.alsa.card.name"
71 #define SPA_KEY_API_ALSA_CARD_LONGNAME "api.alsa.card.longname"
72 #define SPA_KEY_API_ALSA_CARD_MIXERNAME "api.alsa.card.mixername"
75 #define SPA_KEY_API_ALSA_PCM_ID "api.alsa.pcm.id"
76 #define SPA_KEY_API_ALSA_PCM_CARD "api.alsa.pcm.card"
77 #define SPA_KEY_API_ALSA_PCM_NAME "api.alsa.pcm.name"
78 #define SPA_KEY_API_ALSA_PCM_SUBNAME "api.alsa.pcm.subname"
79 #define SPA_KEY_API_ALSA_PCM_STREAM "api.alsa.pcm.stream"
80 #define SPA_KEY_API_ALSA_PCM_CLASS "api.alsa.pcm.class"
81 #define SPA_KEY_API_ALSA_PCM_DEVICE "api.alsa.pcm.device"
82 #define SPA_KEY_API_ALSA_PCM_SUBDEVICE "api.alsa.pcm.subdevice"
83 #define SPA_KEY_API_ALSA_PCM_SUBCLASS "api.alsa.pcm.subclass"
84 #define SPA_KEY_API_ALSA_PCM_SYNC_ID "api.alsa.pcm.sync-id"
87 #define SPA_KEY_API_V4L2 "api.v4l2"
88 #define SPA_KEY_API_V4L2_PATH "api.v4l2.path"
92 #define SPA_KEY_API_LIBCAMERA "api.libcamera"
93 #define SPA_KEY_API_LIBCAMERA_PATH "api.libcamera.path"
97 #define SPA_KEY_API_LIBCAMERA_CAP_DRIVER "api.libcamera.cap.driver"
98 #define SPA_KEY_API_LIBCAMERA_CAP_CARD "api.libcamera.cap.card"
99 #define SPA_KEY_API_LIBCAMERA_CAP_BUS_INFO "api.libcamera.cap.bus_info"
100 #define SPA_KEY_API_LIBCAMERA_CAP_VERSION "api.libcamera.cap.version"
101 #define SPA_KEY_API_LIBCAMERA_CAP_CAPABILITIES \
102  "api.libcamera.cap.capabilities"
103 #define SPA_KEY_API_LIBCAMERA_CAP_DEVICE_CAPS \
104  "api.libcamera.cap.device-caps"
106 #define SPA_KEY_API_V4L2_CAP_DRIVER "api.v4l2.cap.driver"
107 #define SPA_KEY_API_V4L2_CAP_CARD "api.v4l2.cap.card"
108 #define SPA_KEY_API_V4L2_CAP_BUS_INFO "api.v4l2.cap.bus_info"
109 #define SPA_KEY_API_V4L2_CAP_VERSION "api.v4l2.cap.version"
110 #define SPA_KEY_API_V4L2_CAP_CAPABILITIES \
111  "api.v4l2.cap.capabilities"
112 #define SPA_KEY_API_V4L2_CAP_DEVICE_CAPS \
113  "api.v4l2.cap.device-caps"
117 #define SPA_KEY_API_BLUEZ5 "api.bluez5"
118 #define SPA_KEY_API_BLUEZ5_PATH "api.bluez5.path"
119 #define SPA_KEY_API_BLUEZ5_DEVICE "api.bluez5.device"
120 #define SPA_KEY_API_BLUEZ5_CONNECTION "api.bluez5.connection"
121 #define SPA_KEY_API_BLUEZ5_TRANSPORT "api.bluez5.transport"
122 #define SPA_KEY_API_BLUEZ5_PROFILE "api.bluez5.profile"
123 #define SPA_KEY_API_BLUEZ5_ADDRESS "api.bluez5.address"
124 #define SPA_KEY_API_BLUEZ5_CODEC "api.bluez5.codec"
125 #define SPA_KEY_API_BLUEZ5_CLASS "api.bluez5.class"
126 #define SPA_KEY_API_BLUEZ5_ICON "api.bluez5.icon"
129 #define SPA_KEY_API_JACK "api.jack"
130 #define SPA_KEY_API_JACK_SERVER "api.jack.server"
131 #define SPA_KEY_API_JACK_CLIENT "api.jack.client"
137 #ifdef __cplusplus
138 } /* extern "C" */
139 #endif
140 
141 #endif /* SPA_UTILS_KEYS_H */