IFullScreenVideoEx::SetEnabled 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 SetEnabled method enables or disables a specified display mode.

Syntax

HRESULT SetEnabled(
  [in] long Mode,
  [in] long bEnabled
);

Parameters

[in] Mode

Index of the display mode to enable or disable.

[in] bEnabled

Specifies one of the following Boolean values:

Value	Meaning
OATRUE	Enable the specified display mode.
OAFALSE	Disable the specified display mode.

Return value

Value	Description
E_INVALIDARG	Invalid argument.
S_OK	Success.

Remarks

The Full Screen Renderer supports a static set of display modes. By default, every mode is enabled. You can use this method to enable or disable a particular display mode. The video card on the user's system might not support every mode. The Full Screen Renderer will not use a mode that the video card does not support, even if that mode is enabled. To determine whether the card supports a particular mode, call the IFullScreenVideoEx::IsModeAvailable method. If a mode is disabled, the Full Screen Renderer will not use it, even if the card supports it.

Display modes are indexed from zero. The IFullScreenVideoEx::CountModes method returns the number of modes. To retrieve the width, height, and bit depth of a particular display mode, call the IFullScreenVideoEx::GetModeInfo method.

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