IVideoGain Property |
Index into the Gains array for the selected camera gain.
Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
SyntaxProperty Value
Type: Int16Short integer index for the current camera gain in the Gains string array.
Return Value
Type: Int16Index into the Gains array for the selected camera gain
Exceptions| Exception | Condition |
|---|---|
| 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. |
RemarksGain 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