PipeWire: pipewire/pipewire.h Source File

PipeWire 0.3.51

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
29extern "C" {
30#endif
31
32#include <spa/support/plugin.h>
33
34#include <pipewire/array.h>
35#include <pipewire/client.h>
36#include <pipewire/context.h>
37#include <pipewire/device.h>
38#include <pipewire/buffers.h>
39#include <pipewire/core.h>
40#include <pipewire/factory.h>
41#include <pipewire/keys.h>
42#include <pipewire/log.h>
43#include <pipewire/loop.h>
44#include <pipewire/link.h>
45#include <pipewire/main-loop.h>
46#include <pipewire/map.h>
47#include <pipewire/mem.h>
48#include <pipewire/module.h>
49#include <pipewire/node.h>
50#include <pipewire/properties.h>
51#include <pipewire/proxy.h>
52#include <pipewire/permission.h>
53#include <pipewire/protocol.h>
54#include <pipewire/port.h>
55#include <pipewire/stream.h>
56#include <pipewire/filter.h>
57#include <pipewire/thread-loop.h>
58#include <pipewire/data-loop.h>
59#include <pipewire/type.h>
60#include <pipewire/utils.h>
61#include <pipewire/version.h>
62
71void
72 pw_init(int *argc, char **argv[]);
73
74void pw_deinit(void);
75
76bool
77 pw_debug_is_category_enabled(const char *name);
78
79const char *
80 pw_get_application_name(void);
81
82const char *
83 pw_get_prgname(void);
84
85const char *
86 pw_get_user_name(void);
87
88const char *
89 pw_get_host_name(void);
90
91const char *
92 pw_get_client_name(void);
93
94bool pw_in_valgrind(void);
95
96bool pw_check_option(const char *option, const char *value);
97
98enum pw_direction
99 pw_direction_reverse(enum pw_direction direction);
100
101int pw_set_domain(const char *domain);
102const char *pw_get_domain(void);
103
104uint32_t pw_get_support(struct spa_support *support, uint32_t max_support);
105
106struct spa_handle *pw_load_spa_handle(const char *lib,
107 const char *factory_name,
108 const struct spa_dict *info,
109 uint32_t n_support,
110 const struct spa_support support[]);
111
112int pw_unload_spa_handle(struct spa_handle *handle);
113
118#ifdef __cplusplus
119}
120#endif
121
122#endif /* PIPEWIRE_H */
array.h
pipewire/array.h
buffers.h
pipewire/buffers.h
client.h
pipewire/client.h
context.h
pipewire/context.h
core.h
pipewire/core.h
data-loop.h
pipewire/data-loop.h
factory.h
pipewire/factory.h
pw_init
void pw_init(int *argc, char **argv[])
Initialize PipeWire.
Definition: pipewire.c:583
pw_get_support
uint32_t pw_get_support(struct spa_support *support, uint32_t max_support)
Definition: pipewire.c:220
pw_get_prgname
const char * pw_get_prgname(void)
Get the program name.
Definition: pipewire.c:784
pw_in_valgrind
bool pw_in_valgrind(void)
Definition: pipewire.c:818
pw_get_domain
const char * pw_get_domain(void)
Definition: pipewire.c:395
pw_direction_reverse
enum pw_direction pw_direction_reverse(enum pw_direction direction)
Reverse the direction.
Definition: pipewire.c:860
pw_check_option
bool pw_check_option(const char *option, const char *value)
Definition: pipewire.c:824
pw_get_host_name
const char * pw_get_host_name(void)
Get the host name.
Definition: pipewire.c:806
pw_get_application_name
const char * pw_get_application_name(void)
Get the application name.
Definition: pipewire.c:741
pw_set_domain
int pw_set_domain(const char *domain)
Definition: pipewire.c:383
pw_load_spa_handle
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:308
pw_debug_is_category_enabled
bool pw_debug_is_category_enabled(const char *name)
Check if a debug category is enabled.
Definition: pipewire.c:725
pw_get_user_name
const char * pw_get_user_name(void)
Get the user name.
Definition: pipewire.c:794
pw_unload_spa_handle
int pw_unload_spa_handle(struct spa_handle *handle)
Definition: pipewire.c:337
pw_deinit
void pw_deinit(void)
Deinitialize PipeWire.
Definition: pipewire.c:686
pw_get_client_name
const char * pw_get_client_name(void)
Get the client name.
Definition: pipewire.c:842
pw_direction
#define pw_direction
The direction of a port.
Definition: port.h:63
link.h
pipewire/link.h
main-loop.h
pipewire/main-loop.h
map.h
pipewire/map.h
module.h
pipewire/module.h
permission.h
pipewire/permission.h
plugin.h
spa/support/plugin.h
port.h
pipewire/port.h
properties.h
pipewire/properties.h
protocol.h
pipewire/protocol.h
proxy.h
pipewire/proxy.h
device.h
pipewire/device.h
filter.h
pipewire/filter.h
keys.h
pipewire/keys.h
log.h
pipewire/log.h
loop.h
pipewire/loop.h
mem.h
pipewire/mem.h
node.h
pipewire/node.h
type.h
pipewire/type.h
utils.h
stream.h
pipewire/stream.h
spa_dict
Definition: dict.h:59
spa_handle
Definition: plugin.h:50
spa_support
Extra supporting infrastructure passed to the init() function of a factory.
Definition: plugin.h:96
thread-loop.h
pipewire/thread-loop.h