WhiteBalanceControl
Top  Previous  Next

Description

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

-1 - Off  
   The white balance control is disabled  
0 - Manual  
The white balance levels is controlled by the values of the WhiteBalanceUB and WhiteBalanceVR properties  
1 - Auto  
The camera controls the white balance levels by itself continuously  
2 - One push  
The camera sets the optimal white balance levels by itself and returns to the manual mode  


Syntax


[VB]
objActiveDcam.WhiteBalanceControl [= Value]


[C/C++]
HRESULT get_WhiteBalanceControl( short *pWhiteBalanceControl );
HRESULT put_WhiteBalanceControl( short WhiteBalanceControl );



Data Type
[VB]

Integer

Parameters
[C/C++]

pWhiteBalanceControl [out, retval]  
Pointer to the current white balance control mode  
WhiteBalanceControl [in]  
The white balance control mode to be set  

Return Values


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

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

ActiveDcam1.WhiteBalanceControl = 1
Else

ActiveDcam1.WhiteBalanceControl = 0
End If

End Sub

 

Remarks


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