Method

PwgCoreload_module

since: 0.1

Declaration [src]

PwgImplModule*
pwg_core_load_module (
  PwgCore* self,
  const char* name,
  const char* arguments,
  GError** error
)

Description [src]

Loads a PipeWire implementation module into this core context.

This is for app-owned module lifecycles such as loading a loopback or filter-chain helper. It does not replace WirePlumber or implement session-management policy.

Stability: Unstable

Available since: 0.1

Parameters

name

Type: const char*

The PipeWire implementation module name.

The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
arguments

Type: const char*

PipeWire module arguments.

The argument can be NULL.
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.
If the return location is not NULL, then you must initialize it to a NULL GError*.
The argument will be left initialized to NULL by the method if there are no errors.
In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: PwgImplModule

A loaded module handle, or NULL on failure.

The caller of the method takes ownership of the returned data, and is responsible for freeing it.
The return value can be NULL.