IAudioData::SetFormat method (austream.h)

  • Article

[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.
 
The SetFormat method sets the current data format.

Syntax

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

Parameters

[in] lpWaveFormat

Pointer to a WAVEFORMATEX structure that will contain the current data format.

Return value

Returns an HRESULT value, which can include the following values.

Return code Description
E_POINTER
 Invalid pointer argument.
E_INVALIDARG
 Invalid format.
S_OK
 Success.

Requirements

   
Target Platform Windows
Header austream.h

See also

IAudioData Interface

IAudioData::GetFormat