PipeWire Global Object Proxy

WpGlobalProxy

GObject
    ╰──WpObject
        ╰──WpProxy
            ╰──WpGlobalProxy
                ╰──WpClient
                ╰──WpDevice
                ╰──WpEndpoint
                ╰──WpEndpointLink
                ╰──WpLink
                ╰──WpMetadata
                ╰──WpNode
                ╰──WpPort
                ╰──WpSession

A proxy that represents a PipeWire global object, i.e. an object that is made available through the PipeWire registry.

Members

parent_instance (WpObject) –
No description available

Class structure

WpGlobalProxyClass

Fields
parent_class (WpProxyClass) –
No description available

Methods

wp_global_proxy_bind

gboolean
wp_global_proxy_bind (WpGlobalProxy * self)

Binds to the global and creates the underlying pw_proxy. This may only be called if there is no pw_proxy associated with this object yet.

This is mostly meant to be called internally. It will create the pw_proxy and will activate the WP_PROXY_FEATURE_BOUND feature.

Parameters:

self

the pipewire global

Returns

TRUE on success, FALSE if there is no global to bind to


wp_global_proxy_get_global_properties

WpProperties *
wp_global_proxy_get_global_properties (WpGlobalProxy * self)

Parameters:

self

the pipewire global

Returns ( [transfer: full])

the global (immutable) properties of this pipewire object


wp_global_proxy_get_permissions

guint32
wp_global_proxy_get_permissions (WpGlobalProxy * self)

Parameters:

self

the pipewire global

Returns

the permissions that wireplumber has on this object


wp_global_proxy_request_destroy

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::pw-proxy-destroyed signal will be emitted. If the server does not allow it, nothing will happen.

This is mostly useful for destroying WpLink and WpEndpointLink objects.

Parameters:

self

the pipewire global


Properties

global

“global” object*

Flags : Read / Write / Construct Only


global-properties

“global-properties” WpProperties *

Flags : Read


permissions

“permissions” guint

Flags : Read


Constants

WP_TYPE_GLOBAL_PROXY

#define WP_TYPE_GLOBAL_PROXY (wp_global_proxy_get_type ())

The WpGlobalProxy GType


The results of the search are