Package com.sun.speech.engine.synthesis

Class BaseVoice

  • Direct Known Subclasses:
    FreeTTSVoice
    public class BaseVoice
extends Voice
    Extends the JSAPI 1.0 Voice class to encapsulate engine-specific data.

    • Constructor Summary

      Constructors 
      Constructor Description
      BaseVoice​(java.lang.String id, java.lang.String name, int gender, int age, java.lang.String style, float pitch, float pitchRange, float speakingRate, float volume)
      Class constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()
      Creates a copy of this voice.
      java.lang.String getId()
      Gets the id for this voice.
      float getPitch()
      Gets the pitch for this voice
      float getPitchRange()
      Gets the pitch range for this voice
      float getSpeakingRate()
      Gets the speaking rate for this voice
      float getVolume()
      Gets the volume for this voice
      void setId​(java.lang.String id)
      Sets the id for this voice.
      java.lang.String toString()
      Converts a Voice to a printable string.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • voiceId

        protected java.lang.String voiceId
        The id of the voice

      • defaultPitch

        protected float defaultPitch
        The default pitch

      • defaultPitchRange

        protected float defaultPitchRange
        The default pitch range

      • defaultSpeakingRate

        protected float defaultSpeakingRate
        The default speaking rate

      • defaultVolume

        protected float defaultVolume
        The default volume

    • Constructor Detail

      • BaseVoice

        public BaseVoice​(java.lang.String id,
                 java.lang.String name,
                 int gender,
                 int age,
                 java.lang.String style,
                 float pitch,
                 float pitchRange,
                 float speakingRate,
                 float volume)
        Class constructor. The age and gender parameters are defined in Voice.
        Parameters:
        id - the id
        name - the name
        gender - the gender
        age - the age
        style - the style
        pitch - the baseline pitch in Hertz
        pitchRange - the pitch range in Hertz
        speakingRate - the speaking rate in words per minute
        volume - the volume expressed between 0.0 and 1.0, inclusive

    • Method Detail

      • getId

        public java.lang.String getId()
        Gets the id for this voice. Should be unique for a synthesizer.
        Returns:
        the id for this voice
        See Also:
        setId(java.lang.String)

      • setId

        public void setId​(java.lang.String id)
        Sets the id for this voice.
        Parameters:
        id - the new id
        See Also:
        getId()

      • getPitch

        public float getPitch()
        Gets the pitch for this voice
        Returns:
        the pitch

      • getPitchRange

        public float getPitchRange()
        Gets the pitch range for this voice
        Returns:
        the pitch range

      • getSpeakingRate

        public float getSpeakingRate()
        Gets the speaking rate for this voice
        Returns:
        the speaking rate

      • getVolume

        public float getVolume()
        Gets the volume for this voice
        Returns:
        the volume

      • clone

        public java.lang.Object clone()
        Creates a copy of this voice.
        Returns:
        a clone of this voice

      • toString

        public java.lang.String toString()
        Converts a Voice to a printable string.