SpeechRecognizerAggregatorInterface

SpeechRecognizerAggregator Interface. More...

Collaboration diagram for SpeechRecognizerAggregatorInterface:

Classes
struct	NuguClientKit::_RecognitionResult
	Model for holding recognition result. More...
class	NuguClientKit::ISpeechRecognizerAggregator
	SpeechRecognizerAggregator interface. More...
class	NuguClientKit::ISpeechRecognizerAggregatorListener
	SpeechRecognizerAggregator listener interface. More...

Typedefs
typedef struct NuguClientKit::_RecognitionResult	NuguClientKit::RecognitionResult
	Model for holding recognition result. More...

Enumerations
enum class	NuguClientKit::_RecognitionResult::Status {   NuguClientKit::_RecognitionResult::None , NuguClientKit::_RecognitionResult::Partial , NuguClientKit::_RecognitionResult::Complete , NuguClientKit::_RecognitionResult::Cancel ,   NuguClientKit::_RecognitionResult::Error }
	Result status. More...

Functions
virtual void	NuguClientKit::ISpeechRecognizerAggregator::addListener (ISpeechRecognizerAggregatorListener *listener)=0
	Add the ISpeechRecognizerAggregatorListener object. More...
virtual void	NuguClientKit::ISpeechRecognizerAggregator::finishListening ()=0
	finish listening speech
virtual void	NuguClientKit::ISpeechRecognizerAggregatorListener::onASRState (ASRState state, const std::string &dialog_id, ASRInitiator initiator)=0
	Notify to user the asr state changed. More...
virtual void	NuguClientKit::ISpeechRecognizerAggregatorListener::onResult (const RecognitionResult &result, const std::string &dialog_id)=0
	Notify to user the recognition result. More...
virtual void	NuguClientKit::ISpeechRecognizerAggregatorListener::onWakeupState (WakeupDetectState state, float power_noise, float power_speech)=0
	Notify to user the wakeup detection state changed. More...
virtual void	NuguClientKit::ISpeechRecognizerAggregator::removeListener (ISpeechRecognizerAggregatorListener *listener)=0
	Remove the ISpeechRecognizerAggregatorListener object. More...
virtual void	NuguClientKit::ISpeechRecognizerAggregator::setWakeupHandler (const std::shared_ptr< IWakeupHandler > &wakeup_handler)=0
	Set the IWakeupHandler object. More...
virtual bool	NuguClientKit::ISpeechRecognizerAggregator::setWakeupModel (const WakeupModelFile &model_file)=0
	Set wakeup model file. More...
virtual void	NuguClientKit::ISpeechRecognizerAggregator::startListening (float power_noise=0, float power_speech=0, ASRInitiator initiator=ASRInitiator::TAP)=0
	Start recognizing speech. More...
virtual void	NuguClientKit::ISpeechRecognizerAggregator::startListeningWithTrigger ()=0
	Start detecting wakeup and progress recognizing speech after wakeup detected.
virtual void	NuguClientKit::ISpeechRecognizerAggregator::stopListening (bool cancel=false)=0
	Stop both recognizing speech and detecting wakeup. More...

Variables
ASRError	NuguClientKit::_RecognitionResult::error
bool	NuguClientKit::_RecognitionResult::listen_timeout_fail_beep
std::string	NuguClientKit::_RecognitionResult::recognized_text
Status	NuguClientKit::_RecognitionResult::status

Detailed Description

SpeechRecognizerAggregator Interface.

Interface of SpeechRecognizerAggregator for operating wakeup detection and speech recognition process conveniently.

Typedef Documentation

RecognitionResult

typedef struct NuguClientKit::_RecognitionResult NuguClientKit::RecognitionResult

Model for holding recognition result.

See also

ISpeechRecognizerAggregatorListener::onResult

Enumeration Type Documentation

Status

enum NuguClientKit::_RecognitionResult::Status

strong

Result status.

Enumerator
None	no result
Partial	partial text received
Complete	complete text received
Cancel	recognition canceled
Error	error occurred

Function Documentation

onWakeupState()

virtual void NuguClientKit::ISpeechRecognizerAggregatorListener::onWakeupState ( WakeupDetectState  state, float  power_noise, float  power_speech  )

pure virtual

Notify to user the wakeup detection state changed.

Parameters

[in]	state	wakeup detection state
[in]	power_noise	min power value
[in]	power_speech	max power value

onASRState()

virtual void NuguClientKit::ISpeechRecognizerAggregatorListener::onASRState ( ASRState  state, const std::string &  dialog_id, ASRInitiator  initiator  )

pure virtual

Notify to user the asr state changed.

Parameters

[in]	state	asr state
[in]	dialog_id	dialog request id
[in]	initiator	asr initiator

onResult()

virtual void NuguClientKit::ISpeechRecognizerAggregatorListener::onResult ( const RecognitionResult &  result, const std::string &  dialog_id  )

pure virtual

Notify to user the recognition result.

Parameters

[in]	result	recognition result
[in]	dialog_id	dialog request id

addListener()

virtual void NuguClientKit::ISpeechRecognizerAggregator::addListener ( ISpeechRecognizerAggregatorListener *  listener )

pure virtual

Add the ISpeechRecognizerAggregatorListener object.

Parameters

[in]

listener

ISpeechRecognizerAggregatorListener object

removeListener()

virtual void NuguClientKit::ISpeechRecognizerAggregator::removeListener ( ISpeechRecognizerAggregatorListener *  listener )

pure virtual

Remove the ISpeechRecognizerAggregatorListener object.

Parameters

[in]

listener

ISpeechRecognizerAggregatorListener object

setWakeupHandler()

virtual void NuguClientKit::ISpeechRecognizerAggregator::setWakeupHandler ( const std::shared_ptr< IWakeupHandler > &  wakeup_handler )

pure virtual

Set the IWakeupHandler object.

Parameters

[in]

wakeup_handler

IWakeupHandler object

setWakeupModel()

virtual bool NuguClientKit::ISpeechRecognizerAggregator::setWakeupModel ( const WakeupModelFile &  model_file )

pure virtual

Set wakeup model file.

Parameters

[in]

model_file

wakeup model file

Returns

true if set success, otherwise false

startListening()

virtual void NuguClientKit::ISpeechRecognizerAggregator::startListening ( float  power_noise = 0, float  power_speech = 0, ASRInitiator  initiator = ASRInitiator::TAP  )

pure virtual

Start recognizing speech.

Parameters

[in]	power_noise	min wakeup power value
[in]	power_speech	max wakeup power value
[in]	initiator	asr initiator

stopListening()

virtual void NuguClientKit::ISpeechRecognizerAggregator::stopListening ( bool  cancel = false )

pure virtual

Stop both recognizing speech and detecting wakeup.

Parameters

[in]

cancel

if true, cancel the directives to be received for current dialog

Variable Documentation

status

Status NuguClientKit::_RecognitionResult::status

result status

recognized_text

std::string NuguClientKit::_RecognitionResult::recognized_text

partial or complete recognized text

error

ASRError NuguClientKit::_RecognitionResult::error

ASR error

listen_timeout_fail_beep

bool NuguClientKit::_RecognitionResult::listen_timeout_fail_beep

flag whether to play fail beep or not when listen-timeout occurred