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_HELLO 0 70 #define PW_CORE_PROXY_METHOD_UPDATE_TYPES 1 71 #define PW_CORE_PROXY_METHOD_SYNC 2 72 #define PW_CORE_PROXY_METHOD_GET_REGISTRY 3 73 #define PW_CORE_PROXY_METHOD_CLIENT_UPDATE 4 74 #define PW_CORE_PROXY_METHOD_PERMISSIONS 5 75 #define PW_CORE_PROXY_METHOD_CREATE_OBJECT 6 76 #define PW_CORE_PROXY_METHOD_NUM 7 81 #define PW_CORE_PROXY_PERMISSIONS_DEFAULT "permissions.default" 88 #define PW_CORE_PROXY_PERMISSIONS_GLOBAL "permissions.global" 96 #define PW_CORE_PROXY_PERMISSIONS_EXISTING "permissions.existing" 98 #define PW_LINK_OUTPUT_NODE_ID "link.output_node.id" 99 #define PW_LINK_OUTPUT_PORT_ID "link.output_port.id" 100 #define PW_LINK_INPUT_NODE_ID "link.input_node.id" 101 #define PW_LINK_INPUT_PORT_ID "link.input_port.id" 112 #define PW_VERSION_CORE_PROXY_METHODS 0 141 void (*
sync) (
void *object, uint32_t seq);
181 const char *factory_name,
184 const struct spa_dict *props,
189 pw_core_proxy_hello(
struct pw_core_proxy *core)
195 pw_core_proxy_update_types(
struct pw_core_proxy *core, uint32_t first_id,
const char **types, uint32_t n_types)
201 pw_core_proxy_sync(
struct pw_core_proxy *core, uint32_t seq)
206 static inline struct pw_registry_proxy *
207 pw_core_proxy_get_registry(
struct pw_core_proxy *core, uint32_t type, uint32_t version,
size_t user_data_size)
211 return (
struct pw_registry_proxy *) p;
215 pw_core_proxy_client_update(
struct pw_core_proxy *core,
const struct spa_dict *props)
221 pw_core_proxy_permissions(
struct pw_core_proxy *core,
const struct spa_dict *props)
227 pw_core_proxy_create_object(
struct pw_core_proxy *core,
228 const char *factory_name,
231 const struct spa_dict *props,
232 size_t user_data_size)
240 #define PW_CORE_PROXY_EVENT_UPDATE_TYPES 0 241 #define PW_CORE_PROXY_EVENT_DONE 1 242 #define PW_CORE_PROXY_EVENT_ERROR 2 243 #define PW_CORE_PROXY_EVENT_REMOVE_ID 3 244 #define PW_CORE_PROXY_EVENT_INFO 4 245 #define PW_CORE_PROXY_EVENT_NUM 5 252 #define PW_VERSION_CORE_PROXY_EVENTS 0 274 void (*
done) (
void *object, uint32_t seq);
287 void (*
error) (
void *object, uint32_t id,
int res,
const char *
error, ...);
308 pw_core_proxy_add_listener(
struct pw_core_proxy *core,
309 struct spa_hook *listener,
317 #define pw_core_resource_update_types(r,...) pw_resource_notify(r,struct pw_core_proxy_events,update_types,__VA_ARGS__) 318 #define pw_core_resource_done(r,...) pw_resource_notify(r,struct pw_core_proxy_events,done,__VA_ARGS__) 319 #define pw_core_resource_error(r,...) pw_resource_notify(r,struct pw_core_proxy_events,error,__VA_ARGS__) 320 #define pw_core_resource_remove_id(r,...) pw_resource_notify(r,struct pw_core_proxy_events,remove_id,__VA_ARGS__) 321 #define pw_core_resource_info(r,...) pw_resource_notify(r,struct pw_core_proxy_events,info,__VA_ARGS__) 324 #define PW_VERSION_REGISTRY 0 357 #define PW_REGISTRY_PROXY_METHOD_BIND 0 358 #define PW_REGISTRY_PROXY_METHOD_NUM 1 362 #define PW_VERSION_REGISTRY_PROXY_METHODS 0 376 void (*
bind) (
void *object, uint32_t id, uint32_t type, uint32_t
version, uint32_t new_id);
381 pw_registry_proxy_bind(
struct pw_registry_proxy *registry,
382 uint32_t
id, uint32_t type, uint32_t version,
383 size_t user_data_size)
391 #define PW_REGISTRY_PROXY_EVENT_GLOBAL 0 392 #define PW_REGISTRY_PROXY_EVENT_GLOBAL_REMOVE 1 393 #define PW_REGISTRY_PROXY_EVENT_NUM 2 397 #define PW_VERSION_REGISTRY_PROXY_EVENTS 0 412 void (*
global) (
void *object, uint32_t id, uint32_t parent_id,
413 uint32_t permissions, uint32_t type, uint32_t
version,
414 const struct spa_dict *props);
428 pw_registry_proxy_add_listener(
struct pw_registry_proxy *registry,
429 struct spa_hook *listener,
436 #define pw_registry_resource_global(r,...) pw_resource_notify(r,struct pw_registry_proxy_events,global,__VA_ARGS__) 437 #define pw_registry_resource_global_remove(r,...) pw_resource_notify(r,struct pw_registry_proxy_events,global_remove,__VA_ARGS__) 440 #define PW_VERSION_MODULE 0 442 #define PW_MODULE_PROXY_EVENT_INFO 0 443 #define PW_MODULE_PROXY_EVENT_NUM 1 447 #define PW_VERSION_MODULE_PROXY_EVENTS 0 458 pw_module_proxy_add_listener(
struct pw_module_proxy *module,
459 struct spa_hook *listener,
466 #define pw_module_resource_info(r,...) pw_resource_notify(r,struct pw_module_proxy_events,info,__VA_ARGS__) 468 #define PW_VERSION_NODE 0 470 #define PW_NODE_PROXY_EVENT_INFO 0 471 #define PW_NODE_PROXY_EVENT_NUM 1 475 #define PW_VERSION_NODE_PROXY_EVENTS 0 486 pw_node_proxy_add_listener(
struct pw_node_proxy *node,
487 struct spa_hook *listener,
494 #define pw_node_resource_info(r,...) pw_resource_notify(r,struct pw_node_proxy_events,info,__VA_ARGS__) 496 #define PW_VERSION_FACTORY 0 498 #define PW_FACTORY_PROXY_EVENT_INFO 0 499 #define PW_FACTORY_PROXY_EVENT_NUM 1 503 #define PW_VERSION_FACTORY_PROXY_EVENTS 0 515 pw_factory_proxy_add_listener(
struct pw_factory_proxy *factory,
516 struct spa_hook *listener,
523 #define pw_factory_resource_info(r,...) pw_resource_notify(r,struct pw_factory_proxy_events,info,__VA_ARGS__) 525 #define PW_VERSION_CLIENT 0 527 #define PW_CLIENT_PROXY_EVENT_INFO 0 528 #define PW_CLIENT_PROXY_EVENT_NUM 1 532 #define PW_VERSION_CLIENT_PROXY_EVENTS 0 544 pw_client_proxy_add_listener(
struct pw_client_proxy *client,
545 struct spa_hook *listener,
552 #define pw_client_resource_info(r,...) pw_resource_notify(r,struct pw_client_proxy_events,info,__VA_ARGS__) 555 #define PW_VERSION_LINK 0 557 #define PW_LINK_PROXY_EVENT_INFO 0 558 #define PW_LINK_PROXY_EVENT_NUM 1 562 #define PW_VERSION_LINK_PROXY_EVENTS 0 574 pw_link_proxy_add_listener(
struct pw_link_proxy *link,
575 struct spa_hook *listener,
582 #define pw_link_resource_info(r,...) pw_resource_notify(r,struct pw_link_proxy_events,info,__VA_ARGS__) void(* update_types)(void *object, uint32_t first_id, const char **types, uint32_t n_types)
Update the type map.
Definition: interfaces.h:263
uint32_t version
Definition: interfaces.h:448
uint32_t version
Definition: interfaces.h:533
void(* bind)(void *object, uint32_t id, uint32_t type, uint32_t version, uint32_t new_id)
Bind to a global object.
Definition: interfaces.h:376
void(* global)(void *object, uint32_t id, uint32_t parent_id, uint32_t permissions, uint32_t type, uint32_t version, const struct spa_dict *props)
Notify of a new global object.
Definition: interfaces.h:412
void(* client_update)(void *object, const struct spa_dict *props)
Update the client properties.
Definition: interfaces.h:155
Module events.
Definition: interfaces.h:446
void(* get_registry)(void *object, uint32_t version, uint32_t new_id)
Get the registry object.
Definition: interfaces.h:150
void(* info)(void *object, struct pw_module_info *info)
Notify module info.
Definition: interfaces.h:454
uint32_t version
Definition: interfaces.h:563
The core information.
Definition: introspect.h:76
void(* hello)(void *object)
Start a conversation with the server.
Definition: interfaces.h:118
void(* permissions)(void *object, const struct spa_dict *props)
Manage the permissions of the global objects.
Definition: interfaces.h:168
uint32_t version
Definition: interfaces.h:398
Factory events.
Definition: interfaces.h:502
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
Node events.
Definition: interfaces.h:474
#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
void(* remove_id)(void *object, uint32_t id)
Remove an object ID.
Definition: interfaces.h:298
uint32_t version
Definition: interfaces.h:363
void(* error)(void *object, uint32_t id, int res, const char *error,...)
Fatal error event.
Definition: interfaces.h:287
The client information.
Definition: introspect.h:125
Link events.
Definition: interfaces.h:561
void(* info)(void *object, struct pw_factory_info *info)
Notify factory info.
Definition: interfaces.h:510
void(* info)(void *object, struct pw_client_info *info)
Notify client info.
Definition: interfaces.h:539
uint32_t version
Definition: interfaces.h:476
void(* done)(void *object, uint32_t seq)
Emit a done event.
Definition: interfaces.h:274
void(* global_remove)(void *object, uint32_t id)
Notify of a global object removal.
Definition: interfaces.h:424
Core events
Definition: interfaces.h:251
uint32_t version
Definition: interfaces.h:504
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:180
The module information.
Definition: introspect.h:103
Client events.
Definition: interfaces.h:531
uint32_t version
Definition: interfaces.h:113
struct pw_proxy * pw_proxy_new(struct pw_proxy *factory, uint32_t type, size_t user_data_size)
Create a proxy object with a given id and type.
Definition: proxy.c:46
void(* info)(void *object, struct pw_link_info *info)
Notify link info.
Definition: interfaces.h:569
uint32_t version
Definition: interfaces.h:253
Registry methods.
Definition: interfaces.h:361
void(* info)(void *object, struct pw_core_info *info)
Notify new core info.
Definition: interfaces.h:304
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:128
void(* info)(void *object, struct pw_node_info *info)
Notify node info.
Definition: interfaces.h:482
Core methods.
Definition: interfaces.h:111
Registry events.
Definition: interfaces.h:396
void(* sync)(void *object, uint32_t seq)
Do server roundtrip.
Definition: interfaces.h:141