![]() |
Multimedia API ReferenceNovember 16, 2016 | 24.2.1 Release |
An interface to settings that control the sensor module.
Definition at line 60 of file Settings.h.
Public Member Functions | |
virtual Status | setExposureTimeRange (const Range< uint64_t > &exposureTimeRange)=0 |
Sets the exposure time range of the source, in nanoseconds. More... | |
virtual Range< uint64_t > | getExposureTimeRange () const =0 |
Returns the exposure time range of the source, in nanoseconds. More... | |
virtual Status | setFocusPosition (int32_t position)=0 |
Sets the focus position, in focuser units. More... | |
virtual int32_t | getFocusPosition () const =0 |
Returns the focus position, in focuser units. More... | |
virtual Status | setFrameDurationRange (const Range< uint64_t > &frameDurationRange)=0 |
Sets the frame duration range, in nanoseconds. More... | |
virtual Range< uint64_t > | getFrameDurationRange () const =0 |
Returns the frame duration range, in nanoseconds. More... | |
virtual Status | setGainRange (const Range< float > &gainRange)=0 |
Sets the gain range for the sensor. More... | |
virtual Range< float > | getGainRange () const =0 |
Returns the gain range. More... | |
virtual Status | setSensorMode (SensorMode *mode)=0 |
Sets the sensor mode. More... | |
virtual SensorMode * | getSensorMode () const =0 |
Returns the sensor mode. More... | |
Static Public Member Functions | |
static const InterfaceID & | id () |
Protected Member Functions | |
~ISourceSettings () | |
|
inlineprotected |
Definition at line 146 of file Settings.h.
|
pure virtual |
Returns the exposure time range of the source, in nanoseconds.
|
pure virtual |
Returns the focus position, in focuser units.
|
pure virtual |
Returns the frame duration range, in nanoseconds.
|
pure virtual |
Returns the gain range.
|
pure virtual |
Returns the sensor mode.
|
inlinestatic |
Definition at line 63 of file Settings.h.
|
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.
[in] | exposureTimeRange | Exposure time range, in nanoseconds. |
|
pure virtual |
Sets the focus position, in focuser units.
If the position is set outside of the focuser limits, the position will be clamped.
[in] | position | The new focus position, in focuser units. |
|
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.
[in] | frameDurationRange | Frame duration range, in nanoseconds |
|
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.
[in] | gainRange | scalar gain range |
|
pure virtual |
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.
[in] | mode | Desired sensor mode for the capture. |