Package org.robolectric.shadows

Class ShadowTextToSpeech

java.lang.Object

org.robolectric.shadows.ShadowTextToSpeech

@Implements(android.speech.tts.TextToSpeech.class)
public class ShadowTextToSpeech
extends Object

Constructor Summary

Constructors

Constructor	Description
ShadowTextToSpeech()

Method Summary

Modifier and Type	Method	Description
protected void	__constructor__(Context context, TextToSpeech.OnInitListener listener, String engine, String packageName, boolean useFallback)
static void	addLanguageAvailability(Locale locale)	Makes Locale an available language returned by TextToSpeech.isLanguageAvailable(Locale).
static void	addVoice(Voice voice)	Makes Voice an available voice returned by TextToSpeech.getVoices().
void	clearLastSpokenText()
Context	getContext()
Locale	getCurrentLanguage()	Returns Locale set using TextToSpeech.setLanguage(Locale) or null if not set.
Voice	getCurrentVoice()	Returns Voice set using TextToSpeech.setVoice(Voice), or null if not set.
String	getLastSpokenText()
File	getLastSynthesizeToFile()	Returns last file File written to by TextToSpeech.synthesizeToFile(CharSequence, Bundle, File, String).
String	getLastSynthesizeToFileText()	Returns last text CharSequence passed to TextToSpeech.synthesizeToFile(CharSequence, Bundle, File, String).
static TextToSpeech	getLastTextToSpeechInstance()	Returns the most recently instantiated TextToSpeech or null if none exist.
TextToSpeech.OnInitListener	getOnInitListener()
int	getQueueMode()
com.google.common.collect.ImmutableList<String>	getSpokenTextList()	Returns list of all the text spoken by speak(java.lang.String, int, java.util.HashMap<java.lang.String, java.lang.String>).
UtteranceProgressListener	getUtteranceProgressListener()
protected Voice	getVoice()	Returns the Voice instance describing the voice currently being used for synthesis requests.
protected Set<Voice>	getVoices()
protected int	initTts()
protected int	isLanguageAvailable(Locale lang)
boolean	isShutdown()
boolean	isStopped()
static void	reset()
protected int	setLanguage(Locale locale)	Sets the text-to-speech language.
protected int	setVoice(Voice voice)
protected void	shutdown()
void	simulateSynthesizeToFileResult(int result)	Sets up synthesizeToFile to succeed or fail in the synthesis operation.
protected int	speak(CharSequence text, int queueMode, Bundle params, String utteranceId)
protected int	speak(String text, int queueMode, HashMap<String,String> params)	Speaks the string using the specified queuing strategy and speech parameters.
protected int	stop()
protected int	synthesizeToFile(CharSequence text, Bundle params, File file, String utteranceId)	Stores text and returns TextToSpeech.SUCCESS.

Methods inherited from class java.lang.Object

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

Constructor Details

ShadowTextToSpeech

public ShadowTextToSpeech()

Method Details

__constructor__

@Implementation
protected void __constructor__(Context context,
 TextToSpeech.OnInitListener listener,
 String engine,
 String packageName,
 boolean useFallback)

simulateSynthesizeToFileResult

public void simulateSynthesizeToFileResult(int result)

Sets up synthesizeToFile to succeed or fail in the synthesis operation.

This controls calls the relevant callbacks but does not set the return value of synthesizeToFile.

Parameters:

result - TextToSpeech enum (SUCCESS, ERROR, or one of the ERROR_ codes from TextToSpeech)

initTts

@Implementation
protected int initTts()

speak

@Implementation
protected int speak(String text,
 int queueMode,
 HashMap<String,String> params)

Speaks the string using the specified queuing strategy and speech parameters.

Parameters:

params - The real implementation converts the hashmap into a bundle, but the bundle argument is not used in the shadow implementation.

speak

@Implementation
protected int speak(CharSequence text,
 int queueMode,
 Bundle params,
 String utteranceId)

shutdown

@Implementation
protected void shutdown()

stop

@Implementation
protected int stop()

isLanguageAvailable

@Implementation
protected int isLanguageAvailable(Locale lang)

setLanguage

@Implementation
protected int setLanguage(Locale locale)

Sets the text-to-speech language.

This method sets the current voice to the default one for the given Locale; getVoice() can be used to retrieve it.

synthesizeToFile

@Implementation
protected int synthesizeToFile(CharSequence text,
 Bundle params,
 File file,
 String utteranceId)
                        throws IOException

Stores text and returns TextToSpeech.SUCCESS.

Throws:

IOException

See Also:

• getLastSynthesizeToFileText()

setVoice

@Implementation
protected int setVoice(Voice voice)

getVoice

@Implementation
protected Voice getVoice()

Returns the Voice instance describing the voice currently being used for synthesis requests.

getVoices

@Implementation
protected Set<Voice> getVoices()

getUtteranceProgressListener

public UtteranceProgressListener getUtteranceProgressListener()

getContext

public Context getContext()

getOnInitListener

public TextToSpeech.OnInitListener getOnInitListener()

getLastSpokenText

public String getLastSpokenText()

clearLastSpokenText

public void clearLastSpokenText()

isShutdown

public boolean isShutdown()

isStopped

public boolean isStopped()

Returns:

true if the TTS is stopped.

getQueueMode

public int getQueueMode()

getCurrentLanguage

public Locale getCurrentLanguage()

Returns Locale set using TextToSpeech.setLanguage(Locale) or null if not set.

getLastSynthesizeToFileText

public String getLastSynthesizeToFileText()

Returns last text CharSequence passed to TextToSpeech.synthesizeToFile(CharSequence, Bundle, File, String).

getLastSynthesizeToFile

public File getLastSynthesizeToFile()

Returns last file File written to by TextToSpeech.synthesizeToFile(CharSequence, Bundle, File, String).

getSpokenTextList

public com.google.common.collect.ImmutableList<String> getSpokenTextList()

Returns list of all the text spoken by speak(java.lang.String, int, java.util.HashMap<java.lang.String, java.lang.String>).

addLanguageAvailability

public static void addLanguageAvailability(Locale locale)

Makes Locale an available language returned by TextToSpeech.isLanguageAvailable(Locale). The value returned by isLanguageAvailable(Locale) will vary depending on language, country, and variant.

addVoice

public static void addVoice(Voice voice)

Makes Voice an available voice returned by TextToSpeech.getVoices().

getCurrentVoice

public Voice getCurrentVoice()

Returns Voice set using TextToSpeech.setVoice(Voice), or null if not set.

getLastTextToSpeechInstance

public static TextToSpeech getLastTextToSpeechInstance()

Returns the most recently instantiated TextToSpeech or null if none exist.

reset

@Resetter
public static void reset()