SpeechSpeak

(Obsolete)

Note: SpeechSpeak is obsolete. This documentation is maintained for backward compatibility only.

Returns: Nothing

Usage: Script

Description: This statement executes in its own thread to speak the supplied text through a specified SAPI text-to-speech stream.

Format: SpeechSpeak(SpeechHandle, Text, ErrorCode)

Parameters: SpeechHandle is the SAPI text-to-speech handle to use; this is the return value from a SpeechStream call.

Text is any text expression that will be spoken using the mode selected by a SpeechSelect call on the specified stream.

ErrorCode is any variable that will be set to a valid value upon completion of the statement. The value of ErrorCode will be zero if no errors occurred or will be set to the low-order 16-bits of the standard Win32 error code or a SAPI text-to-speech specific error code.

Comments: This function executes in the thread created by the SpeechStream call, so it will not block other statements from executing. This does mean, however, that the timing for Result becoming valid is unpredictable and should therefore be checked for validity prior to being used.

Multiple SpeechSpeak statements can be issued on a SAPI text-to-speech stream without blocking. The text will be queued up and will be spoken in the order it is submitted. The text speech queue will be terminated immediately if the SAPI text-to-speech stream is closed.

The text string spoken can, optionally, contain embedded "control tags" which affect the way that the text is spoken (e.g. \Emp\ emphasizes the word following it and \Mrk=32\ sets the SAPI text-to-speech stream current bookmark number to 32). For a complete list of embedded control tags, refer to your text-to-speech engine documentation.

You will require a text-to-speech engine and voices to be able to execute speech related statements.

Example:

sHandle = SpeechStream();

If Valid(sHandle) && ZButton(10, 40, 110, 10, "Talk", 1);

[

SpeechSpeak(sHandle, "Mary had a \Emp\little lamb", eCode);

]

This will speak the supplied text with emphasis on the word "little".