alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsInterface Class Reference

#include <VisualCharacteristicsInterface.h>

Inheritance diagram for alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsInterface:

Public Member Functions
virtual	~VisualCharacteristicsInterface ()=default
virtual std::vector< WindowTemplate >	getWindowTemplates ()=0
virtual std::vector< InteractionMode >	getInteractionModes ()=0
virtual DisplayCharacteristics	getDisplayCharacteristics ()=0
virtual void	setWindowInstances (const std::vector< WindowInstance > &instances, const std::string &defaultWindowInstanceId)=0
virtual bool	addWindowInstance (const WindowInstance &instance)=0
virtual bool	removeWindowInstance (const std::string &windowInstanceId)=0
virtual void	updateWindowInstance (const WindowInstance &instance)=0
virtual bool	setDefaultWindowInstance (const std::string &windowInstanceId)=0

Detailed Description

Interface contract for VisualCharacteristics capability agent.

Constructor & Destructor Documentation

~VisualCharacteristicsInterface()

virtual alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsInterface::~VisualCharacteristicsInterface ( )

virtualdefault

Destructor

Member Function Documentation

addWindowInstance()

virtual bool alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsInterface::addWindowInstance ( const WindowInstance &  instance )

pure virtual

Adds a window instance to be reported in WindowState

Parameters

instance

The window instance to add, the templateId, interactionMode and sizeConfigurationId must match existing Ids which are reported by VisualCharacteristics, the window ID must be unique

Returns

true if the instance was successfully added, false otherwise

getDisplayCharacteristics()

virtual DisplayCharacteristics alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsInterface::getDisplayCharacteristics ( )

pure virtual

Get the display characteristics

Returns

the display characteristics object

getInteractionModes()

virtual std::vector<InteractionMode> alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsInterface::getInteractionModes ( )

pure virtual

Retrieve the interaction mode configuration

Returns

vector containing the interaction modes

getWindowTemplates()

virtual std::vector<WindowTemplate> alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsInterface::getWindowTemplates ( )

pure virtual

Gets the window template configuration

Returns

vector containing the window templates

removeWindowInstance()

virtual bool alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsInterface::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

setDefaultWindowInstance()

virtual bool alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsInterface::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

setWindowInstances()

virtual void alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsInterface::setWindowInstances ( const std::vector< WindowInstance > &  instances, const std::string &  defaultWindowInstanceId  )

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

updateWindowInstance()

virtual void alexaClientSDK::visualCharacteristicsInterfaces::VisualCharacteristicsInterface::updateWindowInstance ( const WindowInstance &  instance )

pure virtual

Updates an already existing window instance

Parameters

instace

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

---

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

• /workplace/avs-device-sdk/capabilities/VisualCharacteristics/VisualCharacteristicsInterfaces/include/acsdk/VisualCharacteristicsInterfaces/VisualCharacteristicsInterface.h