PipeWire  0.1.4
pw_module Class Reference

A dynamically loadable module. More...

Collaboration diagram for pw_module:

Public Types

typedef bool(* pw_module_init_func_t) (struct pw_module *module, char *args)
 Module init function signature. More...
 

Public Member Functions

struct pw_modulepw_module_load (struct pw_core *core, const char *name, const char *args)
 Load a module. More...
 
void pw_module_destroy (struct pw_module *module)
 Destroy a module. More...
 

Data Fields

struct pw_corecore
 the core object More...
 
struct spa_list link
 link in the core module_list More...
 
struct pw_globalglobal
 global object for this module More...
 
struct pw_module_info info
 introspectable module info More...
 
struct spa_list resource_list
 list of resources for this module More...
 
struct spa_hook_list listener_list
 
void * user_data
 module user_data More...
 

Detailed Description

A dynamically loadable module.

Member Typedef Documentation

◆ pw_module_init_func_t

typedef bool(* pw_module_init_func_t) (struct pw_module *module, char *args)

Module init function signature.

Parameters
moduleA pw_module
argsArguments to the module
Returns
true on success, false otherwise

A module should provide an init function with this signature. This function will be called when a module is loaded.

Member Function Documentation

◆ pw_module_destroy()

void pw_module_destroy ( struct pw_module module)

◆ pw_module_load()

struct pw_module * pw_module_load ( struct pw_core core,
const char *  name,
const char *  args 
)

Load a module.

Parameters
corea pw_core
namename of the module to load
argsA string with arguments for the module
[out]errorReturn location for an error string, or NULL
Returns
A pw_module if the module could be loaded, or NULL on failure.

References pw_split_strv().

Field Documentation

◆ core

struct pw_core* pw_module::core

the core object

Referenced by pw_module_get_core().

◆ global

struct pw_global* pw_module::global

global object for this module

Referenced by pw_module_destroy(), and pw_module_get_global().

◆ info

struct pw_module_info pw_module::info

introspectable module info

Referenced by pw_core_find_module(), pw_module_destroy(), and pw_module_get_info().

◆ link

struct spa_list pw_module::link

link in the core module_list

Referenced by pw_core::pw_core_destroy(), pw_core_find_module(), and pw_module_destroy().

◆ listener_list

struct spa_hook_list pw_module::listener_list

◆ resource_list

struct spa_list pw_module::resource_list

list of resources for this module

Referenced by pw_module_destroy().

◆ user_data

void* pw_module::user_data

module user_data


The documentation for this class was generated from the following files: