org.csapi.jr.se.ui
Class UISynthesisInfoData

java.lang.Object
  |
  +--org.csapi.jr.se.ui.UISynthesisInfoData
All Implemented Interfaces:
java.io.Serializable

public final class UISynthesisInfoData
extends java.lang.Object
implements java.io.Serializable

Defines the Sequence of Data Elements that specify the information to use in generating the desired effects on the generated voice. The speech synthesis parameters or processing tags will be interpreted as hints and may be ignored by the speech synthesis engine. Note that the language is specified on the sendInfoReq() and sendInfoAndCollectReq() method calls. The TextData field may contain the following tags to affect the processing of the text. The tag specifies a timing pause. The tag specifies an emphasis on a word or phrase. // specifies a timing pause in the // middle of the text in milliseconds A word // apply emphasis to a word or words

See Also:
Serialized Form

Constructor Summary
UISynthesisInfoData()
          Creates a new UISynthesisInfoData instance.
UISynthesisInfoData(org.csapi.jr.se.ui.UISynthesisGender _speakerGender, org.csapi.jr.se.ui.UISynthesisAge _speakerAge, org.csapi.jr.se.ui.UISynthesisRate _speakerRate, org.csapi.jr.se.ui.UISynthesisRange _speakerRange, java.lang.String _textData, org.csapi.jr.se.ui.UIWordOverride[] _wordOverrideList)
          Creates a new UISynthesisInfoData instance.
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is 'equal to' this one.
 org.csapi.jr.se.ui.UISynthesisAge getSpeakerAge()
          This method returns a speakerAge.
 org.csapi.jr.se.ui.UISynthesisGender getSpeakerGender()
          This method returns a speakerGender.
 org.csapi.jr.se.ui.UISynthesisRange getSpeakerRange()
          This method returns a speakerRange.
 org.csapi.jr.se.ui.UISynthesisRate getSpeakerRate()
          This method returns a speakerRate.
 java.lang.String getTextData()
          This method returns a textData.
 org.csapi.jr.se.ui.UIWordOverride[] getWordOverrideList()
          This method returns a wordOverrideList.
 int hashCode()
          Returns a hashcode value for the object.
 void setSpeakerAge(org.csapi.jr.se.ui.UISynthesisAge speakerAge)
          This method sets a speakerAge.
 void setSpeakerGender(org.csapi.jr.se.ui.UISynthesisGender speakerGender)
          This method sets a speakerGender.
 void setSpeakerRange(org.csapi.jr.se.ui.UISynthesisRange speakerRange)
          This method sets a speakerRange.
 void setSpeakerRate(org.csapi.jr.se.ui.UISynthesisRate speakerRate)
          This method sets a speakerRate.
 void setTextData(java.lang.String textData)
          This method sets a textData.
 void setWordOverrideList(org.csapi.jr.se.ui.UIWordOverride[] wordOverrideList)
          This method sets a wordOverrideList.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UISynthesisInfoData

public UISynthesisInfoData()
Creates a new UISynthesisInfoData instance.


UISynthesisInfoData

public UISynthesisInfoData(org.csapi.jr.se.ui.UISynthesisGender _speakerGender,
                           org.csapi.jr.se.ui.UISynthesisAge _speakerAge,
                           org.csapi.jr.se.ui.UISynthesisRate _speakerRate,
                           org.csapi.jr.se.ui.UISynthesisRange _speakerRange,
                           java.lang.String _textData,
                           org.csapi.jr.se.ui.UIWordOverride[] _wordOverrideList)
Creates a new UISynthesisInfoData instance.

Parameters:
_speakerGender - Defines the gender of the speaker.
_speakerAge - Defines the age of the speaker.
_speakerRate - Defines the rate of the speaker.
_speakerRange - Defines the range of the speaker.
_textData - Defines the text to synthesize into speech.
_wordOverrideList - Defines the pronunciation overrides.
Method Detail

getSpeakerGender

public org.csapi.jr.se.ui.UISynthesisGender getSpeakerGender()
This method returns a speakerGender.

Returns:
a org.csapi.jr.se.ui.UISynthesisGender value

getSpeakerAge

public org.csapi.jr.se.ui.UISynthesisAge getSpeakerAge()
This method returns a speakerAge.

Returns:
a org.csapi.jr.se.ui.UISynthesisAge value

getSpeakerRate

public org.csapi.jr.se.ui.UISynthesisRate getSpeakerRate()
This method returns a speakerRate.

Returns:
a org.csapi.jr.se.ui.UISynthesisRate value

getSpeakerRange

public org.csapi.jr.se.ui.UISynthesisRange getSpeakerRange()
This method returns a speakerRange.

Returns:
a org.csapi.jr.se.ui.UISynthesisRange value

getTextData

public java.lang.String getTextData()
This method returns a textData.

Returns:
a String value

getWordOverrideList

public org.csapi.jr.se.ui.UIWordOverride[] getWordOverrideList()
This method returns a wordOverrideList.

Returns:
a org.csapi.jr.se.ui.UIWordOverride[] value

setSpeakerGender

public void setSpeakerGender(org.csapi.jr.se.ui.UISynthesisGender speakerGender)
This method sets a speakerGender.


setSpeakerAge

public void setSpeakerAge(org.csapi.jr.se.ui.UISynthesisAge speakerAge)
This method sets a speakerAge.


setSpeakerRate

public void setSpeakerRate(org.csapi.jr.se.ui.UISynthesisRate speakerRate)
This method sets a speakerRate.


setSpeakerRange

public void setSpeakerRange(org.csapi.jr.se.ui.UISynthesisRange speakerRange)
This method sets a speakerRange.


setTextData

public void setTextData(java.lang.String textData)
This method sets a textData.


setWordOverrideList

public void setWordOverrideList(org.csapi.jr.se.ui.UIWordOverride[] wordOverrideList)
This method sets a wordOverrideList.


equals

public boolean equals(java.lang.Object o)
Indicates whether some other object is 'equal to' this one.

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Returns a hashcode value for the object.

Overrides:
hashCode in class java.lang.Object