/documentation/tts/com/google/tts/TTS.html
http://eyes-free.googlecode.com/ · HTML · 733 lines · 633 code · 77 blank · 23 comment · 0 complexity · 1f99a90ce75accbc1d3a6a1f6865189c MD5 · raw file
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!--NewPage-->
- <HTML>
- <HEAD>
- <!-- Generated by javadoc (build 1.6.0_16) on Fri Oct 09 19:06:10 PDT 2009 -->
- <TITLE>
- TTS
- </TITLE>
-
- <META NAME="date" CONTENT="2009-10-09">
-
- <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
-
- <SCRIPT type="text/javascript">
- function windowTitle()
- {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="TTS";
- }
- }
- </SCRIPT>
- <NOSCRIPT>
- </NOSCRIPT>
-
- </HEAD>
-
- <BODY BGCOLOR="white" onload="windowTitle();">
- <HR>
-
-
- <!-- ========= START OF TOP NAVBAR ======= -->
- <A NAME="navbar_top"><!-- --></A>
- <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_top_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../com/google/tts/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
-
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../com/google/tts/TextToSpeechBeta.OnUtteranceCompletedListener.html" title="interface in com.google.tts"><B>PREV CLASS</B></A>
- <A HREF="../../../com/google/tts/TTS.InitListener.html" title="interface in com.google.tts"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../index.html?com/google/tts/TTS.html" target="_top"><B>FRAMES</B></A>
- <A HREF="TTS.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
- if(window==top) {
- document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
- }
- //-->
- </SCRIPT>
- <NOSCRIPT>
- <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
-
-
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_top"></A>
- <!-- ========= END OF TOP NAVBAR ========= -->
-
- <HR>
- <!-- ======== START OF CLASS DATA ======== -->
- <H2>
- <FONT SIZE="-1">
- com.google.tts</FONT>
- <BR>
- Class TTS</H2>
- <PRE>
- java.lang.Object
- <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.google.tts.TTS</B>
- </PRE>
- <HR>
- <B>Deprecated.</B> <I>- Use TextToSpeechBeta instead</I>
- <P>
- <DL>
- <DT><PRE>public class <B>TTS</B><DT>extends java.lang.Object</DL>
- </PRE>
-
- <P>
- Synthesizes speech from text. This abstracts away the complexities of using
- the TTS service such as setting up the IBinder connection and handling
- RemoteExceptions, etc.
-
- The TTS should always be safe the use; if the user does not have the
- necessary TTS apk installed, the behavior is that all calls to the TTS act as
- no-ops.
- <P>
-
- <P>
- <HR>
-
- <P>
- <!-- ======== NESTED CLASS SUMMARY ======== -->
-
- <A NAME="nested_class_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Nested Class Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static interface</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.InitListener.html" title="interface in com.google.tts">TTS.InitListener</A></B></CODE>
-
- <BR>
- <B>Deprecated.</B> Called when the TTS has initialized
-
- The InitListener must implement the onInit function.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static interface</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.SpeechCompletedListener.html" title="interface in com.google.tts">TTS.SpeechCompletedListener</A></B></CODE>
-
- <BR>
- <B>Deprecated.</B> Called when the TTS has finished speaking by itself (ie, speaking finished
- without being canceled).</TD>
- </TR>
- </TABLE>
-
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
-
- <A NAME="constructor_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Constructor Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#TTS(Context, com.google.tts.TTS.InitListener, boolean)">TTS</A></B>(Context context,
- <A HREF="../../../com/google/tts/TTS.InitListener.html" title="interface in com.google.tts">TTS.InitListener</A> callback,
- boolean displayInstallMessage)</CODE>
-
- <BR>
- <B>Deprecated.</B> The constructor for the TTS.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#TTS(Context, com.google.tts.TTS.InitListener, com.google.tts.TTSVersionAlert)">TTS</A></B>(Context context,
- <A HREF="../../../com/google/tts/TTS.InitListener.html" title="interface in com.google.tts">TTS.InitListener</A> callback,
- <A HREF="../../../com/google/tts/TTSVersionAlert.html" title="class in com.google.tts">TTSVersionAlert</A> alert)</CODE>
-
- <BR>
- <B>Deprecated.</B> The constructor for the TTS.</TD>
- </TR>
- </TABLE>
-
- <!-- ========== METHOD SUMMARY =========== -->
-
- <A NAME="method_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Method Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#addSpeech(java.lang.String, java.lang.String)">addSpeech</A></B>(java.lang.String text,
- java.lang.String filename)</CODE>
-
- <BR>
- <B>Deprecated.</B> Adds a mapping between a string of text and a sound file.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#addSpeech(java.lang.String, java.lang.String, int)">addSpeech</A></B>(java.lang.String text,
- java.lang.String packagename,
- int resourceId)</CODE>
-
- <BR>
- <B>Deprecated.</B> Adds a mapping between a string of text and a sound resource in a package.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#getVersion()">getVersion</A></B>()</CODE>
-
- <BR>
- <B>Deprecated.</B> Returns the version number of the TTS library that the user has installed.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#isInstalled(Context)">isInstalled</A></B>(Context ctx)</CODE>
-
- <BR>
- <B>Deprecated.</B> Checks if the TTS service is installed or not</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#isSpeaking()">isSpeaking</A></B>()</CODE>
-
- <BR>
- <B>Deprecated.</B> Returns whether or not the TTS is busy speaking.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#playEarcon(java.lang.String, int, java.lang.String[])">playEarcon</A></B>(java.lang.String earcon,
- int queueMode,
- java.lang.String[] params)</CODE>
-
- <BR>
- <B>Deprecated.</B> Plays the earcon using the specified queueing mode and parameters.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#playEarcon(com.google.tts.TTSEarcon, int, java.lang.String[])">playEarcon</A></B>(<A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts">TTSEarcon</A> earcon,
- int queueMode,
- java.lang.String[] params)</CODE>
-
- <BR>
- <B>Deprecated.</B> Plays the earcon using the specified queueing mode and parameters.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#setEngine(java.lang.String)">setEngine</A></B>(java.lang.String ttsEngineBinary)</CODE>
-
- <BR>
- <B>Deprecated.</B> </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#setEngine(com.google.tts.TTSEngine)">setEngine</A></B>(<A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A> selectedEngine)</CODE>
-
- <BR>
- <B>Deprecated.</B> Sets the TTS engine to be used.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#setLanguage(java.lang.String)">setLanguage</A></B>(java.lang.String language)</CODE>
-
- <BR>
- <B>Deprecated.</B> Sets the language for the TTS engine.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#setOnSpeechCompletedListener(com.google.tts.TTS.SpeechCompletedListener)">setOnSpeechCompletedListener</A></B>(<A HREF="../../../com/google/tts/TTS.SpeechCompletedListener.html" title="interface in com.google.tts">TTS.SpeechCompletedListener</A> listener)</CODE>
-
- <BR>
- <B>Deprecated.</B> </TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#setSpeechRate(int)">setSpeechRate</A></B>(int speechRate)</CODE>
-
- <BR>
- <B>Deprecated.</B> Sets the speech rate for the TTS engine.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#showVersionAlert()">showVersionAlert</A></B>()</CODE>
-
- <BR>
- <B>Deprecated.</B> Displays an alert that prompts users to install the TTS that is available
- on the Market.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#shutdown()">shutdown</A></B>()</CODE>
-
- <BR>
- <B>Deprecated.</B> Shuts down the TTS.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#speak(java.lang.String, int, java.lang.String[])">speak</A></B>(java.lang.String text,
- int queueMode,
- java.lang.String[] params)</CODE>
-
- <BR>
- <B>Deprecated.</B> Speaks the string using the specified queuing strategy and speech
- parameters.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#stop()">stop</A></B>()</CODE>
-
- <BR>
- <B>Deprecated.</B> Stops speech from the TTS.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../com/google/tts/TTS.html#synthesizeToFile(java.lang.String, java.lang.String[], java.lang.String)">synthesizeToFile</A></B>(java.lang.String text,
- java.lang.String[] params,
- java.lang.String filename)</CODE>
-
- <BR>
- <B>Deprecated.</B> Speaks the given text using the specified queueing mode and parameters.</TD>
- </TR>
- </TABLE>
- <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
- </TR>
- </TABLE>
-
- <P>
-
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
-
- <A NAME="constructor_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
- <B>Constructor Detail</B></FONT></TH>
- </TR>
- </TABLE>
-
- <A NAME="TTS(Context, com.google.tts.TTS.InitListener, boolean)"><!-- --></A><H3>
- TTS</H3>
- <PRE>
- public <B>TTS</B>(Context context,
- <A HREF="../../../com/google/tts/TTS.InitListener.html" title="interface in com.google.tts">TTS.InitListener</A> callback,
- boolean displayInstallMessage)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>The constructor for the TTS.
- <P>
- <DL>
- <DT><B>Parameters:</B><DD><CODE>context</CODE> - The context<DD><CODE>callback</CODE> - The InitListener that should be called when the TTS has
- initialized successfully.<DD><CODE>displayInstallMessage</CODE> - Boolean indicating whether or not an
- installation prompt should be displayed to users who do not have the
- TTS library. If this is true, a generic alert asking the user to
- install the TTS will be used. If you wish to specify the exact
- message of that prompt, please use TTS(Context context, InitListener
- callback, TTSVersionAlert alert) as the constructor instead.</DL>
- </DL>
- <HR>
-
- <A NAME="TTS(Context, com.google.tts.TTS.InitListener, com.google.tts.TTSVersionAlert)"><!-- --></A><H3>
- TTS</H3>
- <PRE>
- public <B>TTS</B>(Context context,
- <A HREF="../../../com/google/tts/TTS.InitListener.html" title="interface in com.google.tts">TTS.InitListener</A> callback,
- <A HREF="../../../com/google/tts/TTSVersionAlert.html" title="class in com.google.tts">TTSVersionAlert</A> alert)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>The constructor for the TTS.
- <P>
- <DL>
- <DT><B>Parameters:</B><DD><CODE>context</CODE> - The context<DD><CODE>callback</CODE> - The InitListener that should be called when the TTS has
- initialized successfully.<DD><CODE>alert</CODE> - The TTSVersionAlert to be displayed</DL>
- </DL>
-
- <!-- ============ METHOD DETAIL ========== -->
-
- <A NAME="method_detail"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
- <B>Method Detail</B></FONT></TH>
- </TR>
- </TABLE>
-
- <A NAME="setOnSpeechCompletedListener(com.google.tts.TTS.SpeechCompletedListener)"><!-- --></A><H3>
- setOnSpeechCompletedListener</H3>
- <PRE>
- public void <B>setOnSpeechCompletedListener</B>(<A HREF="../../../com/google/tts/TTS.SpeechCompletedListener.html" title="interface in com.google.tts">TTS.SpeechCompletedListener</A> listener)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="shutdown()"><!-- --></A><H3>
- shutdown</H3>
- <PRE>
- public void <B>shutdown</B>()</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Shuts down the TTS. It is good practice to call this in the onDestroy
- method of the Activity that is using the TTS so that the TTS is stopped
- cleanly.
- <P>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="addSpeech(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
- addSpeech</H3>
- <PRE>
- public void <B>addSpeech</B>(java.lang.String text,
- java.lang.String packagename,
- int resourceId)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Adds a mapping between a string of text and a sound resource in a package.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>text</CODE> - Example: <b><code>"south_south_east"</code></b><br/><DD><CODE>packagename</CODE> - Pass the packagename of the application that contains
- the resource. If the resource is in your own application (this is
- the most common case), then put the packagename of your application
- here.<br/>
- Example: <b>"com.google.marvin.compass"</b><br/>
- The packagename can be found in the AndroidManifest.xml of your
- application.
- <p>
- <code><manifest xmlns:android="..."
- package="<b>com.google.marvin.compass</b>"></code>
- </p><DD><CODE>resourceId</CODE> - Example: <b><code>R.raw.south_south_east</code></b><DT><B>See Also:</B><DD><CODE>#TTS.speak(String text, int queueMode, String[] params)</CODE></DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="addSpeech(java.lang.String, java.lang.String)"><!-- --></A><H3>
- addSpeech</H3>
- <PRE>
- public void <B>addSpeech</B>(java.lang.String text,
- java.lang.String filename)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Adds a mapping between a string of text and a sound file. Using this, it is
- possible to add custom pronounciations for text.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>text</CODE> - The string of text<DD><CODE>filename</CODE> - The full path to the sound file (for example:
- "/sdcard/mysounds/hello.wav")</DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="speak(java.lang.String, int, java.lang.String[])"><!-- --></A><H3>
- speak</H3>
- <PRE>
- public void <B>speak</B>(java.lang.String text,
- int queueMode,
- java.lang.String[] params)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Speaks the string using the specified queuing strategy and speech
- parameters. Note that the speech parameters are not universally supported
- by all engines and will be treated as a hint. The TTS library will try to
- fulfill these parameters as much as possible, but there is no guarantee
- that the voice used will have the properties specified.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>text</CODE> - The string of text to be spoken.<DD><CODE>queueMode</CODE> - The queuing strategy to use. Use 0 for no queuing, and 1
- for queuing.<DD><CODE>params</CODE> - The array of speech parameters to be used. Currently, only
- params[0] is defined - it is for setting the type of voice if the
- engine allows it. Possible values are "VOICE_MALE", "VOICE_FEMALE",
- and "VOICE_ROBOT". Note that right now only the pre-recorded voice
- has this support - this setting has no effect on eSpeak.</DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="playEarcon(java.lang.String, int, java.lang.String[])"><!-- --></A><H3>
- playEarcon</H3>
- <PRE>
- public void <B>playEarcon</B>(java.lang.String earcon,
- int queueMode,
- java.lang.String[] params)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Plays the earcon using the specified queueing mode and parameters.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>earcon</CODE> - The earcon that should be played<DD><CODE>queueMode</CODE> - 0 for no queue (interrupts all previous utterances), 1 for
- queued<DD><CODE>params</CODE> - An ArrayList of parameters.</DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="playEarcon(com.google.tts.TTSEarcon, int, java.lang.String[])"><!-- --></A><H3>
- playEarcon</H3>
- <PRE>
- public void <B>playEarcon</B>(<A HREF="../../../com/google/tts/TTSEarcon.html" title="enum in com.google.tts">TTSEarcon</A> earcon,
- int queueMode,
- java.lang.String[] params)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Plays the earcon using the specified queueing mode and parameters.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>earcon</CODE> - The TTSEarcon that should be played<DD><CODE>queueMode</CODE> - 0 for no queue (interrupts all previous utterances), 1 for
- queued<DD><CODE>params</CODE> - An ArrayList of parameters.</DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="isSpeaking()"><!-- --></A><H3>
- isSpeaking</H3>
- <PRE>
- public boolean <B>isSpeaking</B>()</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Returns whether or not the TTS is busy speaking.
- <P>
- <DD><DL>
-
- <DT><B>Returns:</B><DD>Whether or not the TTS is busy speaking.</DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="stop()"><!-- --></A><H3>
- stop</H3>
- <PRE>
- public void <B>stop</B>()</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Stops speech from the TTS.
- <P>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="getVersion()"><!-- --></A><H3>
- getVersion</H3>
- <PRE>
- public int <B>getVersion</B>()</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Returns the version number of the TTS library that the user has installed.
- <P>
- <DD><DL>
-
- <DT><B>Returns:</B><DD>The version number of the TTS library that the user has installed.</DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="setEngine(com.google.tts.TTSEngine)"><!-- --></A><H3>
- setEngine</H3>
- <PRE>
- public void <B>setEngine</B>(<A HREF="../../../com/google/tts/TTSEngine.html" title="enum in com.google.tts">TTSEngine</A> selectedEngine)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Sets the TTS engine to be used.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>selectedEngine</CODE> - The TTS engine that should be used.</DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="setEngine(java.lang.String)"><!-- --></A><H3>
- setEngine</H3>
- <PRE>
- public void <B>setEngine</B>(java.lang.String ttsEngineBinary)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="setSpeechRate(int)"><!-- --></A><H3>
- setSpeechRate</H3>
- <PRE>
- public void <B>setSpeechRate</B>(int speechRate)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Sets the speech rate for the TTS engine.
-
- Note that the speech rate is not universally supported by all engines and
- will be treated as a hint. The TTS library will try to use the specified
- speech rate, but there is no guarantee.
-
- Currently, this will change the speech rate for the espeak engine, but it
- has no effect on any pre-recorded speech.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>speechRate</CODE> - The speech rate for the TTS engine.</DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="setLanguage(java.lang.String)"><!-- --></A><H3>
- setLanguage</H3>
- <PRE>
- public void <B>setLanguage</B>(java.lang.String language)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Sets the language for the TTS engine.
-
- Note that the language is not universally supported by all engines and will
- be treated as a hint. The TTS library will try to use the specified
- language, but there is no guarantee.
-
- Currently, this will change the language for the espeak engine, but it has
- no effect on any pre-recorded speech.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>language</CODE> - The language to be used. The languages are specified by
- their IETF language tags as defined by BCP 47. This is the same
- standard used for the lang attribute in HTML. See:
- http://en.wikipedia.org/wiki/IETF_language_tag</DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="synthesizeToFile(java.lang.String, java.lang.String[], java.lang.String)"><!-- --></A><H3>
- synthesizeToFile</H3>
- <PRE>
- public boolean <B>synthesizeToFile</B>(java.lang.String text,
- java.lang.String[] params,
- java.lang.String filename)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Speaks the given text using the specified queueing mode and parameters.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>text</CODE> - The String of text that should be synthesized<DD><CODE>params</CODE> - An ArrayList of parameters. The first element of this array
- controls the type of voice to use.<DD><CODE>filename</CODE> - The string that gives the full output filename; it should
- be something like "/sdcard/myappsounds/mysound.wav".
- <DT><B>Returns:</B><DD>A boolean that indicates if the synthesis succeeded</DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="showVersionAlert()"><!-- --></A><H3>
- showVersionAlert</H3>
- <PRE>
- public void <B>showVersionAlert</B>()</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Displays an alert that prompts users to install the TTS that is available
- on the Market. This is useful if the application expects a newer version of
- the TTS than what the user has.
- <P>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
-
- <A NAME="isInstalled(Context)"><!-- --></A><H3>
- isInstalled</H3>
- <PRE>
- public static boolean <B>isInstalled</B>(Context ctx)</PRE>
- <DL>
- <DD><B>Deprecated.</B> <DD>Checks if the TTS service is installed or not
- <P>
- <DD><DL>
-
- <DT><B>Returns:</B><DD>A boolean that indicates whether the TTS service is installed</DL>
- </DD>
- </DL>
- <!-- ========= END OF CLASS DATA ========= -->
- <HR>
-
-
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <A NAME="navbar_bottom"><!-- --></A>
- <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_bottom_firstrow"><!-- --></A>
- <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
- <TR ALIGN="center" VALIGN="top">
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../com/google/tts/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
-
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../com/google/tts/TextToSpeechBeta.OnUtteranceCompletedListener.html" title="interface in com.google.tts"><B>PREV CLASS</B></A>
- <A HREF="../../../com/google/tts/TTS.InitListener.html" title="interface in com.google.tts"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../index.html?com/google/tts/TTS.html" target="_top"><B>FRAMES</B></A>
- <A HREF="TTS.html" target="_top"><B>NO FRAMES</B></A>
- <SCRIPT type="text/javascript">
- <!--
- if(window==top) {
- document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
- }
- //-->
- </SCRIPT>
- <NOSCRIPT>
- <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
-
-
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_bottom"></A>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
-
- <HR>
-
- </BODY>
- </HTML>