IVideoProcAmp::put_WhiteBalanceComponent 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_WhiteBalanceComponent method sets the camera's white balance, specified as red and blue component values.

Syntax

HRESULT put_WhiteBalanceComponent(
  [in] long Value1,
  [in] long Value2,
  [in] long Flags
);

Parameters

[in] Value1

Specifies the red component.

[in] Value2

Specifies the blue component.

[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