PipeWire  0.3.45
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 
81 struct pw_impl_client;
82 
83 #include <pipewire/context.h>
84 #include <pipewire/global.h>
86 #include <pipewire/resource.h>
87 #include <pipewire/permission.h>
88 
90 struct pw_impl_client_events {
91 #define PW_VERSION_IMPL_CLIENT_EVENTS 0
92  uint32_t version;
93 
95  void (*destroy) (void *data);
96 
98  void (*free) (void *data);
99 
101  void (*initialized) (void *data);
102 
104  void (*info_changed) (void *data, const struct pw_client_info *info);
105 
107  void (*resource_added) (void *data, struct pw_resource *resource);
108 
110  void (*resource_removed) (void *data, struct pw_resource *resource);
111 
115  void (*busy_changed) (void *data, bool busy);
116 };
117 
119 struct pw_impl_client *
121  struct pw_protocol *protocol,
122  struct pw_properties *properties,
123  size_t user_data_size );
124 
126 void pw_impl_client_destroy(struct pw_impl_client *client);
127 
129 int pw_impl_client_register(struct pw_impl_client *client,
130  struct pw_properties *properties);
131 
133 void *pw_impl_client_get_user_data(struct pw_impl_client *client);
134 
136 const struct pw_client_info *pw_impl_client_get_info(struct pw_impl_client *client);
137 
139 int pw_impl_client_update_properties(struct pw_impl_client *client, const struct spa_dict *dict);
140 
142 int pw_impl_client_update_permissions(struct pw_impl_client *client, uint32_t n_permissions,
143  const struct pw_permission *permissions);
144 
147  uint32_t global_id, uint32_t permissions);
148 
150 const struct pw_properties *pw_impl_client_get_properties(struct pw_impl_client *client);
151 
156 
159 
161 struct pw_resource *pw_impl_client_find_resource(struct pw_impl_client *client, uint32_t id);
162 
164 struct pw_global *pw_impl_client_get_global(struct pw_impl_client *client);
165 
167 void pw_impl_client_add_listener(struct pw_impl_client *client,
168  struct spa_hook *listener,
169  const struct pw_impl_client_events *events,
170  void *data);
171 
172 
175 void pw_impl_client_set_busy(struct pw_impl_client *client, bool busy);
176 
181 #ifdef __cplusplus
182 }
183 #endif
184 
185 #endif /* PIPEWIRE_IMPL_CLIENT_H */
pipewire/context.h
pipewire/global.h
void pw_impl_client_destroy(struct pw_impl_client *client)
Destroy a previously created client.
Definition: impl-client.c:581
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:617
void pw_impl_client_set_busy(struct pw_impl_client *client, bool busy)
Mark the client busy.
Definition: impl-client.c:720
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:526
const struct pw_client_info * pw_impl_client_get_info(struct pw_impl_client *client)
Get the client information.
Definition: impl-client.c:626
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:730
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)
Create a new client.
Definition: impl-client.c:387
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:650
struct pw_resource * pw_impl_client_get_core_resource(struct pw_impl_client *client)
Get the client core resource.
Definition: impl-client.c:538
void * pw_impl_client_get_user_data(struct pw_impl_client *client)
Get the client user data.
Definition: impl-client.c:562
const struct pw_properties * pw_impl_client_get_properties(struct pw_impl_client *client)
Get the client properties.
Definition: impl-client.c:556
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:532
int pw_impl_client_register(struct pw_impl_client *client, struct pw_properties *properties)
Finish configuration and register a client.
Definition: impl-client.c:474
int pw_impl_client_update_properties(struct pw_impl_client *client, const struct spa_dict *dict)
Update the client properties.
Definition: impl-client.c:642
struct pw_global * pw_impl_client_get_global(struct pw_impl_client *client)
Get the global associated with this client.
Definition: impl-client.c:550
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:544
spa/utils/hook.h
pipewire/permission.h
pipewire/properties.h
pipewire/resource.h
The client information.
Definition: client.h:63
Definition: context.h:67
The events that a client can emit.
Definition: impl-client.h:95
void(* busy_changed)(void *data, bool busy)
emitted when the client becomes busy processing an asynchronous message.
Definition: impl-client.h:121
uint32_t version
Definition: impl-client.h:98
void(* initialized)(void *data)
the client is initialized
Definition: impl-client.h:107
void(* resource_added)(void *data, struct pw_resource *resource)
emitted when a new resource is added for client
Definition: impl-client.h:113
void(* info_changed)(void *data, const struct pw_client_info *info)
emitted when the client info changed
Definition: impl-client.h:110
void(* destroy)(void *data)
emitted when the client is destroyed
Definition: impl-client.h:101
void(* free)(void *data)
emitted right before the client is freed
Definition: impl-client.h:104
void(* resource_removed)(void *data, struct pw_resource *resource)
emitted when a resource is removed
Definition: impl-client.h:116
Definition: permission.h:80
Definition: properties.h:53
Definition: impl.h:49
Definition: dict.h:59
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:342