aace::arbitrator::ArbitratorEngineInterface Class Reference

Classes
struct	DialogStateRule
	Describes the rules for the dialog state. More...

Public Types
enum	AgentState {   AgentState::ACTIVE,   AgentState::INACTIVE }
	Describes the agent states. More...
enum	Mode {   Mode::WAKEWORD,   Mode::GESTURE }
	Describes the dialog request modes. More...

Public Member Functions
virtual bool	onRegisterAgent (const std::string &assistantId, const std::string &name, const std::vector< DialogStateRule > &dialogStateRules)=0
virtual bool	onDeregisterAgent (const std::string &assistantId)=0
virtual void	onStartDialog (const std::string &assistantId, Mode mode, const std::string &token)=0
virtual void	onStopDialog (const std::string &assistantId, const std::string &dialogId)=0
virtual void	onSetDialogState (const std::string &assistantId, const std::string &dialogId, const std::string &state)=0

Detailed Description

The class to interface with the Arbitrator Engine.

Member Enumeration Documentation

AgentState

enum aace::arbitrator::ArbitratorEngineInterface::AgentState

strong

Describes the agent states.

Enumerator
ACTIVE	Agent is active with an on-going dialog.
INACTIVE	Agent is inactive.

Mode

enum aace::arbitrator::ArbitratorEngineInterface::Mode

strong

Describes the dialog request modes.

Enumerator
WAKEWORD	Wakeword.
GESTURE	Gesture - e.g., PTT/TTT.

Member Function Documentation

onRegisterAgent()

virtual bool aace::arbitrator::ArbitratorEngineInterface::onRegisterAgent ( const std::string &  assistantId, const std::string &  name, const std::vector< DialogStateRule > &  dialogStateRules  )

pure virtual

Register an agent with the Engine

Parameters

assistantId	The id of agent to register
name	The name of agent to register
dialogStateRules	The barge in rules for the agent

Returns

true On success

false On failure

onDeregisterAgent()

virtual bool aace::arbitrator::ArbitratorEngineInterface::onDeregisterAgent ( const std::string &  assistantId )

pure virtual

Deregister an agent with the Engine

Parameters

assistantId

The id of agent to deregister

Returns

true On success

false On failure

onStartDialog()

virtual void aace::arbitrator::ArbitratorEngineInterface::onStartDialog ( const std::string &  assistantId, Mode  mode, const std::string &  token  )

pure virtual

Notifies Engine to start dialog for an agent.

Parameters

assistantId	The id of agent for whom the dialog is started
mode	The mode of trigger for dialog - one of Wakeword, Gesture (for PTT/TTT)
token	An unique identifier to correlate startDialogReply to startDialog. This will be sent back in startDialogReply.

onStopDialog()

virtual void aace::arbitrator::ArbitratorEngineInterface::onStopDialog ( const std::string &  assistantId, const std::string &  dialogId  )

pure virtual

Notifies Engine to stop the dialog

Parameters

assistantId	The id of agent whose dialog should be stopped
dialogId	The id of the dialog that should be stopped

onSetDialogState()

virtual void aace::arbitrator::ArbitratorEngineInterface::onSetDialogState ( const std::string &  assistantId, const std::string &  dialogId, const std::string &  state  )

pure virtual

Notifies Engine to set the dialog state

Parameters

assistantId	The id of agent whose dialog state should be set
dialogId	The id of the dialog whose state should be set
state	The new state of the dialog