PipeWire Factory Interface

The factory is used to make objects on demand. More...

Data Structures
struct	pw_impl_factory_events
	Factory events, listen to them with pw_impl_factory_add_listener. More...
struct	pw_impl_factory_implementation

Functions
struct pw_impl_factory *	pw_context_create_factory (struct pw_context *context, const char *name, const char *type, uint32_t version, struct pw_properties *properties, size_t user_data_size)
const struct pw_properties *	pw_impl_factory_get_properties (struct pw_impl_factory *factory)
	Get the factory properties. More...
const struct pw_factory_info *	pw_impl_factory_get_info (struct pw_impl_factory *factory)
	Get the factory info. More...
int	pw_impl_factory_update_properties (struct pw_impl_factory *factory, const struct spa_dict *dict)
	Update the factory properties. More...
int	pw_impl_factory_register (struct pw_impl_factory *factory, struct pw_properties *properties)
void	pw_impl_factory_destroy (struct pw_impl_factory *factory)
void *	pw_impl_factory_get_user_data (struct pw_impl_factory *factory)
struct pw_global *	pw_impl_factory_get_global (struct pw_impl_factory *factory)
	Get the global of this factory. More...
void	pw_impl_factory_add_listener (struct pw_impl_factory *factory, struct spa_hook *listener, const struct pw_impl_factory_events *events, void *data)
	Add an event listener. More...
void	pw_impl_factory_set_implementation (struct pw_impl_factory *factory, const struct pw_impl_factory_implementation *implementation, void *data)
void *	pw_impl_factory_create_object (struct pw_impl_factory *factory, struct pw_resource *resource, const char *type, uint32_t version, struct pw_properties *properties, uint32_t new_id)
struct pw_impl_factory *	pw_context_find_factory (struct pw_context *context, const char *name)
	Find a factory by name. More...

Detailed Description

The factory is used to make objects on demand.

Function Documentation

pw_context_create_factory()

struct pw_impl_factory* pw_context_create_factory	(	struct pw_context *	context,
		const char *	name,
		const char *	type,
		uint32_t	version,
		struct pw_properties *	properties,
		size_t	user_data_size
	)

References pw_properties::dict, name, NAME, pw_log_debug, pw_properties_free(), pw_properties_new(), spa_hook_list_init(), and SPA_PTROFF.

Referenced by pipewire__module_init().

pw_context_find_factory()

struct pw_impl_factory* pw_context_find_factory	(	struct pw_context *	context,
		const char *	name
	)

Find a factory by name.

Parameters

context	the context object
name	the name of the factory to find

Find in the list of factories registered in context for one with the given name.

Parameters

context	the context
name	the factory name

References name, spa_list_for_each, and spa_streq().

pw_impl_factory_add_listener()

void pw_impl_factory_add_listener	(	struct pw_impl_factory *	factory,
		struct spa_hook *	listener,
		const struct pw_impl_factory_events *	events,
		void *	data
	)

Add an event listener.

References spa_hook_list_append().

pw_impl_factory_create_object()

void* pw_impl_factory_create_object	(	struct pw_impl_factory *	factory,
		struct pw_resource *	resource,
		const char *	type,
		uint32_t	version,
		struct pw_properties *	properties,
		uint32_t	new_id
	)

References spa_callbacks_call_res.

pw_impl_factory_destroy()

void pw_impl_factory_destroy

(

struct pw_impl_factory *

factory

)

References NAME, pw_global_destroy(), pw_log_debug, pw_properties_free(), spa_hook_list_clean(), spa_hook_remove(), and spa_list_remove().

Referenced by pipewire__module_init().

pw_impl_factory_get_global()

struct pw_global* pw_impl_factory_get_global

(

struct pw_impl_factory *

factory

)

Get the global of this factory.

pw_impl_factory_get_info()

const struct pw_factory_info* pw_impl_factory_get_info

(

struct pw_impl_factory *

factory

)

Get the factory info.

pw_impl_factory_get_properties()

const struct pw_properties* pw_impl_factory_get_properties

(

struct pw_impl_factory *

factory

)

Get the factory properties.

pw_impl_factory_get_user_data()

void* pw_impl_factory_get_user_data

(

struct pw_impl_factory *

factory

)

Referenced by pipewire__module_init().

pw_impl_factory_register()

int pw_impl_factory_register	(	struct pw_impl_factory *	factory,
		struct pw_properties *	properties
	)

References pw_global_new(), PW_KEY_FACTORY_NAME, PW_KEY_FACTORY_TYPE_NAME, PW_KEY_FACTORY_TYPE_VERSION, PW_KEY_MODULE_ID, PW_TYPE_INTERFACE_Factory, and PW_VERSION_FACTORY.

pw_impl_factory_set_implementation()

void pw_impl_factory_set_implementation	(	struct pw_impl_factory *	factory,
		const struct pw_impl_factory_implementation *	implementation,
		void *	data
	)

References SPA_CALLBACKS_INIT.

Referenced by pipewire__module_init().

pw_impl_factory_update_properties()

int pw_impl_factory_update_properties	(	struct pw_impl_factory *	factory,
		const struct spa_dict *	dict
	)

Update the factory properties.

References NAME, PW_FACTORY_CHANGE_MASK_PROPS, pw_factory_resource_info, pw_log_debug, pw_properties_update(), and spa_list_for_each.