IFullScreenVideoEx::IsModeAvailable 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 IsModeAvailable method queries whether a specified display mode is available.

Syntax

HRESULT IsModeAvailable(
  [in] long Mode
);

Parameters

[in] Mode

Index of the display mode.

Return value

Returns an HRESULT value. Possible values include the following.

Return code	Description
E_INVALIDARG	Index out of range.
S_FALSE	The display mode is not available.
S_OK	The display mode is available.

Remarks

The Full Screen Renderer supports a static set of display modes. However, the video card on the user's system might not support every mode. If a particular display mode is not supported by the video card, this method returns S_FALSE. Even if a particular mode is available, it will not necessarily be used for video playback. The mode must also be compatible with the filters in the filter graph.

You can disable a display mode by calling the IFullScreenVideoEx::SetEnabled method. The Full Screen Renderer will not use a disabled mode, even if the video card supports it.

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

Partager via