ICameraControl::get_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 get_IrisRelative method returns the camera's relative aperture setting. The relative aperture is expressed as a number of steps, where the size of each step depends on the camera model.
Syntax
HRESULT get_IrisRelative(
[out] long *pValue,
[out] long *pFlags
);
Parameters
[out] pValue
Receives the relative aperture setting. To get the range of possible values, call ICameraControl::getRange_IrisRelative.
| Value | Description |
|---|---|
| 0 | Default aperture setting. |
| Positive value | Open by one step. |
| Negative value | Close by one step. |
[out] pFlags
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 |