ICameraControl::put_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 put_IrisRelative method sets 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 put_IrisRelative(
[in] long Value,
[in] long Flags
);
Parameters
[in] Value
Specifies the relative aperture setting. To get the range of possible values, call ICameraControl::getRange_IrisRelative.
| Value | Description |
|---|---|
| 0 | Set the default aperture setting, which is implementation dependent. |
| Positive value | Open the iris one step. |
| Negative value | Close the iris one step. |
[in] Flags
Zero or more flags. See CameraControlFlags. If the CameraControl_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 [desktop apps only] |
| Target Platform | Windows |
| Header | vidcap.h |
| Library | Strmiids.lib |