IVoiceText::AudioPause

HRESULT AudioPause(void);

Pauses text-to-speech output for a voice-text site.

· Returns NOERROR if successful, or one of these error values:

VTXTERR_INVALIDMODE
VTXTERR_NOTENABLED
VTXTERR_OUTOFMEM

AudioPause affects all applications using the site, so the application should resume audio as soon as possible.

When a voice-text object is first created, text-to-speech output is not paused. Because pausing text-to-speech output affects all applications that use voice text on the site, an application should resume text-to-speech output as soon as possible by calling the IVoiceText::AudioResume member function.

When output has been paused, the IVTxtAttributes::IsSpeaking member function returns FALSE, even though the voice-text object still has data available in its queue and has not yet sent a IVTxtNotifySink::SpeakingDone notification.

No notifications are sent when audio is paused or resumed.