Export (0) Print
Expand All

ISpStreamFormatConverter::SetFormat (SAPI 5.3)

Speech API 5.3
Microsoft Speech API 5.3

ISpStreamFormatConverter::SetFormat

ISpStreamFormatConverter::SetFormat sets the output format of the converter. 

The ISpStreamFormat::GetFormat method returns the format of the output (converted) stream.

HRESULT SetFormat(
   REFGUID               rguidFormatIdOfConvertedStream,
   const WAVEFORMATEX   *pWaveFormatExOfConvertedStream
);

Parameters

rguidFormatIdOfConvertedStream
[in] Address of the data format identifier associated with the requested output stream. Can be GUID_NULL or SPDFID_WaveFormatEx.
pWaveFormatExOfConvertedStream
[in] Address of the WAVEFORMATEX structure containing the wave file format information of the converted stream. Must be NULL with GUID_NULL. Must be a valid WAVEFORMATEX with SPDFID_WaveFormatEx.

Return values

ValueDescription
S_OKFunction completed successfully.
E_INVALIDARGOne of the following was encountered:

rguidFormatIdOfConvertedStream is neither GUID_NULL or SPDFID_WaveFormatEx;

pWaveFormatExOfConvertedStream is not valid for the supplied REFGUID.

Remarks

The helper class CSpStreamFormat and the SPSTREAMFORMAT enumeration can be used to avoid the possibility of typos or mistakes when filling in the WAVEFORMATEX structure.
Show:
© 2014 Microsoft