alexaClientSDK::equalizer::MiscDBEqualizerStorage Class Reference

#include <MiscDBEqualizerStorage.h>

Inheritance diagram for alexaClientSDK::equalizer::MiscDBEqualizerStorage:

Collaboration diagram for alexaClientSDK::equalizer::MiscDBEqualizerStorage:

Public Member Functions
EqualizerStorageInterface functions.
void	saveState (const avsCommon::sdkInterfaces::audio::EqualizerState &state) override
avsCommon::utils::error::SuccessResult< avsCommon::sdkInterfaces::audio::EqualizerState >	loadState () override
void	clear () override
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::audio::EqualizerStorageInterface
virtual	~EqualizerStorageInterface ()=default

Static Public Member Functions
static std::shared_ptr< MiscDBEqualizerStorage >	create (std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface > storage)

Detailed Description

An implementation of EqualizerStorageInterface that uses MiscStorageInterface as an underlying storage.

Member Function Documentation

clear()

void alexaClientSDK::equalizer::MiscDBEqualizerStorage::clear ( )

overridevirtual

Clears all the EQ settings from the storage. The next call to loadState() must return no state unless another state is saved between clear() and loadState().

Implements alexaClientSDK::avsCommon::sdkInterfaces::audio::EqualizerStorageInterface.

create()

std::shared_ptr< MiscDBEqualizerStorage > alexaClientSDK::equalizer::MiscDBEqualizerStorage::create ( std::shared_ptr< avsCommon::sdkInterfaces::storage::MiscStorageInterface >  storage )

static

Factory method to create an instance of MiscDBEqualizerStorage given the instance MiscStorageInterface.

Parameters

storage

An instance of MiscStorageInterface to use as an underlying storage.

Returns

An instance of MiscDBEqualizerStorage on success, nullptr otherwise.

loadState()

SuccessResult< EqualizerState > alexaClientSDK::equalizer::MiscDBEqualizerStorage::loadState ( )

overridevirtual

Loads a stored equalizer state from the storage.

Returns

State retrieved from the storage or nullptr if no state is stored.

Implements alexaClientSDK::avsCommon::sdkInterfaces::audio::EqualizerStorageInterface.

saveState()

void alexaClientSDK::equalizer::MiscDBEqualizerStorage::saveState ( const avsCommon::sdkInterfaces::audio::EqualizerState &  state )

overridevirtual

Saves equalizer state to the storage.

Parameters

state

EqualizerState to store.

Implements alexaClientSDK::avsCommon::sdkInterfaces::audio::EqualizerStorageInterface.

---

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

• /workplace/avs-device-sdk/EqualizerImplementations/include/EqualizerImplementations/MiscDBEqualizerStorage.h
• /workplace/avs-device-sdk/EqualizerImplementations/src/MiscDBEqualizerStorage.cpp