Class BaseSynthesizerProperties

  • All Implemented Interfaces:
    SpeechEventDispatcher

    public class BaseSynthesizerProperties
    extends BaseEngineProperties
    Supports the JSAPI 1.0 SynthesizerProperties interface. The properties of a Synthesizer are:
    • Speaking voice,
    • Baseline pitch,
    • Pitch range,
    • Speaking rate,
    • Volume.
    • Field Detail

      • defaultVoice

        protected Voice defaultVoice
        The default voice.
      • defaultPitch

        protected float defaultPitch
        The default pitch.
      • defaultPitchRange

        protected float defaultPitchRange
        The default pitch range.
      • defaultSpeakingRate

        protected float defaultSpeakingRate
        The default specking rate.
      • defaultVolume

        protected float defaultVolume
        The default volume.
      • currentVoice

        protected Voice currentVoice
        The current voice.
      • currentPitch

        protected float currentPitch
        The current pitch.
      • currentPitchRange

        protected float currentPitchRange
        The current pitch range.
      • currentSpeakingRate

        protected float currentSpeakingRate
        The current speaking rate.
      • currentVolume

        protected float currentVolume
        The current volume.
    • Constructor Detail

      • BaseSynthesizerProperties

        public BaseSynthesizerProperties()
        Class constructor.
      • BaseSynthesizerProperties

        public BaseSynthesizerProperties​(Voice defaultVoice,
                                         float defaultPitch,
                                         float defaultPitchRange,
                                         float defaultSpeakingRate,
                                         float defaultVolume)
        Creates a new BaseSynthesizerProperties with the given default values.
        Parameters:
        defaultVoice - the default voice
        defaultPitch - the default pitch
        defaultPitchRange - the default pitch range
        defaultSpeakingRate - the default speaking rate
        defaultVolume - the default volume
    • Method Detail

      • reset

        public void reset()
        Resets all properties to their default values.
        Specified by:
        reset in class BaseEngineProperties
      • getVoice

        public Voice getVoice()
        Gets the current synthesizer voice.
        Returns:
        the current synthesizer voice.
        See Also:
        setVoice(Voice)
      • setVoice

        public void setVoice​(Voice voice)
                      throws java.beans.PropertyVetoException
        Sets the current synthesizer voice.
        Parameters:
        voice - the new voice
        Throws:
        java.beans.PropertyVetoException - if the voice cannot be set to the given value
        See Also:
        getVoice()
      • getPitch

        public float getPitch()
        Gets the baseline pitch for synthesis.
        Returns:
        the baseline pitch in Hertz
        See Also:
        setPitch(float)
      • setPitch

        public void setPitch​(float hertz)
                      throws java.beans.PropertyVetoException
        Sets the baseline pitch for the current synthesis voice.
        Parameters:
        hertz - the new baseline pitch in Hertz
        Throws:
        java.beans.PropertyVetoException - if the baseline pitch cannot be set to the given value
        See Also:
        getPitch()
      • getPitchRange

        public float getPitchRange()
        Gets the pitch range for synthesis.
        Returns:
        the current pitch range in Hertz
        See Also:
        setPitchRange(float)
      • setPitchRange

        public void setPitchRange​(float hertz)
                           throws java.beans.PropertyVetoException
        Sets the pitch range for the current synthesis voice.
        Parameters:
        hertz - the new range in Hertz
        Throws:
        java.beans.PropertyVetoException - if the pitch range cannot be set to the given value
        See Also:
        getPitchRange()
      • getSpeakingRate

        public float getSpeakingRate()
        Gets the current target speaking rate in words per minute.
        Returns:
        the current target speaking rate in words per minute.
        See Also:
        getSpeakingRate()
      • setSpeakingRate

        public void setSpeakingRate​(float wpm)
                             throws java.beans.PropertyVetoException
        Sets the target speaking rate in words per minute.
        Parameters:
        wpm - the new speaking rate in words per minute
        Throws:
        java.beans.PropertyVetoException - if the speaking rate cannot be set to the given value
        See Also:
        getSpeakingRate()
      • getVolume

        public float getVolume()
        Gets the current volume.
        Returns:
        the current volume expressed as a float 0.0 and 1.0, inclusive
        See Also:
        setVolume(float)
      • setVolume

        public void setVolume​(float volume)
                       throws java.beans.PropertyVetoException
        Sets the volume.
        Parameters:
        volume - the new volume expressed as a float 0.0 and 1.0, inclusive
        Throws:
        java.beans.PropertyVetoException - if the volume cannot be set to the given value
        See Also:
        getVolume()