Exposure time

Functions
peak_access_status	peak_ExposureTime_GetAccessStatus (peak_camera_handle hCam)
	Query the exposure time access status. More...
peak_status	peak_ExposureTime_GetRange (peak_camera_handle hCam, double *minExposureTime_us, double *maxExposureTime_us, double *incExposureTime_us)
	Get the current range of valid exposure time values. More...
peak_status	peak_ExposureTime_Set (peak_camera_handle hCam, double exposureTime_us)
	Set the exposure time. More...
peak_status	peak_ExposureTime_Get (peak_camera_handle hCam, double *exposureTime_us)
	Get the exposure time. More...

Detailed Description

Exposure time related functions and types.

Function Documentation

peak_ExposureTime_Get()

peak_status peak_ExposureTime_Get	(	peak_camera_handle	hCam,
		double *	exposureTime_us
	)

Get the exposure time.

Reads the current exposure time.

Parameters

[in]	hCam	The camera handle.
[out]	exposureTime_us	The exposure time in microseconds.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The exposure time control is not available for read access. Check the access status via peak_ExposureTime_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER exposureTime_us is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

peak_ExposureTime_GetAccessStatus()

peak_access_status peak_ExposureTime_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the exposure time access status.

Provides the current access status for the exposure time control.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The exposure time control is readable and writeable.

PEAK_ACCESS_READONLY The exposure time control is readable only.

PEAK_ACCESS_GFA_LOCK The exposure time control is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The exposure time control is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The exposure time control is not supported.

PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

If the function indicates an error by returning PEAK_ACCESS_INVALID, these are the possible errors:

• PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.
• PEAK_STATUS_NOT_INITIALIZED The library is not initialized.
• PEAK_STATUS_ERROR An unexpected internal error occurred.

peak_ExposureTime_GetRange()

peak_status peak_ExposureTime_GetRange	(	peak_camera_handle	hCam,
		double *	minExposureTime_us,
		double *	maxExposureTime_us,
		double *	incExposureTime_us
	)

Get the current range of valid exposure time values.

Queries the current range of valid values for the exposure time control.

The range of valid exposure time values may depend on the camera configuration and the camera status.

Parameters

[in]	hCam	The camera handle.
[out]	minExposureTime_us	The minimum exposure time in microseconds.
[out]	maxExposureTime_us	The maximum exposure time in microseconds.
[out]	incExposureTime_us	The exposure time increment in microseconds.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The exposure time control is not accessible. Check the access status via peak_ExposureTime_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER At least one of minExposureTime_us, maxExposureTime_us, and incExposureTime_us is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

peak_ExposureTime_Set()

peak_status peak_ExposureTime_Set	(	peak_camera_handle	hCam,
		double	exposureTime_us
	)

Set the exposure time.

Writes the desired exposure time.

Parameters

[in]	hCam	The camera handle.
[in]	exposureTime_us	The exposure time to set in microseconds.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE exposureTime_us is out of range. Check the range of valid values via peak_ExposureTime_GetRange.

PEAK_STATUS_ACCESS_DENIED The exposure time control is not available for write access. Check the access status via peak_ExposureTime_GetAccessStatus.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.