com.sun.speech.engine.synthesis
Class VoiceList

java.lang.Object
  com.sun.speech.engine.synthesis.VoiceList

public class VoiceList

extends java.lang.Object

Maintains a list of JSAPI 1.0 Voices.

Field Summary

protected java.util.Vector

voiceList The list of Voices.

Constructor Summary

VoiceList()
Class constructor.

VoiceList(javax.speech.synthesis.SynthesizerModeDesc desc)
Constructs from the voice list in desc.

Method Summary

void	addVoice(BaseVoice voice) Adds a voice to the list.
BaseVoice	getVoiceById(java.lang.String id) Gets a voice by its identifier.
java.lang.String	getVoiceId(java.lang.String name, int gender, int age, int variant) Gets id for voice based on parameters provided in JSML.
java.lang.String	getVoiceId(javax.speech.synthesis.Voice voice, int variant) Gets the id of a voice.
void	removeVoice(BaseVoice voice) Removes a voice from the list.

Methods inherited from class java.lang.Object

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

Field Detail

voiceList

protected java.util.Vector voiceList

The list of Voices.

Constructor Detail

VoiceList

public VoiceList()

Class constructor.

VoiceList

public VoiceList(javax.speech.synthesis.SynthesizerModeDesc desc)

Constructs from the voice list in desc. Requires that all voices in mode desc be instances of BaseVoice.

Parameters:

desc - the SynthesizerModeDesc to get voices from

Method Detail

addVoice

public void addVoice(BaseVoice voice)

Adds a voice to the list.

Parameters:

voice - the voice to add

See Also:

removeVoice(com.sun.speech.engine.synthesis.BaseVoice)

removeVoice

public void removeVoice(BaseVoice voice)

Removes a voice from the list.

Parameters:

voice - the voice to remove

See Also:

addVoice(com.sun.speech.engine.synthesis.BaseVoice)

getVoiceById

public BaseVoice getVoiceById(java.lang.String id)

Gets a voice by its identifier.

Parameters:

id - the voice id

Returns:

the voice if it exists; otherwise null

See Also:

BaseVoice.getId()

getVoiceId

public java.lang.String getVoiceId(javax.speech.synthesis.Voice voice,
                                   int variant)

Gets the id of a voice.

Parameters:

voice - the voice

variant - the voice variant

Returns:

the id of the voice

getVoiceId

public java.lang.String getVoiceId(java.lang.String name,
                                   int gender,
                                   int age,
                                   int variant)

Gets id for voice based on parameters provided in JSML. Priority to voice name. Then try to match age and gender plus variant.

Parameters:

name - the voice name

gender - the gender

age - the age

variant - the variant

Returns:

the voice id

See Also:

BaseVoice, Voice