alexaClientSDK::sampleApplications::ipcServerSampleApp::gui Namespace Reference

Classes
class	GUIActivityEventNotifier
class	GUIActivityEventNotifierInterface
class	GUIClient
class	GUIClientInterface
class	GUIManager
class	GUIServerInterface
	An interface providing APIs to be used by GUIClient. More...
class	TemplateRuntimePresentationAdapterBridge

Enumerations
enum	CaptureState { CaptureState::START, CaptureState::STOP, CaptureState::UNKNOWN }
	Enumeration defining the states of audio input initiator. More...
enum	NavigationEvent { NavigationEvent::EXIT, NavigationEvent::BACK, NavigationEvent::UNKNOWN }
	Enumeration of navigation events that could be sent from GUI App to SampleApp. More...

Functions
CaptureState	captureStateFromString (const std::string &string)
std::string	captureStateToString (CaptureState state)
NavigationEvent	navigationEventFromString (const std::string &string)
std::string	navigationEventToString (NavigationEvent event)

Enumeration Type Documentation

CaptureState

enum alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::CaptureState

strong

Enumeration defining the states of audio input initiator.

Enumerator
START	Start Capture.
STOP	Stop Capture. Only supported for PRESS_AND_HOLD. TAP will stop capturing only when StopCapture directive is received by device. See also https://developer.amazon.com/en-US/docs/alexa/alexa-voice-service/speechrecognizer.html#stopcapture
UNKNOWN	Guard option for unknown received state.

NavigationEvent

enum alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::NavigationEvent

strong

Enumeration of navigation events that could be sent from GUI App to SampleApp.

Enumerator
EXIT	Exit button has been pressed.
BACK	Back button has been pressed.
UNKNOWN	Guard option for unknown received state.

Function Documentation

captureStateFromString()

CaptureState alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::captureStateFromString ( const std::string &  string )

inline

This function converts the provided string to an CaptureState.

Parameters

string

The string to convert to CaptureState.

Returns

The CaptureState.

captureStateToString()

std::string alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::captureStateToString ( CaptureState  state )

inline

This function converts a CaptureState to a string.

Parameters

state

the input CaptureState.

Returns

the string for the input CaptureState.

navigationEventFromString()

NavigationEvent alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::navigationEventFromString ( const std::string &  string )

inline

This function converts the provided string to an NavigationEvent.

Parameters

string

The string to convert to NavigationEvent.

Returns

The NavigationEvent.

navigationEventToString()

std::string alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::navigationEventToString ( NavigationEvent  event )

inline

This function converts a NavigationEvent to string

Parameters

event

the input NavigationEvent

Returns

the string for the input NavigationEvent