alexaClientSDK::speakerManager::SpeakerManagerConfigInterface Struct Reference

Speaker manager configuration interface. More...

#include <SpeakerManagerConfigInterface.h>

Inheritance diagram for alexaClientSDK::speakerManager::SpeakerManagerConfigInterface:

Public Member Functions
virtual	~SpeakerManagerConfigInterface () noexcept=default
	Virtual destructor to assure proper cleanup of derived types. More...
virtual bool	getPersistentStorage (bool &persistentStorage) noexcept=0
	Load persistent storage setting from platform configuration. More...
virtual bool	getMinUnmuteVolume (std::uint8_t &minUnmuteVolume) noexcept=0
	Load minimum unmute volume from platform configuration. More...
virtual bool	getRestoreMuteState (bool &restoreMuteState) noexcept=0
	Load minimum unmute volume from platform configuration. More...
virtual bool	getDefaultSpeakerVolume (std::uint8_t &defaultSpeakerVolume) noexcept=0
	Load minimum unmute volume from platform configuration. More...
virtual bool	getDefaultAlertsVolume (std::uint8_t &defaultAlertsVolume) noexcept=0
	Load minimum unmute volume from platform configuration. More...

Detailed Description

Speaker manager configuration interface.

This interface provides initial configuration for speaker manager capability agent.

See also

createSpeakerManagerConfig()

Constructor & Destructor Documentation

~SpeakerManagerConfigInterface()

virtual alexaClientSDK::speakerManager::SpeakerManagerConfigInterface::~SpeakerManagerConfigInterface ( )

virtualdefaultnoexcept

Virtual destructor to assure proper cleanup of derived types.

Member Function Documentation

getDefaultAlertsVolume()

virtual bool alexaClientSDK::speakerManager::SpeakerManagerConfigInterface::getDefaultAlertsVolume ( std::uint8_t &  defaultAlertsVolume )

pure virtualnoexcept

Load minimum unmute volume from platform configuration.

Parameters

[out]

defaultAlertsVolume

Default volume for alerts channel. The value must be in range 0..100 inclusive.

Returns

True if value is loaded, false if value is not present, is out of range, or operation failed.

getDefaultSpeakerVolume()

virtual bool alexaClientSDK::speakerManager::SpeakerManagerConfigInterface::getDefaultSpeakerVolume ( std::uint8_t &  defaultSpeakerVolume )

pure virtualnoexcept

Load minimum unmute volume from platform configuration.

Parameters

[out]

defaultSpeakerVolume

Default volume for speaker channel. The value must be in range 0..100 inclusive.

Returns

True if value is loaded, false if value is not present, is out of range, or operation failed.

getMinUnmuteVolume()

virtual bool alexaClientSDK::speakerManager::SpeakerManagerConfigInterface::getMinUnmuteVolume ( std::uint8_t &  minUnmuteVolume )

pure virtualnoexcept

Load minimum unmute volume from platform configuration.

Parameters

[out]

minUnmuteVolume

Minimum volume for unmuting speakers. The value must be in range 0..100 inclusive.

Returns

True if value is loaded, false if value is not present, is out of range, or operation failed.

getPersistentStorage()

virtual bool alexaClientSDK::speakerManager::SpeakerManagerConfigInterface::getPersistentStorage ( bool &  persistentStorage )

pure virtualnoexcept

Load persistent storage setting from platform configuration.

Parameters

[out]

persistentStorage

Flag if persistent storage is enabled for speaker settings.

Returns

True if value is loaded, false is value is not present, is out of range, or operation failed.

getRestoreMuteState()

virtual bool alexaClientSDK::speakerManager::SpeakerManagerConfigInterface::getRestoreMuteState ( bool &  restoreMuteState )

pure virtualnoexcept

Load minimum unmute volume from platform configuration.

Parameters

[out]

restoreMuteState

Flag if the speaker mute state must be preserved between sessions.

Returns

True if value is loaded, false if value is not present, is out of range, or operation failed.

---

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

• /workplace/avs-device-sdk/CapabilityAgents/SpeakerManager/SpeakerManager/include/acsdk/SpeakerManager/SpeakerManagerConfigInterface.h