IVMRFilterConfig9::GetRenderingPrefs 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 GetRenderingPrefs method retrieves the current set of rendering preferences being used by the VMR-9.

Syntax

HRESULT GetRenderingPrefs(
  [out] DWORD *pdwRenderFlags
);

Parameters

[out] pdwRenderFlags

Receives a VMR9RenderPrefs value indicating the current 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
The VMR has not created an allocator-presenter, or the allocator-presenter does not implement the IVMRImagePresenterConfig9 interface.

Remarks

If the allocator-presenter implements the IVMRImagePresenterConfig9 interface, this method calls the IVMRImagePresenterConfig9::GetRenderingPrefs method on the allocator-presenter.

The default allocator-presenter implements IVMRImagePresenterConfig9. Custom allocator-presenters can also implements this interface if desired.

If the VMR-9 has not yet created the allocator-presenter, or if a custom allocator-presenter 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_Windowless.

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