Share via

Microsoft Speech SDK Version 5.1

  • Article

CSpStreamFormat::Constructor

The following methods may be used to construct the instance.

Initializes the class members to null values

  
    CSpStreamFormat( void );

Parameters

None.

Formats the instance into a wave format structure. The new format and format ID are passed back from the class' public members, m_pCoMemWaveFormatEx and m_guidFormatId respectively.

  
    CSpStreamFormat(
   SPSTREAMFORMAT   eFormat,
   HRESULT         *phr
);

Parameters

  • eFormat
    [in] The requested stream format. Must be a valid SPSTREAMFORMAT value of SPSF_8kHz8BitMono or greater.
  • phr
    The return value for the method.

Return values

Value Description
S_OK Function completed successfully.
E_OUTOFMEMORY Exceeded available memory.
E_INVALIDARG Either class member m_guidFormatId or m_pCoMemWaveFormatEx is invalid or bad. Alternatively, the current format is not recognized.
FAILED(hr) Appropriate error message.

Formats the instance according to the format structure specified.

  
    CSpStreamFormat(
   const WAVEFORMATEX *pWaveFormatEx,
   HRESULT            *phr
);

Parameters

  • pWaveFormatEx
    [in] Address of the WAVEFORMATEX structure containing the wave file format information.
  • phr
    The return value for the method.

Return values

Value Description
S_OK Function completed successfully.
E_OUTOFMEMORY Exceeded available memory.