Go to the documentation of this file.
26 #ifndef PIPEWIRE_IMPL_MODULE_H
27 #define PIPEWIRE_IMPL_MODULE_H
37 #define PIPEWIRE_SYMBOL_MODULE_INIT "pipewire__module_init"
38 #define PIPEWIRE_MODULE_PREFIX "libpipewire-"
49 struct pw_impl_module;
64 #define PW_VERSION_IMPL_MODULE_EVENTS 0
79 struct pw_impl_module *
#define PW_VERSION_MODULE
Definition: module.h:39
void(* registered)(void *data)
The module is registered.
Definition: impl-module.h:76
int pw_global_register(struct pw_global *global)
Register a global object to the context registry.
Definition: global.c:125
#define PW_KEY_OBJECT_ID
a global object id
Definition: src/pipewire/keys.h:60
void(* free)(void *data)
The module is freed.
Definition: impl-module.h:70
struct pw_impl_module * pw_context_load_module(struct pw_context *context, const char *name, const char *args, struct pw_properties *properties)
Load a module.
Definition: impl-module.c:160
struct pw_global * pw_global_new(struct pw_context *context, const char *type, uint32_t version, struct pw_properties *properties, pw_global_bind_func_t func, void *object)
Create a new global object.
Definition: global.c:66
int pw_global_add_resource(struct pw_global *global, struct pw_resource *resource)
Add a resource to a global.
Definition: global.c:230
bool spa_streq(const char *s1, const char *s2)
Definition: string.h:50
#define spa_list_for_each(pos, head, member)
Definition: list.h:111
Module events added with pw_impl_module_add_listener.
Definition: impl-module.h:63
#define PW_TYPE_INTERFACE_Module
Definition: module.h:37
#define spa_aprintf(_fmt,...)
Definition: defs.h:309
#define SPA_EXPORT
Definition: defs.h:207
void(* initialized)(void *data)
The module is initialized.
Definition: impl-module.h:72
Global events, use pw_global_add_listener.
Definition: global.h:68
#define pw_log_debug(...)
Definition: src/pipewire/log.h:89
void(* destroy)(void *data)
The module is destroyed.
Definition: impl-module.h:68
void spa_hook_list_init(struct spa_hook_list *list)
Initialize a hook list.
Definition: hook.h:86
SPA_EXPORT struct pw_impl_module * pw_context_load_module(struct pw_context *context, const char *name, const char *args, struct pw_properties *properties)
Load a module.
Definition: impl-module.c:160
void spa_hook_remove(struct spa_hook *hook)
Remove a hook.
Definition: hook.h:117
static uint32_t int int res
Definition: core.h:329
void pw_impl_module_add_listener(struct pw_impl_module *module, struct spa_hook *listener, const struct pw_impl_module_events *events, void *data)
Add an event listener to a module.
Definition: impl-module.c:373
struct spa_dict dict
dictionary of key/values
Definition: properties.h:50
SPA_EXPORT const struct pw_properties * pw_impl_module_get_properties(struct pw_impl_module *module)
Get the node properties.
Definition: impl-module.c:337
#define SPA_CONTAINER_OF(p, t, m)
Definition: defs.h:170
void pw_impl_module_destroy(struct pw_impl_module *module)
Destroy a module.
Definition: impl-module.c:295
SPA_EXPORT int pw_impl_module_update_properties(struct pw_impl_module *module, const struct spa_dict *dict)
Update the module properties.
Definition: impl-module.c:343
SPA_EXPORT struct pw_context * pw_impl_module_get_context(struct pw_impl_module *module)
Get the context of a module.
Definition: impl-module.c:325
#define pw_log_error(...)
Definition: src/pipewire/log.h:86
int(* pw_impl_module_init_func_t)(struct pw_impl_module *module, const char *args)
Module init function signature.
Definition: impl-module.h:60
SPA_EXPORT int pw_properties_setf(struct pw_properties *properties, const char *key, const char *format,...)
Set a property value by format.
Definition: properties.c:492
void pw_global_add_listener(struct pw_global *global, struct spa_hook *listener, const struct pw_global_events *events, void *data)
Add an event listener on the global.
Definition: global.c:255
void spa_list_remove(struct spa_list *elem)
Definition: list.h:69
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:76
struct pw_global * pw_impl_module_get_global(struct pw_impl_module *module)
Get the global of a module.
Definition: impl-module.c:331
SPA_EXPORT int pw_properties_update(struct pw_properties *props, const struct spa_dict *dict)
Update properties.
Definition: properties.c:314
Definition: utils/dict.h:48
The module information.
Definition: module.h:43
SPA_EXPORT struct pw_global * pw_impl_module_get_global(struct pw_impl_module *module)
Get the global of a module.
Definition: impl-module.c:331
#define PW_KEY_MODULE_NAME
the name of the module
Definition: src/pipewire/keys.h:229
#define spa_strerror(err)
Definition: result.h:51
struct pw_resource * pw_resource_new(struct pw_impl_client *client, uint32_t id, uint32_t permissions, const char *type, uint32_t version, size_t user_data_size)
Make a new resource for client.
Definition: resource.c:43
const struct pw_module_info * pw_impl_module_get_info(struct pw_impl_module *module)
Get the module info.
Definition: impl-module.c:367
SPA_EXPORT void pw_impl_module_destroy(struct pw_impl_module *module)
Destroy a module.
Definition: impl-module.c:295
SPA_EXPORT int pw_properties_set(struct pw_properties *properties, const char *key, const char *value)
Set a property value.
Definition: properties.c:459
bool pw_in_valgrind(void)
Definition: pipewire.c:670
#define PW_MODULE_CHANGE_MASK_PROPS
Definition: module.h:48
void pw_global_destroy(struct pw_global *global)
Destroy a global.
Definition: global.c:369
#define PW_VERSION_GLOBAL_EVENTS
Definition: global.h:69
#define PW_MODULE_CHANGE_MASK_ALL
Definition: module.h:49
struct pw_control this
Definition: control.c:34
uint32_t version
Definition: impl-module.h:65
void spa_hook_list_append(struct spa_hook_list *list, struct spa_hook *hook, const void *funcs, void *data)
Append a hook.
Definition: hook.h:97
SPA_EXPORT struct pw_properties * pw_properties_new(const char *key,...)
Make a new properties object.
Definition: properties.c:100
const struct pw_properties * pw_impl_module_get_properties(struct pw_impl_module *module)
Get the node properties.
Definition: impl-module.c:337
SPA_EXPORT void pw_impl_module_add_listener(struct pw_impl_module *module, struct spa_hook *listener, const struct pw_impl_module_events *events, void *data)
Add an event listener to a module.
Definition: impl-module.c:373
#define NAME
Definition: impl-module.c:41
struct pw_context * pw_impl_module_get_context(struct pw_impl_module *module)
Get the context of a module.
Definition: impl-module.c:325
SPA_EXPORT const struct pw_module_info * pw_impl_module_get_info(struct pw_impl_module *module)
Get the module info.
Definition: impl-module.c:367
static uint32_t int int const char va_list args
Definition: core.h:330
Definition: properties.h:49
SPA_EXPORT void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition: properties.c:386
#define PIPEWIRE_SYMBOL_MODULE_INIT
Definition: impl-module.h:37
void spa_hook_list_clean(struct spa_hook_list *list)
Definition: hook.h:124
int pw_impl_module_update_properties(struct pw_impl_module *module, const struct spa_dict *dict)
Update the module properties.
Definition: impl-module.c:343
#define spa_list_append(list, item)
Definition: list.h:81
#define pw_log_warn(...)
Definition: src/pipewire/log.h:87