alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface Class Reference

#include <PresentationOrchestratorStateTrackerInterface.h>

Inheritance diagram for alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface:

Public Member Functions
virtual	~PresentationOrchestratorStateTrackerInterface ()=default
virtual void	acquireWindow (const std::string &clientId, const std::string &windowId, PresentationMetadata metadata)=0
virtual void	updatePresentationMetadata (const std::string &clientId, const std::string &windowId, PresentationMetadata metadata)=0
virtual void	releaseWindow (const std::string &clientId, const std::string &windowId)=0
virtual std::string	getFocusedInterface ()=0
virtual std::string	getFocusedWindowId ()=0
virtual void	setWindows (const std::vector< PresentationOrchestratorWindowInstance > &windows)=0
virtual bool	addWindow (const PresentationOrchestratorWindowInstance &window)=0
virtual void	removeWindow (const std::string &windowId)=0
virtual void	updateWindow (const PresentationOrchestratorWindowInstance &window)=0
virtual std::vector< PresentationOrchestratorWindowInfo >	getWindowInformation ()=0
virtual void	addWindowObserver (std::weak_ptr< PresentationOrchestratorWindowObserverInterface > observer)=0
virtual void	removeWindowObserver (std::weak_ptr< PresentationOrchestratorWindowObserverInterface > observer)=0
virtual void	addStateObserver (std::weak_ptr< PresentationOrchestratorStateObserverInterface > observer)=0
virtual void	removeStateObserver (std::weak_ptr< PresentationOrchestratorStateObserverInterface > observer)=0
virtual void	setDeviceInterface (std::string interfaceName)=0
virtual void	releaseDeviceInterface ()=0

Detailed Description

The PresentationOrchestratorStateTrackerInterface tracks windows and presentations, the active presentation state will be reported to the VisualActivityTracker in addition to any registered observers.

Constructor & Destructor Documentation

~PresentationOrchestratorStateTrackerInterface()

virtual alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::~PresentationOrchestratorStateTrackerInterface ( )

virtualdefault

Member Function Documentation

acquireWindow()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::acquireWindow ( const std::string &  clientId, const std::string &  windowId, PresentationMetadata  metadata  )

pure virtual

Acquires, or reacquires the given window ID To ensure accurate state reporting it is recommended this function is called whenever a window is foregrounded

Parameters

clientId	The identifier for the client making this request
windowId	The window ID which is being acquired
metadata	The metadata for this request

addStateObserver()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::addStateObserver ( std::weak_ptr< PresentationOrchestratorStateObserverInterface >  observer )

pure virtual

Adds an observer to be notified of state changes

Parameters

observer

The observer to add

addWindow()

virtual bool alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::addWindow ( const PresentationOrchestratorWindowInstance &  window )

pure virtual

Adds a window instance to the orchestrator

Parameters

window

The window instance information

Returns

true if the window was added, false if the addition failed

addWindowObserver()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::addWindowObserver ( std::weak_ptr< PresentationOrchestratorWindowObserverInterface >  observer )

pure virtual

Adds an observer to be notified of window changes

Parameters

observer

The observer to add

getFocusedInterface()

virtual std::string alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::getFocusedInterface ( )

pure virtual

Retrieve the interface for the current focused presentation

Returns

The interface, or an empty string if nothing is active

getFocusedWindowId()

virtual std::string alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::getFocusedWindowId ( )

pure virtual

Retrieve the current focused windowId

Returns

The window ID, or an empty string if nothing is active

getWindowInformation()

virtual std::vector<PresentationOrchestratorWindowInfo> alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::getWindowInformation ( )

pure virtual

Retrieves information for all window instances tracked by orchestrator

Returns

vector of window information

releaseDeviceInterface()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::releaseDeviceInterface ( )

pure virtual

Releases the device interface which was previously set with setDeviceInterface

releaseWindow()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::releaseWindow ( const std::string &  clientId, const std::string &  windowId  )

pure virtual

Releases a previously acquired window

Parameters

clientId	The identifier for the client making this request
windowId	The window ID which is being released

removeStateObserver()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::removeStateObserver ( std::weak_ptr< PresentationOrchestratorStateObserverInterface >  observer )

pure virtual

Removes an observer that was previously added

Parameters

observer

The observer to remove

removeWindow()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::removeWindow ( const std::string &  windowId )

pure virtual

Removes a window instance from this orchestrator

Parameters

windowId

The id of the window to remove

removeWindowObserver()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::removeWindowObserver ( std::weak_ptr< PresentationOrchestratorWindowObserverInterface >  observer )

pure virtual

Removes a window observer that was previously added

Parameters

observer

The observer to remove

setDeviceInterface()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::setDeviceInterface ( std::string  interfaceName )

pure virtual

Sets the interface which will be reported if no other clients have acquired a window

Parameters

interfaceName

The interface to report in VisualActivityTracker

setWindows()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::setWindows ( const std::vector< PresentationOrchestratorWindowInstance > &  windows )

pure virtual

Sets the window instances that the orchestrator should track. Will remove/update any existing orchestrator windows that are not in the set or have changed. Will add any window instances in the set that are not currently handled by orchestrator.

Parameters

windows

Array of window instances

updatePresentationMetadata()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::updatePresentationMetadata ( const std::string &  clientId, const std::string &  windowId, PresentationMetadata  metadata  )

pure virtual

Updates the presentation metadata, a previous acquireWindow call should already have been made This function does not move this client to the front of the window stack

Parameters

clientId	The identifier for the client making this request
windowId	The window ID to update
metadata	The new metadata

updateWindow()

virtual void alexaClientSDK::presentationOrchestratorInterfaces::PresentationOrchestratorStateTrackerInterface::updateWindow ( const PresentationOrchestratorWindowInstance &  window )

pure virtual

Updates an existing window instance

Parameters

window

The window instance information, the window id must already exist

---

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

• /workplace/avs-device-sdk/shared/PresentationOrchestrator/PresentationOrchestratorInterfaces/include/acsdk/PresentationOrchestratorInterfaces/PresentationOrchestratorStateTrackerInterface.h