IVoiceText::AudioPause

This method pauses text-to-speech output for a voice text site.

Syntax

HRESULT AudioPause(void);

Return Values

NOERROR: The method successfully paused the text-to-speech output.
VTXTERR_INVALIDMODE: The text-to-speech mode is invalid, or the application has not been registered to use the voice text on the site.
VTXTERR_NOTENABLED: Voice text is not enabled.
VTXTERR_OUTOFMEM: There is not enough memory.

Remarks

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 method.

When output has been paused, the IVTxtAttributes::IsSpeaking method 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.