Programming Reference:SpeechStimulus Class: Difference between revisions
Jump to navigation
Jump to search
Line 4: | Line 4: | ||
==Synopsis== | ==Synopsis== | ||
The <tt>SpeechStimulus</tt> class combines the [[Programming Reference:Stimulus Class|Stimulus Class]] interface with the [[Programming Reference:TextToSpeech Class|TextToSpeech Class]], resulting in a stimulus that uses a system-wide text-to-speech engine to render a given text. | The <tt>SpeechStimulus</tt> class combines the [[Programming Reference:Stimulus Class|Stimulus Class]] interface with the [[Programming Reference:TextToSpeech Class|TextToSpeech Class]], resulting in a stimulus that uses a system-wide text-to-speech engine to render a given text. | ||
When a <tt>SpeechStimulus</tt> object is deallocated while a text is spoken, speech is not aborted. Rather, it continues to the end of the text. | |||
==Properties== | ==Properties== |
Latest revision as of 12:53, 15 July 2010
Location
src/shared/modules/application/audio
Synopsis
The SpeechStimulus class combines the Stimulus Class interface with the TextToSpeech Class, resulting in a stimulus that uses a system-wide text-to-speech engine to render a given text. When a SpeechStimulus object is deallocated while a text is spoken, speech is not aborted. Rather, it continues to the end of the text.
Properties
string Text (rw)
Text to be rendered by the system-wide text-to-speech engine.
float Volume (rw)
A number between 0 and 1, representing the volume of TTS output.
Methods
Present()
Renders the text contained in the Text property using the system-wide text-to-speech engine.
Conceal()
Does nothing.
See also
Programming Reference:Stimulus Class, Programming Reference:AudioStimulus Class, Programming Reference:TextToSpeech Class.