alexaClientSDK::sampleApplications::common::InteractionManager Class Reference

#include <InteractionManager.h>

Inheritance diagram for alexaClientSDK::sampleApplications::common::InteractionManager:

Collaboration diagram for alexaClientSDK::sampleApplications::common::InteractionManager:

Public Member Functions
	InteractionManager (std::shared_ptr< defaultClient::DefaultClient > client, std::shared_ptr< applicationUtilities::resources::audio::MicrophoneInterface > micWrapper, std::shared_ptr< UIManager > userInterface, capabilityAgents::aip::AudioProvider holdToTalkAudioProvider, capabilityAgents::aip::AudioProvider tapToTalkAudioProvider, capabilityAgents::aip::AudioProvider wakeWordAudioProvider=capabilityAgents::aip::AudioProvider::null(), std::shared_ptr< avsCommon::sdkInterfaces::CallManagerInterface > callManager=nullptr, std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface > diagnostics=nullptr)
void	begin ()
void	help ()
void	limitedHelp ()
void	microphoneToggle ()
void	holdToggled ()
void	tap ()
void	stopForegroundActivity ()
void	playbackPlay ()
void	playbackPause ()
void	playbackNext ()
void	playbackPrevious ()
void	playbackSkipForward ()
void	playbackSkipBackward ()
void	playbackShuffle (bool action)
void	playbackLoop (bool action)
void	playbackRepeat (bool action)
void	playbackThumbsUp (bool action)
void	playbackThumbsDown (bool action)
void	settings ()
void	alarmVolumeRamp ()
void	wakewordConfirmation ()
void	speechConfirmation ()
void	locale ()
void	clearCachedEndpointIdentifiers (const std::vector< avsCommon::sdkInterfaces::endpoints::EndpointIdentifier > &deletedEndpoints)
void	timeZone ()
void	networkInfo ()
void	doNotDisturb ()
void	errorValue ()
void	speakerControl ()
void	firmwareVersionControl ()
void	setFirmwareVersion (avsCommon::sdkInterfaces::softwareInfo::FirmwareVersion firmwareVersion)
void	volumeControl ()
void	adjustVolume (avsCommon::sdkInterfaces::ChannelVolumeInterface::Type type, int8_t delta)
void	setMute (avsCommon::sdkInterfaces::ChannelVolumeInterface::Type type, bool mute)
void	overrideHoldToTalkSpeechHandler (std::shared_ptr< avsCommon::sdkInterfaces::SpeechInteractionHandlerInterface > holdToTalkHandler)
void	resetDevice ()
void	confirmResetDevice ()
void	confirmReauthorizeDevice ()
void	onDialogUXStateChanged (DialogUXState newState) override
void	onCallStateChange (CallState newState) override
void	setDoNotDisturbMode (bool enable)
void	setAlarmVolumeRamp (bool enable)
void	setSpeechConfirmation (settings::SpeechConfirmationSettingType value)
void	setWakewordConfirmation (settings::WakeWordConfirmationSettingType value)
void	setTimeZone (const std::string &value)
void	setLocale (const settings::DeviceLocales &value)
settings::types::NetworkInfo	getNetworkInfo ()
void	setNetworkInfo (const settings::types::NetworkInfo &value)
void	stopMicrophone ()
void	startMicrophone ()
void	diagnosticsControl ()
void	devicePropertiesControl ()
void	showDeviceProperties ()
void	audioInjectionControl ()
void	injectWavFile (const std::string &absoluteFilePath)
void	deviceProtocolTraceControl ()
void	printProtocolTrace ()
void	setProtocolTraceFlag (bool enabled)
void	clearProtocolTrace ()
void	sendDeviceSetupComplete ()
Network Info Prompt Functions
Should be called whenever a user requests a specific 'NETWORK_INFO' change.
void	networkInfoConnectionTypePrompt ()
void	networkInfoESSIDPrompt ()
void	networkInfoBSSIDPrompt ()
void	networkInfoIpPrompt ()
void	networkInfoSubnetPrompt ()
void	networkInfoMacPrompt ()
void	networkInfoDHCPPrompt ()
void	networkInfoStaticIpPrompt ()
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface
virtual	~DialogUXStateObserverInterface ()=default
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::CallStateObserverInterface
virtual	~CallStateObserverInterface ()=default
virtual void	onCallStateInfoChange (const CallStateInfo &stateInfo)
Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
	RequiresShutdown (const std::string &name)
virtual	~RequiresShutdown ()
	Destructor. More...
const std::string &	name () const
void	shutdown ()
bool	isShutdown () const

Additional Inherited Members
Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface
enum	DialogUXState {   DialogUXState::IDLE, DialogUXState::LISTENING, DialogUXState::EXPECTING, DialogUXState::THINKING,   DialogUXState::SPEAKING, DialogUXState::FINISHED }
	The different dialog specific AVS UX states. More...
Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::CallStateObserverInterface
enum	CallState {   CallState::CONNECTING, CallState::INBOUND_RINGING, CallState::CALL_CONNECTED, CallState::CALL_DISCONNECTED,   CallState::NONE }
	An enumeration representing the state of a call. More...
typedef struct alexaClientSDK::avsCommon::sdkInterfaces::CallStateObserverInterface::CallStateInfo	CallStateInfo
	An struct containing call state information. More...
Static Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface
static std::string	stateToString (DialogUXState state)
Static Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::CallStateObserverInterface
static bool	isStateActive (const CallStateObserverInterface::CallState &state)

Detailed Description

This class manages most of the user interaction by taking in commands and notifying the DefaultClient and the userInterface (the view) accordingly.

Constructor & Destructor Documentation

InteractionManager()

alexaClientSDK::sampleApplications::common::InteractionManager::InteractionManager	(	std::shared_ptr< defaultClient::DefaultClient >	client,
		std::shared_ptr< applicationUtilities::resources::audio::MicrophoneInterface >	micWrapper,
		std::shared_ptr< UIManager >	userInterface,
		capabilityAgents::aip::AudioProvider	holdToTalkAudioProvider,
		capabilityAgents::aip::AudioProvider	tapToTalkAudioProvider,
		capabilityAgents::aip::AudioProvider	wakeWordAudioProvider = capabilityAgents::aip::AudioProvider::null(),
		std::shared_ptr< avsCommon::sdkInterfaces::CallManagerInterface >	callManager = nullptr,
		std::shared_ptr< avsCommon::sdkInterfaces::diagnostics::DiagnosticsInterface >	diagnostics = nullptr
	)

Constructor.

Member Function Documentation

adjustVolume()

void alexaClientSDK::sampleApplications::common::InteractionManager::adjustVolume	(	avsCommon::sdkInterfaces::ChannelVolumeInterface::Type	type,
		int8_t	delta
	)

Should be called after a user wishes to modify the volume.

alarmVolumeRamp()

void alexaClientSDK::sampleApplications::common::InteractionManager::alarmVolumeRamp

(

)

Should be called whenever a user requests 'ALARM_VOLUME_RAMP' change.

audioInjectionControl()

void alexaClientSDK::sampleApplications::common::InteractionManager::audioInjectionControl

(

)

Prints the audio injection screen.

begin()

void alexaClientSDK::sampleApplications::common::InteractionManager::begin

(

)

Begins the interaction between the Sample App and the user. This should only be called at startup.

clearCachedEndpointIdentifiers()

void alexaClientSDK::sampleApplications::common::InteractionManager::clearCachedEndpointIdentifiers

(

const std::vector< avsCommon::sdkInterfaces::endpoints::EndpointIdentifier > &

deletedEndpoints

)

Resets cached endpoint identifiers.

clearProtocolTrace()

void alexaClientSDK::sampleApplications::common::InteractionManager::clearProtocolTrace

(

)

Clears the protocol trace message list.

confirmReauthorizeDevice()

void alexaClientSDK::sampleApplications::common::InteractionManager::confirmReauthorizeDevice

(

)

Prompts the user to confirm the intent to re-authorize the device.

confirmResetDevice()

void alexaClientSDK::sampleApplications::common::InteractionManager::confirmResetDevice

(

)

Prompts the user to confirm the intent to reset the device.

devicePropertiesControl()

void alexaClientSDK::sampleApplications::common::InteractionManager::devicePropertiesControl

(

)

Prints the device properties screen.

deviceProtocolTraceControl()

void alexaClientSDK::sampleApplications::common::InteractionManager::deviceProtocolTraceControl

(

)

Prints device protocol tracer screen.

diagnosticsControl()

void alexaClientSDK::sampleApplications::common::InteractionManager::diagnosticsControl

(

)

Prints the diagnostics screen.

doNotDisturb()

void alexaClientSDK::sampleApplications::common::InteractionManager::doNotDisturb

(

)

Should be called whenever a user requests 'DO_NOT_DISTURB' change.

errorValue()

void alexaClientSDK::sampleApplications::common::InteractionManager::errorValue

(

)

Should be called whenever a user presses invalid option.

firmwareVersionControl()

void alexaClientSDK::sampleApplications::common::InteractionManager::firmwareVersionControl

(

)

Should be called whenever a users requests to set the firmware version.

getNetworkInfo()

settings::types::NetworkInfo alexaClientSDK::sampleApplications::common::InteractionManager::getNetworkInfo

(

)

Gets the network info of the device.

Returns

The network info.

help()

void alexaClientSDK::sampleApplications::common::InteractionManager::help

(

)

Should be called when a user requests help.

holdToggled()

void alexaClientSDK::sampleApplications::common::InteractionManager::holdToggled

(

)

Should be called whenever a user presses or releases the hold button.

injectWavFile()

void alexaClientSDK::sampleApplications::common::InteractionManager::injectWavFile

(

const std::string &

absoluteFilePath

)

Injects wav file into audio stream.

Note: Currently audio injection is supported for wav files with the following properties Sample Size: 16 bits Sample Rate: 16 KHz Number of channels : 1 Endianness : Little Encoding Format : LPCM

Parameters

absoluteFilePath

the absolute filepath of the wav file containing the audio to be injected.

limitedHelp()

void alexaClientSDK::sampleApplications::common::InteractionManager::limitedHelp

(

)

Should be called when a user requests help and the application failed to connect to AVS.

locale()

void alexaClientSDK::sampleApplications::common::InteractionManager::locale

(

)

Should be called whenever a user requests 'LOCALE' change.

microphoneToggle()

void alexaClientSDK::sampleApplications::common::InteractionManager::microphoneToggle

(

)

Toggles the microphone state if the Sample App was built with wakeword. When the microphone is turned off, the app enters a privacy mode in which it stops recording audio data from the microphone, thus disabling Alexa waking up due to wake word. Note however that hold-to-talk and tap-to-talk modes will still work by recording microphone data temporarily until a user initiated interacion is complete. If this app was built without wakeword then this will do nothing as the microphone is already off.

networkInfo()

void alexaClientSDK::sampleApplications::common::InteractionManager::networkInfo

(

)

Should be called whenever a user requests 'NETWORK_INFO' change.

networkInfoBSSIDPrompt()

void alexaClientSDK::sampleApplications::common::InteractionManager::networkInfoBSSIDPrompt

(

)

networkInfoConnectionTypePrompt()

void alexaClientSDK::sampleApplications::common::InteractionManager::networkInfoConnectionTypePrompt

(

)

networkInfoDHCPPrompt()

void alexaClientSDK::sampleApplications::common::InteractionManager::networkInfoDHCPPrompt

(

)

networkInfoESSIDPrompt()

void alexaClientSDK::sampleApplications::common::InteractionManager::networkInfoESSIDPrompt

(

)

networkInfoIpPrompt()

void alexaClientSDK::sampleApplications::common::InteractionManager::networkInfoIpPrompt

(

)

networkInfoMacPrompt()

void alexaClientSDK::sampleApplications::common::InteractionManager::networkInfoMacPrompt

(

)

networkInfoStaticIpPrompt()

void alexaClientSDK::sampleApplications::common::InteractionManager::networkInfoStaticIpPrompt

(

)

networkInfoSubnetPrompt()

void alexaClientSDK::sampleApplications::common::InteractionManager::networkInfoSubnetPrompt

(

)

onCallStateChange()

void alexaClientSDK::sampleApplications::common::InteractionManager::onCallStateChange ( CallState  newState )

overridevirtual

CallStateObserverInterface methods

Implements alexaClientSDK::avsCommon::sdkInterfaces::CallStateObserverInterface.

onDialogUXStateChanged()

void alexaClientSDK::sampleApplications::common::InteractionManager::onDialogUXStateChanged ( DialogUXState  newState )

overridevirtual

UXDialogObserverInterface methods

Implements alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface.

overrideHoldToTalkSpeechHandler()

void alexaClientSDK::sampleApplications::common::InteractionManager::overrideHoldToTalkSpeechHandler

(

std::shared_ptr< avsCommon::sdkInterfaces::SpeechInteractionHandlerInterface >

holdToTalkHandler

)

Overrides the default SpeechInteractionHandlerInterface for Hold To Talk interactions. Defaults to DefaultClient.

Parameters

holdToTalkHandler

the SpeechInteractionHandlerInterface to use as override for Hold To Talk interactions.

playbackLoop()

void alexaClientSDK::sampleApplications::common::InteractionManager::playbackLoop

(

bool

action

)

Should be called whenever a user presses 'LOOP' for playback.

Parameters

action

The boolean action for the toggle state that needs to be applied. If true, loop button is set to be active.

playbackNext()

void alexaClientSDK::sampleApplications::common::InteractionManager::playbackNext

(

)

Should be called whenever a user presses 'NEXT' for playback.

playbackPause()

void alexaClientSDK::sampleApplications::common::InteractionManager::playbackPause

(

)

Should be called whenever a user presses 'PAUSE' for playback.

playbackPlay()

void alexaClientSDK::sampleApplications::common::InteractionManager::playbackPlay

(

)

Should be called whenever a user presses 'PLAY' for playback.

playbackPrevious()

void alexaClientSDK::sampleApplications::common::InteractionManager::playbackPrevious

(

)

Should be called whenever a user presses 'PREVIOUS' for playback.

playbackRepeat()

void alexaClientSDK::sampleApplications::common::InteractionManager::playbackRepeat

(

bool

action

)

Should be called whenever a user presses 'REPEAT' for playback.

Parameters

action

The boolean action for the toggle state that needs to be applied. If true, repeat button is set to be active.

playbackShuffle()

void alexaClientSDK::sampleApplications::common::InteractionManager::playbackShuffle

(

bool

action

)

Should be called whenever a user presses 'SHUFFLE' for playback.

Parameters

action

The boolean action for the toggle state that needs to be applied. If true, shuffle button is set to be active.

playbackSkipBackward()

void alexaClientSDK::sampleApplications::common::InteractionManager::playbackSkipBackward

(

)

Should be called whenever a user presses 'SKIP_BACKWARD' for playback.

playbackSkipForward()

void alexaClientSDK::sampleApplications::common::InteractionManager::playbackSkipForward

(

)

Should be called whenever a user presses 'SKIP_FORWARD' for playback.

playbackThumbsDown()

void alexaClientSDK::sampleApplications::common::InteractionManager::playbackThumbsDown

(

bool

action

)

Should be called whenever a user presses 'THUMBS_DOWN' for playback.

Parameters

action

The boolean action for the toggle state that needs to be applied. If true, thumbs-down button is set to be active.

playbackThumbsUp()

void alexaClientSDK::sampleApplications::common::InteractionManager::playbackThumbsUp

(

bool

action

)

Should be called whenever a user presses 'THUMBS_UP' for playback.

Parameters

action

The boolean action for the toggle state that needs to be applied. If true, thumbs-up button is set to be active.

printProtocolTrace()

void alexaClientSDK::sampleApplications::common::InteractionManager::printProtocolTrace

(

)

Prints the protocol trace string.

resetDevice()

void alexaClientSDK::sampleApplications::common::InteractionManager::resetDevice

(

)

Reset the device and remove any customer data.

sendDeviceSetupComplete()

void alexaClientSDK::sampleApplications::common::InteractionManager::sendDeviceSetupComplete

(

)

Send the DeviceSetupComplete event

setAlarmVolumeRamp()

void alexaClientSDK::sampleApplications::common::InteractionManager::setAlarmVolumeRamp

(

bool

enable

)

Sets the Alarm Volume Ramp state.

setDoNotDisturbMode()

void alexaClientSDK::sampleApplications::common::InteractionManager::setDoNotDisturbMode

(

bool

enable

)

Sets the do not disturb mode state.

setFirmwareVersion()

void alexaClientSDK::sampleApplications::common::InteractionManager::setFirmwareVersion

(

avsCommon::sdkInterfaces::softwareInfo::FirmwareVersion

firmwareVersion

)

Update the firmware version.

Parameters

firmwareVersion

The new firmware version.

setLocale()

void alexaClientSDK::sampleApplications::common::InteractionManager::setLocale

(

const settings::DeviceLocales &

value

)

Sets the locale of the device.

setMute()

void alexaClientSDK::sampleApplications::common::InteractionManager::setMute	(	avsCommon::sdkInterfaces::ChannelVolumeInterface::Type	type,
		bool	mute
	)

Should be called after a user wishes to set mute.

setNetworkInfo()

void alexaClientSDK::sampleApplications::common::InteractionManager::setNetworkInfo

(

const settings::types::NetworkInfo &

value

)

Sets the network info of the device.

Parameters

value

The network info being set.

setProtocolTraceFlag()

void alexaClientSDK::sampleApplications::common::InteractionManager::setProtocolTraceFlag

(

bool

enabled

)

Enables the protocol trace utility.

Parameters

enabled

flag indicating if protocol trace is enabled/disabled.

setSpeechConfirmation()

void alexaClientSDK::sampleApplications::common::InteractionManager::setSpeechConfirmation

(

settings::SpeechConfirmationSettingType

value

)

Sets the speech confirmation state.

setTimeZone()

void alexaClientSDK::sampleApplications::common::InteractionManager::setTimeZone

(

const std::string &

value

)

Sets the time zone of the device.

settings()

void alexaClientSDK::sampleApplications::common::InteractionManager::settings

(

)

Should be called whenever a user presses 'SETTINGS' for settings options.

setWakewordConfirmation()

void alexaClientSDK::sampleApplications::common::InteractionManager::setWakewordConfirmation

(

settings::WakeWordConfirmationSettingType

value

)

Sets the wake word confirmation state.

showDeviceProperties()

void alexaClientSDK::sampleApplications::common::InteractionManager::showDeviceProperties

(

)

Prints a requested device property.

speakerControl()

void alexaClientSDK::sampleApplications::common::InteractionManager::speakerControl

(

)

Should be called whenever a users requests 'SPEAKER_CONTROL' for speaker control.

speechConfirmation()

void alexaClientSDK::sampleApplications::common::InteractionManager::speechConfirmation

(

)

Should be called whenever a user requests 'SPEECH_CONFIRMATION' change.

startMicrophone()

void alexaClientSDK::sampleApplications::common::InteractionManager::startMicrophone

(

)

Start streaming audio data from the microphone.

stopForegroundActivity()

void alexaClientSDK::sampleApplications::common::InteractionManager::stopForegroundActivity

(

)

Acts as a "stop" button. This stops whatever has foreground focus.

stopMicrophone()

void alexaClientSDK::sampleApplications::common::InteractionManager::stopMicrophone

(

)

Stop the microphone from streaming audio data.

tap()

void alexaClientSDK::sampleApplications::common::InteractionManager::tap

(

)

Should be called whenever a user presses and releases the tap button.

timeZone()

void alexaClientSDK::sampleApplications::common::InteractionManager::timeZone

(

)

Should be called whenever a user requests 'TIMEZONE' change.

volumeControl()

void alexaClientSDK::sampleApplications::common::InteractionManager::volumeControl

(

)

Should be called after a user selects a speaker.

wakewordConfirmation()

void alexaClientSDK::sampleApplications::common::InteractionManager::wakewordConfirmation

(

)

Should be called whenever a user requests 'WAKEWORD_CONFIRMATION' change.

---

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

• /workplace/avs-device-sdk/SampleApplications/Common/InteractionManager/include/acsdk/Sample/InteractionManager/InteractionManager.h