IMSVidVideoRenderer2::put_SuppressEffects method (segment.h)

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

The put_SuppressEffects method sets preferences for power management and visual effects.

Syntax

HRESULT put_SuppressEffects(
  [in] VARIANT_BOOL bSuppress
);

Parameters

[in] bSuppress

Specifies a Boolean value. See Remarks for more information.

Return value

Returns an HRESULT value. Possible values include the following.

Return code Description
S_OK
Success.

Remarks

If bSuppress equals VARIANT_TRUE, the Video Control does the following:

  • Disables font smoothing and the system-wide drop shadow effect. (Only when the Video Control is using hardware overlay.) This is useful if the application draws onto the overlay.
  • Disables the screen saver, and turns off power management for the display. This is useful to prevent the operating system from interrupting playback while the user is watching a program.
The Video Control restores the original system settings after it stops.

If bSuppress equals VARIANT_FALSE, the Video Control uses the existing system settings.

Requirements

Requirement Value
Minimum supported client Windows�XP with SP1 [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header segment.h (include Msvidctl.h)

See also

IMSVidVideoRenderer2 Interface

IMSVidVideoRenderer::put_UsingOverlay