alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface Class Reference

An interface providing APIs to be used by GUIClient. More...

#include <GUIServerInterface.h>

Inheritance diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface:

Public Member Functions
virtual void	handleRecognizeSpeechRequest (capabilityAgents::aip::Initiator initiator, bool start)=0
virtual void	handleMicrophoneToggle ()=0
virtual void	handlePlaybackPlay ()=0
virtual void	handlePlaybackPause ()=0
virtual void	handlePlaybackNext ()=0
virtual void	handlePlaybackPrevious ()=0
virtual void	handlePlaybackSeekTo (int offset)=0
virtual void	handlePlaybackSkipForward ()=0
virtual void	handlePlaybackSkipBackward ()=0
virtual void	handlePlaybackToggle (const std::string &name, bool checked)=0
virtual bool	handleFocusAcquireRequest (std::string avsInterface, std::string channelName, avsCommon::avs::ContentType contentType, std::shared_ptr< avsCommon::sdkInterfaces::ChannelObserverInterface > channelObserver)=0
virtual bool	handleFocusReleaseRequest (std::string avsInterface, std::string channelName, std::shared_ptr< avsCommon::sdkInterfaces::ChannelObserverInterface > channelObserver)=0
virtual void	handleGUIActivityEvent (avsCommon::sdkInterfaces::GUIActivityEvent event, const std::string &source="")=0
virtual void	handleNavigationEvent (NavigationEvent event)=0
virtual std::vector< visualCharacteristicsInterfaces::WindowTemplate >	getWindowTemplates ()=0
virtual std::vector< visualCharacteristicsInterfaces::InteractionMode >	getInteractionModes ()=0
virtual visualCharacteristicsInterfaces::DisplayCharacteristics	getDisplayCharacteristics ()=0
virtual void	setWindowInstances (const std::vector< presentationOrchestratorInterfaces::PresentationOrchestratorWindowInstance > &instances, const std::string &defaultWindowInstanceId, const std::string &audioPlaybackUIWindowId)=0
virtual bool	addWindowInstance (const presentationOrchestratorInterfaces::PresentationOrchestratorWindowInstance &instance)=0
virtual bool	removeWindowInstance (const std::string &windowInstanceId)=0
virtual void	updateWindowInstance (const presentationOrchestratorInterfaces::PresentationOrchestratorWindowInstance &instance)=0
virtual bool	setDefaultWindowInstance (const std::string &windowInstanceId)=0
virtual bool	serializeInteractionMode (const std::vector< visualCharacteristicsInterfaces::InteractionMode > &interactionModes, std::string &serializedJson)=0
virtual bool	serializeWindowTemplate (const std::vector< visualCharacteristicsInterfaces::WindowTemplate > &windowTemplates, std::string &serializedJson)=0
virtual bool	serializeDisplayCharacteristics (const visualCharacteristicsInterfaces::DisplayCharacteristics &display, std::string &serializedJson)=0
virtual std::chrono::milliseconds	getDeviceTimezoneOffset ()=0
virtual void	onUserEvent ()=0
virtual void	forceExit ()=0
virtual void	acceptCall ()=0
virtual void	stopCall ()=0
virtual void	enableLocalVideo ()=0
virtual void	disableLocalVideo ()=0
virtual void	handleOnMessagingServerConnectionOpened ()=0
virtual void	handleDocumentTerminated (const std::string &token, bool failed)=0
virtual void	handleLocaleChange ()=0
virtual void	initClient ()=0

Detailed Description

An interface providing APIs to be used by GUIClient.

Member Function Documentation

acceptCall()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::acceptCall ( )

pure virtual

Handle accept call event.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

addWindowInstance()

virtual bool alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::addWindowInstance ( const presentationOrchestratorInterfaces::PresentationOrchestratorWindowInstance &  instance )

pure virtual

Adds a window instance to be reported in WindowState

Parameters

instance

The window instance to add

Returns

true if the instance was successfully added, false otherwise

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

disableLocalVideo()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::disableLocalVideo ( )

pure virtual

Handle disable local video event.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

enableLocalVideo()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::enableLocalVideo ( )

pure virtual

Handle enable local video event.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

forceExit()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::forceExit ( )

pure virtual

Force exit to reset focus state and clear card.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

getDeviceTimezoneOffset()

virtual std::chrono::milliseconds alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::getDeviceTimezoneOffset ( )

pure virtual

Gets Device Time Zone Offset.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

getDisplayCharacteristics()

virtual visualCharacteristicsInterfaces::DisplayCharacteristics alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::getDisplayCharacteristics ( )

pure virtual

Get the display characteristics

Returns

the display characteristics object

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

getInteractionModes()

virtual std::vector<visualCharacteristicsInterfaces::InteractionMode> alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::getInteractionModes ( )

pure virtual

Retrieve the interaction mode configuration

Returns

vector containing the interaction modes

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

getWindowTemplates()

virtual std::vector<visualCharacteristicsInterfaces::WindowTemplate> alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::getWindowTemplates ( )

pure virtual

Gets the window template configuration

Returns

vector containing the window templates

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handleDocumentTerminated()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handleDocumentTerminated ( const std::string &  token, bool  failed  )

pure virtual

Handle document terminated result. Handler should clear the associated APL document, and any active/pending ExecuteCommands directives for the document.

Parameters

token	the apl document result token.
failed	the indication if document terminated due to failure.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handleFocusAcquireRequest()

virtual bool alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handleFocusAcquireRequest ( std::string  avsInterface, std::string  channelName, avsCommon::avs::ContentType  contentType, std::shared_ptr< avsCommon::sdkInterfaces::ChannelObserverInterface >  channelObserver  )

pure virtual

Handle focus acquire requests.

Parameters

avsInterface	The AVS Interface requesting focus.
channelName	The channel to be requested.
contentType	The type of content acquiring focus.
channelObserver	the channelObserver to be notified.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handleFocusReleaseRequest()

virtual bool alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handleFocusReleaseRequest ( std::string  avsInterface, std::string  channelName, std::shared_ptr< avsCommon::sdkInterfaces::ChannelObserverInterface >  channelObserver  )

pure virtual

Handle focus release requests.

Parameters

avsInterface	The avsInterface to be released.
channelName	channelName to be released.
channelObserver	the channelObserver to be notified.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handleGUIActivityEvent()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handleGUIActivityEvent ( avsCommon::sdkInterfaces::GUIActivityEvent  event, const std::string &  source = ""  )

pure virtual

Handle activityEvent message.

Parameters

event	the activity event.
source	The source of the activity event. Default empty string.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handleLocaleChange()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handleLocaleChange ( )

pure virtual

Handle Locale Change

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handleMicrophoneToggle()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handleMicrophoneToggle ( )

pure virtual

Toggles the microphone state if the Sample App was built with wake word. 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 interaction is complete. If this app was built without wake word then this will do nothing as the microphone is already off.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handleNavigationEvent()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handleNavigationEvent ( NavigationEvent  event )

pure virtual

Handle event the navigation event.

Parameters

event

the navigation event.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handleOnMessagingServerConnectionOpened()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handleOnMessagingServerConnectionOpened ( )

pure virtual

Handle an onConnectionOpened event from the messaging server

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handlePlaybackNext()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handlePlaybackNext ( )

pure virtual

Handle playback 'NEXT' event.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handlePlaybackPause()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handlePlaybackPause ( )

pure virtual

Handle playback 'PAUSE' event.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handlePlaybackPlay()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handlePlaybackPlay ( )

pure virtual

Handle playback 'PLAY' event.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handlePlaybackPrevious()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handlePlaybackPrevious ( )

pure virtual

Handle playback 'PREVIOUS' event.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handlePlaybackSeekTo()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handlePlaybackSeekTo ( int  offset )

pure virtual

Handle playback 'SEEK_TO' event.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handlePlaybackSkipBackward()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handlePlaybackSkipBackward ( )

pure virtual

Handle playback 'SKIP_BACKWARD' event.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handlePlaybackSkipForward()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handlePlaybackSkipForward ( )

pure virtual

Handle playback 'SKIP_FORWARD' event.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handlePlaybackToggle()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handlePlaybackToggle ( const std::string &  name, bool  checked  )

pure virtual

Handle playback 'TOGGLE' event.

Parameters

name	name of the TOGGLE.
checked	checked state of the TOGGLE.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

handleRecognizeSpeechRequest()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::handleRecognizeSpeechRequest ( capabilityAgents::aip::Initiator  initiator, bool  start  )

pure virtual

Handle Recognize Speech Request Event

Parameters

initiator	the Initiator type for speech recognition
start	true if this is the start of speech recognition

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

initClient()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::initClient ( )

pure virtual

Initialize the IPC connection and inform the IPC client of the IPC framework version.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

onUserEvent()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::onUserEvent ( )

pure virtual

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

removeWindowInstance()

virtual bool alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::removeWindowInstance ( const std::string &  windowInstanceId )

pure virtual

Remove an existing window instance, at least one window must exist at all times

Parameters

windowInstanceId

The id of the window to remove

Returns

true if the instance was removed, false otherwise

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

serializeDisplayCharacteristics()

virtual bool alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::serializeDisplayCharacteristics ( const visualCharacteristicsInterfaces::DisplayCharacteristics &  display, std::string &  serializedJson  )

pure virtual

Serialize display characteristics into reportable json format.

Parameters

display	Instance of DisplayCharacteristics to be serialized
serializedJson	[ out ] Serialized json payload

Returns

True if serialization successful, false otherwise.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

serializeInteractionMode()

virtual bool alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::serializeInteractionMode ( const std::vector< visualCharacteristicsInterfaces::InteractionMode > &  interactionModes, std::string &  serializedJson  )

pure virtual

Serialize interaction modes into reportable json format.

Parameters

interactionModes	Collection of InteractionMode to be serialized
serializedJson	[ out ] Serialized json payload

Returns

True if serialization successful, false otherwise.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

serializeWindowTemplate()

virtual bool alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::serializeWindowTemplate ( const std::vector< visualCharacteristicsInterfaces::WindowTemplate > &  windowTemplates, std::string &  serializedJson  )

pure virtual

Serialize window template into reportable json format.

Parameters

windowTemplates	Collection of WindowTemplate to be serialized
serializedJson	[ out ] Serialized json payload

Returns

True if serialization successful, false otherwise.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

setDefaultWindowInstance()

virtual bool alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::setDefaultWindowInstance ( const std::string &  windowInstanceId )

pure virtual

Sets the default window instance

Parameters

windowInstanceId

The id of window to set as the default, this window id must already exist

Returns

true if the default has been set, false otherwise

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

setWindowInstances()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::setWindowInstances ( const std::vector< presentationOrchestratorInterfaces::PresentationOrchestratorWindowInstance > &  instances, const std::string &  defaultWindowInstanceId, const std::string &  audioPlaybackUIWindowId  )

pure virtual

Sets the window instances to be reported in WindowState. Replaces any windows in the existing WindowState set.

Parameters

instances	The vector of window instances to aad/report in WindowState
defaultWindowInstanceId	The default window id to report in WindowState
audioPlaybackUIWindowId	The id of the window handling audio playback to report in WindowState

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

stopCall()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::stopCall ( )

pure virtual

Handle stop call event.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

updateWindowInstance()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface::updateWindowInstance ( const presentationOrchestratorInterfaces::PresentationOrchestratorWindowInstance &  instance )

pure virtual

Updates an already existing window instance

Parameters

instance

The updated window instance, the window ID must match an already existing window

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager.

---

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

• /workplace/avs-device-sdk/SampleApplications/IPCServerSampleApplication/LibIPCServerSampleApp/include/IPCServerSampleApp/GUI/GUIServerInterface.h