Frame rate

Functions
peak_access_status	peak_FrameRate_GetAccessStatus (peak_camera_handle hCam)
	Query the frame rate access status.
peak_status	peak_FrameRate_GetRange (peak_camera_handle hCam, double *minFrameRate_fps, double *maxFrameRate_fps, double *incFrameRate_fps)
	Get the current range of valid frame rate values.
peak_status	peak_FrameRate_Set (peak_camera_handle hCam, double frameRate_fps)
	Set the frame rate.
peak_status	peak_FrameRate_Get (peak_camera_handle hCam, double *frameRate_fps)
	Get the frame rate.

Detailed Description

Frame rate related functions and types.

Function Documentation

peak_FrameRate_Get()

peak_status peak_FrameRate_Get	(	peak_camera_handle	hCam,
		double *	frameRate_fps
	)

Get the frame rate.

Reads the current frame rate.

Parameters

[in]	hCam	The camera handle.
[out]	frameRate_fps	The frame rate in frames per second.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The frame rate control is not available for read access. Check the access status via peak_FrameRate_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER frameRate_fps 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_FrameRate_GetAccessStatus()

peak_access_status peak_FrameRate_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the frame rate access status.

Provides the current access status for the frame rate control.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The frame rate control is readable and writeable.

PEAK_ACCESS_READONLY The frame rate control is readable only.

PEAK_ACCESS_GFA_LOCK The frame rate control is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The frame rate control is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The frame rate 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_FrameRate_GetRange()

peak_status peak_FrameRate_GetRange	(	peak_camera_handle	hCam,
		double *	minFrameRate_fps,
		double *	maxFrameRate_fps,
		double *	incFrameRate_fps
	)

Get the current range of valid frame rate values.

Queries the current range of valid values for the frame rate control.

The range of valid frame rate values may depend on the camera configuration and the camera status.

Parameters

[in]	hCam	The camera handle.
[out]	minFrameRate_fps	The minimum frame rate in frames per second.
[out]	maxFrameRate_fps	The maximum frame rate in frames per second.
[out]	incFrameRate_fps	The frame rate increment in frames per second.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The frame rate control is not accessible. Check the access status via peak_FrameRate_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER At least one of minFrameRate_fps, maxFrameRate_fps, and incFrameRate_fps 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_FrameRate_Set()

peak_status peak_FrameRate_Set	(	peak_camera_handle	hCam,
		double	frameRate_fps
	)

Set the frame rate.

Writes the desired frame rate.

Parameters

[in]	hCam	The camera handle.
[in]	frameRate_fps	The frame rate to set in frames per second.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE frameRate_fps is out of range. Check the range of valid values via peak_FrameRate_GetRange.

PEAK_STATUS_ACCESS_DENIED The frame rate control is not available for write access. Check the access status via peak_FrameRate_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.