|
PipeWire
0.3.15
|
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... | |
PipeWire filter object class.
The filter object provides a convenient way to implement processing filters.
See also page_filters and page_core_api
| 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.
You should connect to the process event and use pw_filter_dequeue_buffer() to get the latest metadata and data.
| filter | a pw_filter |
| flags | filter flags |
| params | an array with params. |
| n_params | number of items in params |
| void pw_filter_destroy | ( | struct pw_filter * | filter | ) |
Destroy a filter.
| int pw_filter_disconnect | ( | struct pw_filter * | filter | ) |
Disconnect filter.
Referenced by pw_filter_destroy().
| uint32_t pw_filter_get_node_id | ( | struct pw_filter * | filter | ) |
Get the node ID of the filter.
Query the time on the filter.
| struct pw_filter * pw_filter_new | ( | struct pw_core * | core, |
| const char * | name, | ||
| struct pw_properties * | props | ||
| ) |
| int pw_filter_set_active | ( | struct pw_filter * | filter, |
| bool | active | ||
| ) |
Activate or deactivate the filter.
| const char * pw_filter_state_as_string | ( | enum pw_filter_state | state | ) |
Convert a filter state to a readable string.