Element base class. More...

#include <mpipe_element.h>

Data Fields
struct mpipe_object	object
	Base object.
const char *	name
	Name of the element, set to its type by the element's init function and overridable per instance with mpipe_element_set_name.
sys_dlist_t	src_pads
	List of source pads.
sys_dlist_t	sink_pads
	List of sink pads.
enum mpipe_state	current_state
	Current state of the element.
int(*	set_state )(struct mpipe_element *element, enum mpipe_state state)
	Set state function, 0 on success, negative errno otherwise.
int(*	change_state )(struct mpipe_element *element, enum mpipe_state_change transition)
	Change state function, 0 on success, negative errno otherwise.

Detailed Description

Element base class.

The base class for all elements. Elements are the basic building blocks of a multimedia pipeline. They can have source pads (outputs) and sink pads (inputs) and can be linked together to form processing chains.

Field Documentation

◆ change_state

int(* mpipe_element::change_state) (struct mpipe_element *element, enum mpipe_state_change transition)

Change state function, 0 on success, negative errno otherwise.

◆ current_state

enum mpipe_state mpipe_element::current_state

Current state of the element.

◆ name

const char* mpipe_element::name

Name of the element, set to its type by the element's init function and overridable per instance with mpipe_element_set_name.

Debugging only.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_MPIPE_DUMP

.

◆ object

struct mpipe_object mpipe_element::object

Base object.

◆ set_state

int(* mpipe_element::set_state) (struct mpipe_element *element, enum mpipe_state state)

Set state function, 0 on success, negative errno otherwise.

◆ sink_pads

sys_dlist_t mpipe_element::sink_pads

List of sink pads.

◆ src_pads

sys_dlist_t mpipe_element::src_pads

List of source pads.

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

include/zephyr/mpipe/mpipe_element.h

Data Fields