git.gag.com Git - debian/freetts/blob - docs/jsapi_setup.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 1.0 Setup</title></head>
  17     <body>
  18         <center>
  19             <table bgcolor="#FFCC66" width="100%">
  20                 <tr>
  21                     <td align=center width="100%">
  22                         <h1>JSAPI 1.0 Setup</h1>
  23                     </td>
  24                 </tr>
  25             </table>
  26         </center>
  27
  28         <p>FreeTTS provides some level support for the <a
  29         href="http://java.sun.com/products/java-media/speech/forDevelopers/jsapi-doc/index.html">Java
  30         Speech API v1.0</a> (JSAPI).  In particular, since FreeTTS is
  31         a speech synthesis system, none of the JSAPI 1.0 Recognition
  32         interfaces are supported. In addition, FreeTTS supports only a
  33         subset of the JSAPI 1.0 <code>javax.speech.synthesis</code>
  34         specification.  The FreeTTS support for JSAPI 1.0 has the
  35         following restrictions:
  36         <ul>
  37             <li>JSML Speech Markup is ignored. FreeTTS will
  38             process JSML, but currently does not apply the markup to
  39             the generated speech.
  40             <li>FreeTTS does not currently generate the
  41             <code>WORD_STARTED</code>
  42             or the <code>MARKER_REACHED</code> events.
  43             <li>Vocabulary management is not supported.
  44             <li>The <code>Synthesizer.phoneme()</code> method is not
  45             implemented.
  46             <li><code>PropertyVeto</code> exceptions are not always
  47             properly thrown when property change requests are rejected
  48             or constrained.
  49         </ul>
  50
  51         <p>Note that the JSAPI specification is undergoing changes.
  52         The official work being done on JSAPI is now for JSAPI 2.0 via
  53         the Java Community Process (JCP) under JSR-113.  Read more
  54         about the JCP and JSR-113 at <a href="http://www.jcp.org">
  55         http://www.jcp.org</a>.
  56
  57         <h3>Set Up Your JSAPI Environment</h3> <p>The sources to
  58         the JSAPI 1.0 specification implementation (i.e., the
  59         <code>javax.speech.*</code> classes) are not available under a
  60         BSD-style license.  Instead, we make the JSAPI binary
  61         available under a separate binary code license (BCL).
  62
  63         <p>Obtaining the JSAPI binary is as simple as unpacking
  64         the <code>jsapi.jar</code> file in the <code>lib</code>
  65         directory:
  66         <ul>
  67             <li><p>UNIX Systems
  68             <ul>
  69                 <li>Go to the <code>lib</code> directory.
  70                 <li>Type  <code>chmod +x ./jsapi.sh</code>.
  71                 <li>Type  <code>sh ./jsapi.sh</code> and view the BCL.
  72                 <li>If the BCL is acceptable, accept it by typing
  73                 "y".  The <code>jsapi.jar</code> file will be unpacked
  74                 and deposited into the <code>lib</code> directory.
  75             </ul>
  76
  77             <li><p>Windows Systems
  78             <ul>
  79                 <li>Go to the <code>lib</code> directory.
  80                 <li>Type  <code>.\jsapi.exe</code> and view the BCL.
  81                 <li>If the BCL is acceptable, accept it by typing
  82                 "y".  The <code>jsapi.jar</code> file will be unpacked
  83                 and deposited into the <code>lib</code> directory.
  84             </ul>
  85         </ul>
  86
  87
  88         <h3>Copy speech.properties</h3>
  89         <p>You will also need to copy the
  90         <code>speech.properties</code> file to your home directory
  91         before running he demos that use JSAPI.  If you are not sure
  92         where to copy this file, try running one of the JSAPI
  93         demos. If the demo cannot find the
  94         <code>speech.properties</code> file, it will tell you where
  95         you should put it.
  96
  97         <p><b>NOTE</b>: if you want to avoid the need for using the
  98         <code>speech.properties</code> file with any applications you
  99         create, you can subvert the JSAPI specification by obtaining
 100         the FreeTTS JSAPI synthesizer directly rather than using the
 101         recommended and standard way (i.e., java.speech.Central).
 102         See the code in <a href="../demo/JSAPI/WebStartClock/README.html">
 103         the WebStartClock demo for an example of how to do this</a>.
 104     </body>
 105 </html>