Wp.GlobalProxy¶

Subclasses:: Wp.Client, Wp.Device, Wp.Factory, Wp.Link, Wp.Metadata, Wp.Node, Wp.Port

Methods¶

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

	`bind` ()
	`get_global_properties` ()
	`get_permissions` ()
	`request_destroy` ()

Virtual Methods¶

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

Properties¶

Inherited:: Wp.Proxy (2), Wp.Object (4)

Name	Type	Flags	Short Description
`factory-name`	`str`	w/co	The factory name
`global-properties`	`Wp.Properties`	r/w/co	The pipewire global properties
`permissions`	`int`	r	The pipewire global permissions

Signals¶

Inherited:: Wp.Proxy (4), GObject.Object (1)

Fields¶

Inherited:: Wp.Proxy (4), GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Wp.Proxy`	r

Class Details¶

class Wp.GlobalProxy(**kwargs)¶

Bases:: Wp.Proxy
Abstract:: No
Structure:: Wp.GlobalProxyClass

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

bind()¶

Returns:: True on success, False if there is no global to bind to
Return type:: bool

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.ProxyFeatures.PROXY_FEATURE_BOUND feature. This may only be called if there is no pw_proxy associated with this object yet.

get_global_properties()¶

Returns:: the global (immutable) properties of this pipewire object
Return type:: Wp.Properties

Gets the global properties of a pipewire global.

get_permissions()¶

Returns:: the permissions that wireplumber has on this object
Return type:: int

Gets the permissions of a pipewire global.

request_destroy()¶

Requests the PipeWire server to destroy the object represented by this proxy.

If the server allows it, the object will be destroyed and the Wp.Proxy's pw-proxy-destroyed signal will be emitted. If the server does not allow it, nothing will happen. This is mostly useful for destroying Wp.Link objects.

Property Details¶

Wp.GlobalProxy.props.factory_name¶

Name:: factory-name
Type:: str
Default Value:: ''
Flags:: WRITABLE, CONSTRUCT_ONLY

The factory name

Wp.GlobalProxy.props.global_properties¶

Name:: global-properties
Type:: Wp.Properties
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The pipewire global properties

Wp.GlobalProxy.props.permissions¶

Name:: permissions
Type:: int
Default Value:: 0
Flags:: READABLE

The pipewire global permissions