PipeWire  0.3.36
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_propertiespw_impl_factory_get_properties (struct pw_impl_factory *factory)
 Get the factory properties. More...
 
const struct pw_factory_infopw_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 
)

◆ 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
contextthe context object
namethe name of the factory to find

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

Parameters
contextthe context
namethe 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 
)

◆ pw_impl_factory_destroy()

void pw_impl_factory_destroy ( struct pw_impl_factory *  factory)

◆ 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 
)

◆ 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 
)