com.sun.speech.freetts.jsapi
Class FreeTTSSynthesizerModeDesc

java.lang.Object
  javax.speech.EngineModeDesc
      javax.speech.synthesis.SynthesizerModeDesc
          com.sun.speech.freetts.jsapi.FreeTTSSynthesizerModeDesc

All Implemented Interfaces:

javax.speech.EngineCreate

public class FreeTTSSynthesizerModeDesc

extends javax.speech.synthesis.SynthesizerModeDesc

implements javax.speech.EngineCreate

Represents a SynthesizerModeDesc for the FreeTTSSynthesizer. A FreeTTSSynthesizerModeDesc adds an audio player to the standard mode items.

Constructor Summary

FreeTTSSynthesizerModeDesc(java.lang.String engineName, java.lang.String modeName, java.util.Locale locale)
Creates a fully-specified descriptor.

Method Summary

javax.speech.Engine	createEngine() Constructs a FreeTTSSynthesizer with the properties of this mode descriptor.
javax.speech.synthesis.Voice[]	getVoices() Returns the valid voices in this synthesizer mode.
void	validate() Returns true if this is a valid FreeTTSSynthesizerModeDesc.

Methods inherited from class javax.speech.synthesis.SynthesizerModeDesc

addVoice, equals, match, setVoices

Methods inherited from class javax.speech.EngineModeDesc

getEngineName, getLocale, getModeName, getRunning, setEngineName, setLocale, setModeName, setRunning

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FreeTTSSynthesizerModeDesc

public FreeTTSSynthesizerModeDesc(java.lang.String engineName,
                                  java.lang.String modeName,
                                  java.util.Locale locale)

Creates a fully-specified descriptor. Any of the features may be null.

Parameters:

engineName - the name of the engine

modeName - the name of the mode

locale - the locale associated with this mode

Method Detail

getVoices

public javax.speech.synthesis.Voice[] getVoices()

Returns the valid voices in this synthesizer mode.

Returns:

an array of valid voices, if no valid voices, it will return an array of size 0

validate

public void validate()
              throws ValidationException

Returns true if this is a valid FreeTTSSynthesizerModeDesc. It is valid if it contains at least one valid Voice. Returns false otherwise.

Throws:

ValidationException - if this FreeTTSSynthesizerModeDesc is invalid

createEngine

public javax.speech.Engine createEngine()
                                 throws java.lang.IllegalArgumentException,
                                        javax.speech.EngineException,
                                        java.lang.SecurityException

Constructs a FreeTTSSynthesizer with the properties of this mode descriptor.

Specified by:

createEngine in interface javax.speech.EngineCreate

Returns:

a synthesizer that mathes the mode

Throws:

java.lang.IllegalArgumentException - if the properties of this descriptor do not match any known engine or mode

javax.speech.EngineException - if the engine could not be created

java.lang.SecurityException - if the caller does not have permission to use the speech engine