stanford.androidlib

Class SimpleSpeech

java.lang.Object

stanford.androidlib.SimpleSpeech

public final class SimpleSpeech
extends Object

A utility class for converting text-to-speech and speech-to-text.

 SimpleSpeech.with(this).speak("hello!");
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	REQ_CODE_SPEECH_TO_TEXT Request code for Intent for speech-to-text.

Method Summary

Modifier and Type	Method and Description
SimpleSpeech	shutdown() Shuts down the text-to-speech services and releases resources used.
SimpleSpeech	speak(int id) Says the given text aloud using Text-to-speech.
SimpleSpeech	speak(int id, boolean immediately) Says the given text aloud using Text-to-speech.
SimpleSpeech	speak(String text) Says the given text aloud using Text-to-speech.
SimpleSpeech	speak(String text, boolean immediately) Says the given text aloud using Text-to-speech.
SimpleSpeech	speechToText(int promptID) Asks the device to start recording speech and converting it to text.
SimpleSpeech	speechToText(String prompt) Asks the device to start recording speech and converting it to text.
boolean	speechToTextSupported() Returns true if the current device supports speech-to-text recognition.
boolean	textToSpeechSupported() Returns true if the current device supports text-to-speech capability.
static SimpleSpeech	with(Context context) Returns a singleton SimpleSpeech instance bound to the given context.
static SimpleSpeech	with(View context) Returns a singleton SimpleSpeech instance bound to the given view's context.

Methods inherited from class java.lang.Object

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

Field Detail

REQ_CODE_SPEECH_TO_TEXT

public static final int REQ_CODE_SPEECH_TO_TEXT

Request code for Intent for speech-to-text.

See Also:

Constant Field Values

Method Detail

with

public static SimpleSpeech with(Context context)

Returns a singleton SimpleSpeech instance bound to the given context.

with

public static SimpleSpeech with(View context)

Returns a singleton SimpleSpeech instance bound to the given view's context.

speak

public SimpleSpeech speak(@StringRes
                          int id)

Says the given text aloud using Text-to-speech. If any other speech is occurring, it is halted and this new speech begins immediately.

speak

public SimpleSpeech speak(@StringRes
                          int id,
                          boolean immediately)

Says the given text aloud using Text-to-speech. If the 'immediately' boolean parameter is true, and if any other speech is occurring, it is halted and this new speech begins immediately. If the 'immediately' parameter is false, this text is spoken after any other text previously sent to speak() is done being spoken.

speak

public SimpleSpeech speak(String text)

Says the given text aloud using Text-to-speech. If any other speech is occurring, it is halted and this new speech begins immediately.

speak

public SimpleSpeech speak(String text,
                          boolean immediately)

Says the given text aloud using Text-to-speech. If the 'immediately' boolean parameter is true, and if any other speech is occurring, it is halted and this new speech begins immediately. If the 'immediately' parameter is false, this text is spoken after any other text previously sent to speak() is done being spoken.

shutdown

public SimpleSpeech shutdown()

Shuts down the text-to-speech services and releases resources used.

textToSpeechSupported

public boolean textToSpeechSupported()

Returns true if the current device supports text-to-speech capability.

speechToText

public SimpleSpeech speechToText(@StringRes
                                 int promptID)

Asks the device to start recording speech and converting it to text. The prompt text represented by the given string resource ID is shown on the screen to prompt the user to speak. When the spoken words are done converting to text, the method onSpeechToTextReady will be called. Subclasses should override that method to grab the spoken text as a string. Logs the error if the action failed (e.g. if this device cannot support speech-to-text). You may want to call speechToTextSupported first.

speechToText

public SimpleSpeech speechToText(String prompt)

Asks the device to start recording speech and converting it to text. The given prompt text is shown on the screen to prompt the user to speak. When the spoken words are done converting to text, the method onSpeechToTextReady will be called. Subclasses should override that method to grab the spoken text as a string. Logs the error if the action failed (e.g. if this device cannot support speech-to-text). You may want to call speechToTextSupported first.

speechToTextSupported

public boolean speechToTextSupported()

Returns true if the current device supports speech-to-text recognition.