PipeWire  0.3.32
Registry

The registry object is a singleton object that keeps track of global objects on the PipeWire instance. More...

Data Structures

struct  pw_registry_events
 Registry events. More...
 
struct  pw_registry_methods
 Registry methods. More...
 

Macros

#define PW_REGISTRY_EVENT_GLOBAL   0
 
#define PW_REGISTRY_EVENT_GLOBAL_REMOVE   1
 
#define PW_REGISTRY_EVENT_NUM   2
 
#define PW_REGISTRY_METHOD_ADD_LISTENER   0
 
#define PW_REGISTRY_METHOD_BIND   1
 
#define PW_REGISTRY_METHOD_DESTROY   2
 
#define PW_REGISTRY_METHOD_NUM   3
 
#define pw_registry_method(o, method, version, ...)
 
#define pw_registry_add_listener(p, ...)   pw_registry_method(p,add_listener,0,__VA_ARGS__)
 Registry. More...
 
#define pw_registry_destroy(p, ...)   pw_registry_method(p,destroy,0,__VA_ARGS__)
 

Detailed Description

The registry object is a singleton object that keeps track of global objects on the PipeWire instance.

See also Global Object.

Global objects typically represent an actual object in PipeWire (for example, a module or node) or they are singleton objects such as the core.

When a client creates a registry object, the registry object will emit a global event for each global currently in the registry. Globals come and go as a result of device hotplugs or reconfiguration or other events, and the registry will send out global and global_remove events to keep the client up to date with the changes. To mark the end of the initial burst of events, the client can use the pw_core.sync methosd immediately after calling pw_core.get_registry.

A client can bind to a global object by using the bind request. This creates a client-side proxy that lets the object emit events to the client and lets the client invoke methods on the object. See Proxy

Clients can also change the permissions of the global objects that it can see. This is interesting when you want to configure a pipewire session before handing it to another application. You can, for example, hide certain existing or new objects or limit the access permissions on an object.

Macro Definition Documentation

◆ pw_registry_add_listener

#define pw_registry_add_listener (   p,
  ... 
)    pw_registry_method(p,add_listener,0,__VA_ARGS__)

Registry.

◆ pw_registry_destroy

#define pw_registry_destroy (   p,
  ... 
)    pw_registry_method(p,destroy,0,__VA_ARGS__)

◆ PW_REGISTRY_EVENT_GLOBAL

#define PW_REGISTRY_EVENT_GLOBAL   0

◆ PW_REGISTRY_EVENT_GLOBAL_REMOVE

#define PW_REGISTRY_EVENT_GLOBAL_REMOVE   1

◆ PW_REGISTRY_EVENT_NUM

#define PW_REGISTRY_EVENT_NUM   2

◆ pw_registry_method

#define pw_registry_method (   o,
  method,
  version,
  ... 
)
Value:
({ \
int _res = -ENOTSUP; \
spa_interface_call_res((struct spa_interface*)o, \
struct pw_registry_methods, _res, \
method, version, ##__VA_ARGS__); \
_res; \
})

◆ PW_REGISTRY_METHOD_ADD_LISTENER

#define PW_REGISTRY_METHOD_ADD_LISTENER   0

◆ PW_REGISTRY_METHOD_BIND

#define PW_REGISTRY_METHOD_BIND   1

◆ PW_REGISTRY_METHOD_DESTROY

#define PW_REGISTRY_METHOD_DESTROY   2

◆ PW_REGISTRY_METHOD_NUM

#define PW_REGISTRY_METHOD_NUM   3
spa_interface
Definition: hook.h:65
pw_registry_methods
Registry methods.
Definition: core.h:458