SaturationControl
Top  Previous  Next

Description

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

-1 - Off  
   The saturation control is disabled  
0 - Manual  
The saturation level is controlled by the value of the Saturation property  
1 - Auto  
The camera controls the saturation level by itself continuously  
2 - One push  
The camera sets the optimal saturation level by itself and returns to the manual mode  


Syntax


[VB]
objActiveDcam.SaturationControl [= Value]


[C/C++]
HRESULT get_SaturationControl( short *pSaturationControl );
HRESULT put_SaturationControl( short SaturationControl );



Data Type
[VB]

Integer

Parameters
[C/C++]

pSaturationControl [out, retval]  
Pointer to the current saturation control mode  
SaturationControl [in]  
The saturation control mode to be set  

Return Values


S_OK  
Success  
E_FAIL  
The saturation 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 saturation control.

Private Sub
 Check1_Click()
If
 Check1.Value = 1 
Then

ActiveDcam1.SaturationControl = 1
Else

ActiveDcam1.SaturationControl = 0
End If

End Sub

 

Remarks


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