GainAuto
Top  Previous  Next

Description

Returns or sets the automatic gain control (AGC) mode. Can be one of the following values:

"Off"  
Gain is manually controlled using GainRaw or GainAbs  
"Once"  
The camera sets the optimal gain level and returns to the "Off" state  
"Continuous"  
The camera constantly adjusts the gain level  


Syntax


[VB]
objActiveGeni.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 gain control mode  
Value [in]  
The gain control 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 check box to switch between the manual and automatic gain control.

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

ActiveGeni1.GainAuto = "On"
Else

ActiveGeni1.GainAuto = "Off"
End If

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 GainAuto feature per GenICam standard.