Wp.Plugin

Subclasses:

None

Methods

Inherited:

Wp.Object (12), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	find (core, plugin_name)
	get_name ()

Virtual Methods

Inherited:

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

	do_disable ()
	do_enable (transition)

Properties

Inherited:

Wp.Object (4)

Name	Type	Flags	Short Description
name	str	r/w/co	The name of this plugin

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent_instance	Wp.Object	r

Class Details

class Wp.Plugin(**kwargs)

Bases:

Wp.Object

Abstract:

Yes

Structure:

Wp.PluginClass

Wp.Plugin is a base class for objects that provide functionality to the WirePlumber daemon. Typically, a plugin is created within a module and then registered to make it available for use by the daemon. The daemon is responsible for calling Wp.Object.activate() on it after all modules have been loaded, the core is connected and the initial discovery of global objects is done. Being a Wp.Object subclass, the plugin inherits Wp.Object's activation system. For most implementations, there is only need for activating one feature, Wp.PluginFeatures.ENABLED, and this can be done by implementing only WpPluginClass::enable() and WpPluginClass::disable(). For more advanced plugins that need to have more features, you may implement directly the functions of Wp.ObjectClass and ignore the ones of Wp.PluginClass.

classmethod find(core, plugin_name)

Parameters:

• core (Wp.Core) – the core

• plugin_name (str) – the lookup name

Returns:

the plugin matching the lookup name

Return type:

Wp.Plugin or None

Looks up a plugin.

get_name()

Returns:

the name of this plugin

Return type:

str

Retreives the name of a plugin.

do_disable() virtual

do_enable(transition) virtual

Parameters:

transition (Wp.Transition) –

Property Details

Wp.Plugin.props.name

Name:

name

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The name of this plugin