PipeWire Object Proxy

WpProxy

GObject
    ╰──WpObject
        ╰──WpProxy
            ╰──WpGlobalProxy
            ╰──WpImplNode
            ╰──WpSpaDevice

Base class for all objects that expose PipeWire objects using pw_proxy underneath.

This base class cannot be instantiated. It provides handling of pw_proxy's events and exposes common functionality.

Members

parent_instance (WpObject) –
No description available

Class structure

WpProxyClass

Fields
parent_class (WpObjectClass) –
No description available
pw_iface_type (const gchar*) –

the PipeWire type of the interface that is being proxied by this class (ex. PW_TYPE_INTERFACE_Node for WpNode)

pw_iface_version (guint32) –

the PipeWire version of the interface that is being proxied by this class


Methods

wp_proxy_get_bound_id

guint32
wp_proxy_get_bound_id (WpProxy * self)

Returns the bound id, which is the id that this object has on the pipewire registry (a.k.a. the global id). The object must have the WP_PROXY_FEATURE_BOUND feature before this method can be called.

Parameters:

self

the proxy

Returns

the bound id of this object


wp_proxy_get_interface_type

const gchar*
wp_proxy_get_interface_type (WpProxy * self,
                             guint32* version)

Parameters:

self

the proxy

version ( [out][optional])

the version of the interface

Returns

the PipeWire type of the interface that is being proxied


wp_proxy_get_pw_proxy

pw_proxy*
wp_proxy_get_pw_proxy (WpProxy * self)

Parameters:

self
No description available
Returns

a pointer to the underlying pw_proxy object


wp_proxy_set_pw_proxy

wp_proxy_set_pw_proxy (WpProxy * self,
                       pw_proxy* proxy)

Private method to be used by subclasses to set the pw_proxy pointer when it is available. This can be called only if there is no pw_proxy already set. Takes ownership of proxy.

Parameters:

self
No description available
proxy
No description available

Signals

bound

bound_callback (WpProxy * self,
                guint object,
                gpointer user_data)

Parameters:

self
No description available
object
No description available
user_data
No description available

Flags: Run First


pw-proxy-created

pw_proxy_created_callback (WpProxy * self,
                           gpointer object,
                           gpointer user_data)

Parameters:

self
No description available
object
No description available
user_data
No description available

Flags: Run First


pw-proxy-destroyed

pw_proxy_destroyed_callback (WpProxy * self,
                             gpointer user_data)

Parameters:

self
No description available
user_data
No description available

Flags: Run First


Properties

bound-id

“bound-id” guint

Flags : Read


pw-proxy

“pw-proxy” gpointer

Flags : Read


Virtual Methods

bound

bound (WpProxy * self,
       guint32 id)

Parameters:

self
No description available
id
No description available

pw_proxy_created

pw_proxy_created (WpProxy * self,
                  pw_proxy* proxy)

Parameters:

self
No description available
proxy
No description available

pw_proxy_destroyed

pw_proxy_destroyed (WpProxy * self)

Parameters:

self
No description available

Enumerations

WpProxyFeatures

Flags to be used as WpObjectFeatures for WpProxy subclasses.

Members
WP_PROXY_FEATURE_BOUND (1) –
No description available
WP_PIPEWIRE_OBJECT_FEATURE_INFO (16) –
No description available
WP_PIPEWIRE_OBJECT_FEATURE_PARAM_PROPS (32) –
No description available
WP_PIPEWIRE_OBJECT_FEATURE_PARAM_FORMAT (64) –
No description available
WP_PIPEWIRE_OBJECT_FEATURE_PARAM_PROFILE (128) –
No description available
WP_PIPEWIRE_OBJECT_FEATURE_PARAM_PORT_CONFIG (256) –
No description available
WP_PIPEWIRE_OBJECT_FEATURE_PARAM_ROUTE (512) –
No description available

Constants

WP_TYPE_PROXY

#define WP_TYPE_PROXY (wp_proxy_get_type ())

The WpProxy GType


The results of the search are