WirePlumber Daemon Plugins

WpPlugin 

GObject
    ╰──WpPlugin

WpPlugin 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 activate() after all modules have been loaded, the core is connected and the initial discovery of global objects is done.

Members

parent_instance (GObject) –
No description available

Class structure

WpPluginClass

Fields
parent_class (GObjectClass) –
No description available

Wp.PluginClass

Attributes
parent_class (GObject.ObjectClass) –
No description available

Wp.PluginClass

Attributes
parent_class (GObject.ObjectClass) –
No description available

WpPlugin 

GObject
    ╰──WpPlugin

WpPlugin 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 activate() after all modules have been loaded, the core is connected and the initial discovery of global objects is done.

Members

parent_instance (GObject) –
No description available

WpPlugin 

GObject
    ╰──WpPlugin

WpPlugin 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 activate() after all modules have been loaded, the core is connected and the initial discovery of global objects is done.

Members

parent_instance (GObject) –
No description available

Methods

wp_plugin_activate 

wp_plugin_activate (WpPlugin * self)

Activates the plugin. The plugin is required to start any operations only when this method is called and not before.

Parameters:

self –

the plugin

Wp.Plugin.activate 

def Wp.Plugin.activate (self):
    #python wrapper for 'wp_plugin_activate'

Activates the plugin. The plugin is required to start any operations only when this method is called and not before.

Parameters:

self ( Wp.Plugin ) –

the plugin

Wp.Plugin.prototype.activate 

function Wp.Plugin.prototype.activate(): {
    // javascript wrapper for 'wp_plugin_activate'
}

Activates the plugin. The plugin is required to start any operations only when this method is called and not before.

Parameters:

self ( Wp.Plugin ) –

the plugin

wp_plugin_deactivate 

wp_plugin_deactivate (WpPlugin * self)

Deactivates the plugin. The plugin is required to stop all operations and release all resources associated with it.

Parameters:

self –

the plugin

Wp.Plugin.deactivate 

def Wp.Plugin.deactivate (self):
    #python wrapper for 'wp_plugin_deactivate'

Deactivates the plugin. The plugin is required to stop all operations and release all resources associated with it.

Parameters:

self ( Wp.Plugin ) –

the plugin

Wp.Plugin.prototype.deactivate 

function Wp.Plugin.prototype.deactivate(): {
    // javascript wrapper for 'wp_plugin_deactivate'
}

Deactivates the plugin. The plugin is required to stop all operations and release all resources associated with it.

Parameters:

self ( Wp.Plugin ) –

the plugin

wp_plugin_get_core 

WpCore *
wp_plugin_get_core (WpPlugin * self)

Parameters:

self –

the plugin

Returns ( [transfer: full] ) –

the core associated with this plugin

Wp.Plugin.get_core 

def Wp.Plugin.get_core (self):
    #python wrapper for 'wp_plugin_get_core'

Parameters:

self ( Wp.Plugin ) –

the plugin

Returns ( Wp.Core ) –

the core associated with this plugin

Wp.Plugin.prototype.get_core 

function Wp.Plugin.prototype.get_core(): {
    // javascript wrapper for 'wp_plugin_get_core'
}

Parameters:

self ( Wp.Plugin ) –

the plugin

Returns ( Wp.Core ) –

the core associated with this plugin

wp_plugin_get_module 

WpModule *
wp_plugin_get_module (WpPlugin * self)

Parameters:

self –

the plugin

Returns ( [transfer: full] ) –

the module associated with this plugin

Wp.Plugin.get_module 

def Wp.Plugin.get_module (self):
    #python wrapper for 'wp_plugin_get_module'

Parameters:

self ( Wp.Plugin ) –

the plugin

Returns ( Wp.Module ) –

the module associated with this plugin

Wp.Plugin.prototype.get_module 

function Wp.Plugin.prototype.get_module(): {
    // javascript wrapper for 'wp_plugin_get_module'
}

Parameters:

self ( Wp.Plugin ) –

the plugin

Returns ( Wp.Module ) –

the module associated with this plugin

wp_plugin_register 

wp_plugin_register (WpPlugin * plugin)

Registers the plugin to its associated core, making it available for use

Parameters:

plugin ( [transfer: full] ) –

the plugin

Wp.Plugin.register 

def Wp.Plugin.register (self):
    #python wrapper for 'wp_plugin_register'

Registers the plugin to its associated core, making it available for use

Parameters:

plugin ( Wp.Plugin ) –

the plugin

Wp.Plugin.prototype.register 

function Wp.Plugin.prototype.register(): {
    // javascript wrapper for 'wp_plugin_register'
}

Registers the plugin to its associated core, making it available for use

Parameters:

plugin ( Wp.Plugin ) –

the plugin

Properties

module 

“module” WpModule *

The module that created this plugin. Implementations should initialize this in the constructor.

Flags : Read / Write / Construct Only

module 

“self.props.module” Wp.Module

The module that created this plugin. Implementations should initialize this in the constructor.

Flags : Read / Write / Construct Only

module 

“module” Wp.Module

The module that created this plugin. Implementations should initialize this in the constructor.

Flags : Read / Write / Construct Only

Virtual Methods

activate 

activate (WpPlugin * self)

See wp_plugin_activate

Parameters:

self –
No description available

do_activate 

def do_activate (self):
    #python implementation of the 'activate' virtual method

See Wp.Plugin.activate

Parameters:

self ( Wp.Plugin ) –
No description available

vfunc_activate 

function vfunc_activate(self: Wp.Plugin): {
    // javascript implementation of the 'activate' virtual method
}

See Wp.Plugin.prototype.activate

Parameters:

self ( Wp.Plugin ) –
No description available

deactivate 

deactivate (WpPlugin * self)

See wp_plugin_deactivate

Parameters:

self –
No description available

do_deactivate 

def do_deactivate (self):
    #python implementation of the 'deactivate' virtual method

See Wp.Plugin.deactivate

Parameters:

self ( Wp.Plugin ) –
No description available

vfunc_deactivate 

function vfunc_deactivate(self: Wp.Plugin): {
    // javascript implementation of the 'deactivate' virtual method
}

See Wp.Plugin.prototype.deactivate

Parameters:

self ( Wp.Plugin ) –
No description available

Constants

WP_TYPE_PLUGIN 

#define WP_TYPE_PLUGIN (wp_plugin_get_type ())

The WpPlugin GType

The results of the search are