IVideoProcAmp::put_BacklightCompensation method (vidcap.h)

[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 put_BacklightCompensation method sets the camera's backlight compensation.

Syntax

HRESULT put_BacklightCompensation(
  [in] long Value,
  [in] long Flags
);

Parameters

[in] Value

Specifies the backlight compensation setting. If the value is zero, backlight compensation is disabled. Otherwise, backlight compensation is enabled. The camera may support a Boolean setting (0/1) or a range of settings. If it supports a range of settings, higher numbers indicate a greater degree of backlight compensation.

[in] Flags

Zero or more flags. See VideoProcAmpFlags. If the VideoProcAmp_Flags_Auto flag is used, the Value parameter is ignored and the camera sets the default value.

Return value

Returns an HRESULT value.

Requirements

Requirement Value
Minimum supported client Windows XP with SP2 [desktop apps only]
Minimum supported server Windows Server 2003 R2 [desktop apps only]
Target Platform Windows
Header vidcap.h

See also

Error and Success Codes

IVideoProcAmp Interface