Speech (speech 1.6.2 Reference)

java.lang.Object
- net.gotev.speech.Speech

```
public class Speech
extends java.lang.Object
```
Helper class to easily work with Android speech recognition.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Speech`	`getInstance()` Gets speech recognition instance.
`java.util.Locale`	`getSpeechToTextLanguage()` Gets the locale used for speech recognition.
`void`	`getSupportedSpeechToTextLanguages(SupportedLanguagesListener listener)` Gets the list of the supported speech to text languages on this device
`java.util.List<android.speech.tts.Voice>`	`getSupportedTextToSpeechVoices()` Gets the list of the supported Text to Speech languages on this device
`android.speech.tts.Voice`	`getTextToSpeechVoice()` Gets the current voice used for text to speech.
`static Speech`	`init(android.content.Context context)` Initializes speech recognition.
`static Speech`	`init(android.content.Context context, java.lang.String callingPackage)` Initializes speech recognition.
`static Speech`	`init(android.content.Context context, java.lang.String callingPackage, android.speech.tts.TextToSpeech.OnInitListener onInitListener)`
`static Speech`	`init(android.content.Context context, java.lang.String callingPackage, android.speech.tts.TextToSpeech.OnInitListener onInitListener, SpeechRecognitionEngine speechRecognitionEngine, TextToSpeechEngine textToSpeechEngine)`
`boolean`	`isListening()` Check if voice recognition is currently active.
`boolean`	`isSpeaking()` Check if text to speak is currently speaking.
`void`	`say(java.lang.String message)` Uses text to speech to transform a written message into a sound.
`void`	`say(java.lang.String message, TextToSpeechCallback callback)` Uses text to speech to transform a written message into a sound.
`Speech`	`setAudioStream(int audioStream)` Sets the audio stream type.
`Speech`	`setGetPartialResults(boolean getPartialResults)` Set whether partial results should be returned by the recognizer as the user speaks (default is true).
`Speech`	`setLocale(java.util.Locale locale)` Sets text to speech and recognition language.
`Speech`	`setPreferOffline(boolean preferOffline)` Set whether to only use an offline speech recognition engine.
`Speech`	`setStopListeningAfterInactivity(long milliseconds)` Sets the idle timeout after which the listening will be automatically stopped.
`Speech`	`setTextToSpeechPitch(float pitch)` Sets the speech pitch for the TextToSpeech engine.
`Speech`	`setTextToSpeechQueueMode(int mode)` Sets the text to speech queue mode.
`Speech`	`setTextToSpeechRate(float rate)` Sets the speech rate.
`Speech`	`setTransitionMinimumDelay(long milliseconds)` Sets the minimum interval between start/stop events.
`Speech`	`setVoice(android.speech.tts.Voice voice)` Sets the voice for the TextToSpeech engine.
`void`	`shutdown()` Must be called inside Activity's onDestroy.
`void`	`startListening(SpeechDelegate delegate)` Starts voice recognition.
`void`	`startListening(SpeechProgressView progressView, SpeechDelegate delegate)` Starts voice recognition.
`void`	`stopListening()` Stops voice recognition listening.
`void`	`stopTextToSpeech()` Stops text to speech.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - init
```
public static Speech init(android.content.Context context)
```
    Initializes speech recognition.
    
    Parameters:
    
    context - application context
    
    Returns:
    
    speech instance
  - init
```
public static Speech init(android.content.Context context,
                          java.lang.String callingPackage)
```
    Initializes speech recognition.
    
    Parameters:
    
    context - application context
    
    callingPackage - The extra key used in an intent to the speech recognizer for voice search. Not generally to be used by developers. The system search dialog uses this, for example, to set a calling package for identification by a voice search API. If this extra is set by anyone but the system process, it should be overridden by the voice search implementation. By passing null or empty string (which is the default) you are not overriding the calling package
    
    Returns:
    
    speech instance
  - init
```
public static Speech init(android.content.Context context,
                          java.lang.String callingPackage,
                          android.speech.tts.TextToSpeech.OnInitListener onInitListener)
```
  - init
```
public static Speech init(android.content.Context context,
                          java.lang.String callingPackage,
                          android.speech.tts.TextToSpeech.OnInitListener onInitListener,
                          SpeechRecognitionEngine speechRecognitionEngine,
                          TextToSpeechEngine textToSpeechEngine)
```
  - shutdown
```
public void shutdown()
```
    Must be called inside Activity's onDestroy.
  - getInstance
```
public static Speech getInstance()
```
    Gets speech recognition instance.
    
    Returns:
    
    SpeechRecognition instance
  - startListening
```
public void startListening(SpeechDelegate delegate)
                    throws SpeechRecognitionNotAvailable,
                           GoogleVoiceTypingDisabledException
```
    Starts voice recognition.
    
    Parameters:
    
    delegate - delegate which will receive speech recognition events and status
    
    Throws:
    
    SpeechRecognitionNotAvailable - when speech recognition is not available on the device
    
    GoogleVoiceTypingDisabledException - when google voice typing is disabled on the device
  - startListening
```
public void startListening(SpeechProgressView progressView,
                           SpeechDelegate delegate)
                    throws SpeechRecognitionNotAvailable,
                           GoogleVoiceTypingDisabledException
```
    Starts voice recognition.
    
    Parameters:
    
    progressView - view in which to draw speech animation
    
    delegate - delegate which will receive speech recognition events and status
    
    Throws:
    
    SpeechRecognitionNotAvailable - when speech recognition is not available on the device
    
    GoogleVoiceTypingDisabledException - when google voice typing is disabled on the device
  - stopListening
```
public void stopListening()
```
    Stops voice recognition listening. This method does nothing if voice listening is not active
  - isListening
```
public boolean isListening()
```
    Check if voice recognition is currently active.
    
    Returns:
    
    true if the voice recognition is on, false otherwise
  - isSpeaking
```
public boolean isSpeaking()
```
    Check if text to speak is currently speaking.
    
    Returns:
    
    true if the text to speak is speaking, false otherwise
  - say
```
public void say(java.lang.String message)
```
    Uses text to speech to transform a written message into a sound.
    
    Parameters:
    
    message - message to play
  - say
```
public void say(java.lang.String message,
                TextToSpeechCallback callback)
```
    Uses text to speech to transform a written message into a sound.
    
    Parameters:
    
    message - message to play
    
    callback - callback which will receive progress status of the operation
  - stopTextToSpeech
```
public void stopTextToSpeech()
```
    Stops text to speech.
  - setPreferOffline
```
public Speech setPreferOffline(boolean preferOffline)
```
    Set whether to only use an offline speech recognition engine. The default is false, meaning that either network or offline recognition engines may be used.
    
    Parameters:
    
    preferOffline - true to prefer offline engine, false to use either one of the two
    
    Returns:
    
    speech instance
  - setGetPartialResults
```
public Speech setGetPartialResults(boolean getPartialResults)
```
    Set whether partial results should be returned by the recognizer as the user speaks (default is true). The server may ignore a request for partial results in some or all cases.
    
    Parameters:
    
    getPartialResults - true to get also partial recognition results, false otherwise
    
    Returns:
    
    speech instance
  - setLocale
```
public Speech setLocale(java.util.Locale locale)
```
    Sets text to speech and recognition language. Defaults to device language setting.
    
    Parameters:
    
    locale - new locale
    
    Returns:
    
    speech instance
  - setTextToSpeechRate
```
public Speech setTextToSpeechRate(float rate)
```
    Sets the speech rate. This has no effect on any pre-recorded speech.
    
    Parameters:
    
    rate - Speech rate. 1.0 is the normal speech rate, lower values slow down the speech (0.5 is half the normal speech rate), greater values accelerate it (2.0 is twice the normal speech rate).
    
    Returns:
    
    speech instance
  - setVoice
```
public Speech setVoice(android.speech.tts.Voice voice)
```
    Sets the voice for the TextToSpeech engine. This has no effect on any pre-recorded speech.
    
    Parameters:
    
    voice - Speech voice.
    
    Returns:
    
    speech instance
  - setTextToSpeechPitch
```
public Speech setTextToSpeechPitch(float pitch)
```
    Sets the speech pitch for the TextToSpeech engine. This has no effect on any pre-recorded speech.
    
    Parameters:
    
    pitch - Speech pitch. 1.0 is the normal pitch, lower values lower the tone of the synthesized voice, greater values increase it.
    
    Returns:
    
    speech instance
  - setStopListeningAfterInactivity
```
public Speech setStopListeningAfterInactivity(long milliseconds)
```
    Sets the idle timeout after which the listening will be automatically stopped.
    
    Parameters:
    
    milliseconds - timeout in milliseconds
    
    Returns:
    
    speech instance
  - setTransitionMinimumDelay
```
public Speech setTransitionMinimumDelay(long milliseconds)
```
    Sets the minimum interval between start/stop events. This is useful to prevent monkey input from users.
    
    Parameters:
    
    milliseconds - minimum interval betweeb state change in milliseconds
    
    Returns:
    
    speech instance
  - setTextToSpeechQueueMode
```
public Speech setTextToSpeechQueueMode(int mode)
```
    Sets the text to speech queue mode. By default is TextToSpeech.QUEUE_FLUSH, which is faster, because it clears all the messages before speaking the new one. TextToSpeech.QUEUE_ADD adds the last message to speak in the queue, without clearing the messages that have been added.
    
    Parameters:
    
    mode - It can be either TextToSpeech.QUEUE_ADD or TextToSpeech.QUEUE_FLUSH.
    
    Returns:
    
    speech instance
  - setAudioStream
```
public Speech setAudioStream(int audioStream)
```
    Sets the audio stream type. By default is TextToSpeech.Engine.DEFAULT_STREAM, which is equivalent to AudioManager.STREAM_MUSIC.
    
    Parameters:
    
    audioStream - A constant from AudioManager. e.g. AudioManager.STREAM_VOICE_CALL
    
    Returns:
    
    speech instance
  - getSupportedSpeechToTextLanguages
```
public void getSupportedSpeechToTextLanguages(SupportedLanguagesListener listener)
```
    Gets the list of the supported speech to text languages on this device
    
    Parameters:
    
    listener - listner which will receive the results
  - getSupportedTextToSpeechVoices
```
public java.util.List<android.speech.tts.Voice> getSupportedTextToSpeechVoices()
```
    Gets the list of the supported Text to Speech languages on this device
    
    Returns:
    
    list of locales on android API 23 and newer and empty list on lower Android, because native TTS engine does not support querying voices on API lower than 23. Officially it's declared that query voices support started on API 21, but in reality it started from 23. If still skeptic about this, search the web and try on your own.
  - getSpeechToTextLanguage
```
public java.util.Locale getSpeechToTextLanguage()
```
    Gets the locale used for speech recognition.
    
    Returns:
    
    speech recognition locale
  - getTextToSpeechVoice
```
public android.speech.tts.Voice getTextToSpeechVoice()
```
    Gets the current voice used for text to speech.
    
    Returns:
    
    current voice on android API 23 or newer and null on lower Android, because native TTS engine does not support querying voices on API lower than 23. Officially it's declared that query voices support started on API 21, but in reality it started from 23. If still skeptic about this, search the web and try on your own.

Class Speech

Method Summary

Methods inherited from class java.lang.Object

Method Detail

init

init

init

init

shutdown

getInstance

startListening

startListening

stopListening

isListening

isSpeaking

say

say

stopTextToSpeech

setPreferOffline

setGetPartialResults

setLocale

setTextToSpeechRate

setVoice

setTextToSpeechPitch

setStopListeningAfterInactivity

setTransitionMinimumDelay

setTextToSpeechQueueMode

setAudioStream

getSupportedSpeechToTextLanguages

getSupportedTextToSpeechVoices

getSpeechToTextLanguage

getTextToSpeechVoice