Note

Please see Azure Cognitive Services for Speech documentation for the latest supported speech solutions.

Microsoft Speech Platform

ISpVoice::WaitUntilDone

ISpVoice::WaitUntilDone blocks the caller until either the voice has completed speaking or the specified time interval has elapsed.

<pre IsFakePre="true" xmlns="http://www.w3.org/1999/xhtml"> <strong>HRESULT WaitUntilDone(</strong> <strong> ULONG</strong> <em>msTimeout</em> <strong>);</strong> </pre>

Parameters

  • msTimeout
    [in] Timeout period in milliseconds. INFINITE may be used to prevent this method from timing out.

Return Values

Value Description
S_OK Function completed successfully.
S_FALSE Wait time interval was exceeded.

Remarks

This call may be used after a single asynchronous Speak (or SpeakStream) call, or after several calls have been queued. In either case it will return only after all pending calls have been completed (or after the specified time interval has elapsed).