NuguClientKit::ICapabilityHelper Class Reference

CapabilityHelper interface. More...

#include <capability_helper_interface.hh>

Public Member Functions
virtual bool	getCapabilityProperties (const std::string &cap, const std::string &property, std::list< std::string > &values)=0
	Get properties from CapabilityAgent. More...
virtual bool	getCapabilityProperty (const std::string &cap, const std::string &property, std::string &value)=0
	Get property from CapabilityAgent. More...
virtual IDirectiveSequencer *	getDirectiveSequencer ()=0
	Get IDirectiveSequencer instance. More...
virtual IFocusManager *	getFocusManager ()=0
	Get IFocusManager instance. More...
virtual IInteractionControlManager *	getInteractionControlManager ()=0
	Get IInteractionControlManager instance. More...
virtual IPlaySyncManager *	getPlaySyncManager ()=0
	Get IPlaySyncManager instance. More...
virtual IRoutineManager *	getRoutineManager ()=0
	Get IRoutineManager instance. More...
virtual ISessionManager *	getSessionManager ()=0
	Get ISessionManager instance. More...
virtual std::string	getWakeupWord ()=0
	Get wakeup keyword for detection.
virtual std::string	makeAllContextInfo ()=0
	Get context info from All CapabilityAgents.
virtual std::string	makeContextInfo (const std::string &cname, NJson::Value &ctx)=0
	Get context info. More...
virtual void	requestEventResult (NuguEvent *event)=0
	Request to send event result via CapabilityManager. More...
virtual void	restoreAll ()=0
	Restore previous suspended capability action.
virtual bool	sendCommand (const std::string &from, const std::string &to, const std::string &command, const std::string &param)=0
	Send command between CapabilityAgents. More...
virtual bool	setMute (bool mute)=0
	Set Audio Recorder mute/unmute. More...
virtual void	suspendAll ()=0
	Suspend all current capability action.

Detailed Description

CapabilityHelper interface.

Member Function Documentation

getPlaySyncManager()

virtual IPlaySyncManager* NuguClientKit::ICapabilityHelper::getPlaySyncManager ( )

pure virtual

Get IPlaySyncManager instance.

Returns

IPlaySyncManager instance

getFocusManager()

virtual IFocusManager* NuguClientKit::ICapabilityHelper::getFocusManager ( )

pure virtual

Get IFocusManager instance.

Returns

IFocusManager instance

getSessionManager()

virtual ISessionManager* NuguClientKit::ICapabilityHelper::getSessionManager ( )

pure virtual

Get ISessionManager instance.

Returns

ISessionManager instance

getInteractionControlManager()

virtual IInteractionControlManager* NuguClientKit::ICapabilityHelper::getInteractionControlManager ( )

pure virtual

Get IInteractionControlManager instance.

Returns

IInteractionControlManager instance

getDirectiveSequencer()

virtual IDirectiveSequencer* NuguClientKit::ICapabilityHelper::getDirectiveSequencer ( )

pure virtual

Get IDirectiveSequencer instance.

Returns

IDirectiveSequencer instance

getRoutineManager()

virtual IRoutineManager* NuguClientKit::ICapabilityHelper::getRoutineManager ( )

pure virtual

Get IRoutineManager instance.

Returns

IRoutineManager instance

setMute()

virtual bool NuguClientKit::ICapabilityHelper::setMute ( bool  mute )

pure virtual

Set Audio Recorder mute/unmute.

Parameters

[in]

mute

mute/unmute

sendCommand()

virtual bool NuguClientKit::ICapabilityHelper::sendCommand ( const std::string &  from, const std::string &  to, const std::string &  command, const std::string &  param  )

pure virtual

Send command between CapabilityAgents.

Parameters

[in]	from	source CapabilityAgent
[in]	to	target CapabilityAgent
[in]	command	command
[in]	param	parameter

Returns

send command result

Return values

true	CapabilityAgent and command are valid
false	CapabilityAgent or command is invalid

requestEventResult()

virtual void NuguClientKit::ICapabilityHelper::requestEventResult ( NuguEvent *  event )

pure virtual

Request to send event result via CapabilityManager.

Parameters

[in]

event

event for monitoring result

getCapabilityProperty()

virtual bool NuguClientKit::ICapabilityHelper::getCapabilityProperty ( const std::string &  cap, const std::string &  property, std::string &  value  )

pure virtual

Get property from CapabilityAgent.

Parameters

[in]	cap	CapabilityAgent
[in]	property	property key
[in]	value	property value

Returns

property get result

Return values

true	CapabilityAgent and property are valid
false	CapabilityAgent or property is invalid

getCapabilityProperties()

virtual bool NuguClientKit::ICapabilityHelper::getCapabilityProperties ( const std::string &  cap, const std::string &  property, std::list< std::string > &  values  )

pure virtual

Get properties from CapabilityAgent.

Parameters

[in]	cap	CapabilityAgent
[in]	property	property key
[in]	values	property values

Returns

property get result

Return values

true	CapabilityAgent and property are valid
false	CapabilityAgent or property is invalid

makeContextInfo()

virtual std::string NuguClientKit::ICapabilityHelper::makeContextInfo ( const std::string &  cname, NJson::Value &  ctx  )

pure virtual

Get context info.

Parameters

[in]	cname	The name of the capability requesting the context
[in]	ctx	reference object for storing context info

---

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

• capability_helper_interface.hh