Wp.ImplModule¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class

load (core, name, arguments, properties)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`arguments`	`str`	r/w/co	The arguments to provide to the module while loading
`core`	`int`	r/w/co	The WirePlumber core
`name`	`str`	r/w/co	The name of the PipeWire module
`properties`	`Wp.Properties`	r/w	Properties of the module
`pw-impl-module`	`int`	r	Pointer to the underlying pw_impl_module structure for the module

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Wp.ImplModule(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Wp.ImplModuleClass

Used to load PipeWire modules within the WirePlumber process. This is slightly different from other objects in that the module is not exported to PipeWire, but it may create an export objects itself.

New in version 0.4.2.

classmethod load(core, name, arguments, properties)¶

Parameters:

core (Wp.Core) – The WirePlumber core
name (str) – the name of the module to load
arguments (str or None) – arguments to be passed to the module
properties (Wp.Properties or None) – additional properties to be provided to the module

Returns:

the Wp.ImplModule for the module that was loaded on success, None on failure.

Return type:

Wp.ImplModule or None

Loads a PipeWire module into the WirePlumber process.

New in version 0.4.2.

Property Details¶

Wp.ImplModule.props.arguments¶

Name:: arguments
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The arguments to provide to the module while loading

Wp.ImplModule.props.core¶

Name:: core
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The WirePlumber core

Wp.ImplModule.props.name¶

Name:: name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The name of the PipeWire module

Wp.ImplModule.props.properties¶

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

Properties of the module

Wp.ImplModule.props.pw_impl_module¶

Name:: pw-impl-module
Type:: int
Default Value:: None
Flags:: READABLE

Pointer to the underlying pw_impl_module structure for the module