Programming Reference:TextToSpeech Class - Revision history

Mellinger at 12:50, 15 July 2010

2010-07-15T12:50:45Z

← Older revision		Revision as of 12:50, 15 July 2010
Line 15:		Line 15:
	===float Volume (rw)===		===float Volume (rw)===
	Playback volume in the range 0.0 to 1.0.		Playback volume in the range 0.0 to 1.0.

			===bool IsSpeaking (r)===
			True when text is currently spoken, false otherwise.

	==Methods==		==Methods==

Mellinger: /* Synopsis */

2008-06-19T13:08:17Z

Synopsis

← Older revision		Revision as of 13:08, 19 June 2008
Line 1:		Line 1:
			==Location==
			<tt>BCI2000/src/shared/modules/application/audio</tt>

	==Synopsis==		==Synopsis==
	The <tt>TextToSpeech</tt> class is a wrapper for synthetic speech audio output.		The <tt>TextToSpeech</tt> class is a wrapper for synthetic speech audio output.

Mellinger: /* string Text (rw) */

2008-06-16T10:34:39Z

string Text (rw)

← Older revision		Revision as of 10:34, 16 June 2008
Line 7:		Line 7:
	===string Text (rw)===		===string Text (rw)===
	The text to be spoken. This text is provided to the underlying text-to-speech engine unchanged, and may contain control characters as defined by that engine.		The text to be spoken. This text is provided to the underlying text-to-speech engine unchanged, and may contain control characters as defined by that engine.
	(For speech markup defined by the Microsoft TTS Engine, see [http://msdn.microsoft.com/en-us/library/ms723638(VS.85).aspx].)
			For speech markup defined by the Microsoft TTS Engine, see http://msdn.microsoft.com/en-us/library/ms723638(VS.85).aspx.

	===float Volume (rw)===		===float Volume (rw)===
	Playback volume in the range 0.0 to 1.0.		Playback volume in the range 0.0 to 1.0.

Mellinger at 10:34, 16 June 2008

2008-06-16T10:34:06Z

New page

==Synopsis==
The <tt>TextToSpeech</tt> class is a wrapper for synthetic speech audio output.
<tt>TextToSpeech</tt> objects may be stored in STL containers.

==Properties==
For each property, there is a getter method carrying the plain property name. Writable properties have an additional setter method prefixed with "Set".
===string Text (rw)===
The text to be spoken. This text is provided to the underlying text-to-speech engine unchanged, and may contain control characters as defined by that engine.
(For speech markup defined by the Microsoft TTS Engine, see [http://msdn.microsoft.com/en-us/library/ms723638(VS.85).aspx].)
===float Volume (rw)===
Playback volume in the range 0.0 to 1.0.

==Methods==
===Default Constructor, Destructor===
These provide the full set of methods required to use <tt>TextToSpeech</tt> as a data type in STL containers, such as <tt>std::vector<TextToSpeech></tt>.
===Speak()===
Starts speaking.
===Stop()===
Stops speaking, and resets the speaking position to the beginning. This method does nothing when no speaking is performed.

==See also==
[[Programming Reference:WavePlayer Class]], [[Programming Reference:MidiPlayer Class]]

[[Category:Framework API]][[Category:Development]]