Share via

ISpStreamFormatConverter::SetFormat (Windows Embedded CE 6.0)

  • Article

1/6/2010

This method sets the output format of the format converter. The ISpStreamFormat::GetFormat method gets the format of the output (converted) stream.

Syntax

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] Pointer to a WAVEFORMATEX structure containing the wave file format information for the converted stream. Must be NULL with GUID_NULL. Must be a valid WAVEFORMATEX with SPDFID_WaveFormatEx.

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.

Return Value

The following table shows the possible return values.

Value Description

S_OK

Function completed successfully.

E_INVALIDARG

E_INVALIDARG One of the following was encountered:

  • rguidFormatIdOfConvertedStream is neither GUID_NULL or SPDFID_WaveFormatEx.
  • pWaveFormatExOfConvertedStream is not valid for the supplied REFGUID.

Requirements

Header sapi.h, sapi.idl
Library sapilib.lib
Windows Embedded CE Windows CE .NET 4.1 and later

See Also

Reference

ISpStreamFormatConverter
SAPI Interfaces