IVMRMonitorConfig::GetDefaultMonitor method (strmif.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 GetDefaultMonitor method retrieves the default monitor that all future instances of the VMR will use for video playback.

Syntax

HRESULT GetDefaultMonitor(
  [out] VMRGUID *pGUID
);

Parameters

[out] pGUID

Pointer to a VMRGUID structure that identifies the default monitor on the system.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
E_POINTER
NULL pointer argument.
S_OK
Success.
VFW_E_WRONG_STATE
The allocator-presenter has not been loaded.

Remarks

Use this method on a multi-monitor system to determine which is the default DirectDraw device the VMR will use when connecting to an upstream filter.

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

See also

Error and Success Codes

IVMRMonitorConfig Interface

IVMRMonitorConfig::SetDefaultMonitor

Using the Video Mixing Renderer