android.speech.tts
Class TextToSpeech

java.lang.Object
  extended by android.speech.tts.TextToSpeech

public class TextToSpeech
extends Object


Nested Class Summary
 class TextToSpeech.Engine
           
static class TextToSpeech.EngineInfo
           
static interface TextToSpeech.OnInitListener
           
static interface TextToSpeech.OnUtteranceCompletedListener
           
 
Field Summary
static String ACTION_TTS_QUEUE_PROCESSING_COMPLETED
           
static int ERROR
           
static int LANG_AVAILABLE
           
static int LANG_COUNTRY_AVAILABLE
           
static int LANG_COUNTRY_VAR_AVAILABLE
           
static int LANG_MISSING_DATA
           
static int LANG_NOT_SUPPORTED
           
static int QUEUE_ADD
           
static int QUEUE_FLUSH
           
static int SUCCESS
           
 
Constructor Summary
TextToSpeech(Context context, TextToSpeech.OnInitListener listener)
           
TextToSpeech(Context context, TextToSpeech.OnInitListener listener, String engine)
           
 
Method Summary
 int addEarcon(String earcon, String filename)
           
 int addEarcon(String earcon, String packagename, int resourceId)
           
 int addSpeech(String text, String filename)
           
 int addSpeech(String text, String packagename, int resourceId)
           
 boolean areDefaultsEnforced()
           
 String getDefaultEngine()
           
 List<TextToSpeech.EngineInfo> getEngines()
           
 Locale getLanguage()
           
 int isLanguageAvailable(Locale loc)
           
 boolean isSpeaking()
           
 int playEarcon(String earcon, int queueMode, HashMap<String,String> params)
           
 int playSilence(long durationInMs, int queueMode, HashMap<String,String> params)
           
 int setEngineByPackageName(String enginePackageName)
           
 int setLanguage(Locale loc)
           
 int setOnUtteranceCompletedListener(TextToSpeech.OnUtteranceCompletedListener listener)
           
 int setPitch(float pitch)
           
 int setSpeechRate(float speechRate)
           
 void shutdown()
           
 int speak(String text, int queueMode, HashMap<String,String> params)
           
 int stop()
           
 int synthesizeToFile(String text, HashMap<String,String> params, String filename)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SUCCESS

public static final int SUCCESS
See Also:
Constant Field Values

ERROR

public static final int ERROR
See Also:
Constant Field Values

QUEUE_FLUSH

public static final int QUEUE_FLUSH
See Also:
Constant Field Values

QUEUE_ADD

public static final int QUEUE_ADD
See Also:
Constant Field Values

LANG_COUNTRY_VAR_AVAILABLE

public static final int LANG_COUNTRY_VAR_AVAILABLE
See Also:
Constant Field Values

LANG_COUNTRY_AVAILABLE

public static final int LANG_COUNTRY_AVAILABLE
See Also:
Constant Field Values

LANG_AVAILABLE

public static final int LANG_AVAILABLE
See Also:
Constant Field Values

LANG_MISSING_DATA

public static final int LANG_MISSING_DATA
See Also:
Constant Field Values

LANG_NOT_SUPPORTED

public static final int LANG_NOT_SUPPORTED
See Also:
Constant Field Values

ACTION_TTS_QUEUE_PROCESSING_COMPLETED

public static final String ACTION_TTS_QUEUE_PROCESSING_COMPLETED
See Also:
Constant Field Values
Constructor Detail

TextToSpeech

public TextToSpeech(Context context,
                    TextToSpeech.OnInitListener listener)

TextToSpeech

public TextToSpeech(Context context,
                    TextToSpeech.OnInitListener listener,
                    String engine)
Method Detail

shutdown

public void shutdown()

addSpeech

public int addSpeech(String text,
                     String packagename,
                     int resourceId)

addSpeech

public int addSpeech(String text,
                     String filename)

addEarcon

public int addEarcon(String earcon,
                     String packagename,
                     int resourceId)

addEarcon

public int addEarcon(String earcon,
                     String filename)

speak

public int speak(String text,
                 int queueMode,
                 HashMap<String,String> params)

playEarcon

public int playEarcon(String earcon,
                      int queueMode,
                      HashMap<String,String> params)

playSilence

public int playSilence(long durationInMs,
                       int queueMode,
                       HashMap<String,String> params)

isSpeaking

public boolean isSpeaking()

stop

public int stop()

setSpeechRate

public int setSpeechRate(float speechRate)

setPitch

public int setPitch(float pitch)

setLanguage

public int setLanguage(Locale loc)

getLanguage

public Locale getLanguage()

isLanguageAvailable

public int isLanguageAvailable(Locale loc)

synthesizeToFile

public int synthesizeToFile(String text,
                            HashMap<String,String> params,
                            String filename)

setOnUtteranceCompletedListener

public int setOnUtteranceCompletedListener(TextToSpeech.OnUtteranceCompletedListener listener)

setEngineByPackageName

public int setEngineByPackageName(String enginePackageName)

getDefaultEngine

public String getDefaultEngine()

areDefaultsEnforced

public boolean areDefaultsEnforced()

getEngines

public List<TextToSpeech.EngineInfo> getEngines()


Copyright © 2008-2012. All Rights Reserved.