Modules | Files | Inheritance Tree | Inheritance Graph | Name Index
module GNOME::Speech::Synthesis
interface SynthesizerProperties
Files: GNOME_Speech.idl
GNOME-Speech-Synthesis-SynthesizerProperties-inheritance GNOME-Speech-EngineProperties.html GNOME-Speech-SpeechObject.html Bonobo-Unknown.html
Operations Summary:
 floatgetPitch()
 floatgetPitchRange()
 floatgetSpeakingRate()
 VoicegetVoice()
 floatgetVolume()
 voidsetPitch(in float hertz) raises
 voidsetPitchRange(in float hertz) raises
 voidsetSpeakingRate(in float wpm) raises
 voidsetVoice(in Voice voice) raises
 voidsetVolume(in float volume) raises

Operations Inherited from EngineProperties
addPropertyChangeListener, getControlComponent, removePropertyChangeListener, reset

Operations Inherited from Bonobo::Unknown
ref, unref, queryInterface

Operation Details:
 float getPitch()

Get the baseline pitch for synthesis.

Return:
the baseline pitch for synthesis.
See Also:
setPitch


 float getPitchRange()

Get the pitch range for synthesis.

Return:
the pitch range for synthesis.
See Also:
setPitchRange


 float getSpeakingRate()

Get the current target speaking rate.

Return:
the current target speaking rate.
See Also:
setSpeakingRate


 Voice getVoice()

Get the current synthesizer voice. Modifications to the returned voice do not affect the Synthesizer voice - a call to setVoice is required for a change to take effect.

See Also:
setVoice


 float getVolume()

Get the current volume.

Return:
the current volume.
See Also:
setVolume


 void setPitch(in float hertz) raises (PropertyVetoException)

Set the baseline pitch for the current synthesis voice. Out-of-range values may be ignored or restricted to engine-defined limits. Different voices have different natural sounding ranges of pitch. Typical male voices are between 80 and 180 Hertz. Female pitches typically vary from 150 to 300 Hertz.

Parameters:
hertz - the new baseline pitch for the current synthesis voice.
See Also:
getPitch


 void setPitchRange(in float hertz) raises (PropertyVetoException)

Set the pitch range for the current synthesis voice. A narrow pitch range provides monotonous output while wide range provide a more lively voice. This setting is a hint to the synthesis engine. Engines may choose to ignore unreasonable requests. Some synthesizers may not support pitch variability. The pitch range is typically between 20% and 80% of the baseline pitch.

Parameters:
hertz - the new pitch range for the current synthesis voice.
See Also:
getPitchRange


 void setSpeakingRate(in float wpm) raises (PropertyVetoException)

Set the target speaking rate for the synthesis voice in words per minute.

Reasonable speaking rates depend upon the synthesizer and the current voice (some voices sound better at higher or lower speed than others).

Speaking rate is also dependent upon the language because of different conventions for what is a "word". A reasonable speaking rate for English is 200 words per minute.

Parameters:
wpm - the target speaking rate (in words per minute).
See Also:
getSpeakingRate


 void setVoice(in Voice voice) raises (PropertyVetoException)

Set the current synthesizer voice.

The list of available voices for a Synthesizer is returned by the getVoices method of the synthesizer's SynthesizerModeDesc. Any one of the voices returned by that method can be passed to setVoice to set the current speaking voice.

Alternatively, the voice parameter may be an application-created partially specified Voice object. If there is no matching voice, the call is ignored.

Parameters:
voice - the synthesizer voice.
See Also:
getVoice
SynthesizerModeDesc
Engine#getEngineModeDesc


 void setVolume(in float volume) raises (PropertyVetoException)

Set the volume for the synthesizer's speech output as a value between 0.0 and 1.0. A value of 0.0 indicates silence. A value of 1.0 is maximum volume and is usually the synthesizer default.

A synthesizer may change the voice's style with volume. For example, a quiet volume might produce whispered output and loud might produce shouting. Most synthesizer do not make this type of change.

Parameters:
volume - the volume for the synthesizer's speech output as a value between 0.0 and 1.0.
See Also:
getVolume