PipeWire  0.3.66
global.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_GLOBAL_H
6 #define PIPEWIRE_GLOBAL_H
7 
8 #ifdef __cplusplus
9 extern "C" {
10 #endif
11 
37 struct pw_global;
38 
39 #include <pipewire/impl.h>
40 
41 typedef int (*pw_global_bind_func_t) (void *object,
42  struct pw_impl_client *client,
43  uint32_t permissions,
44  uint32_t version,
45  uint32_t id );
46 
48 struct pw_global_events {
49 #define PW_VERSION_GLOBAL_EVENTS 0
50  uint32_t version;
51 
53  void (*destroy) (void *data);
55  void (*free) (void *data);
57  void (*permissions_changed) (void *data,
58  struct pw_impl_client *client,
59  uint32_t old_permissions,
60  uint32_t new_permissions);
61 };
62 
64 struct pw_global *
65 pw_global_new(struct pw_context *context,
66  const char *type,
67  uint32_t version,
68  struct pw_properties *properties,
70  void *object );
71 
73 int pw_global_register(struct pw_global *global);
74 
76 void pw_global_add_listener(struct pw_global *global,
77  struct spa_hook *listener,
78  const struct pw_global_events *events,
79  void *data);
80 
82 uint32_t pw_global_get_permissions(struct pw_global *global, struct pw_impl_client *client);
83 
85 struct pw_context *pw_global_get_context(struct pw_global *global);
86 
88 const char *pw_global_get_type(struct pw_global *global);
89 
91 bool pw_global_is_type(struct pw_global *global, const char *type);
92 
94 uint32_t pw_global_get_version(struct pw_global *global);
95 
97 const struct pw_properties *pw_global_get_properties(struct pw_global *global);
98 
100 int pw_global_update_keys(struct pw_global *global,
101  const struct spa_dict *dict, const char * const keys[]);
102 
105 void *pw_global_get_object(struct pw_global *global);
106 
108 uint32_t pw_global_get_id(struct pw_global *global);
109 
111 uint64_t pw_global_get_serial(struct pw_global *global);
112 
114 int pw_global_add_resource(struct pw_global *global, struct pw_resource *resource);
115 
120 int pw_global_for_each_resource(struct pw_global *global,
121  int (*callback) (void *data, struct pw_resource *resource),
122  void *data);
123 
125 int pw_global_bind(struct pw_global *global,
126  struct pw_impl_client *client,
127  uint32_t permissions,
128  uint32_t version,
129  uint32_t id);
130 
131 int pw_global_update_permissions(struct pw_global *global, struct pw_impl_client *client,
132  uint32_t old_permissions, uint32_t new_permissions);
133 
135 void pw_global_destroy(struct pw_global *global);
136 
141 #ifdef __cplusplus
142 }
143 #endif
144 
145 #endif /* PIPEWIRE_GLOBAL_H */
int pw_global_bind(struct pw_global *global, struct pw_impl_client *client, uint32_t permissions, uint32_t version, uint32_t id)
Let a client bind to a global.
Definition: global.c:294
const char * pw_global_get_type(struct pw_global *global)
Get the global type.
Definition: global.c:202
uint32_t pw_global_get_permissions(struct pw_global *global, struct pw_impl_client *client)
Get the permissions of the global for a given client.
Definition: global.c:26
int(* pw_global_bind_func_t)(void *object, struct pw_impl_client *client, uint32_t permissions, uint32_t version, uint32_t id)
Definition: global.h:46
uint64_t pw_global_get_serial(struct pw_global *global)
Get the serial number of the global.
Definition: global.c:101
struct pw_global * pw_global_new(struct pw_context *context, const char *type, uint32_t version, struct pw_properties *properties, pw_global_bind_func_t func, void *object)
Create a new global object.
Definition: global.c:47
uint32_t pw_global_get_version(struct pw_global *global)
Get the global version.
Definition: global.c:214
void pw_global_add_listener(struct pw_global *global, struct spa_hook *listener, const struct pw_global_events *events, void *data)
Add an event listener on the global.
Definition: global.c:272
uint32_t pw_global_get_id(struct pw_global *global)
Get the unique id of the global.
Definition: global.c:241
void pw_global_destroy(struct pw_global *global)
Destroy a global.
Definition: global.c:386
int pw_global_for_each_resource(struct pw_global *global, int(*callback)(void *data, struct pw_resource *resource), void *data)
Iterate all resources added to the global The callback should return 0 to fetch the next item,...
Definition: global.c:258
int pw_global_update_permissions(struct pw_global *global, struct pw_impl_client *client, uint32_t old_permissions, uint32_t new_permissions)
Definition: global.c:331
int pw_global_add_resource(struct pw_global *global, struct pw_resource *resource)
Add a resource to a global.
Definition: global.c:247
const struct pw_properties * pw_global_get_properties(struct pw_global *global)
Get the global properties.
Definition: global.c:220
struct pw_context * pw_global_get_context(struct pw_global *global)
Get the context object of this global.
Definition: global.c:196
void * pw_global_get_object(struct pw_global *global)
Get the object associated with the global.
Definition: global.c:235
bool pw_global_is_type(struct pw_global *global, const char *type)
Check a global type.
Definition: global.c:208
int pw_global_update_keys(struct pw_global *global, const struct spa_dict *dict, const char *const keys[])
Update the global properties, must be done when unregistered.
Definition: global.c:226
int pw_global_register(struct pw_global *global)
Register a global object to the context registry.
Definition: global.c:118
pipewire/impl.h
Global events, use pw_global_add_listener.
Definition: global.h:53
void(* free)(void *data)
The global is freed.
Definition: global.h:61
void(* destroy)(void *data)
The global is destroyed.
Definition: global.h:59
uint32_t version
Definition: global.h:56
void(* permissions_changed)(void *data, struct pw_impl_client *client, uint32_t old_permissions, uint32_t new_permissions)
The permissions changed for a client.
Definition: global.h:63
Definition: src/pipewire/context.h:47
Definition: properties.h:33
struct spa_dict dict
dictionary of key/values
Definition: properties.h:34
Definition: impl.h:29
Definition: utils/dict.h:39
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:331