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

Speaker manager storage interface. More...

#include <SpeakerManagerStorageInterface.h>

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

Public Member Functions

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

Detailed Description

Speaker manager storage interface.

See also
SpeakerManagerStorageState

Constructor & Destructor Documentation

◆ ~SpeakerManagerStorageInterface()

virtual alexaClientSDK::speakerManager::SpeakerManagerStorageInterface::~SpeakerManagerStorageInterface ( )
virtualdefaultnoexcept

Virtual destructor to assure proper cleanup of derived types.

Member Function Documentation

◆ loadState()

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

Loads state from underlying storage.

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

◆ saveState()

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

Stores state to underlying storage.

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

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

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