Package com.vivoka.vsdk.asr

Class UserWordEnroller

java.lang.Object

com.vivoka.vsdk.asr.UserWordEnroller

All Implemented Interfaces:

IConsumerModule

public abstract class UserWordEnroller
extends Object
implements IConsumerModule

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_isRunning
protected IRecognizerListener	_listener
protected Recognizer	_recognizer
protected String	_user
protected String	_word

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserWordEnroller(Recognizer recognizer, IRecognizerListener listener)

Method Summary

Modifier and Type	Method	Description
abstract void	deleteUser(String user)	Delete a user
abstract void	deleteUsers()	Delete all registered users
double	getUpTime()	Get the uptime of the user word enroller.
boolean	isRunning()	Check if the recognizer is currently running.
String	recognizerName()	Name of the recognizer associated with this user word enroller
protected abstract void	release()
void	setListener(IRecognizerListener listener)	Set the listener for the user word enroller.
abstract void	setUserWordToEnroll(String user, String word)	Selects a user and a word for enrolling
String	user()	Get selected user name to enroll
abstract List<String>	users()	Get all registered users
String	word()	Get selected word to enroll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vivoka.vsdk.audio.IConsumerModule

process

Field Details

_user

protected String _user

_word

protected String _word

_recognizer

protected Recognizer _recognizer

_isRunning

protected boolean _isRunning

_listener

protected IRecognizerListener _listener

Constructor Details

UserWordEnroller

protected UserWordEnroller(Recognizer recognizer,
 IRecognizerListener listener)
                    throws Exception

Throws:

Exception

Method Details

setUserWordToEnroll

public abstract void setUserWordToEnroll(String user,
 String word)
                                  throws Exception

Selects a user and a word for enrolling

Parameters:

user - the user name to enroll

word - the word to enroll

Throws:

Exception - If any error occurs.

users

public abstract List<String> users()
                            throws Exception

Get all registered users

Throws:

Exception

deleteUsers

public abstract void deleteUsers()
                          throws Exception

Delete all registered users

Throws:

Exception - If any error occurs.

deleteUser

public abstract void deleteUser(String user)
                         throws Exception

Delete a user

Parameters:

user - the user to delete

Throws:

Exception - If any error occurs.

release

protected abstract void release()
                         throws Exception

Throws:

Exception

recognizerName

public String recognizerName()

Name of the recognizer associated with this user word enroller

isRunning

public boolean isRunning()

Check if the recognizer is currently running.

Returns:

True if the recognizer is running, false otherwise.

getUpTime

public double getUpTime()

Get the uptime of the user word enroller. This is the time since the user word enroller was started.

Returns:

The uptime in seconds.

user

public String user()

Get selected user name to enroll

word

public String word()

Get selected word to enroll

setListener

public void setListener(IRecognizerListener listener)

Set the listener for the user word enroller.

Parameters:

listener - The listener to set.