IFullScreenVideoEx::SetEnabled

  • Article
 
Microsoft DirectShow 9.0

IFullScreenVideoEx::SetEnabled

The SetEnabled method enables or disables a specified display mode.

Syntax

  HRESULT SetEnabled(
  long Mode,
  long bEnabled
);

Parameters

Mode

[in] Index of the display mode to enable or disable.

bEnabled

[out] Specifies one of the following Boolean values:

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

Return Values

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

Header: Declared in Amvideo.h; include Dshow.h.

Library: Use Strmiids.lib.

See Also