Focus

Functions
peak_access_status	peak_Focus_GetAccessStatus (peak_camera_handle hCam)
	Query the focus access status.
peak_status	peak_Focus_GetRange (peak_camera_handle hCam, uint32_t *minFocus, uint32_t *maxFocus, uint32_t *incFocus)
	Get the current range of valid focus values.
peak_status	peak_Focus_Set (peak_camera_handle hCam, uint32_t focus)
	Set the focus value.
peak_status	peak_Focus_Get (peak_camera_handle hCam, uint32_t *focus)
	Get the focus value.

Detailed Description

Focus related functions and types.

Function Documentation

peak_Focus_Get()

peak_status peak_Focus_Get	(	peak_camera_handle	hCam,
		uint32_t *	focus
	)

Get the focus value.

Reads the current focus value.

Parameters

[in]	hCam	The camera handle.
[out]	focus	The focus value.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The focus feature is not available for read access. Check the access status via peak_Focus_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER focus 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_Focus_GetAccessStatus()

peak_access_status peak_Focus_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the focus access status.

Provides the current access status for the focus feature.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The focus feature is readable and writeable.

PEAK_ACCESS_READONLY The focus feature is readable only.

PEAK_ACCESS_GFA_LOCK The focus feature is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The focus feature is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The focus feature 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_Focus_GetRange()

peak_status peak_Focus_GetRange	(	peak_camera_handle	hCam,
		uint32_t *	minFocus,
		uint32_t *	maxFocus,
		uint32_t *	incFocus
	)

Get the current range of valid focus values.

Queries the current range of valid values for the manual focus feature.

Parameters

[in]	hCam	The camera handle.
[out]	minFocus	The minimum focus value.
[out]	maxFocus	The maximum focus value.
[out]	incFocus	The focus value increment.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The focus feature is not accessible. Check the access status via peak_Focus_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER At least one of minFocus, maxFocus, and incFocus 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_Focus_Set()

peak_status peak_Focus_Set	(	peak_camera_handle	hCam,
		uint32_t	focus
	)

Set the focus value.

Writes the desired focus value.

Parameters

[in]	hCam	The camera handle.
[in]	focus	The focus value to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE focus is out of range. Check the range of valid values via peak_Focus_GetRange.

PEAK_STATUS_ACCESS_DENIED The focus feature is not available for write access. Check the access status via peak_Focus_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.

Note

There is no guarantee that the same manually set focal point will always lead to the same focal distance.

The actual focal point for a certain focal value may differ from camera model to camera model.