upstream version 1.2.2
[debian/freetts] / demo / JSAPI / Player / README.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
3 <!--
4
5 /**
6  * Copyright 2001 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>
17     <title>JSAPI Demo Player</title>
18   </head>
19
20   <body bgcolor="#FFFFFF">
21     <center>
22       <table bgcolor="#FFCC66" width="100%">
23           <tr>
24             <td align=center width="100%">
25               <h1>JSAPI Demo Player</h1>
26             </td>
27           </tr>
28       </table>
29     </center>
30
31     <p>The Player demonstrates the use of JSAPI to build
32     applications. It is capable of performing text-to-speech on ASCII
33     text, ASCII text files, JSML text, and JSML files. Here is a
34     snapshot of the Player:
35
36       <p><center><img src="player.jpg"></center>
37
38         <h3>Building</h3>
39         <p>To build this demo, merely type the following in a shell from
40         any directory in the FreeTTS hierarchy:
41         <ul>
42             <code>ant -find demo.xml</code>
43         </ul>
44         <p>Doing so will create
45         <code>bin/Player.jar</code> under the top level
46         directory.  You can run the demo 
47         using <code>java -jar</code> (see "Running" below).
48
49
50         <h3>Running</h3>
51         <p>To run this demo, type the following command from a command
52         window at the top level FreeTTS directory:</p>
53         <ul>
54             <p><code>java -jar bin/Player.jar</code></p>
55         </ul>
56
57         <p>The player will find all available voices, including voices
58         in all domains (e.g., general and time), and allow you to
59         select them for synthesizing text. If you want the Player to
60         use MBROLA voices, you must <a
61         href="../../../mbrola/README.html">setup
62         and install MBROLA</a> before using MBROLA voices.</p>
63
64         <h3>Instructions for Use</h3>
65         <ul>
66             <li><b>Plain Text</b>: Simply enter text at the
67             <b>"Enter text"</b> text area, then press the button
68             <b>"Speak Text"</b>. The text you entered will be played,
69             and inserted to the Play List.
70         
71             <li><p><b>Text File</b>: Select the <b>File</b> menu,
72             <b>Speak</b>, <b>Text File...</b>. A file choosing dialog
73             will appear. Select a text file, which will be added to
74             the Play List and played. Do not use this method if you
75             want to play a JSML file. Instead, see the bullet <i>JSML
76             file</i>.
77
78             <li><p><b>JSML Text</b>: Simply enter JSML text at the
79             <b>"Enter text"</b> text area, then press the button
80             <b>"Speak JSML"</b>. The text you entered will be played,
81             and inserted to the Play List.
82
83             <li><p><b>JSML File</b>: Select the <b>File</b> menu,
84             <b>Speak</b>, <b>JSML File...</b>. A file choosing dialog
85             will appear. Select a JSML file, which will be added to
86             the Play List and played. There are some JSML files in
87             this directory which you can try out. Do not use this
88             method if you want to play a text file. Instead, see the
89             bullet <i>Text file</i>.
90
91             <li><p><b>URL</b>: It is assumed that the URL is a JSML
92             URL. Select the <b>File</b> menu, <b>Speak</b>,
93             <b>URL...</b>. A dialog will appear asking you to enter a
94             URL. After entering the URL, press <b>OK</b>. The new URL
95             will be added to your Play List, and will start to play.    
96         </ul>
97
98         <p><b>NOTE:</b> To play any item(s) on the Play List again,
99         simply select it on the Play List and press <b>Play</b>.  To
100         clear the text in the text area, press <b>Clear</b>.
101
102         <h3>Other Features</h3> <p>In addition to text-to-speech, the
103         Player has the following functionality:
104         <ol>
105             <li>Pause and resume the playing of text (<b>Pause</b> button).
106             <li>Cancel the current utterance (<b>Cancel</b> button).
107             <li>Change the volume (<b>Volume</b> slider), speaking
108             rate in words per minute (<b>Words/min</b> slider), the
109             pitch (<b>Pitch/Hz</b> slider), and the range
110             (<b>Range</b> slider). The <i>pitch</i> is the base pitch
111             of the voice, where <i>range</i> is amount of pitch
112             variation allowed. Note that these changes will take
113             effect only on the next utterance.
114             <li>Change to another synthesizer (<b>Synthesizer</b>
115             combo box) and voice (<b>Voice</b> combo box).
116             <li>Monitor the progress of the text-to-speech process
117             (select menu <b>Monitor</b>, <b>Show</b>).
118             <li>Change the default look & feel (select <b>Style</b>
119             menu, <b>Look & Feel</b>, and then select the desired look
120             & feel).
121         </ol>
122
123         <h3>Engine Monitor</h3> 
124
125         <p>The Player also includes a Synthesizer Engine Monitor,
126         which allows you to observe the changes in the state of the
127         synthesizer during different stages, e.g., when initializing,
128         performing TTS, etc.. Simply select the <b>Monitor</b> menu,
129         <b>Show</b>) to see it working. To hide it, select the
130         <b>Monitor</b> menu, <b>Hide</b>. Here's a snapshot of the
131         Player with the Monitor:
132
133         <p><center><img src="monitor.jpg"></center>
134
135         <hr>
136
137         <p>See the <a href="../../../license.terms">license terms</a>
138         and <a href="../../../acknowledgments.txt">acknowledgments</a>.
139         <br>
140         Copyright 2001,2003 Sun Microsystems, Inc.  All Rights
141         Reserved.  Use is subject to license terms.</p>
142     </body>
143 </html>