IVMRFilterConfig::SetRenderingMode method (strmif.h)

Article
02/22/2024

[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.]

The SetRenderingMode method sets the rendering mode used by the VMR.

Syntax

HRESULT SetRenderingMode(
  [in] DWORD Mode
);

Parameters

[in] Mode

Specifies the rendering mode as a VMRMode value.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Return code	Description
E_INVALIDARG	An invalid rendering mode was specified.
VFW_E_WRONG_STATE	The mode cannot be changed for some reason. See Remarks.

Remarks

The VMR is in VMRMode_Windowed by default. Use this method only if you are putting the VMR into VMRMode_Windowless or VMRMode_Renderless mode. You cannot change the mode after any pin has been connected and you cannot change the mode from windowless or renderless back to windowed, even before any pins are connected. Therefore, specifying VMRMode_Windowed for Mode has no effect under any circumstances.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP1 [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib