IVMRFilterConfig9::SetRenderingMode method (vmr9.h)

Article
4/26/2023

[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 VMR9Mode value.

Return value

The method returns an HRESULT. Possible values include those in the following table.

Return code	Description
S_OK	The method succeeded.
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 windowed mode (VMR9Mode_Windowed) by default. Use this method to put the VMR into windowless mode (VMR9Mode_Windowless) or renderless mode (VMR9Mode_Renderless).

The mode cannot be changed after any pin has been connected. Also, the mode cannot be changed from windowless or renderless mode back to windowed mode, even before pins are connected. Therefore, specifying VMR9Mode_Windowed for the Mode parameter has no effect under any circumstances.

Requirements

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

Share via