AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::acsdkEqualizerInterfaces::EqualizerStorageInterface Class Referenceabstract

#include <EqualizerStorageInterface.h>

Inheritance diagram for alexaClientSDK::acsdkEqualizerInterfaces::EqualizerStorageInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~EqualizerStorageInterface ()=default
 
virtual void saveState (const EqualizerState &state)=0
 
virtual avsCommon::utils::error::SuccessResult< EqualizerStateloadState ()=0
 
virtual void clear ()=0
 

Detailed Description

Interface to persist the last set to EqualizerController.

Constructor & Destructor Documentation

◆ ~EqualizerStorageInterface()

virtual alexaClientSDK::acsdkEqualizerInterfaces::EqualizerStorageInterface::~EqualizerStorageInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ clear()

virtual void alexaClientSDK::acsdkEqualizerInterfaces::EqualizerStorageInterface::clear ( )
pure virtual

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().

Implemented in alexaClientSDK::acsdkEqualizer::MiscDBEqualizerStorage.

◆ loadState()

virtual avsCommon::utils::error::SuccessResult<EqualizerState> alexaClientSDK::acsdkEqualizerInterfaces::EqualizerStorageInterface::loadState ( )
pure virtual

Loads a stored equalizer state from the storage.

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

Implemented in alexaClientSDK::acsdkEqualizer::MiscDBEqualizerStorage.

◆ saveState()

virtual void alexaClientSDK::acsdkEqualizerInterfaces::EqualizerStorageInterface::saveState ( const EqualizerState state)
pure virtual

Saves equalizer state to the storage.

Parameters
stateEqualizerState to store.

Implemented in alexaClientSDK::acsdkEqualizer::MiscDBEqualizerStorage.


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

AlexaClientSDK 1.26.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0