IVMRFilterConfig9::SetRenderingPrefs method (vmr9.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.]

The SetRenderingPrefs method sets various application preferences related to video rendering.

Syntax

HRESULT SetRenderingPrefs(
  [in] DWORD dwRenderFlags
);

Parameters

[in] dwRenderFlags

Double word containing a bitwise OR of VMR9RenderPrefs values specifying the rendering preferences.

Return value

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

Return code Description
S_OK
The method succeeded.
VFW_E_WRONG_STATE
No allocator-presenter is present.
E_INVALIDARG
dwRenderFlags is invalid.

Remarks

This method calls through to the allocator-presenter's IVMRImagePresenterConfig9::SetRenderingPrefs method. (The default allocator-presenter exposes IVMRImagePresenterConfig9. Custom allocator-presenters can also expose this interface if desired.) If the VMR-9 has not yet created the default allocator-presenter, or if the application provided a custom allocator-presenter which does not support IVMRImagePresenterConfig9, this method returns VFW_E_WRONG_STATE. To create the default allocator-presenter, call IVMRFilterConfig9::SetRenderingMode with the value VMR9Mode_Windowed or VMR9Mode_Windowed.

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

See also

IVMRFilterConfig9 Interface

Using the Video Mixing Renderer