IAMWstDecoder::SetOutputFormat method (iwstdec.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.]

Downstream filters use the SetOutputFormat method to define an output video format.

Syntax

HRESULT SetOutputFormat(
  [in] LPBITMAPINFO lpbmi
);

Parameters

[in] lpbmi

A pointer to a BITMAPINFO structure that describes the output video format, such as size, bit depth, and other properties.

Return value

When the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Return code Description
S_FALSE
So far, downstream filters have defined no output format.
S_OK
Downstream filters have already defined an output format.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header iwstdec.h
Library Strmiids.lib

See also

Error and Success Codes

IAMWstDecoder Interface