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

Syntax

HRESULT GetRenderingPrefs(
  [out] DWORD *pdwRenderFlags
);

Parameters

[out] pdwRenderFlags

Receives a member of the VMRRenderPrefs enumeration, indicating the current rendering preferences.

Return value

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

Return code	Description
E_POINTER	pdwRenderingPrefs is invalid
VFW_E_WRONG_STATE	No allocator-presenter object is currently loaded.

Remarks

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

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