ISpVoice::SetSyncSpeakTimeout (Windows Embedded CE 6.0)
1/6/2010
This method sets the timeout interval in milliseconds after which synchronous Speak and SpeakStream calls to this voice will timeout.
Syntax
HRESULT SetSyncSpeakTimeout(
ULONG msTimeout
);
Parameters
- msTimeout
[in] Value specifying the timeout interval, in milliseconds. The default is 10 seconds. "INFINITE" can also be used to prevent timeouts.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
Remarks
Timeouts occur when waiting for access to the output object. This means that for a normal priority voice (see ISpVoice::SetPriority for more information on priorities) and an output device which implements ISpAudio, a timeout can occur while waiting to reacquire the output object after an interruption by an alert priority voice. For voices of both normal and alert priorities, a timeout can also occur while waiting to reacquire the output object after the voice has been paused and resumed (see ISpVoice::Pause and ISpVoice::Resume).
Wait times are not accumulated - that is, if a voice waits for n milliseconds to initially acquire the output object, and is then paused and resumed, it will again wait for up to msTimeout milliseconds to reacquire the output object, not msTimeout - n milliseconds.
Requirements
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |