Share via


Note

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

Microsoft Speech Platform

ISpStreamFormat::GetFormat

ISpStreamFormat::GetFormat passes back the cached format of the stream.

The Speech Platform uses this data to determine how to handle the stream data present in the underlying IStream.

<pre IsFakePre="true" xmlns="http://www.w3.org/1999/xhtml"> <strong>HRESULT GetFormat(</strong> <strong> GUID</strong> *<em>pguidFormatId</em>, <strong><a runat="server" href="jj127893(v=msdn.10).md">WAVEFORMATEX</a></strong> **<em>ppCoMemWaveFormatEx</em> <strong>);</strong> </pre>

Parameters

  • pguidFormatId
    Address of a pointer to GUID data object that receives the format of the stream being used. This is typically either SPDFID_Text or SPDFID_WaveFormatEx.
  • ppCoMemWaveFormatEx
    Address of a pointer to a WAVEFORMATEX data structure that receives the WAV file format information. This is only applicable when the return GUID is SPDFID_WaveFormatEx. The implementer of this interface allocates the memory for the WAVEFORMATEX data structure using CoTaskMemAlloc, but it is the caller's responsibility to call CoTaskMemFree on the returned WAVEFORMATEX pointer.

Return Values

Value Description
S_OK Function completed successfully.
E_POINTER Pointer is locating a memory block that is NULL or either too small or is not writable.
SPERR_UNINITIALIZED The object has not been properly initialized.
SPERR_STREAM_CLOSED The stream is closed or unavailable.