This class is exposed by the InterfaceProvider returned by IRequest::getSourceSettings().
An interface to settings that control the sensor module.
Definition at line 61 of file Settings.h.
| Argus::ISourceSettings::~ISourceSettings |
( |
| ) |
|
|
inlineprotected |
| virtual Range<uint64_t> Argus::ISourceSettings::getExposureTimeRange |
( |
| ) |
const |
|
pure virtual |
Returns the exposure time range of the source, in nanoseconds.
| virtual int32_t Argus::ISourceSettings::getFocusPosition |
( |
| ) |
const |
|
pure virtual |
Returns the focus position, in focuser units.
| virtual Range<uint64_t> Argus::ISourceSettings::getFrameDurationRange |
( |
| ) |
const |
|
pure virtual |
Returns the frame duration range, in nanoseconds.
| virtual Range<float> Argus::ISourceSettings::getGainRange |
( |
| ) |
const |
|
pure virtual |
| virtual SensorMode* Argus::ISourceSettings::getSensorMode |
( |
| ) |
const |
|
pure virtual |
| static const InterfaceID& Argus::ISourceSettings::id |
( |
| ) |
|
|
inlinestatic |
| virtual Status Argus::ISourceSettings::setExposureTimeRange |
( |
const Range< uint64_t > & |
exposureTimeRange | ) |
|
|
pure virtual |
Sets the exposure time range of the source, in nanoseconds.
If the exposure range is outside of the available range, the capture's exposure time will be as close as possible to the exposure range specified.
- Parameters
-
| [in] | exposureTimeRange | Exposure time range, in nanoseconds. |
- See also
- ISensorMode::getExposureTimeRange()
- Returns
- success/status of the call.
| virtual Status Argus::ISourceSettings::setFocusPosition |
( |
int32_t |
position | ) |
|
|
pure virtual |
Sets the focus position, in focuser units.
If the position is set outside of the focuser limits, the position will be clamped.
- Parameters
-
| [in] | position | The new focus position, in focuser units. |
- See also
- ICameraProperties::getFocusPositionRange()
- Returns
- success/status of the call.
| virtual Status Argus::ISourceSettings::setFrameDurationRange |
( |
const Range< uint64_t > & |
frameDurationRange | ) |
|
|
pure virtual |
Sets the frame duration range, in nanoseconds.
If frame range is out of bounds of the current sensor mode, the capture's frame duration will be as close as possible to the range specified.
- Parameters
-
| [in] | frameDurationRange | Frame duration range, in nanoseconds |
- See also
- ISensorMode::getFrameDurationRange()
- Returns
- success/status of the call.
| virtual Status Argus::ISourceSettings::setGainRange |
( |
const Range< float > & |
gainRange | ) |
|
|
pure virtual |
Sets the gain range for the sensor.
The range has to be within the max and min reported in the CameraProperties Otherwise the range will be clipped.
- Parameters
-
| [in] | gainRange | scalar gain range |
- See also
- ISensorMode::getAnalogGainRange()
- Returns
- success/status of the call.
Sets the sensor mode.
Note that changing sensor mode from one capture to the next may result in multiple sensor frames being dropped between the two captures.
- Parameters
-
| [in] | mode | Desired sensor mode for the capture. |
- See also
- ICameraProperties::getAllSensorModes()
- Returns
- success/status of the call.
The documentation for this class was generated from the following file:
