org.ispeech

Class SpeechRecognizer

java.lang.Object

org.ispeech.SpeechRecognizer

All Implemented Interfaces:

Recognizer

public class SpeechRecognizer
extends Object
implements Recognizer

Contains methods to recognize spoken audio and convert free form speech into text.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAlias(String name, String[] values) Adds an alias to use inside of a command.
void	addCommand(String phrase) Adds a new command phrase.
void	addCommand(String[] commandPhrases) Adds a command phrases.
void	addMeta(MetaType type, String value) Add meta value to synthesizer
void	addOptionalCommand(String command, String parameter) Specify additional parameters to send to the server.
void	cancelProcessing() Cancels the processing of the recorded voice data i.e.
void	cancelRecord() Cancels voice recording that is in progress
void	clearAlias() Clear all aliases
void	clearCommand() Clears all commands
void	clearOptionalCommand() Clear all optional commands
FreeformType	getFreeForm() Get current free form value
static SpeechRecognizer	getInstance(Context context) Gets an instance of the iSpeech SpeechRecognizer class.
boolean	isRunning() Test this to determine if this is still running
void	setChime(boolean isOn) Disable or enable the audio chime
void	setFreeForm(FreeformType freeFormType) Set to free form recognition.
void	setLocale(String locale) Sets to Locale for recognizer.
void	setModel(String model) Sets the language model
void	setSilenceDetection(boolean silenceDetection) Enables and disables silence detection.
void	setTimeout(int timeout) Set the maximum recording time in milliseconds
void	startRecord(SpeechRecognizerEvent speechRecognizerEvent) Starts recording audio for SpeechRecognition
void	stopRecord() Stops the recording process
void	toDisableTheDialogContact_salesATiSpeechDOTorg() To disable loading dialogs and prompts please contact sales@iSpeech.org

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SpeechRecognizer getInstance(Context context)
                                    throws InvalidApiKeyException

Gets an instance of the iSpeech SpeechRecognizer class. The ApiKey parameter is only required on initial call to this method.

Parameters:

context - Context object

isProduction - Set to true to specify that this application is in production mode. Set to false to use the sandbox servers. Your key must be provisioned for production use in order to deploy your application. Note: This flag is global.

Throws:

InvalidApiKeyException

startRecord

public void startRecord(SpeechRecognizerEvent speechRecognizerEvent)
                 throws BusyException,
                        NoNetworkException

Starts recording audio for SpeechRecognition

Specified by:

startRecord in interface Recognizer

Throws:

BusyException - If a player could not be created

NoNetworkException

setSilenceDetection

public void setSilenceDetection(boolean silenceDetection)

Enables and disables silence detection.

Parameters:

silenceDetection - boolean set to true to enable silence detection, and false to disable silence detection.

stopRecord

public void stopRecord()

Stops the recording process

Specified by:

stopRecord in interface Recognizer

Throws:

ApiException - The server could not process your command and an API exception occurred.

cancelRecord

public void cancelRecord()

Cancels voice recording that is in progress

Specified by:

cancelRecord in interface Recognizer

toDisableTheDialogContact_salesATiSpeechDOTorg

public void toDisableTheDialogContact_salesATiSpeechDOTorg()

To disable loading dialogs and prompts please contact sales@iSpeech.org

cancelProcessing

public void cancelProcessing()

Cancels the processing of the recorded voice data i.e. does not send the data to the server or ignores the responce that comes back from the server if the data was already sent.

Specified by:

cancelProcessing in interface Recognizer

clearCommand

public void clearCommand()

Clears all commands

Specified by:

clearCommand in interface Recognizer

addCommand

public void addCommand(String[] commandPhrases)

Adds a command phrases.

Example:

 SpeechRecognizer rec = SpeechRecognizer.getInstance("APIKEY");
 rec.addCommand(new String[]{"yes","no"};);
 

The user can now speak "Yes" or "No" and it will be recognized correctly.

Specified by:

addCommand in interface Recognizer

Parameters:

commandPhrases - An array containing your command phrases

setFreeForm

public void setFreeForm(FreeformType freeFormType)

Set to free form recognition. Will not use any command or alias list. Your API key must be provisioned to use this feature. One of the FreeformType values.

Specified by:

setFreeForm in interface Recognizer

getFreeForm

public FreeformType getFreeForm()

Get current free form value

Specified by:

getFreeForm in interface Recognizer

Returns:

free form value

isRunning

public boolean isRunning()

Test this to determine if this is still running

Specified by:

isRunning in interface Recognizer

Returns:

true if the recognizer is still running

addAlias

public void addAlias(String name,
            String[] values)

Adds an alias to use inside of a command. You can reference the added alias using %ALIASNAME% from within a command. Alias names are automatically capitalized. Note: You can only have a maximum of two aliases per command.

Example:

 SpeechRecognizer rec = SpeechRecognizer.getInstance("APIKEY");
 String[] names = new String[] { "jane", "bob", "john" };
 rec.addAlias("NAMES", names);
 rec.addCommand("call %NAMES%");
 

The user can now speak "call john" and it will be recognized correctly.

Specified by:

addAlias in interface Recognizer

Parameters:

name - The name of your alias for referencing inside of your commands.

values - The list of phrases for this alias.

clearAlias

public void clearAlias()

Clear all aliases

Specified by:

clearAlias in interface Recognizer

setTimeout

public void setTimeout(int timeout)

Set the maximum recording time in milliseconds

Parameters:

timeout -

addMeta

public void addMeta(MetaType type,
           String value)

Add meta value to synthesizer

Specified by:

addMeta in interface Recognizer

Parameters:

type -

value -

clearOptionalCommand

public void clearOptionalCommand()

Clear all optional commands

Specified by:

clearOptionalCommand in interface Recognizer

addOptionalCommand

public void addOptionalCommand(String command,
                      String parameter)

Specify additional parameters to send to the server.

Specified by:

addOptionalCommand in interface Recognizer

addCommand

public void addCommand(String phrase)

Description copied from interface: Recognizer

Adds a new command phrase.

Specified by:

addCommand in interface Recognizer

Parameters:

phrase - Your command phrase

setModel

public void setModel(String model)

Description copied from interface: Recognizer

Sets the language model

Specified by:

setModel in interface Recognizer

setLocale

public void setLocale(String locale)

Sets to Locale for recognizer. Example:

 SpeechRecognizer recognizer;
 recognizer = SpeechRecognizer.getInstance(this);
 recognizer.setLocale("en-US"); //set to US-English
 
 

Specified by:

setLocale in interface Recognizer

Parameters:

locale - currently implemented locales: *

 Catalan                (Catalan) (ca-ES) 
 Chinese                (Taiwan) (zh-TW)
 Danish                 (Denmark) (da-DK)
 English                (United States) (en-US)
 Finnish                (Finland) (fi-FI) 
 French                 (France) (fr-FR)
 Italian                (Italy) (it-IT)
 Japanese       (Japan) (ja-JP)
 Korean                 (Korea) (ko-KR)
 Dutch          (Netherlands) (nl-NL)
 Norwegian      (Norway) (nb-NO)
 Polish                 (Poland) (pl-PL)
 Portuguese     (Brazil) (pt-BR)
 Russian                (Russia) (ru-RU)
 Swedish                (Sweden) (sv-SE)
 Chinese                (People's Republic of China) (zh-CN)
 English                (United Kingdom) (en-GB)
 Spanish                (Mexico) (es-MX)
 Portuguese     (Portugal) (pt-PT)
 Chinese                (Hong Kong S.A.R.) (zh-HK)
 English                (Australia) (en-AU)
 Spanish                (Spain) (es-ES)
 French                 (Canada) (fr-CA)
 English                (Canada) (en-CA)
 

setChime

public void setChime(boolean isOn)

Description copied from interface: Recognizer

Disable or enable the audio chime

Specified by:

setChime in interface Recognizer