PipeWire: impl-client.h Source File

PipeWire 0.3.26

impl-client.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_IMPL_CLIENT_H
26 #define PIPEWIRE_IMPL_CLIENT_H
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 #include <spa/utils/hook.h>
33
44 struct pw_impl_client;
45
46 #include <pipewire/context.h>
47 #include <pipewire/global.h>
48 #include <pipewire/properties.h>
49 #include <pipewire/resource.h>
50 #include <pipewire/permission.h>
51
83 struct pw_impl_client_events {
84 #define PW_VERSION_IMPL_CLIENT_EVENTS 0
85 uint32_t version;
86
88 void (*destroy) (void *data);
89
91 void (*free) (void *data);
92
94 void (*initialized) (void *data);
95
97 void (*info_changed) (void *data, const struct pw_client_info *info);
98
100 void (*resource_added) (void *data, struct pw_resource *resource);
101
103 void (*resource_removed) (void *data, struct pw_resource *resource);
104
108 void (*busy_changed) (void *data, bool busy);
109 };
110
112 struct pw_impl_client *
113 pw_context_create_client(struct pw_impl_core *core,
114 struct pw_protocol *prototol,
115 struct pw_properties *properties,
116 size_t user_data_size );
117
119 void pw_impl_client_destroy(struct pw_impl_client *client);
120
122 int pw_impl_client_register(struct pw_impl_client *client,
123 struct pw_properties *properties);
124
126 void *pw_impl_client_get_user_data(struct pw_impl_client *client);
127
129 const struct pw_client_info *pw_impl_client_get_info(struct pw_impl_client *client);
130
132 int pw_impl_client_update_properties(struct pw_impl_client *client, const struct spa_dict *dict);
133
135 int pw_impl_client_update_permissions(struct pw_impl_client *client, uint32_t n_permissions,
136 const struct pw_permission *permissions);
137
139 int pw_impl_client_check_permissions(struct pw_impl_client *client,
140 uint32_t global_id, uint32_t permissions);
141
143 const struct pw_properties *pw_impl_client_get_properties(struct pw_impl_client *client);
144
146 struct pw_context *pw_impl_client_get_context(struct pw_impl_client *client);
148 struct pw_protocol *pw_impl_client_get_protocol(struct pw_impl_client *client);
149
151 struct pw_resource *pw_impl_client_get_core_resource(struct pw_impl_client *client);
152
154 struct pw_resource *pw_impl_client_find_resource(struct pw_impl_client *client, uint32_t id);
155
157 struct pw_global *pw_impl_client_get_global(struct pw_impl_client *client);
158
160 void pw_impl_client_add_listener(struct pw_impl_client *client,
161 struct spa_hook *listener,
162 const struct pw_impl_client_events *events,
163 void *data);
164
165
168 void pw_impl_client_set_busy(struct pw_impl_client *client, bool busy);
169
170 #ifdef __cplusplus
171 }
172 #endif
173
174 #endif /* PIPEWIRE_IMPL_CLIENT_H */
pw_context
the PipeWire context
pw_global
A global object visible to remote clients.
pw_impl_client
PipeWire client object class.
pw_impl_client::pw_context_create_client
SPA_EXPORT struct pw_impl_client * pw_context_create_client(struct pw_impl_core *core, struct pw_protocol *protocol, struct pw_properties *properties, size_t user_data_size)
Make a new client object.
Definition: impl-client.c:382
pw_impl_client::pw_impl_client_destroy
SPA_EXPORT void pw_impl_client_destroy(struct pw_impl_client *client)
Destroy a client object.
Definition: impl-client.c:575
pw_impl_client::pw_impl_client_update_properties
SPA_EXPORT int pw_impl_client_update_properties(struct pw_impl_client *client, const struct spa_dict *dict)
Update client properties.
Definition: impl-client.c:637
pw_impl_core
PipeWire core interface.
pw_protocol
Manages protocols and their implementation.
pw_resource
Client owned objects.
context.h
global.h
pw_impl_client_add_listener
void pw_impl_client_add_listener(struct pw_impl_client *client, struct spa_hook *listener, const struct pw_impl_client_events *events, void *data)
listen to events from this client
Definition: impl-client.c:611
pw_impl_client_set_busy
void pw_impl_client_set_busy(struct pw_impl_client *client, bool busy)
Mark the client busy.
Definition: impl-client.c:715
pw_impl_client_get_context
struct pw_context * pw_impl_client_get_context(struct pw_impl_client *client)
Get the context used to create this client.
Definition: impl-client.c:519
pw_impl_client_get_info
const struct pw_client_info * pw_impl_client_get_info(struct pw_impl_client *client)
Get the client information.
Definition: impl-client.c:620
pw_impl_client_check_permissions
int pw_impl_client_check_permissions(struct pw_impl_client *client, uint32_t global_id, uint32_t permissions)
check if a client has permissions for global_id, Since 0.3.9
Definition: impl-client.c:725
pw_impl_client_update_permissions
int pw_impl_client_update_permissions(struct pw_impl_client *client, uint32_t n_permissions, const struct pw_permission *permissions)
Update the client permissions.
Definition: impl-client.c:645
pw_impl_client_get_core_resource
struct pw_resource * pw_impl_client_get_core_resource(struct pw_impl_client *client)
Get the client core resource.
Definition: impl-client.c:531
pw_impl_client_get_user_data
void * pw_impl_client_get_user_data(struct pw_impl_client *client)
Get the client user data.
Definition: impl-client.c:555
pw_impl_client_get_properties
const struct pw_properties * pw_impl_client_get_properties(struct pw_impl_client *client)
Get the client properties.
Definition: impl-client.c:549
pw_impl_client_get_protocol
struct pw_protocol * pw_impl_client_get_protocol(struct pw_impl_client *client)
Get the protocol used to create this client.
Definition: impl-client.c:525
pw_impl_client_register
int pw_impl_client_register(struct pw_impl_client *client, struct pw_properties *properties)
Finish configuration and register a client.
Definition: impl-client.c:470
pw_impl_client_get_global
struct pw_global * pw_impl_client_get_global(struct pw_impl_client *client)
Get the global associated with this client.
Definition: impl-client.c:543
pw_impl_client_find_resource
struct pw_resource * pw_impl_client_find_resource(struct pw_impl_client *client, uint32_t id)
Get a resource with the given id.
Definition: impl-client.c:537
permission.h
properties.h
resource.h
data
Definition: filter.c:74
pw_client_info
The client information.
Definition: client.h:47
pw_impl_client_events
The events that a client can emit.
Definition: impl-client.h:83
pw_impl_client_events::busy_changed
void(* busy_changed)(void *data, bool busy)
emitted when the client becomes busy processing an asynchronous message.
Definition: impl-client.h:108
pw_impl_client_events::version
uint32_t version
Definition: impl-client.h:85
pw_impl_client_events::initialized
void(* initialized)(void *data)
the client is initialized
Definition: impl-client.h:94
pw_impl_client_events::resource_added
void(* resource_added)(void *data, struct pw_resource *resource)
emitted when a new resource is added for client
Definition: impl-client.h:100
pw_impl_client_events::info_changed
void(* info_changed)(void *data, const struct pw_client_info *info)
emitted when the client info changed
Definition: impl-client.h:97
pw_impl_client_events::destroy
void(* destroy)(void *data)
emitted when the client is destroyed
Definition: impl-client.h:88
pw_impl_client_events::free
void(* free)(void *data)
emitted right before the client is freed
Definition: impl-client.h:91
pw_impl_client_events::resource_removed
void(* resource_removed)(void *data, struct pw_resource *resource)
emitted when a resource is removed
Definition: impl-client.h:103
pw_permission
a PipeWire permission
Definition: permission.h:61
pw_properties
A collection of key/value pairs.
Definition: properties.h:45