OpticalFilterControl

Description

Returns or sets the optical filter control mode. The values from -1 to 2 correspond to the following modes:

-1 - Off

The optical filter control is disabled

0 - Manual

The optical filter level is controlled by the value of the OpticalFilter property

1 - Auto

The camera controls the optical filter level by itself continuously

2 - One push

The camera sets the optimal optical filter level by itself and returns to the manual mode

Syntax

[VB]
objActiveDcam.OpticalFilterControl [= Value]

[C/C++]
HRESULT get_OpticalFilterControl( short *pOpticalFilterControl );
HRESULT put_OpticalFilterControl( short OpticalFilterControl );


Data Type [VB]

Integer

Parameters [C/C++]

pOpticalFilterControl [out, retval]

Pointer to the current optical filter control mode

OpticalFilterControl [in]

The optical filter control mode to be set

Return Values

S_OK

Success

E_FAIL

The optical filter control is not available for the selected camera

Example

The following VB example demonstrates the use of a checkbox to switch between the manual and automatic optical filter control.

Private Sub Check1_Click()
If Check1.Value = 1 Then
ActiveDcam1.OpticalFilterControl = 1
Else
ActiveDcam1.OpticalFilterControl = 0
End If
End Sub

Remarks

The property is available only if the currently selected camera supports automatic optical filter control.