IVideoV2Gain Property

Index into the Gains array for the selected camera gain.

Definition

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 7.1.3+4851.c5da65c2b

C#

short Gain { get; set; }

VB

Property Gain As Short
	Get
	Set

C++

property short Gain {
	short get ();
	void set (short value);
}

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

Int16
Index into the Gains array for the selected camera gain

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.

InvalidValueException	Must throw an exception if not valid.
PropertyNotImplementedException	Must throw an exception if gain is not supported.
NotConnectedException	If the device is not connected
DriverException	An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself.

Date	Version	Description
IVideo	Platform 6.1	Member added.