upstream version 1.2.2
[debian/freetts] / demo / JSAPI / HelloWorld / README.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
3 <!--
4
5 /**
6  * Copyright 2001,2003 Sun Microsystems, Inc.
7  * 
8  * See the file "license.terms" for information on usage and
9  * redistribution of this file, and for a DISCLAIMER OF ALL 
10  * WARRANTIES.
11  */
12
13 -->
14
15 <html>
16     <head><title>JSAPI HelloWorld Demo</title></head>
17     <body>
18         <center>
19             <table bgcolor="#FFCC66" width="100%">
20                 <tr>
21                     <td align=center width="100%">
22                         <h1>JSAPI HelloWorld Demo</h1>
23                     </td>
24                 </tr>
25             </table>
26         </center>
27
28         <p>This demo provides a very simple example of how to use
29         FreeTTS with just the Java Speech API.</p>
30
31         <p><b>NOTE</b>: To build and run this JSAPI demo, you must 
32         <a href="../../../docs/jsapi_setup.html">set up your environment to
33         use JSAPI</a>.
34
35         <h3>Building</h3>
36         <p>To build this demo, merely type the following in a shell from
37         any directory in the FreeTTS hierarchy:
38         <ul>
39             <code>ant -find demo.xml</code>
40         </ul>
41         <p>Doing so will create
42         <code>bin/HelloWorld.jar</code> under the top level
43         directory.  You can run the demo 
44         using <code>java -jar</code> (see "Running" below).
45
46         <h3>Running</h3>
47         <p>To run this demo, type the following command from a command
48         window at the top level FreeTTS directory:</p>
49         <ul>
50             <p><code>java -jar bin/HelloWorld.jar</code></p>
51         </ul>
52
53         <p>You will hear:</p>
54         <ul>
55             <p><b>"Hello, world!"</b></p>
56             <p><img src="../../../docs/images/speaker1.gif"> Click 
57             <a href="helloworld.au">AU</a> or 
58             <a href="helloworld.wav">WAV</a> to listen to it.</p>
59         </ul>
60
61         <h3>Specifying a Voice</h3> 
62
63         <p>By default, this application will use the "kevin16" voice
64         that comes with the lib/cmu_us_kal.jar file.  You can, however,
65         specify a voice by passing the name of a voice as the
66         first (and only) parameter on the command line:</p>
67         <ul>
68             <p><code>java -jar bin/HelloWorld.jar kevin</code>
69             <br><code>java -jar bin/HelloWorld.jar kevin16</code>
70             <br><code>java -Dmbrola.base=/usr/local/mbrola -jar
71             bin/HelloWorld.jar mbrola_us1</code> (*)</p>
72         </ul>
73     
74         <p>(*) You must <a href="../../../mbrola/README.html">setup
75         and install MBROLA</a> before using MBROLA voices.</p>
76
77         <hr>
78
79         <p>See the <a href="../../../license.terms">license terms</a>
80         and <a href="../../../acknowledgments.txt">acknowledgments</a>.
81         <br>
82         Copyright 2001,2003 Sun Microsystems, Inc.  All Rights
83         Reserved.  Use is subject to license terms.</p>
84     </body>
85 </html>