The set of settings item given for initialization of a Module instance. More...

#include <src/include/sof/audio/module_adapter/iadk/module_initial_settings.h>

Data Structures
struct	Array
	A FixedArray whose construction is only granted to ModuleInitialSettings. More...

Public Types
typedef ModuleInitialSettingsKey	Key
	the type of keys to access to the ModuleInitialSettings items

Public Member Functions
	ModuleInitialSettings (ModuleInitialSettingsInterface &performer)
	Initializes a new instance of ModuleInitialSettings given some ModuleInitialSettingsInterface object.

template<Key key>
const Array< typename ModuleInitialSettingsItem< key >::ValueType const >	GetItem ()
	Retrieves the item as an array of values for the given key.

Friends
template<class DERIVED , class PROCESSING_MODULE >
class	ProcessingModuleFactory

class	system::SystemAgent

Detailed Description

The set of settings item given for initialization of a Module instance.

The ModuleInitialSettings is a container of heterogeneous typed value items. Each item is a key-value pair where key is an enumeration value of ModuleInitialSettingsKey

Member Typedef Documentation

◆ Key

typedef ModuleInitialSettingsKey intel_adsp::ModuleInitialSettings::Key

the type of keys to access to the ModuleInitialSettings items

Constructor & Destructor Documentation

◆ ModuleInitialSettings()

intel_adsp::ModuleInitialSettings::ModuleInitialSettings ( ModuleInitialSettingsInterface & performer )

inlineexplicit

Initializes a new instance of ModuleInitialSettings given some ModuleInitialSettingsInterface object.

Member Function Documentation

◆ GetItem()

template<Key key>

const Array< typename ModuleInitialSettingsItem< key >::ValueType const > intel_adsp::ModuleInitialSettings::GetItem ( )

inline

Retrieves the item as an array of values for the given key.

Note: Any item is represented as a value array even if it has a single value.

Remarks: If no item is found for the given key, the returned array will have null length.

Template Parameters

key	value of the Key to retrieve the item.

Friends And Related Symbol Documentation

◆ ProcessingModuleFactory

template<class DERIVED , class PROCESSING_MODULE >

friend class ProcessingModuleFactory

friend

◆ system::SystemAgent

friend class system::SystemAgent

friend

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

src/include/sof/audio/module_adapter/iadk/module_initial_settings.h

Data Structures

Public Types

Public Member Functions

Friends