Wp.Proxy¶

Subclasses:: Wp.GlobalProxy, Wp.ImplNode, Wp.SpaDevice

Methods¶

Inherited:: Wp.Object (12), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`get_bound_id` ()
	`get_interface_type` ()
	`get_pw_proxy` ()
	`set_pw_proxy` (proxy)

Virtual Methods¶

Inherited:: Wp.Object (4), GObject.Object (7)

	`do_bound` (id)
	`do_error` (seq, res, message)
	`do_pw_proxy_created` (proxy)
	`do_pw_proxy_destroyed` ()

Properties¶

Inherited:: Wp.Object (4)

Name	Type	Flags	Short Description
`bound-id`	`int`	r	The id that this object has on the registry
`pw-proxy`	`int`	r	The struct pw_proxy *

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`bound`
`error`
`pw-proxy-created`
`pw-proxy-destroyed`

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Wp.Object`	r

Class Details¶

class Wp.Proxy(**kwargs)¶

Bases:: Wp.Object
Abstract:: Yes
Structure:: Wp.ProxyClass

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.

get_bound_id()¶

Returns:: the bound id of this object
Return type:: int

Returns the proxy bound id.

The bound id is the id that this object has on the PipeWire registry (a.k.a. the global id). The object must have the Wp.ProxyFeatures.PROXY_FEATURE_BOUND feature before this method can be called. Requires Wp.ProxyFeatures.PROXY_FEATURE_BOUND

get_interface_type()¶

Returns:

the PipeWire type of the interface that is being proxied

version:: the version of the interface

Return type:

(str, version: int)

Gets the interface type of the proxied object.

get_pw_proxy()¶

Returns:: a pointer to the underlying pw_proxy object
Return type:: object or None

Gets the pw_proxy wrapped by this proxy object.

set_pw_proxy(proxy)¶

Parameters:: proxy (object or None) –

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.

do_bound(id) virtual¶

Parameters:: id (int) –

do_error(seq, res, message) virtual¶

Parameters:

seq (int) –
res (int) –
message (str) –

do_pw_proxy_created(proxy) virtual¶

Parameters:: proxy (object or None) –

do_pw_proxy_destroyed() virtual¶

Signal Details¶

Wp.Proxy.signals.bound(proxy, object)¶

Signal Name:

bound

Flags:

RUN_FIRST

Parameters:

proxy (Wp.Proxy) – The object which received the signal
object (int) –

Wp.Proxy.signals.error(proxy, object, p0, p1)¶

Signal Name:

error

Flags:

RUN_FIRST

Parameters:

proxy (Wp.Proxy) – The object which received the signal
object (int) –
p0 (int) –
p1 (str) –

Wp.Proxy.signals.pw_proxy_created(proxy, object)¶

Signal Name:

pw-proxy-created

Flags:

RUN_FIRST

Parameters:

proxy (Wp.Proxy) – The object which received the signal
object (object or None) –

Wp.Proxy.signals.pw_proxy_destroyed(proxy)¶

Signal Name:: pw-proxy-destroyed
Flags:: RUN_FIRST
Parameters:: proxy (Wp.Proxy) – The object which received the signal

Property Details¶

Wp.Proxy.props.bound_id¶

Name:: bound-id
Type:: int
Default Value:: 0
Flags:: READABLE

The id that this object has on the registry

Wp.Proxy.props.pw_proxy¶

Name:: pw-proxy
Type:: int
Default Value:: None
Flags:: READABLE

The struct pw_proxy *