Local Modules

The LocalModule object (which binds the WpImplModule C API) provides a way to load PipeWire modules in the WirePlumber process. Instantiating the object loads the module, and when the last reference to the returned module object is dropped, the module is unloaded.

The module is loaded in the client context: a secondary pw_context that runs on its own thread, so that the module is never held up by whatever WirePlumber's main loop is doing. See support.client-context in Well-known features. If that feature is disabled, the module is loaded in WirePlumber's main pw_context instead.

Constructors

LocalModule(name, arguments, properties)

Loads the named module with the provided arguments and properties (either of which can be nil).

Parameters:

  • name (string) -- the module name, such as "libpipewire-module-loopback"

  • arguments (string) -- should be either nil or a string with the desired module arguments

  • properties (table) -- can be nil or a table that can be converted to WpProperties

Returns:

a new LocalModule

Return type:

LocalModule (WpImplModule)

Since:

0.4.2