IMSVidVMR9::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.]
This topic applies to Update Rollup 2 for Microsoft Windows XP Media Center Edition 2005.
The put_SuppressEffects method specifies whether the Video Control configures the system for optimal video playback.
Syntax
HRESULT put_SuppressEffects(
[in] VARIANT_BOOL bSuppress
);
Parameters
[in] bSuppress
Specifies a Boolean value. See Remarks for more information.
Return value
The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.
Return code | Description |
---|---|
|
The method succeeded. |
Remarks
If bSuppress equals VARIANT_TRUE, the Video Control configures several system parameters during video playback:
- Disables the screen saver timeout.
- Disables Microsoft ClearType smoothing.
- Disables the drop shadow effect.
- Disables alpha-blended mouse cursors.
- Prevents the system from turning off the display (power management).
If bSuppress equals VARIANT_FALSE, the Video Control does not modify any of these system settings.
The default value for this property is VARIANT_TRUE. Set this property to VARIANT_FALSE if your application wants to control all of the system settings; for example, if you are providing a custom allocator-presenter (see IMSVidVMR9::SetAllocator).
Requirements
Requirement | Value |
---|---|
Target Platform | Windows |
Header | segment.h (include Msvidctl.h) |