PipeWire Global Object Proxy¶
digraph inheritance { rankdir=LR; GObject -> WpObject; WpObject -> WpProxy; WpProxy -> WpGlobalProxy; }-
struct
WpGlobalProxy
¶ A proxy that represents a PipeWire global object, i.e. an object that is made available through the PipeWire registry.
GObject Properties
-
void
wp_global_proxy_request_destroy
(WpGlobalProxy * self)¶ Requests the PipeWire server to destroy the object represented by this proxy.
If the server allows it, the object will be destroyed and the WpProxy’s
pw-proxy-destroyed
signal will be emitted. If the server does not allow it, nothing will happen.This is mostly useful for destroying WpLink objects.
- Parameters
self
: the pipewire global
-
guint32
wp_global_proxy_get_permissions
(WpGlobalProxy * self)¶ Gets the permissions of a pipewire global.
- Return
- the permissions that wireplumber has on this object
- Parameters
self
: the pipewire global
-
WpProperties *
wp_global_proxy_get_global_properties
(WpGlobalProxy * self)¶ Gets the global properties of a pipewire global.
- Return
- (transfer full): the global (immutable) properties of this pipewire object
- Parameters
self
: the pipewire global
-
gboolean
wp_global_proxy_bind
(WpGlobalProxy * self)¶ Binds to the global and creates the underlying
pw_proxy
.This is mostly meant to be called internally. It will create the
pw_proxy
and will activate the WP_PROXY_FEATURE_BOUND feature.This may only be called if there is no
pw_proxy
associated with this object yet.- Return
- TRUE on success, FALSE if there is no global to bind to
- Parameters
self
: the pipewire global
-
WP_TYPE_GLOBAL_PROXY
(wp_global_proxy_get_type ())¶ The WpGlobalProxy GType.