IFullScreenVideoEx::GetModeInfo method (amvideo.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 GetModeInfo method retrieves information about a specified display mode supported by the Full Screen Renderer filter.

Syntax

HRESULT GetModeInfo(
  [in]  long Mode,
  [out] long *pWidth,
  [out] long *pHeight,
  [out] long *pDepth
);

Parameters

[in] Mode

Index of the display mode.

[out] pWidth

Pointer to a variable that receives the width of the display mode, in pixels.

[out] pHeight

Pointer to a variable that receives the height of the display mode, in pixels.

[out] pDepth

Pointer to a variable that receives the bit depth of the display mode.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
E_INVALIDARG	Index out of range.
E_POINTER	NULL pointer argument.
S_FALSE	The specified display mode is not available and is disabled.
S_OK	Success.

Remarks

Display modes are indexed from zero. The IFullScreenVideoEx::CountModes method returns the number of modes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	amvideo.h (include Dshow.h)
Library	Strmiids.lib

Share via