Index into the Gains array for the selected camera gain.

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 6.0.0.0 (6.1.1.2619)

Syntax

C#
short Gain { get; set; }
Visual Basic
Property Gain As Short
	Get
	Set
Visual C++
property short Gain {
	short get ();
	void set (short value);
}

Field Value

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

Return Value

Index into the Gains array for the selected camera gain

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.

Exceptions

ExceptionCondition
ASCOM..::..NotConnectedExceptionMust throw an exception if the information is not available. (Some drivers may require an active connection in order to retrieve necessary information from the camera.)
ASCOM..::..InvalidValueExceptionMust throw an exception if not valid.
ASCOM..::..PropertyNotImplementedExceptionMust throw an exception if gain is not supported.

See Also