BalanceWhiteAuto
Top  Previous  Next

Description

Returns or sets the automatic white balance control (AWB) mode. Can be one of the following values:

"Off"  
White balance is manually controlled using BalanceRatioSelector and BalanceRatio  
"Once"  
The camera sets the optimal balance ratios for each color channel and returns to the "Off" state  
"Continuous"  
The camera constantly performs white balancing  


Syntax


[VB]
objActiveUSB.GainAuto [= Value]


[C/C++]
HRESULT get_GainAuto( string *pValue );
HRESULT put_GainAuto( string Value );



Data Type
[VB]

String

Parameters
[C/C++]

pValue [out, retval]  
Pointer to the string specifying the white balance mode  
Value [in]  
The white balance mode to be set  

Return Values


S_OK  
Success  
E_NOINTERFACE  
The feature is not available for the selected camera  
E_INVALIDARG  
The value is not part of the enumerated set  
E_FAIL  
Failure to set the feature value  
 

Example


The following VB example demonstrates the use of a button to perform a "one push" white balancing.

Private Sub
 Command1_Click()
ActiveUSB1.BalanceWhiteAuto = "Once"
End Sub

 

Remarks


Depending on a camera model, other device-specific values may be available for this feature. The list of valid values can be retrieved using GetEnumList.

Note that the property is available only if the currently selected camera supports the BalanceWhiteAuto feature per GenICam standard.