IAudioMediaStream::SetFormat method (austream.h)

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

Note  This interface is deprecated. New applications should not use it.

 

Sets the format for the stream.

Syntax

HRESULT SetFormat(
  [in] const WAVEFORMATEX *lpWaveFormat
);

Parameters

[in] lpWaveFormat

Pointer to a WAVEFORMATEX structure that contains stream format information.

Return value

Returns an HRESULT value, which can include the following values or others not listed.

Return code	Description
MS_E_INCOMPATIBLE	Format of the IAudioData object is not compatible with stream.
E_INVALIDARG	Invalid argument.
E_POINTER	NULL pointer argument.
S_OK	Success.

Requirements

Requirement	Value
Target Platform	Windows
Header	austream.h

See also

IAudioMediaStream Interface