com.google.appinventor.components.runtime

Class TextToSpeech

java.lang.Object

com.google.appinventor.components.runtime.AndroidNonvisibleComponent

com.google.appinventor.components.runtime.TextToSpeech

All Implemented Interfaces:

Component, OnDestroyListener, OnResumeListener, OnStopListener

public class TextToSpeech
extends AndroidNonvisibleComponent
implements Component, OnStopListener, OnResumeListener, OnDestroyListener

Component for converting text to speech using either the built-in TTS library or the TextToSpeech Extended library (which must be pre-installed for Android versions earlier than Donut).

Field Summary

Fields inherited from class com.google.appinventor.components.runtime.AndroidNonvisibleComponent

form

Fields inherited from interface com.google.appinventor.components.runtime.Component

ACCELEROMETER_SENSITIVITY_MODERATE, ACCELEROMETER_SENSITIVITY_STRONG, ACCELEROMETER_SENSITIVITY_WEAK, ALIGNMENT_CENTER, ALIGNMENT_NORMAL, ALIGNMENT_OPPOSITE, ASSET_DIRECTORY, BUTTON_SHAPE_DEFAULT, BUTTON_SHAPE_OVAL, BUTTON_SHAPE_RECT, BUTTON_SHAPE_ROUNDED, COLOR_BLACK, COLOR_BLUE, COLOR_CYAN, COLOR_DEFAULT, COLOR_DKGRAY, COLOR_GRAY, COLOR_GREEN, COLOR_LTGRAY, COLOR_MAGENTA, COLOR_NONE, COLOR_ORANGE, COLOR_PINK, COLOR_RED, COLOR_WHITE, COLOR_YELLOW, DEFAULT_VALUE_COLOR_BLACK, DEFAULT_VALUE_COLOR_BLUE, DEFAULT_VALUE_COLOR_CYAN, DEFAULT_VALUE_COLOR_DEFAULT, DEFAULT_VALUE_COLOR_DKGRAY, DEFAULT_VALUE_COLOR_GRAY, DEFAULT_VALUE_COLOR_GREEN, DEFAULT_VALUE_COLOR_LTGRAY, DEFAULT_VALUE_COLOR_MAGENTA, DEFAULT_VALUE_COLOR_NONE, DEFAULT_VALUE_COLOR_ORANGE, DEFAULT_VALUE_COLOR_PINK, DEFAULT_VALUE_COLOR_RED, DEFAULT_VALUE_COLOR_WHITE, DEFAULT_VALUE_COLOR_YELLOW, DIRECTION_EAST, DIRECTION_MAX, DIRECTION_MIN, DIRECTION_NONE, DIRECTION_NORTH, DIRECTION_NORTHEAST, DIRECTION_NORTHWEST, DIRECTION_SOUTH, DIRECTION_SOUTHEAST, DIRECTION_SOUTHWEST, DIRECTION_WEST, FONT_DEFAULT_SIZE, LAYOUT_ORIENTATION_HORIZONTAL, LAYOUT_ORIENTATION_VERTICAL, LENGTH_FILL_PARENT, LENGTH_PREFERRED, LENGTH_UNKNOWN, SLIDER_MAX_VALUE, SLIDER_MIN_VALUE, SLIDER_THUMB_VALUE, TOAST_LENGTH_LONG, TOAST_LENGTH_SHORT, TYPEFACE_DEFAULT, TYPEFACE_MONOSPACE, TYPEFACE_SANSSERIF, TYPEFACE_SERIF

Constructor Summary

Constructors

Constructor and Description
TextToSpeech(ComponentContainer container) Creates a TextToSpeech component.

Method Summary

Methods

Modifier and Type	Method and Description
void	AfterSpeaking(boolean result) Event to raise after the message is spoken.
YailList	AvailableCountries()
YailList	AvailableLanguages()
void	BeforeSpeaking() Event to raise when Speak is invoked, before the message is spoken.
java.lang.String	Country() Gets the country for this TextToSpeech component.
void	Country(java.lang.String country) Sets the country for this TextToSpeech component.
java.lang.String	Language() Gets the language for this TextToSpeech component.
void	Language(java.lang.String language) Sets the language for this TextToSpeech component.
void	onDestroy()
void	onResume()
void	onStop()
float	Pitch() Reports the current value of speech pitch
void	Pitch(float pitch) Sets the speech pitch for the TextToSpeech.
void	prepareLanguageAndCountryProperties()
boolean	Result() Result property getter method.
void	Speak(java.lang.String message) Speaks the given message.
float	SpeechRate() Reports the current value of speechRate
void	SpeechRate(float speechRate) Sets the speech rate

Methods inherited from class com.google.appinventor.components.runtime.AndroidNonvisibleComponent

getDispatchDelegate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.appinventor.components.runtime.Component

getDispatchDelegate

Constructor Detail

TextToSpeech

public TextToSpeech(ComponentContainer container)

Creates a TextToSpeech component.

Parameters:

container - container, component will be placed in

Method Detail

Result

public boolean Result()

Result property getter method.

Language

public void Language(java.lang.String language)

Sets the language for this TextToSpeech component.

Parameters:

language - is the ISO2 (i.e. 2 letter) or ISO3 (i.e. 3 letter) language code to set this TextToSpeech component to.

Pitch

public void Pitch(float pitch)

Sets the speech pitch for the TextToSpeech. 1.0 is the normal pitch, lower values lower the tone of the synthesized voice, greater values increase it.

Parameters:

pitch - a pitch level between 0 and 2

Pitch

public float Pitch()

Reports the current value of speech pitch

SpeechRate

public void SpeechRate(float speechRate)

Sets the speech rate

Parameters:

speechRate - 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).

SpeechRate

public float SpeechRate()

Reports the current value of speechRate

Language

public java.lang.String Language()

Gets the language for this TextToSpeech component. This will be either an ISO2 (i.e. 2 letter) or ISO3 (i.e. 3 letter) code depending on which kind of code the property was set with.

Returns:

the language code for this TextToSpeech component.

Country

public void Country(java.lang.String country)

Sets the country for this TextToSpeech component.

Parameters:

country - is the ISO2 (i.e. 2 letter) or ISO3 (i.e. 3 letter) country code to set this TextToSpeech component to.

Country

public java.lang.String Country()

Gets the country for this TextToSpeech component. This will be either an ISO2 (i.e. 2 letter) or ISO3 (i.e. 3 letter) code depending on which kind of code the property was set with.

Returns:

country code for this TextToSpeech component.

AvailableLanguages

public YailList AvailableLanguages()

AvailableCountries

public YailList AvailableCountries()

prepareLanguageAndCountryProperties

public void prepareLanguageAndCountryProperties()

Speak

public void Speak(java.lang.String message)

Speaks the given message.

BeforeSpeaking

public void BeforeSpeaking()

Event to raise when Speak is invoked, before the message is spoken.

AfterSpeaking

public void AfterSpeaking(boolean result)

Event to raise after the message is spoken.

Parameters:

result - whether the message was successfully spoken

onStop

public void onStop()

Specified by:

onStop in interface OnStopListener

onResume

public void onResume()

Specified by:

onResume in interface OnResumeListener

onDestroy

public void onDestroy()

Specified by:

onDestroy in interface OnDestroyListener