Click or drag to resize

VideoGain Property

Index into the Gains array for the selected camera gain.

Namespace:  ASCOM.DriverAccess
Assembly:  ASCOM.DriverAccess (in ASCOM.DriverAccess.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
Syntax
Copy
public short Gain { get; set; }

Property Value

Type: Int16
Short integer index for the current camera gain in the Gains string array.

Return Value

Type: Int16
Index into the Gains array for the selected camera gain

Implements

IVideoGain
Exceptions
ExceptionCondition
InvalidValueExceptionMust throw an exception if not valid.
PropertyNotImplementedExceptionMust throw an exception if gain is not supported.
NotConnectedExceptionIf the device is not connected
DriverExceptionAn error occurred that is not described by one of the more specific ASCOM exceptions. The device did not successfully complete the request.
Remarks
Gain can be used to adjust the gain setting of the camera, if supported. There are two typical usage scenarios:
  • Discrete gain video cameras will return a 0-based array of strings - Gains, which correspond to different discrete gain settings supported by the camera. Gain must be set to an integer in this range. GainMin and GainMax must thrown an exception if this mode is used.
  • Adjustable gain video cameras - GainMin and GainMax return integers, which specify the valid range for Gain.

The driver must default Gain to a valid value.

See Also