PipeWire  1.0.0
impl-client.h
Go to the documentation of this file.
1 /* PipeWire */
2 /* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
3 /* SPDX-License-Identifier: MIT */
4 
5 #ifndef PIPEWIRE_IMPL_CLIENT_H
6 #define PIPEWIRE_IMPL_CLIENT_H
7 
8 #ifdef __cplusplus
9 extern "C" {
10 #endif
11 
12 #include <spa/utils/hook.h>
13 
63 struct pw_impl_client;
64 
65 #include <pipewire/context.h>
66 #include <pipewire/global.h>
68 #include <pipewire/resource.h>
69 #include <pipewire/permission.h>
70 
72 struct pw_impl_client_events {
73 #define PW_VERSION_IMPL_CLIENT_EVENTS 0
74  uint32_t version;
75 
77  void (*destroy) (void *data);
78 
80  void (*free) (void *data);
81 
83  void (*initialized) (void *data);
84 
86  void (*info_changed) (void *data, const struct pw_client_info *info);
87 
89  void (*resource_added) (void *data, struct pw_resource *resource);
90 
92  void (*resource_removed) (void *data, struct pw_resource *resource);
93 
97  void (*busy_changed) (void *data, bool busy);
98 };
99 
101 struct pw_impl_client *
103  struct pw_protocol *protocol,
104  struct pw_properties *properties,
105  size_t user_data_size );
106 
108 void pw_impl_client_destroy(struct pw_impl_client *client);
109 
111 int pw_impl_client_register(struct pw_impl_client *client,
112  struct pw_properties *properties);
113 
115 void *pw_impl_client_get_user_data(struct pw_impl_client *client);
116 
118 const struct pw_client_info *pw_impl_client_get_info(struct pw_impl_client *client);
119 
121 int pw_impl_client_update_properties(struct pw_impl_client *client, const struct spa_dict *dict);
122 
124 int pw_impl_client_update_permissions(struct pw_impl_client *client, uint32_t n_permissions,
125  const struct pw_permission *permissions);
126 
129  uint32_t global_id, uint32_t permissions);
130 
132 const struct pw_properties *pw_impl_client_get_properties(struct pw_impl_client *client);
133 
138 
141 
143 struct pw_resource *pw_impl_client_find_resource(struct pw_impl_client *client, uint32_t id);
144 
146 struct pw_global *pw_impl_client_get_global(struct pw_impl_client *client);
147 
150 
152 void pw_impl_client_add_listener(struct pw_impl_client *client,
153  struct spa_hook *listener,
154  const struct pw_impl_client_events *events,
155  void *data);
156 
157 
160 void pw_impl_client_set_busy(struct pw_impl_client *client, bool busy);
161 
166 #ifdef __cplusplus
167 }
168 #endif
169 
170 #endif /* PIPEWIRE_IMPL_CLIENT_H */
pipewire/global.h
struct pw_mempool * pw_impl_client_get_mempool(struct pw_impl_client *client)
Get the mempool associated with this client, Since 0.3.74.
Definition: impl-client.c:602
void pw_impl_client_destroy(struct pw_impl_client *client)
Destroy a previously created client.
Definition: impl-client.c:660
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:687
void pw_impl_client_set_busy(struct pw_impl_client *client, bool busy)
Mark the client busy.
Definition: impl-client.c:790
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:572
const struct pw_client_info * pw_impl_client_get_info(struct pw_impl_client *client)
Get the client information.
Definition: impl-client.c:696
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:800
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:430
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:720
struct pw_resource * pw_impl_client_get_core_resource(struct pw_impl_client *client)
Get the client core resource.
Definition: impl-client.c:584
void * pw_impl_client_get_user_data(struct pw_impl_client *client)
Get the client user data.
Definition: impl-client.c:614
const struct pw_properties * pw_impl_client_get_properties(struct pw_impl_client *client)
Get the client properties.
Definition: impl-client.c:608
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:578
int pw_impl_client_register(struct pw_impl_client *client, struct pw_properties *properties)
Finish configuration and register a client.
Definition: impl-client.c:518
int pw_impl_client_update_properties(struct pw_impl_client *client, const struct spa_dict *dict)
Update the client properties.
Definition: impl-client.c:712
struct pw_global * pw_impl_client_get_global(struct pw_impl_client *client)
Get the global associated with this client.
Definition: impl-client.c:596
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:590
spa/utils/hook.h
pipewire/permission.h
pipewire/properties.h
pipewire/resource.h
pipewire/context.h
The client information.
Definition: client.h:46
Definition: context.h:47
The events that a client can emit.
Definition: impl-client.h:77
void(* busy_changed)(void *data, bool busy)
emitted when the client becomes busy processing an asynchronous message.
Definition: impl-client.h:103
uint32_t version
Definition: impl-client.h:80
void(* initialized)(void *data)
the client is initialized
Definition: impl-client.h:89
void(* resource_added)(void *data, struct pw_resource *resource)
emitted when a new resource is added for client
Definition: impl-client.h:95
void(* info_changed)(void *data, const struct pw_client_info *info)
emitted when the client info changed
Definition: impl-client.h:92
void(* destroy)(void *data)
emitted when the client is destroyed
Definition: impl-client.h:83
void(* free)(void *data)
emitted right before the client is freed
Definition: impl-client.h:86
void(* resource_removed)(void *data, struct pw_resource *resource)
emitted when a resource is removed
Definition: impl-client.h:98
A memory pool is a collection of pw_memblocks.
Definition: mem.h:57
Definition: permission.h:69
Definition: properties.h:33
Definition: impl.h:29
Definition: dict.h:39
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:350