interface.h File Reference

Dynamic module interface, lifecycle callbacks, and buffer contracts. More...

Include dependency graph for interface.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	input_stream_buffer
	Input stream buffer. More...
struct	output_stream_buffer
	Output stream buffer. More...
union	config_param_id_data
struct	module_interface
	3rd party processing module interface More...

Enumerations
enum	module_cfg_fragment_position { MODULE_CFG_FRAGMENT_MIDDLE = 0 , MODULE_CFG_FRAGMENT_FIRST , MODULE_CFG_FRAGMENT_LAST , MODULE_CFG_FRAGMENT_SINGLE }
	Fragment position in config MODULE_CFG_FRAGMENT_FIRST: first fragment of the large configuration MODULE_CFG_FRAGMENT_SINGLE: only fragment of the configuration MODULE_CFG_FRAGMENT_LAST: last fragment of the configuration MODULE_CFG_FRAGMENT_MIDDLE: intermediate fragment of the large configuration. More...
enum	module_processing_mode { MODULE_PROCESSING_NORMAL = 0 , MODULE_PROCESSING_BYPASS }
	MODULE_PROCESSING_NORMAL: Indicates that module is expected to apply its custom processing on the input signal MODULE_PROCESSING_BYPASS: Indicates that module is expected to skip custom processing on the input signal and act as a passthrough component. More...

Detailed Description

Dynamic module interface, lifecycle callbacks, and buffer contracts.

Enumeration Type Documentation

module_cfg_fragment_position

enum module_cfg_fragment_position

Fragment position in config MODULE_CFG_FRAGMENT_FIRST: first fragment of the large configuration MODULE_CFG_FRAGMENT_SINGLE: only fragment of the configuration MODULE_CFG_FRAGMENT_LAST: last fragment of the configuration MODULE_CFG_FRAGMENT_MIDDLE: intermediate fragment of the large configuration.

Enumerator
MODULE_CFG_FRAGMENT_MIDDLE
MODULE_CFG_FRAGMENT_FIRST
MODULE_CFG_FRAGMENT_LAST
MODULE_CFG_FRAGMENT_SINGLE

module_processing_mode

enum module_processing_mode

MODULE_PROCESSING_NORMAL: Indicates that module is expected to apply its custom processing on the input signal MODULE_PROCESSING_BYPASS: Indicates that module is expected to skip custom processing on the input signal and act as a passthrough component.

Enumerator
MODULE_PROCESSING_NORMAL
MODULE_PROCESSING_BYPASS