AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::capabilityAgents::speakerManager::SpeakerManagerStorageInterface Struct Referenceabstract

#include <SpeakerManagerStorageInterface.h>

Inheritance diagram for alexaClientSDK::capabilityAgents::speakerManager::SpeakerManagerStorageInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~SpeakerManagerStorageInterface ()=default
 
virtual bool loadState (SpeakerManagerStorageState &state)=0
 
virtual bool saveState (const SpeakerManagerStorageState &state)=0
 

Detailed Description

Storage interface for SpeakerManager.

Constructor & Destructor Documentation

◆ ~SpeakerManagerStorageInterface()

virtual alexaClientSDK::capabilityAgents::speakerManager::SpeakerManagerStorageInterface::~SpeakerManagerStorageInterface ( )
virtualdefault

Virtual destructor to assure proper cleanup of derived types.

Member Function Documentation

◆ loadState()

virtual bool alexaClientSDK::capabilityAgents::speakerManager::SpeakerManagerStorageInterface::loadState ( SpeakerManagerStorageState state)
pure virtual

Loads state from underlying storage.

Parameters
[out]statePointer to state structure for loaded values.
Returns
Boolean flag if the operation is successful.

Implemented in alexaClientSDK::capabilityAgents::speakerManager::SpeakerManagerMiscStorage.

◆ saveState()

virtual bool alexaClientSDK::capabilityAgents::speakerManager::SpeakerManagerStorageInterface::saveState ( const SpeakerManagerStorageState state)
pure virtual

Stores state to underlying storage.

Parameters
[in]stateReference of state structure for values to store.
Returns
Boolean flag if the operation is successful.

Implemented in alexaClientSDK::capabilityAgents::speakerManager::SpeakerManagerMiscStorage.


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

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