Share via

Microsoft Speech SDK Version 5.1

  • Article

ISpAudio::EventHandle

ISpAudio::EventHandle returns a Win32 event handle that applications can use to wait for status changes in the I/O stream.

  
    HANDLE  EventHandle( void );

Parameters

None

Return values

Value Description
HANDLE Returns valid event handle.

Remarks

The handle may use one of the various Win32 wait functions, such as WaitForSingleObject or WaitForMultipleObjects.

For read streams, set the event when there is data available to read and reset it whenever there is no available data. For write streams, set the event when all of the data has been written to the device, and reset it at any time when there is still data available to be played.

The caller should not close the returned handle, nor should the caller ever use the event handle after calling Release() on the audio object. The audio device will close the handle on the final release of the object.