PipeWire  0.2.9
pipewire.h
Go to the documentation of this file.
1 /* PipeWire
2  *
3  * Copyright © 2018 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_H
26 #define PIPEWIRE_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #include <spa/support/plugin.h>
33 
34 #include <pipewire/client.h>
35 #include <pipewire/core.h>
36 #include <pipewire/device.h>
37 #include <pipewire/interfaces.h>
38 #include <pipewire/introspect.h>
39 #include <pipewire/keys.h>
40 #include <pipewire/link.h>
41 #include <pipewire/log.h>
42 #include <pipewire/loop.h>
43 #include <pipewire/main-loop.h>
44 #include <pipewire/module.h>
45 #include <pipewire/factory.h>
46 #include <pipewire/node.h>
47 #include <pipewire/port.h>
48 #include <pipewire/properties.h>
49 #include <pipewire/proxy.h>
50 #include <pipewire/remote.h>
51 #include <pipewire/resource.h>
52 #include <pipewire/stream.h>
53 #include <pipewire/thread-loop.h>
54 #include <pipewire/type.h>
55 #include <pipewire/utils.h>
56 #include <pipewire/version.h>
57 
110 void
111 pw_init(int *argc, char **argv[]);
112 
113 bool
114 pw_debug_is_category_enabled(const char *name);
115 
116 const char *
118 
119 const char *
120 pw_get_prgname(void);
121 
122 const char *
123 pw_get_user_name(void);
124 
125 const char *
126 pw_get_host_name(void);
127 
128 const char *
129 pw_get_client_name(void);
130 
131 void
132 pw_fill_remote_properties(struct pw_core *core, struct pw_properties *properties);
133 
134 void
135 pw_fill_stream_properties(struct pw_core *core, struct pw_properties *properties);
136 
137 enum pw_direction
138 pw_direction_reverse(enum pw_direction direction);
139 
140 uint32_t pw_get_support(struct spa_support *support, uint32_t max_support);
141 
142 struct spa_handle *pw_load_spa_handle(const char *lib,
143  const char *factory_name,
144  const struct spa_dict *info,
145  uint32_t n_support,
146  const struct spa_support support[]);
147 
148 int pw_unload_spa_handle(struct spa_handle *handle);
149 
150 #ifdef __cplusplus
151 }
152 #endif
153 
154 #endif /* PIPEWIRE_H */
SPA_EXPORT void pw_fill_remote_properties(struct pw_core *core, struct pw_properties *properties)
Fill remote properties.
Definition: pipewire.c:496
A collection of key/value pairs.
Definition: properties.h:43
SPA_EXPORT void pw_init(int *argc, char **argv[])
Initialize PipeWire.
Definition: pipewire.c:347
SPA_EXPORT const char * pw_get_prgname(void)
Get the program name.
Definition: pipewire.c:428
SPA_EXPORT bool pw_debug_is_category_enabled(const char *name)
Check if a debug category is enabled.
Definition: pipewire.c:404
Definition: pipewire.c:56
the core PipeWire object
Definition: pipewire.c:68
struct spa_handle * pw_load_spa_handle(const char *lib, const char *factory_name, const struct spa_dict *info, uint32_t n_support, const struct spa_support support[])
Definition: pipewire.c:218
SPA_EXPORT enum pw_direction pw_direction_reverse(enum pw_direction direction)
Reverse the direction.
Definition: pipewire.c:547
SPA_EXPORT void pw_fill_stream_properties(struct pw_core *core, struct pw_properties *properties)
Fill stream properties.
Definition: pipewire.c:541
int pw_unload_spa_handle(struct spa_handle *handle)
Definition: pipewire.c:299
SPA_EXPORT const char * pw_get_application_name(void)
Get the application name.
Definition: pipewire.c:420
SPA_EXPORT const char * pw_get_user_name(void)
Get the user name.
Definition: pipewire.c:441
SPA_EXPORT const char * pw_get_host_name(void)
Get the host name.
Definition: pipewire.c:453
SPA_EXPORT const char * pw_get_client_name(void)
Get the client name.
Definition: pipewire.c:471
pw_direction
The direction of a port.
Definition: introspect.h:52
uint32_t pw_get_support(struct spa_support *support, uint32_t max_support)
Definition: pipewire.c:209