20 #ifndef __PIPEWIRE_INTERFACES_H__ 21 #define __PIPEWIRE_INTERFACES_H__ 27 #include <spa/utils/defs.h> 28 #include <spa/param/param.h> 29 #include <spa/node/node.h> 35 struct pw_registry_proxy;
36 struct pw_module_proxy;
38 struct pw_factory_proxy;
39 struct pw_client_proxy;
60 #define PW_TYPE_INTERFACE__Core PW_TYPE_INTERFACE_BASE "Core" 61 #define PW_TYPE_INTERFACE__Registry PW_TYPE_INTERFACE_BASE "Registry" 62 #define PW_TYPE_INTERFACE__Module PW_TYPE_INTERFACE_BASE "Module" 63 #define PW_TYPE_INTERFACE__Node PW_TYPE_INTERFACE_BASE "Node" 64 #define PW_TYPE_INTERFACE__Client PW_TYPE_INTERFACE_BASE "Client" 65 #define PW_TYPE_INTERFACE__Link PW_TYPE_INTERFACE_BASE "Link" 67 #define PW_VERSION_CORE 0 69 #define PW_CORE_PROXY_METHOD_UPDATE_TYPES 0 70 #define PW_CORE_PROXY_METHOD_SYNC 1 71 #define PW_CORE_PROXY_METHOD_GET_REGISTRY 2 72 #define PW_CORE_PROXY_METHOD_CLIENT_UPDATE 3 73 #define PW_CORE_PROXY_METHOD_CREATE_OBJECT 4 74 #define PW_CORE_PROXY_METHOD_CREATE_LINK 5 75 #define PW_CORE_PROXY_METHOD_NUM 6 86 #define PW_VERSION_CORE_PROXY_METHODS 0 110 void (*
sync) (
void *object, uint32_t seq);
137 const char *factory_name,
140 const struct spa_dict *props,
154 uint32_t output_node_id,
155 uint32_t output_port_id,
156 uint32_t input_node_id,
157 uint32_t input_port_id,
158 const struct spa_pod *filter,
159 const struct spa_dict *props,
164 pw_core_proxy_update_types(
struct pw_core_proxy *core, uint32_t first_id,
const char **types, uint32_t n_types)
170 pw_core_proxy_sync(
struct pw_core_proxy *core, uint32_t seq)
175 static inline struct pw_registry_proxy *
176 pw_core_proxy_get_registry(
struct pw_core_proxy *core, uint32_t type, uint32_t
version,
size_t user_data_size)
180 return (
struct pw_registry_proxy *) p;
184 pw_core_proxy_client_update(
struct pw_core_proxy *core,
const struct spa_dict *props)
190 pw_core_proxy_create_object(
struct pw_core_proxy *core,
191 const char *factory_name,
194 const struct spa_dict *props,
195 size_t user_data_size)
203 static inline struct pw_link_proxy *
204 pw_core_proxy_create_link(
struct pw_core_proxy *core,
206 uint32_t output_node_id,
207 uint32_t output_port_id,
208 uint32_t input_node_id,
209 uint32_t input_port_id,
210 const struct spa_pod *filter,
211 const struct spa_dict *prop,
212 size_t user_data_size)
217 return (
struct pw_link_proxy*) p;
221 #define PW_CORE_PROXY_EVENT_UPDATE_TYPES 0 222 #define PW_CORE_PROXY_EVENT_DONE 1 223 #define PW_CORE_PROXY_EVENT_ERROR 2 224 #define PW_CORE_PROXY_EVENT_REMOVE_ID 3 225 #define PW_CORE_PROXY_EVENT_INFO 4 226 #define PW_CORE_PROXY_EVENT_NUM 5 233 #define PW_VERSION_CORE_PROXY_EVENTS 0 255 void (*done) (
void *object, uint32_t seq);
268 void (*error) (
void *object, uint32_t id,
int res,
const char *
error, ...);
279 void (*remove_id) (
void *object, uint32_t id);
289 pw_core_proxy_add_listener(
struct pw_core_proxy *core,
290 struct spa_hook *listener,
298 #define pw_core_resource_update_types(r,...) pw_resource_notify(r,struct pw_core_proxy_events,update_types,__VA_ARGS__) 299 #define pw_core_resource_done(r,...) pw_resource_notify(r,struct pw_core_proxy_events,done,__VA_ARGS__) 300 #define pw_core_resource_error(r,...) pw_resource_notify(r,struct pw_core_proxy_events,error,__VA_ARGS__) 301 #define pw_core_resource_remove_id(r,...) pw_resource_notify(r,struct pw_core_proxy_events,remove_id,__VA_ARGS__) 302 #define pw_core_resource_info(r,...) pw_resource_notify(r,struct pw_core_proxy_events,info,__VA_ARGS__) 305 #define PW_VERSION_REGISTRY 0 333 #define PW_REGISTRY_PROXY_METHOD_BIND 0 334 #define PW_REGISTRY_PROXY_METHOD_NUM 1 338 #define PW_VERSION_REGISTRY_PROXY_METHODS 0 352 void (*bind) (
void *object, uint32_t id, uint32_t type, uint32_t
version, uint32_t new_id);
357 pw_registry_proxy_bind(
struct pw_registry_proxy *registry,
358 uint32_t
id, uint32_t type, uint32_t version,
359 size_t user_data_size)
367 #define PW_REGISTRY_PROXY_EVENT_GLOBAL 0 368 #define PW_REGISTRY_PROXY_EVENT_GLOBAL_REMOVE 1 369 #define PW_REGISTRY_PROXY_EVENT_NUM 2 373 #define PW_VERSION_REGISTRY_PROXY_EVENTS 0 387 void (*global) (
void *object, uint32_t id, uint32_t parent_id,
388 uint32_t permissions, uint32_t type, uint32_t
version);
398 void (*global_remove) (
void *object, uint32_t id);
402 pw_registry_proxy_add_listener(
struct pw_registry_proxy *registry,
403 struct spa_hook *listener,
410 #define pw_registry_resource_global(r,...) pw_resource_notify(r,struct pw_registry_proxy_events,global,__VA_ARGS__) 411 #define pw_registry_resource_global_remove(r,...) pw_resource_notify(r,struct pw_registry_proxy_events,global_remove,__VA_ARGS__) 414 #define PW_VERSION_MODULE 0 416 #define PW_MODULE_PROXY_EVENT_INFO 0 417 #define PW_MODULE_PROXY_EVENT_NUM 1 421 #define PW_VERSION_MODULE_PROXY_EVENTS 0 432 pw_module_proxy_add_listener(
struct pw_module_proxy *module,
433 struct spa_hook *listener,
440 #define pw_module_resource_info(r,...) pw_resource_notify(r,struct pw_module_proxy_events,info,__VA_ARGS__) 442 #define PW_VERSION_NODE 0 444 #define PW_NODE_PROXY_EVENT_INFO 0 445 #define PW_NODE_PROXY_EVENT_NUM 1 449 #define PW_VERSION_NODE_PROXY_EVENTS 0 460 pw_node_proxy_add_listener(
struct pw_node_proxy *node,
461 struct spa_hook *listener,
468 #define pw_node_resource_info(r,...) pw_resource_notify(r,struct pw_node_proxy_events,info,__VA_ARGS__) 470 #define PW_VERSION_FACTORY 0 472 #define PW_FACTORY_PROXY_EVENT_INFO 0 473 #define PW_FACTORY_PROXY_EVENT_NUM 1 477 #define PW_VERSION_FACTORY_PROXY_EVENTS 0 489 pw_factory_proxy_add_listener(
struct pw_factory_proxy *factory,
490 struct spa_hook *listener,
497 #define pw_factory_resource_info(r,...) pw_resource_notify(r,struct pw_factory_proxy_events,info,__VA_ARGS__) 499 #define PW_VERSION_CLIENT 0 501 #define PW_CLIENT_PROXY_EVENT_INFO 0 502 #define PW_CLIENT_PROXY_EVENT_NUM 1 506 #define PW_VERSION_CLIENT_PROXY_EVENTS 0 518 pw_client_proxy_add_listener(
struct pw_client_proxy *client,
519 struct spa_hook *listener,
526 #define pw_client_resource_info(r,...) pw_resource_notify(r,struct pw_client_proxy_events,info,__VA_ARGS__) 529 #define PW_VERSION_LINK 0 531 #define PW_LINK_PROXY_EVENT_INFO 0 532 #define PW_LINK_PROXY_EVENT_NUM 1 536 #define PW_VERSION_LINK_PROXY_EVENTS 0 548 pw_link_proxy_add_listener(
struct pw_link_proxy *link,
549 struct spa_hook *listener,
556 #define pw_link_resource_info(r,...) pw_resource_notify(r,struct pw_link_proxy_events,info,__VA_ARGS__) uint32_t version
Definition: interfaces.h:422
uint32_t version
Definition: interfaces.h:507
struct pw_proxy * pw_proxy_new(struct pw_proxy *factory, uint32_t type, size_t user_data_size)
Make a new proxy object.
void(* client_update)(void *object, const struct spa_dict *props)
Update the client properties.
Definition: interfaces.h:124
Module events.
Definition: interfaces.h:420
void(* get_registry)(void *object, uint32_t version, uint32_t new_id)
Get the registry object.
Definition: interfaces.h:119
void(* info)(void *object, struct pw_module_info *info)
Notify module info.
Definition: interfaces.h:428
uint32_t version
Definition: interfaces.h:537
The core information.
Definition: introspect.h:76
uint32_t version
Definition: interfaces.h:374
Factory events.
Definition: interfaces.h:476
Represents an object on the client side.
uint32_t pw_proxy_get_id(struct pw_proxy *proxy)
Get the local id of the proxy.
Definition: proxy.c:83
void(* create_link)(void *object, uint32_t output_node_id, uint32_t output_port_id, uint32_t input_node_id, uint32_t input_port_id, const struct spa_pod *filter, const struct spa_dict *props, uint32_t new_id)
Create a new link between two node ports.
Definition: interfaces.h:153
Node events.
Definition: interfaces.h:448
#define pw_proxy_do(p, type, method,...)
Definition: proxy.h:149
void pw_proxy_add_proxy_listener(struct pw_proxy *proxy, struct spa_hook *listener, const void *events, void *data)
Add a listener for the events received from the remote resource.
Definition: proxy.c:101
uint32_t version
Definition: interfaces.h:339
void(* error)(void *object, uint32_t id, int res, const char *error,...)
Fatal error event.
Definition: interfaces.h:268
The client information.
Definition: introspect.h:125
Link events.
Definition: interfaces.h:535
void(* info)(void *object, struct pw_factory_info *info)
Notify factory info.
Definition: interfaces.h:484
void(* info)(void *object, struct pw_client_info *info)
Notify client info.
Definition: interfaces.h:513
uint32_t version
Definition: interfaces.h:450
Core events.
Definition: interfaces.h:232
uint32_t version
Definition: interfaces.h:478
The link information.
Definition: introspect.h:192
The factory information.
Definition: introspect.h:174
void(* create_object)(void *object, const char *factory_name, uint32_t type, uint32_t version, const struct spa_dict *props, uint32_t new_id)
Create a new object on the PipeWire server from a factory.
Definition: interfaces.h:136
The module information.
Definition: introspect.h:103
Client events.
Definition: interfaces.h:505
uint32_t version
Definition: interfaces.h:87
void(* info)(void *object, struct pw_link_info *info)
Notify link info.
Definition: interfaces.h:543
uint32_t version
Definition: interfaces.h:234
Registry methods.
Definition: interfaces.h:337
void(* info)(void *object, struct pw_core_info *info)
Notify new core info.
Definition: interfaces.h:285
The node information.
Definition: introspect.h:142
void(* update_types)(void *object, uint32_t first_id, const char **types, uint32_t n_types)
Update the type map.
Definition: interfaces.h:97
void(* info)(void *object, struct pw_node_info *info)
Notify node info.
Definition: interfaces.h:456
Core methods.
Definition: interfaces.h:85
Registry events.
Definition: interfaces.h:372
void(* sync)(void *object, uint32_t seq)
Do server roundtrip.
Definition: interfaces.h:110