alexaClientSDK::aplCapabilityCommonInterfaces::VisualStateProviderInterface Class Reference

#include <VisualStateProviderInterface.h>

Inheritance diagram for alexaClientSDK::aplCapabilityCommonInterfaces::VisualStateProviderInterface:

Public Member Functions
virtual	~VisualStateProviderInterface ()=default
virtual void	provideState (const PresentationToken &token, const avsCommon::sdkInterfaces::ContextRequestToken stateRequestToken)=0

Detailed Description

A VisualStateProviderInterface may be any client component that provides updates on the visual context of the device.

Constructor & Destructor Documentation

~VisualStateProviderInterface()

virtual alexaClientSDK::aplCapabilityCommonInterfaces::VisualStateProviderInterface::~VisualStateProviderInterface ( )

virtualdefault

Destructor.

Member Function Documentation

provideState()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::VisualStateProviderInterface::provideState ( const PresentationToken &  token, const avsCommon::sdkInterfaces::ContextRequestToken  stateRequestToken  )

pure virtual

A request to a VisualStateProvider to provide the state. The requester specifies a token which the VisualStateProvider must use when it updates the state via the onVisualContextAvailable call to APL Capability Agent.

Parameters

token	The token of the last displaying document to get the correct context in the onVisualContextAvailable call.
stateRequestToken	The token to use in the onVisualContextAvailable call.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::AplClientBridge, and alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimePresentationAdapter.

---

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

• /workplace/avs-device-sdk/capabilities/APLCapabilityCommon/APLCapabilityCommonInterfaces/include/acsdk/APLCapabilityCommonInterfaces/VisualStateProviderInterface.h