IVideoProcAmp::getRange_WhiteBalance 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 getRange_WhiteBalance method returns the range of white balance settings supported by the camera, expressed as color temperature.

Syntax

HRESULT getRange_WhiteBalance(
  [out] long *pMin,
  [out] long *pMax,
  [out] long *pSteppingDelta,
  [out] long *pDefault,
  [out] long *pCapsFlag
);

Parameters

[out] pMin

Receives the minimum white balance, in degrees Kelvin.

[out] pMax

Receives the maximum white balance, in degrees Kelvin.

[out] pSteppingDelta

Receives the smallest step between settings.

[out] pDefault

Receives the default white balance.

[out] pCapsFlag

Receives one or more flags. See VideoProcAmpFlags.

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