ISpSREngineSite::DataAvailable
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method gets the amount of data that can be read by the ISpSREngineSite::Read method without blocking. The DataAvailable method can only be called while the SR engine is inside an ISpSREngine::RecognizeStream call, although it can be called on any thread.
Syntax
HRESULT DataAvailable(
ULONG* pcb
);
Parameters
- pcb
[out] Pointer to the amount, in bytes, of data available. For real-time audio streams, this is the actual amount of data currently available. For non-real-time streams, this method always retrieves the value INFINITE. See Remarks section.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
E_POINTER |
pcb is a bad write pointer. |
SPERR_STREAM_NOT_ACTIVE |
Method called when engine is not inside RecognizeStream call. |
FAILED(hr) |
Appropriate error message. |
Remarks
Engines can determine if a stream is a real-time stream from the fRealTimeAudio parameter on the ISpSREngine::RecognizeStream method.
Requirements
| Header | sapiddk.h, sapiddk.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |