Click or drag to resize

IVideoGainMax Property

Maximum value of Gain.

Namespace:  ASCOM.DeviceInterface
Assembly:  ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
Syntax
short GainMax { get; }

Property Value

Type: Int16
Short integer representing the maximum gain value supported by the camera.

Return Value

Type: Int16
The maximum gain value that this camera supports
Exceptions
ExceptionCondition
PropertyNotImplementedExceptionMust throw an exception if GainMax is not supported.
NotConnectedExceptionIf the device is not connected
DriverExceptionAn 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.
Remarks
When specifying the gain setting with an integer value, GainMax is used in conjunction with GainMin to specify the range of valid settings.

GainMax shall be greater than GainMin. If either is available, then both must be available.

Please see Gain for more information.

It is recommended that this function be called only after a connection is established with the camera hardware, to ensure that the driver is aware of the capabilities of the specific camera model.

See Also