PipeWire: global.h Source File

PipeWire 0.2.4

global.h
Go to the documentation of this file.
1 /* PipeWire
2 * Copyright (C) 2017 Wim Taymans <wim.taymans@gmail.com>
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
13 *
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
18 */
19
20 #ifndef __PIPEWIRE_GLOBAL_H__
21 #define __PIPEWIRE_GLOBAL_H__
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
52 struct pw_global;
53
54 #include <pipewire/core.h>
55 #include <pipewire/client.h>
56 #include <pipewire/properties.h>
57
59 struct pw_global_events {
60 #define PW_VERSION_GLOBAL_EVENTS 0
61 uint32_t version;
62
64 void (*destroy) (void *data);
65
67 void (*free) (void *data);
68
69 /* bind the global */
70 void (*bind) (void *data,
71 struct pw_client *client,
72 uint32_t permissions,
73 uint32_t version,
74 uint32_t id );
75 };
76
78 struct pw_global *
79 pw_global_new(struct pw_core *core,
80 uint32_t type,
81 uint32_t version,
82 struct pw_properties *properties,
83 void *object );
84
86 int pw_global_register(struct pw_global *global,
87 struct pw_client *owner,
88 struct pw_global *parent);
89
91 void pw_global_add_listener(struct pw_global *global,
92 struct spa_hook *listener,
93 const struct pw_global_events *events,
94 void *data);
95
97 uint32_t pw_global_get_permissions(struct pw_global *global, struct pw_client *client);
98
100 struct pw_core *pw_global_get_core(struct pw_global *global);
101
103 struct pw_client *pw_global_get_owner(struct pw_global *global);
104
106 struct pw_global *pw_global_get_parent(struct pw_global *global);
107
109 uint32_t pw_global_get_type(struct pw_global *global);
110
112 uint32_t pw_global_get_version(struct pw_global *global);
113
115 const struct pw_properties *pw_global_get_properties(struct pw_global *global);
116
119 void *pw_global_get_object(struct pw_global *global);
120
122 uint32_t pw_global_get_id(struct pw_global *global);
123
125 int pw_global_bind(struct pw_global *global,
126 struct pw_client *client,
127 uint32_t permissions,
128 uint32_t version,
129 uint32_t id);
130
132 void pw_global_destroy(struct pw_global *global);
133
134 #ifdef __cplusplus
135 }
136 #endif
137
138 #endif /* __PIPEWIRE_GLOBAL_H__ */
pw_properties
A collection of key/value pairs.
Definition: properties.h:38
pw_global_events::version
uint32_t version
Definition: global.h:61
pw_global_get_parent
struct pw_global * pw_global_get_parent(struct pw_global *global)
Get the parent of a global.
Definition: global.c:148
core.h
pw_core
the core PipeWire object
pw_global_get_version
uint32_t pw_global_get_version(struct pw_global *global)
Get the global version.
Definition: global.c:158
pw_global_get_type
uint32_t pw_global_get_type(struct pw_global *global)
Get the global type.
Definition: global.c:153
pw_global::pw_global_register
int pw_global_register(struct pw_global *global, struct pw_client *owner, struct pw_global *parent)
register a global to the core registry
Definition: global.c:99
pw_global_events::free
void(* free)(void *data)
The global is freed.
Definition: global.h:67
pw_global_get_id
uint32_t pw_global_get_id(struct pw_global *global)
Get the unique id of the global.
Definition: global.c:173
pw_global_add_listener
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:178
pw_global::pw_global_new
struct pw_global * pw_global_new(struct pw_core *core, uint32_t type, uint32_t version, struct pw_properties *properties, void *object)
Create a new global.
Definition: global.c:59
pw_global_events::destroy
void(* destroy)(void *data)
The global is destroyed.
Definition: global.h:64
pw_global::pw_global_bind
int pw_global_bind(struct pw_global *global, struct pw_client *client, uint32_t permissions, uint32_t version, uint32_t id)
Bind to a global.
Definition: global.c:200
pw_client
PipeWire client object class.
pw_global::pw_global_destroy
void pw_global_destroy(struct pw_global *global)
Destroy a global.
Definition: global.c:227
pw_global_get_permissions
uint32_t pw_global_get_permissions(struct pw_global *global, struct pw_client *client)
Get the permissions of the global for a given client.
Definition: global.c:36
pw_global_get_core
struct pw_core * pw_global_get_core(struct pw_global *global)
Get the core object of this global.
Definition: global.c:138
properties.h
pw_global_get_owner
struct pw_client * pw_global_get_owner(struct pw_global *global)
Get the owner of the global.
Definition: global.c:143
pw_global_events
Global events, use pw_global_add_listener.
Definition: global.h:59
pw_global
A global object visible to remote clients.
pw_global_get_object
void * pw_global_get_object(struct pw_global *global)
Get the object associated with the global.
Definition: global.c:168
pw_global_events::bind
void(* bind)(void *data, struct pw_client *client, uint32_t permissions, uint32_t version, uint32_t id)
Definition: global.h:70
pw_global_get_properties
const struct pw_properties * pw_global_get_properties(struct pw_global *global)
Get the global properties.
Definition: global.c:163
client.h