#include <GUIManager.h>

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

[legend]

Collaboration diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager:

[legend]

Public Member Functions
void	onDialogUXStateChanged (DialogUXState newState) override

void	setClient (std::shared_ptr< sdkClient::SDKClientRegistry > clientRegistry)

bool	configureSettingsNotifications ()

void	setIpcVersionManager (std::shared_ptr< ipc::IPCVersionManager > ipcVersionManager)

bool	parseWindowInstance (const rapidjson::Value &payload, presentationOrchestratorInterfaces::PresentationOrchestratorWindowInstance &windowInstance)

void	forceClearDialogChannelFocus ()

GUIServerInterface methods
void	handleRecognizeSpeechRequest (capabilityAgents::aip::Initiator initiator, bool start) override

void	handleMicrophoneToggle () override

void	handlePlaybackPlay () override

void	handlePlaybackPause () override

void	handlePlaybackNext () override

void	handlePlaybackPrevious () override

void	handlePlaybackSeekTo (int offset) override

void	handlePlaybackSkipForward () override

void	handlePlaybackSkipBackward () override

void	handlePlaybackToggle (const std::string &name, bool checked) override

void	onUserEvent () override

bool	handleFocusAcquireRequest (std::string avsInterface, std::string channelName, avsCommon::avs::ContentType contentType, std::shared_ptr< avsCommon::sdkInterfaces::ChannelObserverInterface > channelObserver) override

bool	handleFocusReleaseRequest (std::string avsInterface, std::string channelName, std::shared_ptr< avsCommon::sdkInterfaces::ChannelObserverInterface > channelObserver) override

void	handleGUIActivityEvent (avsCommon::sdkInterfaces::GUIActivityEvent event, const std::string &source="") override

void	handleNavigationEvent (NavigationEvent event) override

std::vector< visualCharacteristicsInterfaces::WindowTemplate >	getWindowTemplates () override

std::vector< visualCharacteristicsInterfaces::InteractionMode >	getInteractionModes () override

visualCharacteristicsInterfaces::DisplayCharacteristics	getDisplayCharacteristics () override

void	setWindowInstances (const std::vector< presentationOrchestratorInterfaces::PresentationOrchestratorWindowInstance > &instances, const std::string &defaultWindowInstanceId, const std::string &audioPlaybackUIWindowId) override

bool	addWindowInstance (const presentationOrchestratorInterfaces::PresentationOrchestratorWindowInstance &instance) override

bool	removeWindowInstance (const std::string &windowInstanceId) override

void	updateWindowInstance (const presentationOrchestratorInterfaces::PresentationOrchestratorWindowInstance &instance) override

bool	setDefaultWindowInstance (const std::string &windowInstanceId) override

bool	serializeInteractionMode (const std::vector< visualCharacteristicsInterfaces::InteractionMode > &interactionModes, std::string &serializedJson) override

bool	serializeWindowTemplate (const std::vector< visualCharacteristicsInterfaces::WindowTemplate > &windowTemplates, std::string &serializedJson) override

bool	serializeDisplayCharacteristics (const visualCharacteristicsInterfaces::DisplayCharacteristics &display, std::string &serializedJson) override

void	forceExit () override

std::chrono::milliseconds	getDeviceTimezoneOffset () override

void	handleOnMessagingServerConnectionOpened () override

void	handleDocumentTerminated (const std::string &token, bool failed) override

void	acceptCall () override

void	stopCall () override

void	enableLocalVideo () override

void	disableLocalVideo () override

void	handleLocaleChange () override

void	initClient () override

DoNotDisturbHandlerInterface methods
}
void	doNotDisturbStateChanged (const std::string &message) override

void	doNotDisturbStateRequest (const std::string &message) override

SessionSetupHandlerInterface methods
}
void	namespaceVersionsReport (const std::string &message) override

void	clientInitialized (const std::string &message) override

void	clientConfigRequest (const std::string &message) override

WindowManagerHandlerInterface methods
}
void	visualCharacteristicsRequest (const std::string &message) override

void	defaultWindowInstanceChanged (const std::string &message) override

void	windowInstancesReport (const std::string &message) override

void	windowInstancesAdded (const std::string &message) override

void	windowInstancesRemoved (const std::string &message) override

void	windowInstancesUpdated (const std::string &message) override

InteractionManagerHandlerInterface methods
}
void	recognizeSpeechRequest (const std::string &message) override

void	navigationEvent (const std::string &message) override

void	guiActivityEvent (const std::string &message) override

LoggerHandlerInterface methods
}
void	logEvent (const std::string &message) override

FocusManagerObserverInterface methods
}
void	onFocusChanged (const std::string &channelName, avsCommon::avs::FocusState newFocus) override

AudioPlayerObserverInterface methods
}
void	onPlayerActivityChanged (avsCommon::avs::PlayerActivity state, const Context &context) override

PresentationOrchestratorStateObserverInterface Functions
}
void	onStateChanged (const std::string &windowId, const presentationOrchestratorInterfaces::PresentationMetadata &metadata) override

AudioInputProcessorObserverInterface methods.
void	onStateChanged (AudioInputProcessorObserverInterface::State state) override

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::DialogUXStateObserverInterface
virtual	~DialogUXStateObserverInterface ()=default

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AudioInputProcessorObserverInterface
virtual	~AudioInputProcessorObserverInterface ()=default
	Destructor. More...

virtual void	onStateChanged (State state)=0

virtual void	onASRProfileChanged (const std::string &profile)

Public Member Functions inherited from alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface
virtual	~AudioPlayerObserverInterface ()=default

virtual void	onSeekActivity (const SeekStatus seekStatus, const Context &context)

Public Member Functions inherited from alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateObserverInterface
virtual	~PresentationOrchestratorStateObserverInterface ()=default

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::FocusManagerObserverInterface
virtual	~FocusManagerObserverInterface ()=default

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

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ChannelObserverInterface
virtual	~ChannelObserverInterface ()=default

Public Member Functions inherited from alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::DoNotDisturbHandlerInterface
virtual	~DoNotDisturbHandlerInterface ()=default

Public Member Functions inherited from alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::SessionSetupHandlerInterface
virtual	~SessionSetupHandlerInterface ()=default

Public Member Functions inherited from alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::WindowManagerHandlerInterface
virtual	~WindowManagerHandlerInterface ()=default

Public Member Functions inherited from alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::InteractionManagerHandlerInterface
virtual	~InteractionManagerHandlerInterface ()=default

Public Member Functions inherited from alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::LoggerHandlerInterface
virtual	~LoggerHandlerInterface ()=default

Static Public Member Functions
static std::shared_ptr< GUIManager >	create (std::shared_ptr< gui::GUIClientInterface > guiClient, std::shared_ptr< gui::GUIActivityEventNotifierInterface > activityEventNotifier, std::shared_ptr< applicationUtilities::resources::audio::MicrophoneInterface > micWrapper, std::shared_ptr< common::InteractionManager > interactionManager, std::shared_ptr< common::EndpointAlexaLauncherHandler > launcherHandler)

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::AudioInputProcessorObserverInterface
static std::string	stateToString (State state)

ChannelObserverInterface Methods
void	onFocusChanged (avsCommon::avs::FocusState newFocus, avsCommon::avs::MixingBehavior behavior) override
	} More...

void	setAPLRuntimePresentationAdapter (std::shared_ptr< APLRuntimePresentationAdapter > aplRuntimePresentationAdapter)
	} More...

void	setTemplateRuntimePresentationAdapterBridge (std::shared_ptr< TemplateRuntimePresentationAdapterBridge > templateRuntimePresentationAdapterBridge)

void	initialize ()

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::AudioInputProcessorObserverInterface
enum	State { State::IDLE, State::EXPECTING_SPEECH, State::RECOGNIZING, State::BUSY }
	The different states the `AudioInputProcessor` can be in. More...

Public Types inherited from alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface
enum	SeekStatus { SeekStatus::SEEK_START, SeekStatus::SEEK_COMPLETE }
	Enum representing Seek activities. More...

Detailed Description

Manages all GUI related operations to be called from the SDK and the GUIClient

Member Function Documentation

◆ acceptCall()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::acceptCall ( )

overridevirtual

Handle accept call event.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ addWindowInstance()

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

overridevirtual

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

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ clientConfigRequest()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::clientConfigRequest ( const std::string & message )

overridevirtual

IPC Client sends this event to request SDK to send a client-defined config payload for the IPC Client via the configureClient directive.

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::SessionSetupHandlerInterface.

◆ clientInitialized()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::clientInitialized ( const std::string & message )

overridevirtual

IPC Client sends this event to inform the SDK as a response to the initializeClient directive.

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::SessionSetupHandlerInterface.

◆ configureSettingsNotifications()

bool alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::configureSettingsNotifications ( )

Configure settings notifications.

Returns: if it succeeds to configure the settings notifications; false otherwise.

◆ create()

static std::shared_ptr<GUIManager> alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::create	(	std::shared_ptr< gui::GUIClientInterface >	guiClient,
		std::shared_ptr< gui::GUIActivityEventNotifierInterface >	activityEventNotifier,
		std::shared_ptr< applicationUtilities::resources::audio::MicrophoneInterface >	micWrapper,
		std::shared_ptr< common::InteractionManager >	interactionManager,
		std::shared_ptr< common::EndpointAlexaLauncherHandler >	launcherHandler
	)

static

Create a GUIManager.

Parameters

guiClient	A pointer to a GUI Client.
activityEventNotifier	A pointer to a activity event notifier.
micWrapper	A pointer to a microphone wrapper.
interactionManager	A pointer to interaction manager.
launcherHandler	A pointer to launcher handler.

Returns: An instance of GUIManager.

◆ defaultWindowInstanceChanged()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::defaultWindowInstanceChanged ( const std::string & message )

overridevirtual

IPC Client sends this event to inform the SDK of a change to the default window instance id to report in WindowState.

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::WindowManagerHandlerInterface.

◆ disableLocalVideo()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::disableLocalVideo ( )

overridevirtual

Handle disable local video event.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ doNotDisturbStateChanged()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::doNotDisturbStateChanged ( const std::string & message )

overridevirtual

Set Do Not Disturb mode.

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::DoNotDisturbHandlerInterface.

◆ doNotDisturbStateRequest()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::doNotDisturbStateRequest ( const std::string & message )

overridevirtual

Request the SDK to inform current Do Not Disturb setting state.

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::DoNotDisturbHandlerInterface.

◆ enableLocalVideo()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::enableLocalVideo ( )

overridevirtual

Handle enable local video event.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ forceClearDialogChannelFocus()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::forceClearDialogChannelFocus ( )

This will force clear the DIALOG channel and reset it, allowing for proper cloud-side context when locally stopping DIALOG channel.

◆ forceExit()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::forceExit ( )

overridevirtual

Force exit to reset focus state and clear card.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ getDeviceTimezoneOffset()

std::chrono::milliseconds alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::getDeviceTimezoneOffset ( )

overridevirtual

Gets Device Time Zone Offset.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ getDisplayCharacteristics()

visualCharacteristicsInterfaces::DisplayCharacteristics alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::getDisplayCharacteristics ( )

overridevirtual

Get the display characteristics

Returns: the display characteristics object

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ getInteractionModes()

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

overridevirtual

Retrieve the interaction mode configuration

Returns: vector containing the interaction modes

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ getWindowTemplates()

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

overridevirtual

Gets the window template configuration

Returns: vector containing the window templates

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ guiActivityEvent()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::guiActivityEvent ( const std::string & message )

overridevirtual

Handle GUI activity event message.

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::InteractionManagerHandlerInterface.

◆ handleDocumentTerminated()

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

overridevirtual

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.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handleFocusAcquireRequest()

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

overridevirtual

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.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handleFocusReleaseRequest()

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

overridevirtual

Handle focus release requests.

Parameters

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

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handleGUIActivityEvent()

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

overridevirtual

Handle activityEvent message.

Parameters

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

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handleLocaleChange()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::handleLocaleChange ( )

overridevirtual

Handle Locale Change

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handleMicrophoneToggle()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::handleMicrophoneToggle ( )

overridevirtual

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.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handleNavigationEvent()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::handleNavigationEvent ( NavigationEvent event )

overridevirtual

Handle event the navigation event.

Parameters

event the navigation event.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handleOnMessagingServerConnectionOpened()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::handleOnMessagingServerConnectionOpened ( )

overridevirtual

Handle an onConnectionOpened event from the messaging server

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handlePlaybackNext()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::handlePlaybackNext ( )

overridevirtual

Handle playback 'NEXT' event.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handlePlaybackPause()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::handlePlaybackPause ( )

overridevirtual

Handle playback 'PAUSE' event.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handlePlaybackPlay()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::handlePlaybackPlay ( )

overridevirtual

Handle playback 'PLAY' event.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handlePlaybackPrevious()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::handlePlaybackPrevious ( )

overridevirtual

Handle playback 'PREVIOUS' event.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handlePlaybackSeekTo()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::handlePlaybackSeekTo ( int offset )

overridevirtual

Handle playback 'SEEK_TO' event.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handlePlaybackSkipBackward()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::handlePlaybackSkipBackward ( )

overridevirtual

Handle playback 'SKIP_BACKWARD' event.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handlePlaybackSkipForward()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::handlePlaybackSkipForward ( )

overridevirtual

Handle playback 'SKIP_FORWARD' event.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handlePlaybackToggle()

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

overridevirtual

Handle playback 'TOGGLE' event.

Parameters

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

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ handleRecognizeSpeechRequest()

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

overridevirtual

Handle Recognize Speech Request Event

Parameters

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

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ initClient()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::initClient ( )

overridevirtual

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

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ initialize()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::initialize ( )

Initializes the IPC handlers implemented by the GUIManager.

◆ logEvent()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::logEvent ( const std::string & message )

overridevirtual

IPC Client sends this event to log a message to the SDK’s native logger implementation

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::LoggerHandlerInterface.

◆ namespaceVersionsReport()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::namespaceVersionsReport ( const std::string & message )

overridevirtual

IPC Client sends this event to inform the SDK of the supported IPC namespace versions in the client.

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::SessionSetupHandlerInterface.

◆ navigationEvent()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::navigationEvent ( const std::string & message )

overridevirtual

Handle event the navigation event.

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::InteractionManagerHandlerInterface.

◆ onDialogUXStateChanged()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::onDialogUXStateChanged ( DialogUXState newState )

overridevirtual

UXDialogObserverInterface methods

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

◆ onFocusChanged() [1/2]

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::onFocusChanged	(	const std::string &	channelName,
		avsCommon::avs::FocusState	newFocus
	)

overridevirtual

Used to notify the observer of focus changes. This function should return quickly.

Parameters

channelName	The name of the channel which changed `FocusState`.
newFocus	The new `FocusState` of `channelName`.

Implements alexaClientSDK::avsCommon::sdkInterfaces::FocusManagerObserverInterface.

◆ onFocusChanged() [2/2]

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::onFocusChanged	(	avsCommon::avs::FocusState	newFocus,
		avsCommon::avs::MixingBehavior	behavior
	)

overridevirtual

}

Sets the APL Runtime adapter

Parameters

aplRuntimePresentationAdapter Shared pointer to APL runtime adapter

Implements alexaClientSDK::avsCommon::sdkInterfaces::ChannelObserverInterface.

◆ onPlayerActivityChanged()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::onPlayerActivityChanged	(	avsCommon::avs::PlayerActivity	state,
		const Context &	context
	)

overridevirtual

Used to notify the observer when the AudioPlayer has a change in PlayerActivity.

Parameters

state	The `PlayerActivity` of the `AudioPlayer`.
context	The `Context` of the `AudioPlayer`.

Implements alexaClientSDK::acsdkAudioPlayerInterfaces::AudioPlayerObserverInterface.

◆ onStateChanged() [1/2]

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::onStateChanged	(	const std::string &	windowId,
		const presentationOrchestratorInterfaces::PresentationMetadata &	metadata
	)

overridevirtual

Called when the active presentation in a window has changed

Parameters

windowId	The window ID which was updated
metadata	The new focus metadata

Implements alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateObserverInterface.

◆ onStateChanged() [2/2]

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::onStateChanged ( AudioInputProcessorObserverInterface::State state )

override

◆ onUserEvent()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::onUserEvent ( )

overridevirtual

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ parseWindowInstance()

bool alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::parseWindowInstance	(	const rapidjson::Value &	payload,
		presentationOrchestratorInterfaces::PresentationOrchestratorWindowInstance &	windowInstance
	)

Parse window instance from the specified json.

Parameters

payload	The payload to be parsed
windowInstance	[ out ] Parsed object for `WindowInstance`.

Returns: true if parsed successfully, false otherwise.

◆ recognizeSpeechRequest()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::recognizeSpeechRequest ( const std::string & message )

overridevirtual

Open or close the microphone to start an Alexa interaction via the SpeechRecognizer.Recognize event.

See also: https://developer.amazon.com/en-US/docs/alexa/alexa-voice-service/speechrecognizer.html#recognize

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::InteractionManagerHandlerInterface.

◆ removeWindowInstance()

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

overridevirtual

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

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ serializeDisplayCharacteristics()

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

overridevirtual

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.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ serializeInteractionMode()

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

overridevirtual

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.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ serializeWindowTemplate()

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

overridevirtual

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.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ setAPLRuntimePresentationAdapter()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::setAPLRuntimePresentationAdapter ( std::shared_ptr< APLRuntimePresentationAdapter > aplRuntimePresentationAdapter )

}

Sets the APL Runtime adapter

Parameters

aplRuntimePresentationAdapter Shared pointer to APL runtime adapter

◆ setClient()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::setClient ( std::shared_ptr< sdkClient::SDKClientRegistry > clientRegistry )

Sets the SDK Client Registry

Parameters

clientRegistry Reference to the SDKClientRegistry

◆ setDefaultWindowInstance()

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

overridevirtual

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

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ setIpcVersionManager()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::setIpcVersionManager ( std::shared_ptr< ipc::IPCVersionManager > ipcVersionManager )

Set the IPCVersion manager.

Parameters

ipcVersionManager Pointer to the IPCVersionManager.

◆ setTemplateRuntimePresentationAdapterBridge()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::setTemplateRuntimePresentationAdapterBridge ( std::shared_ptr< TemplateRuntimePresentationAdapterBridge > templateRuntimePresentationAdapterBridge )

Sets the TemplateRuntime Presentation Adapter Bridge

Parameters

templateRuntimePresentationAdapterBridge The TemplateRuntimePresentationAdapterBridge

◆ setWindowInstances()

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

overridevirtual

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

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ stopCall()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::stopCall ( )

overridevirtual

Handle stop call event.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ updateWindowInstance()

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

overridevirtual

Updates an already existing window instance

Parameters

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

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIServerInterface.

◆ visualCharacteristicsRequest()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::visualCharacteristicsRequest ( const std::string & message )

overridevirtual

IPC Client sends this event to request the visual characteristics asserted by SDK.

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::WindowManagerHandlerInterface.

◆ windowInstancesAdded()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::windowInstancesAdded ( const std::string & message )

overridevirtual

IPC Client sends this event to inform the SDK of the window instances added in the IPC Client to track for visual presentation.

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::WindowManagerHandlerInterface.

◆ windowInstancesRemoved()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::windowInstancesRemoved ( const std::string & message )

overridevirtual

IPC Client sends this event to inform the SDK of the window instances removed in the IPC Client to no longer track for visual presentation.

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::WindowManagerHandlerInterface.

◆ windowInstancesReport()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::windowInstancesReport ( const std::string & message )

overridevirtual

IPC Client sends this event to inform the SDK of the window instances created in the IPC Client to track for visual presentation.

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::WindowManagerHandlerInterface.

◆ windowInstancesUpdated()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::gui::GUIManager::windowInstancesUpdated ( const std::string & message )

overridevirtual

IPC Client sends this event to inform the SDK of the window instances updated in the IPC Client.

Parameters

message Incoming IPC message from the IPC client.

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::WindowManagerHandlerInterface.

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

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

Public Member Functions

Static Public Member Functions

ChannelObserverInterface Methods

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ acceptCall()

◆ addWindowInstance()

◆ clientConfigRequest()

◆ clientInitialized()

◆ configureSettingsNotifications()

◆ create()

◆ defaultWindowInstanceChanged()

◆ disableLocalVideo()

◆ doNotDisturbStateChanged()

◆ doNotDisturbStateRequest()

◆ enableLocalVideo()

◆ forceClearDialogChannelFocus()

◆ forceExit()

◆ getDeviceTimezoneOffset()

◆ getDisplayCharacteristics()

◆ getInteractionModes()

◆ getWindowTemplates()

◆ guiActivityEvent()

◆ handleDocumentTerminated()

◆ handleFocusAcquireRequest()

◆ handleFocusReleaseRequest()

◆ handleGUIActivityEvent()

◆ handleLocaleChange()

◆ handleMicrophoneToggle()

◆ handleNavigationEvent()

◆ handleOnMessagingServerConnectionOpened()

◆ handlePlaybackNext()

◆ handlePlaybackPause()

◆ handlePlaybackPlay()

◆ handlePlaybackPrevious()

◆ handlePlaybackSeekTo()

◆ handlePlaybackSkipBackward()

◆ handlePlaybackSkipForward()

◆ handlePlaybackToggle()

◆ handleRecognizeSpeechRequest()

◆ initClient()

◆ initialize()

◆ logEvent()

◆ namespaceVersionsReport()

◆ navigationEvent()

◆ onDialogUXStateChanged()

◆ onFocusChanged() [1/2]

◆ onFocusChanged() [2/2]

◆ onPlayerActivityChanged()

◆ onStateChanged() [1/2]

◆ onStateChanged() [2/2]

◆ onUserEvent()

◆ parseWindowInstance()

◆ recognizeSpeechRequest()

◆ removeWindowInstance()

◆ serializeDisplayCharacteristics()

◆ serializeInteractionMode()

◆ serializeWindowTemplate()

◆ setAPLRuntimePresentationAdapter()

◆ setClient()

◆ setDefaultWindowInstance()

◆ setIpcVersionManager()

◆ setTemplateRuntimePresentationAdapterBridge()

◆ setWindowInstances()

◆ stopCall()

◆ updateWindowInstance()

◆ visualCharacteristicsRequest()

◆ windowInstancesAdded()

◆ windowInstancesRemoved()

◆ windowInstancesReport()

◆ windowInstancesUpdated()