Skip frames

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_SkipFrames_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if skip frames is supported for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_SkipFrames_Set (peak_afl_controller_handle controller, uint32_t count)
	Set number of frames skipped for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_SkipFrames_Get (peak_afl_controller_handle controller, uint32_t *count)
	Get number of frames skipped for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_SkipFrames_GetRange (peak_afl_controller_handle controller, uint32_t *min, uint32_t *max, uint32_t *inc)
	Get range for frames skipped for a controller.

Detailed Description

The Skip frames setting defines how many frames should be skipped. This parameter strongly influences the control speed. Choosing small values can destabilize the automatic control.

Note

For higher frame rates, a larger value should be used for the Skip frames parameter. This reduces the number of automatic adjustments done by the camera.

Function Documentation

peak_afl_AutoController_SkipFrames_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_SkipFrames_Get	(	peak_afl_controller_handle	controller,
		uint32_t *	count )

Get number of frames skipped for a controller.

Gets the skipped frames for the controller. Only every N-th image will be processed.

Parameters

[in]	controller	controller handle
[out]	count	number of frames skipped

Returns

PEAK_AFL_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_AFL_STATUS_INVALID_PARAMETER The argument is invalid.

PEAK_AFL_STATUS_NOT_SUPPORTED The function is not supported.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_afl_AutoController_SkipFrames_GetRange()

PEAK_AFL_API_STATUS peak_afl_AutoController_SkipFrames_GetRange	(	peak_afl_controller_handle	controller,
		uint32_t *	min,
		uint32_t *	max,
		uint32_t *	inc )

Get range for frames skipped for a controller.

Parameters

[in]	controller	controller handle
[out]	min	minimum number of frames skipped
[out]	max	maximum number of frames skipped
[out]	inc	increment number of frames skipped

Returns

PEAK_AFL_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_AFL_STATUS_INVALID_PARAMETER The argument is invalid.

PEAK_AFL_STATUS_NOT_SUPPORTED The function is not supported.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_afl_AutoController_SkipFrames_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_SkipFrames_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

Check if skip frames is supported for a controller.

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller supports skipping frames

Returns

PEAK_AFL_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_AFL_STATUS_INVALID_PARAMETER The argument is invalid.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_afl_AutoController_SkipFrames_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_SkipFrames_Set	(	peak_afl_controller_handle	controller,
		uint32_t	count )

Set number of frames skipped for a controller.

Sets the skipped frames for the controller. Only every N-th image will be processed.

Parameters

[in]	controller	controller handle
[in]	count	number of frames skipped

Returns

PEAK_AFL_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_AFL_STATUS_INVALID_PARAMETER The argument is invalid.

PEAK_AFL_STATUS_NOT_SUPPORTED The function is not supported.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

Since

1.0