pw_filter Class Reference

PipeWire filter object class. More...

Public Member Functions
const char *	pw_filter_state_as_string (enum pw_filter_state state)
	Convert a filter state to a readable string. More...
struct pw_filter *	pw_filter_new (struct pw_core *core, const char *name, struct pw_properties *props)
	Create a new unconneced pw_filter. More...
void	pw_filter_destroy (struct pw_filter *filter)
	Destroy a filter. More...
int	pw_filter_connect (struct pw_filter *filter, enum pw_filter_flags flags, const struct spa_pod **params, uint32_t n_params)
	Connect a filter for processing. More...
uint32_t	pw_filter_get_node_id (struct pw_filter *filter)
	Get the node ID of the filter. More...
int	pw_filter_disconnect (struct pw_filter *filter)
	Disconnect filter. More...
int	pw_filter_get_time (struct pw_filter *filter, struct pw_time *time)
	Query the time on the filter. More...
int	pw_filter_set_active (struct pw_filter *filter, bool active)
	Activate or deactivate the filter. More...

Detailed Description

PipeWire filter object class.

The filter object provides a convenient way to implement processing filters.

See also page_filters and page_core_api

Member Function Documentation

pw_filter_connect()

int pw_filter_connect	(	struct pw_filter *	filter,
		enum pw_filter_flags	flags,
		const struct spa_pod **	params,
		uint32_t	n_params
	)

Connect a filter for processing.

Returns

0 on success < 0 on error.

You should connect to the process event and use pw_filter_dequeue_buffer() to get the latest metadata and data.

Parameters

filter	a pw_filter
flags	filter flags
params	an array with params.
n_params	number of items in params

pw_filter_destroy()

void pw_filter_destroy

(

struct pw_filter *

filter

)

Destroy a filter.

pw_filter_disconnect()

int pw_filter_disconnect

(

struct pw_filter *

filter

)

Disconnect filter.

Referenced by pw_filter_destroy().

pw_filter_get_node_id()

uint32_t pw_filter_get_node_id

(

struct pw_filter *

filter

)

Get the node ID of the filter.

Returns

node ID.

pw_filter_get_time()

int pw_filter_get_time	(	struct pw_filter *	filter,
		struct pw_time *	time
	)

Query the time on the filter.

pw_filter_new()

struct pw_filter * pw_filter_new	(	struct pw_core *	core,
		const char *	name,
		struct pw_properties *	props
	)

Create a new unconneced pw_filter.

Returns

a newly allocated pw_filter

Parameters

core	a pw_core
name	a filter media name
props	filter properties, ownership is taken

pw_filter_set_active()

int pw_filter_set_active	(	struct pw_filter *	filter,
		bool	active
	)

Activate or deactivate the filter.

pw_filter_state_as_string()

const char * pw_filter_state_as_string

(

enum pw_filter_state

state

)

Convert a filter state to a readable string.

---

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

• filter.h