Inheritance diagram for alexaClientSDK::acsdkAlerts::renderer::RendererObserverInterface:

[legend]

Public Types
enum	State { State::UNSET, State::STARTED, State::STOPPED, State::COMPLETED, State::ERROR }

Public Member Functions
virtual	~RendererObserverInterface ()=default

virtual void	onRendererStateChange (State state, const std::string &reason="")=0

Static Public Member Functions
static std::string	stateToString (State state)

Detailed Description

An interface class which specifies an observer to an Alert renderer.

Member Enumeration Documentation

strong

The states which a Renderer may be in.

Enumerator
UNSET	An uninitialized value.
STARTED	The renderer has started rendering.
STOPPED	The renderer has stopped rendering due to being stopped via a direct api call.
COMPLETED	The renderer has completed rendering, if the renderer was initiated with a finite loop count.
ERROR	The renderer has encountered an error.

virtual alexaClientSDK::acsdkAlerts::renderer::RendererObserverInterface::~RendererObserverInterface ( )

virtualdefault

Destructor.

virtual void alexaClientSDK::acsdkAlerts::renderer::RendererObserverInterface::onRendererStateChange	(	State	state,
		const std::string &	reason = `""`
	)

pure virtual

A callback function to communicate a change in render state.

Parameters

state	The current state of the renderer.
reason	The reason for the change of state, if required. This is typically set on an error.

std::string alexaClientSDK::acsdkAlerts::renderer::RendererObserverInterface::stateToString ( State state )

inlinestatic

Convert a State to a std::string.

Parameters

state The State to convert.

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

/workplace/avs-device-sdk/capabilities/Alerts/acsdkAlerts/include/acsdkAlerts/Renderer/RendererObserverInterface.h