ICameraControl::getRange_IrisRelative 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_IrisRelative method returns the range of relative aperture settings supported by the camera. The relative aperture is expressed as a number of steps, where the size of each step depends on the camera model.

Syntax

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

Parameters

[out] pMin

Receives the minimum relative aperture setting.

[out] pMax

Receives the maximum relative aperture setting.

[out] pSteppingDelta

Receives the smallest step between settings.

[out] pDefault

Receives the default relative aperture setting.

[out] pCapsFlag

Receives one or more flags. See CameraControlFlags.

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 [desktop apps only]
Target Platform Windows
Header vidcap.h
Library Strmiids.lib

See also

Error and Success Codes

ICameraControl Interface