1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:29 CET 2009 -->
\r
7 FreeTTSTime (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.FreeTTSTime class">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 parent.document.title="FreeTTSTime (FreeTTS 1.2)";
\r
23 <BODY BGCOLOR="white" onload="windowTitle();">
\r
26 <!-- ========= START OF TOP NAVBAR ======= -->
\r
27 <A NAME="navbar_top"><!-- --></A>
28 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
32 <A NAME="navbar_top_firstrow"><!-- --></A>
33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
34 <TR ALIGN="center" VALIGN="top">
\r
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
52 <A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>
\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
55 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
56 <A HREF="FreeTTSTime.html" target="_top"><B>NO FRAMES</B></A>
\r
57 <SCRIPT type="text/javascript">
\r
60 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
65 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
72 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
74 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->
\r
81 <!-- ======== START OF CLASS DATA ======== -->
\r
84 com.sun.speech.freetts</FONT>
\r
86 Class FreeTTSTime</H2>
\r
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html" title="class in com.sun.speech.freetts">com.sun.speech.freetts.FreeTTS</A>
\r
90 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.FreeTTSTime</B>
\r
94 <DT>public class <B>FreeTTSTime</B><DT>extends <A HREF="../../../../com/sun/speech/freetts/FreeTTS.html" title="class in com.sun.speech.freetts">FreeTTS</A></DL>
\r
97 Standalone utility that tells the time.
99 Defaults to "alan" voice.
\r
106 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
109 <!-- =========== FIELD SUMMARY =========== -->
\r
112 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
114 <A NAME="constructor_summary"><!-- --></A>
115 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
117 <TD COLSPAN=2><FONT SIZE="+2">
\r
118 <B>Constructor Summary</B></FONT></TD>
\r
120 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
121 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSTime.html#FreeTTSTime()">FreeTTSTime</A></B>()</CODE>
\r
124 Class constructor.</TD>
\r
126 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
127 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSTime.html#FreeTTSTime(com.sun.speech.freetts.Voice)">FreeTTSTime</A></B>(<A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A> voice)</CODE>
\r
130 Class constructor.</TD>
\r
134 <!-- ========== METHOD SUMMARY =========== -->
\r
136 <A NAME="method_summary"><!-- --></A>
137 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
138 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
139 <TD COLSPAN=2><FONT SIZE="+2">
\r
140 <B>Method Summary</B></FONT></TD>
\r
142 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
144 <CODE>static void</CODE></FONT></TD>
\r
145 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSTime.html#main(java.lang.String[])">main</A></B>(java.lang.String[] args)</CODE>
\r
148 The main entry point for FreeTTSTime.</TD>
\r
150 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
152 <CODE> void</CODE></FONT></TD>
\r
153 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSTime.html#safeTimeToSpeech(java.lang.String)">safeTimeToSpeech</A></B>(java.lang.String time)</CODE>
\r
156 Speaks the given time. </TD>
\r
158 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
160 <CODE> void</CODE></FONT></TD>
\r
161 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSTime.html#speakNow()">speakNow</A></B>()</CODE>
\r
164 Tells the current time.</TD>
\r
166 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
168 <CODE> void</CODE></FONT></TD>
\r
169 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSTime.html#timeToSpeech(int, int)">timeToSpeech</A></B>(int hour,
170 int min)</CODE>
\r
173 Speaks the time given the hour and minute.</TD>
\r
175 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
177 <CODE> void</CODE></FONT></TD>
\r
178 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSTime.html#timeToSpeech(java.lang.String)">timeToSpeech</A></B>(java.lang.String time)</CODE>
\r
181 Speaks the given time. </TD>
\r
183 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
185 <CODE>static java.lang.String</CODE></FONT></TD>
\r
186 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSTime.html#timeToString(int, int)">timeToString</A></B>(int hour,
187 int min)</CODE>
\r
190 Returns a string that corresponds to the given time.</TD>
\r
192 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
194 <CODE>static java.lang.String</CODE></FONT></TD>
\r
195 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSTime.html#timeToString(java.lang.String)">timeToString</A></B>(java.lang.String time)</CODE>
\r
198 Returns a string that corresponds to the given time.</TD>
\r
200 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
202 <CODE>static void</CODE></FONT></TD>
\r
203 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FreeTTSTime.html#usage()">usage</A></B>()</CODE>
\r
206 Prints the usage message for FreeTTSTime.</TD>
\r
209 <A NAME="methods_inherited_from_class_com.sun.speech.freetts.FreeTTS"><!-- --></A>
210 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
211 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
212 <TD><B>Methods inherited from class com.sun.speech.freetts.<A HREF="../../../../com/sun/speech/freetts/FreeTTS.html" title="class in com.sun.speech.freetts">FreeTTS</A></B></TD>
\r
214 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
215 <TD><CODE><A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#fileToSpeech(java.lang.String)">fileToSpeech</A>, <A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#getInputMode()">getInputMode</A>, <A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#getSilentMode()">getSilentMode</A>, <A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#getVoice()">getVoice</A>, <A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#setAudioFile(java.lang.String)">setAudioFile</A>, <A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#setInputMode(com.sun.speech.freetts.InputMode)">setInputMode</A>, <A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#setMultiAudio(boolean)">setMultiAudio</A>, <A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#setSilentMode(boolean)">setSilentMode</A>, <A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#setStreamingAudio(boolean)">setStreamingAudio</A>, <A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#shutdown()">shutdown</A>, <A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#startup()">startup</A>, <A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#streamToSpeech(java.io.InputStream)">streamToSpeech</A>, <A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#textToSpeech(java.lang.String)">textToSpeech</A>, <A HREF="../../../../com/sun/speech/freetts/FreeTTS.html#urlToSpeech(java.lang.String)">urlToSpeech</A></CODE></TD>
\r
218 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
219 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
220 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
221 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
223 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
224 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
230 <!-- ============ FIELD DETAIL =========== -->
\r
233 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
235 <A NAME="constructor_detail"><!-- --></A>
236 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
237 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
238 <TD COLSPAN=1><FONT SIZE="+2">
\r
239 <B>Constructor Detail</B></FONT></TD>
\r
243 <A NAME="FreeTTSTime()"><!-- --></A><H3>
\r
246 public <B>FreeTTSTime</B>()</PRE>
\r
248 <DD>Class constructor.
\r
253 <A NAME="FreeTTSTime(com.sun.speech.freetts.Voice)"><!-- --></A><H3>
\r
256 public <B>FreeTTSTime</B>(<A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A> voice)</PRE>
\r
258 <DD>Class constructor.
\r
260 <DT><B>Parameters:</B><DD><CODE>voice</CODE> - Voice to say time with</DL>
\r
262 <!-- ============ METHOD DETAIL ========== -->
\r
264 <A NAME="method_detail"><!-- --></A>
265 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
266 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
267 <TD COLSPAN=1><FONT SIZE="+2">
\r
268 <B>Method Detail</B></FONT></TD>
\r
272 <A NAME="usage()"><!-- --></A><H3>
\r
275 public static void <B>usage</B>()</PRE>
\r
277 <DD>Prints the usage message for FreeTTSTime.
\r
285 <A NAME="timeToString(java.lang.String)"><!-- --></A><H3>
\r
288 public static java.lang.String <B>timeToString</B>(java.lang.String time)</PRE>
\r
290 <DD>Returns a string that corresponds to the given time.
\r
293 <DT><B>Parameters:</B><DD><CODE>time</CODE> - the time in the form HH:MM
294 <DT><B>Returns:</B><DD>the time in string, null if the given time is not in the
300 <A NAME="timeToString(int, int)"><!-- --></A><H3>
\r
303 public static java.lang.String <B>timeToString</B>(int hour,
304 int min)</PRE>
\r
306 <DD>Returns a string that corresponds to the given time.
\r
309 <DT><B>Parameters:</B><DD><CODE>hour</CODE> - the hour<DD><CODE>min</CODE> - the minutes
310 <DT><B>Returns:</B><DD>the time in string, null if the given time out of range</DL>
\r
315 <A NAME="timeToSpeech(java.lang.String)"><!-- --></A><H3>
\r
318 public void <B>timeToSpeech</B>(java.lang.String time)</PRE>
\r
320 <DD>Speaks the given time. Time should be in the exact form
321 HH:MM where HH is the hour 00 to 23, and MM is the minute 00 to
325 <DT><B>Parameters:</B><DD><CODE>time</CODE> - the time in the form HH:MM
327 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if time is not in the form
333 <A NAME="timeToSpeech(int, int)"><!-- --></A><H3>
\r
336 public void <B>timeToSpeech</B>(int hour,
337 int min)</PRE>
\r
339 <DD>Speaks the time given the hour and minute.
\r
342 <DT><B>Parameters:</B><DD><CODE>hour</CODE> - the hour of the day (0 to 23)<DD><CODE>min</CODE> - the minute of the hour (0 to 59)</DL>
\r
347 <A NAME="safeTimeToSpeech(java.lang.String)"><!-- --></A><H3>
\r
348 safeTimeToSpeech</H3>
\r
350 public void <B>safeTimeToSpeech</B>(java.lang.String time)</PRE>
\r
352 <DD>Speaks the given time. Prints an error message if the time
356 <DT><B>Parameters:</B><DD><CODE>time</CODE> - the time in the form HH:MM</DL>
\r
361 <A NAME="speakNow()"><!-- --></A><H3>
\r
364 public void <B>speakNow</B>()</PRE>
\r
366 <DD>Tells the current time.
\r
374 <A NAME="main(java.lang.String[])"><!-- --></A><H3>
\r
377 public static void <B>main</B>(java.lang.String[] args)</PRE>
\r
379 <DD>The main entry point for FreeTTSTime.
\r
385 <!-- ========= END OF CLASS DATA ========= -->
\r
389 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
390 <A NAME="navbar_bottom"><!-- --></A>
391 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
392 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
394 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
395 <A NAME="navbar_bottom_firstrow"><!-- --></A>
396 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
397 <TR ALIGN="center" VALIGN="top">
\r
398 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
399 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
400 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
401 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
402 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
403 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
404 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
408 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
414 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
415 <A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakableImpl.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
416 <A HREF="../../../../com/sun/speech/freetts/Gender.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>
\r
417 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
418 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
419 <A HREF="FreeTTSTime.html" target="_top"><B>NO FRAMES</B></A>
\r
420 <SCRIPT type="text/javascript">
\r
423 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
428 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
434 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
435 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
436 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
437 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
440 <A NAME="skip-navbar_bottom"></A>
441 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r