Class VoiceList


  • public class VoiceList
    extends java.lang.Object
    Maintains a list of JSAPI 1.0 Voices.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.List voiceList
      The list of Voices.
    • Constructor Summary

      Constructors 
      Constructor Description
      VoiceList()
      Class constructor.
      VoiceList​(SynthesizerModeDesc desc)
      Constructs from the voice list in desc.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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​(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 final java.util.List voiceList
        The list of Voices.
    • Constructor Detail

      • VoiceList

        public VoiceList()
        Class constructor.
      • VoiceList

        public VoiceList​(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

      • 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​(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