git.gag.com Git - debian/freetts/blob - javadoc/com/sun/speech/freetts/Unit.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
   2 <!--NewPage-->\r
   3 <HTML>\r
   4 <HEAD>\r
   5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:29 CET 2009 -->\r
   6 <TITLE>\r
   7 Unit (FreeTTS 1.2)\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.Unit interface">\r
  11 \r
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">\r
  13 \r
  14 <SCRIPT type="text/javascript">\r
  15 function windowTitle()\r
  16 {\r
  17     parent.document.title="Unit (FreeTTS 1.2)";\r
  18 }\r
  19 </SCRIPT>\r
  20 \r
  21 </HEAD>\r
  22 \r
  23 <BODY BGCOLOR="white" onload="windowTitle();">\r
  24 \r
  25
  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
  30 <TR>\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>&nbsp;</TD>\r
  36   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
  37   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
  39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
  42   </TR>\r
  43 </TABLE>\r
  44 </TD>\r
  45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
  46 </EM>\r
  47 </TD>\r
  48 </TR>\r
  49 \r
  50 <TR>\r
  51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  52 &nbsp;<A HREF="../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
  53 &nbsp;<A HREF="../../../../com/sun/speech/freetts/UtteranceProcessor.html" title="interface 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>  &nbsp;\r
  56 &nbsp;<A HREF="Unit.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
  57 &nbsp;<SCRIPT type="text/javascript">\r
  58   <!--\r
  59   if(window==top) {\r
  60     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
  61   }\r
  62   //-->\r
  63 </SCRIPT>\r
  64 <NOSCRIPT>\r
  65   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
  66 </NOSCRIPT>
  67 \r
  68 </FONT></TD>\r
  69 </TR>\r
  70 <TR>\r
  71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  72   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
  73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  74 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
  75 </TR>\r
  76 </TABLE>\r
  77 <A NAME="skip-navbar_top"></A>
  78 <!-- ========= END OF TOP NAVBAR ========= -->\r
  79 \r
  80 <HR>\r
  81 <!-- ======== START OF CLASS DATA ======== -->\r
  82 <H2>\r
  83 <FONT SIZE="-1">\r
  84 com.sun.speech.freetts</FONT>\r
  85 <BR>\r
  86 Interface Unit</H2>\r
  87 <HR>\r
  88 <DL>\r
  89 <DT>public interface <B>Unit</B></DL>\r
  90 \r
  91 <P>\r
  92 Defines a generic interface to a Unit.\r
  93 <P>\r
  94 \r
  95 <P>\r
  96 <HR>\r
  97 \r
  98 <P>\r
  99 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
 100 \r
 101 \r
 102 <!-- =========== FIELD SUMMARY =========== -->\r
 103 \r
 104 \r
 105 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 106 \r
 107 \r
 108 <!-- ========== METHOD SUMMARY =========== -->\r
 109 \r
 110 <A NAME="method_summary"><!-- --></A>
 111 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 112 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 113 <TD COLSPAN=2><FONT SIZE="+2">\r
 114 <B>Method Summary</B></FONT></TD>\r
 115 </TR>\r
 116 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 117 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 118 <CODE>&nbsp;void</CODE></FONT></TD>\r
 119 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Unit.html#dump()">dump</A></B>()</CODE>\r
 120 \r
 121 <BR>\r
 122 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Dumps this unit.</TD>\r
 123 </TR>\r
 124 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 125 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 126 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 127 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Unit.html#getName()">getName</A></B>()</CODE>\r
 128 \r
 129 <BR>\r
 130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of this Unit.</TD>\r
 131 </TR>\r
 132 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 133 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 134 <CODE>&nbsp;<A HREF="../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A></CODE></FONT></TD>\r
 135 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Unit.html#getNearestSample(float)">getNearestSample</A></B>(float&nbsp;index)</CODE>\r
 136 \r
 137 <BR>\r
 138 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the nearest sample.</TD>\r
 139 </TR>\r
 140 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 142 <CODE>&nbsp;int</CODE></FONT></TD>\r
 143 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/Unit.html#getSize()">getSize</A></B>()</CODE>\r
 144 \r
 145 <BR>\r
 146 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the size of this unit.</TD>\r
 147 </TR>\r
 148 </TABLE>\r
 149 &nbsp;\r
 150 <P>\r
 151 \r
 152 <!-- ============ FIELD DETAIL =========== -->\r
 153 \r
 154 \r
 155 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 156 \r
 157 \r
 158 <!-- ============ METHOD DETAIL ========== -->\r
 159 \r
 160 <A NAME="method_detail"><!-- --></A>
 161 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 162 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 163 <TD COLSPAN=1><FONT SIZE="+2">\r
 164 <B>Method Detail</B></FONT></TD>\r
 165 </TR>\r
 166 </TABLE>\r
 167 \r
 168 <A NAME="getName()"><!-- --></A><H3>\r
 169 getName</H3>\r
 170 <PRE>\r
 171 public java.lang.String <B>getName</B>()</PRE>\r
 172 <DL>\r
 173 <DD>Returns the name of this Unit.\r
 174 <P>\r
 175 <DD><DL>\r
 176
 177 <DT><B>Returns:</B><DD>the name of this Unit</DL>\r
 178 </DD>\r
 179 </DL>\r
 180 <HR>\r
 181 \r
 182 <A NAME="getSize()"><!-- --></A><H3>\r
 183 getSize</H3>\r
 184 <PRE>\r
 185 public int <B>getSize</B>()</PRE>\r
 186 <DL>\r
 187 <DD>Returns the size of this unit.\r
 188 <P>\r
 189 <DD><DL>\r
 190
 191 <DT><B>Returns:</B><DD>the size of this unit</DL>\r
 192 </DD>\r
 193 </DL>\r
 194 <HR>\r
 195 \r
 196 <A NAME="getNearestSample(float)"><!-- --></A><H3>\r
 197 getNearestSample</H3>\r
 198 <PRE>\r
 199 public <A HREF="../../../../com/sun/speech/freetts/relp/Sample.html" title="class in com.sun.speech.freetts.relp">Sample</A> <B>getNearestSample</B>(float&nbsp;index)</PRE>\r
 200 <DL>\r
 201 <DD>Retrieves the nearest sample.\r
 202 <P>\r
 203 <DD><DL>\r
 204 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the ideal index
 205 <DT><B>Returns:</B><DD>the nearest Sample</DL>\r
 206 </DD>\r
 207 </DL>\r
 208 <HR>\r
 209 \r
 210 <A NAME="dump()"><!-- --></A><H3>\r
 211 dump</H3>\r
 212 <PRE>\r
 213 public void <B>dump</B>()</PRE>\r
 214 <DL>\r
 215 <DD>Dumps this unit.\r
 216 <P>\r
 217 <DD><DL>\r
 218 </DL>\r
 219 </DD>\r
 220 </DL>\r
 221 <!-- ========= END OF CLASS DATA ========= -->\r
 222 <HR>\r
 223 \r
 224
 225 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 226 <A NAME="navbar_bottom"><!-- --></A>
 227 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 228 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 229 <TR>\r
 230 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 231 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 232 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 233   <TR ALIGN="center" VALIGN="top">\r
 234   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 235   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 236   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 237   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 238   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 239   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 240   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 241   </TR>\r
 242 </TABLE>\r
 243 </TD>\r
 244 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 245 </EM>\r
 246 </TD>\r
 247 </TR>\r
 248 \r
 249 <TR>\r
 250 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 251 &nbsp;<A HREF="../../../../com/sun/speech/freetts/Tokenizer.html" title="interface in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
 252 &nbsp;<A HREF="../../../../com/sun/speech/freetts/UtteranceProcessor.html" title="interface in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>\r
 253 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 254   <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 255 &nbsp;<A HREF="Unit.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 256 &nbsp;<SCRIPT type="text/javascript">\r
 257   <!--\r
 258   if(window==top) {\r
 259     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 260   }\r
 261   //-->\r
 262 </SCRIPT>\r
 263 <NOSCRIPT>\r
 264   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 265 </NOSCRIPT>
 266 \r
 267 </FONT></TD>\r
 268 </TR>\r
 269 <TR>\r
 270 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 271   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 272 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 273 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 274 </TR>\r
 275 </TABLE>\r
 276 <A NAME="skip-navbar_bottom"></A>
 277 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 278 \r
 279 <HR>\r
 280 \r
 281 </BODY>\r
 282 </HTML>\r