Click or drag to resize

ICameraV3ReadoutModes Property

List of available readout modes, Interface Version 2 only

Namespace:  ASCOM.DeviceInterface
Assembly:  ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
Syntax
Copy
ArrayList ReadoutModes { get; }

Return Value

Type: ArrayList
An ArrayList of readout mode names
Exceptions
ExceptionCondition
PropertyNotImplementedExceptionMust throw an exception if CanFastReadout is .
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

Must be implemented if CanFastReadout is false, must throw a PropertyNotImplementedException if CanFastReadout is true.

This property provides an array of strings, each of which describes an available readout mode of the camera. At least one string must be present in the list. The user interface of a control application will typically present to the user a drop-list of modes. The choice of available modes made available is entirely at the discretion of the driver author. Please note that if the camera has many different modes of operation, then the most commonly adjusted settings should be in ReadoutModes; additional settings may be provided using SetupDialog.

To select a mode, the application will set ReadoutMode to the index of the desired mode. The index is zero-based.

This property should only be read while a connection to the camera is actually established. Drivers often support multiple cameras with different capabilities, which are not known until the connection is made. If the available readout modes are not known because no connection has been established, this property shall throw an exception.

Please note that the default ReadoutMode setting is 0. It is strongly recommended, but not required, that driver authors use the 0-index mode for standard imaging operations, since it is the default.

This feature may be used in parallel with FastReadout; however, care should be taken to ensure that the two features work together consistently. If there are modes that are inconsistent having a separate fast/normal switch, then it may be better to simply list Fast as one of the ReadoutModes.

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.

This is only available for the Camera Interface Version 2 and later.

See Also