alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::APLClientHandlerInterface Class Reference

#include <APLClientHandlerInterface.h>

Inheritance diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::APLClientHandlerInterface:

Public Member Functions
virtual	~APLClientHandlerInterface ()=default
virtual void	initializeRenderersRequest (const std::string &message)=0
virtual void	metricsReport (const std::string &message)=0
virtual void	viewhostEvent (const std::string &message)=0
virtual void	renderCompleted (const std::string &message)=0
virtual void	renderDocumentRequest (const std::string &message)=0
virtual void	executeCommandsRequest (const std::string &message)=0
virtual void	clearDocumentRequest (const std::string &message)=0

Detailed Description

A contract to handle APLClient.

Constructor & Destructor Documentation

~APLClientHandlerInterface()

virtual alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::APLClientHandlerInterface::~APLClientHandlerInterface ( )

virtualdefault

Destructor

Member Function Documentation

clearDocumentRequest()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::APLClientHandlerInterface::clearDocumentRequest ( const std::string &  message )

pure virtual

IPC Client sends this event to clear a local APL document rendered via renderDocumentRequest and release the native renderer.

Parameters

message

Incoming IPC message from the IPC client.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::AplClientBridge.

executeCommandsRequest()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::APLClientHandlerInterface::executeCommandsRequest ( const std::string &  message )

pure virtual

IPC Client sends this event to initiate APL commands on a document rendered via renderDocumentRequest.

Parameters

message

Incoming IPC message from the IPC client.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::AplClientBridge.

initializeRenderersRequest()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::APLClientHandlerInterface::initializeRenderersRequest ( const std::string &  message )

pure virtual

IPC Client sends this event to initialize any native APLClientRenderer instances required for the IPC client’s windows.

Parameters

message

Incoming IPC message from the IPC client.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::AplClientBridge.

metricsReport()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::APLClientHandlerInterface::metricsReport ( const std::string &  message )

pure virtual

This event is sent from the APL IPC Viewhost to report APL Metrics defined in the Viewhost. Not intended to be manually invoked from the IPC client.

Parameters

message

Incoming IPC message from the IPC client.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::AplClientBridge.

renderCompleted()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::APLClientHandlerInterface::renderCompleted ( const std::string &  message )

pure virtual

IPC Client sends this event when the IPC APL Viewhost has completed inflation of an APL document after receipt of a createRenderer directive.

Parameters

message

Incoming IPC message from the IPC client.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::AplClientBridge.

renderDocumentRequest()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::APLClientHandlerInterface::renderDocumentRequest ( const std::string &  message )

pure virtual

IPC Client sends this event to initiate the local rendering of an APL document.

Parameters

message

Incoming IPC message from the IPC client.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::AplClientBridge.

viewhostEvent()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::APLClientHandlerInterface::viewhostEvent ( const std::string &  message )

pure virtual

This event is sent from the APL IPC Viewhost for communicating with APLCore. Not intended to be manually invoked from the IPC client.

Parameters

message

Incoming IPC message from the IPC client.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::AplClientBridge.

---

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

• /workplace/avs-device-sdk/SampleApplications/IPCServerSampleApplication/LibIPCServerSampleApp/include/IPCServerSampleApp/IPC/HandlerInterfaces/APLClientHandlerInterface.h