Share via

ISpVoice::Pause (SAPI 5.4)

  • Article

Microsoft Speech API 5.4

ISpVoice::Pause

ISpVoice::Pause pauses the voice at the nearest alert boundary and closes the output device, allowing access to pending speak requests from other voices.

  
    HRESULT  Pause  ( void );

Parameters

None.

Return values

Value
S_OK
FAILED(hr)

Remarks:

Calling ISpVoice::Pause while the voice is not speaking increments the pause count and will put the voice into a paused state until ISpVoice::Resume is called the same number of times.

The voice maintains a pause count, so each call to pause must be balanced with a corresponding call to ISpVoice::Resume.

The default alert boundary is at the beginning of each word. See ISpVoice::SetAlertBoundary for details.