Syntax
MMRESULT TextToSpeechPause
(LPTTS_HANDLE_T phTTS)
Parameters
LPTTS_HANDLE_T phTTS
Specifies a text-to-speech handle.
Return Value
This call returns a value of type MMRESULT. The return value is zero if the call is successful. The return value is one of the following constants:
Constant
Description
MMSYSERR_NOERROR
Normal successful completion (zero).
MMSYSERR_INVALHANDLE
The specified device handle is invalid. The system is not speaking or the text-to-speech handle is invalid.
Comments
This call only affects the audio output and has no effect when writing log files, wave files, or when using the speech-to-memory capability of the text-to-speech system.
If the text-to-speech system owns the audio device (i.e. OWN_AUDIO_DEVICE was specified in the startup function), then it remains paused until one of the following is called:
If the text-to-speech system does not own the audio device (i.e. OWN_AUDIO_DEVICE was NOT specified in the startup function) and TextToSpeechPause is called while the system is speaking, it will remain paused until the system has completed speaking.
In this case, the wave output device is released when TextToSpeechReset is called. It will also be released if TextToSpeechSync, TextToSpeechOpenInMemory, TextToSpeechOpenLogFile, or TextToSpeechOpenWaveOutFile is called AND the system has completed speaking.
Note that the TextToSpeechPause() call will NOT resume audio output if the text-to-speech system has been paused by the TextToSpeechPause() call.
See Also