Loss handling

Enumerations
enum	peak_loss_handling_mode { PEAK_LOSS_HANDLING_MODE_INVALID , PEAK_LOSS_HANDLING_MODE_OFF , PEAK_LOSS_HANDLING_MODE_LIMITED , PEAK_LOSS_HANDLING_MODE_UNLIMITED }
	peak Loss handling modes More...

Functions
peak_access_status	peak_Acquisition_LossHandling_Mode_GetAccessStatus (peak_camera_handle hCam)
	Query the loss handling mode access status.
peak_status	peak_Acquisition_LossHandling_Mode_GetList (peak_camera_handle hCam, peak_loss_handling_mode *lossHandlingModeList, size_t *lossHandlingModesCount)
	Get the list of currently usable loss handling modes.
peak_status	peak_Acquisition_LossHandling_Mode_Set (peak_camera_handle hCam, peak_loss_handling_mode mode)
	Set the loss handling mode.
peak_status	peak_Acquisition_LossHandling_Mode_Get (peak_camera_handle hCam, peak_loss_handling_mode *mode)
	Get the loss handling mode.
peak_access_status	peak_Acquisition_LossHandling_Extent_GetAccessStatus (peak_camera_handle hCam)
	Query the loss handling extent access status.
peak_status	peak_Acquisition_LossHandling_Extent_GetRange (peak_camera_handle hCam, int64_t *minExtent, int64_t *maxExtent, int64_t *incExtent)
	Get the extent range of valid extent values.
peak_status	peak_Acquisition_LossHandling_Extent_Set (peak_camera_handle hCam, int64_t extent)
	Set the loss handling extent.
peak_status	peak_Acquisition_LossHandling_Extent_Get (peak_camera_handle hCam, int64_t *extent)
	Get the loss handling extent.
peak_access_status	peak_Acquisition_LossHandling_FrameAbortTimeout_GetAccessStatus (peak_camera_handle hCam)
	Query the loss handling frame abort timeout access status.
peak_status	peak_Acquisition_LossHandling_FrameAbortTimeout_GetRange (peak_camera_handle hCam, int64_t *minTimeout, int64_t *maxTimeout, int64_t *incTimeout)
	Get the frame abort timeout range of valid values.
peak_status	peak_Acquisition_LossHandling_FrameAbortTimeout_Set (peak_camera_handle hCam, int64_t timeout)
	Set the loss handling frame abort timeout.
peak_status	peak_Acquisition_LossHandling_FrameAbortTimeout_Get (peak_camera_handle hCam, int64_t *timeout)
	Get the loss handling frame abort timeout.
peak_access_status	peak_Acquisition_LossHandling_ResendRequestTimeout_GetAccessStatus (peak_camera_handle hCam)
	Query the loss handling resend request timeout access status.
peak_status	peak_Acquisition_LossHandling_ResendRequestTimeout_GetRange (peak_camera_handle hCam, int64_t *minTimeout, int64_t *maxTimeout, int64_t *incTimeout)
	Get the current range of valid loss handling resend request timeout values.
peak_status	peak_Acquisition_LossHandling_ResendRequestTimeout_Set (peak_camera_handle hCam, int64_t timeout)
	Set the loss handling resend request timeout.
peak_status	peak_Acquisition_LossHandling_ResendRequestTimeout_Get (peak_camera_handle hCam, int64_t *timeout)
	Get the loss handling resend request timeout.

Detailed Description

Loss handling related functions and types.
Controls the loss handling.

Enumeration Type Documentation

peak_loss_handling_mode

enum peak_loss_handling_mode

peak Loss handling modes

Enumerator
PEAK_LOSS_HANDLING_MODE_INVALID	Invalid loss handling mode. Use this value for the initialization of variables of type peak_loss_handling_mode.
PEAK_LOSS_HANDLING_MODE_OFF	Loss handling mode off. Loss handling is disabled.
PEAK_LOSS_HANDLING_MODE_LIMITED	Loss handling mode limited. If packets are missing, a resend request is sent to the device. The number of packets that can be resent is limited by Loss Handling Extent. Each packet can be resent only once.
PEAK_LOSS_HANDLING_MODE_UNLIMITED	Loss handling mode unlimited. If packets are missing, a resend request is sent to the device. The number of packets that can be resent is limited by the camera's buffering capabilities.

Function Documentation

peak_Acquisition_LossHandling_Extent_Get()

peak_status peak_Acquisition_LossHandling_Extent_Get	(	peak_camera_handle	hCam,
		int64_t *	extent )

Get the loss handling extent.

Reads the desired loss handling extent.

Parameters

[in]	hCam	The camera handle.
[in]	extent	The loss handling extent to get.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The loss handling extent property is not available for write access. Check the access status of the loss handling resend request timeout via peak_Acquisition_LossHandling_Extent_GetAccessStatus.

PEAK_STATUS_OUT_OF_RANGE extent is out of range. Check the range of valid values via peak_Acquisition_LossHandling_Extent_GetRange.

PEAK_STATUS_INVALID_PARAMETER extent 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.

Since

1.9

peak_Acquisition_LossHandling_Extent_GetAccessStatus()

peak_access_status peak_Acquisition_LossHandling_Extent_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the loss handling extent access status.

Provides the current access status for extent.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The extent property is readable and writeable.

PEAK_ACCESS_READONLY The extent property can be applied only.

PEAK_ACCESS_WRITEONLY The extent property can be stored only.

PEAK_ACCESS_GFA_LOCK The extent property is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The extent property is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The extent property 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.

Since

1.9

peak_Acquisition_LossHandling_Extent_GetRange()

peak_status peak_Acquisition_LossHandling_Extent_GetRange	(	peak_camera_handle	hCam,
		int64_t *	minExtent,
		int64_t *	maxExtent,
		int64_t *	incExtent )

Get the extent range of valid extent values.

Queries the current range of valid values for the loss handling extent.

Parameters

[in]	hCam	The camera handle.
[out]	minExtent	The minimum extent in percent.
[out]	maxExtent	The maximum extent in percent.
[out]	incExtent	The extent increment in percent.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The loss handling extent control is not accessible. Check the access status via peak_Acquisition_LossHandling_Extent_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER At least one of minExtent, maxExtent, and incExtent 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.

Since

1.9

peak_Acquisition_LossHandling_Extent_Set()

peak_status peak_Acquisition_LossHandling_Extent_Set	(	peak_camera_handle	hCam,
		int64_t	extent )

Set the loss handling extent.

Writes the loss handling extent.

Parameters

[in]	hCam	The camera handle.
[in]	extent	The loss handling extent

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE extent is out of range. Check the range of valid values via peak_Acquisition_LossHandling_Extent_GetRange.

PEAK_STATUS_ACCESS_DENIED The loss handling extent control is not available for write access. Check the access status via peak_Acquisition_LossHandling_Extent_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.

Since

1.9

peak_Acquisition_LossHandling_FrameAbortTimeout_Get()

peak_status peak_Acquisition_LossHandling_FrameAbortTimeout_Get	(	peak_camera_handle	hCam,
		int64_t *	timeout )

Get the loss handling frame abort timeout.

Reads the desired loss handling frame abort timeout.

Parameters

[in]	hCam	The camera handle.
[in]	timeout	The loss handling frame abort timeout to get.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The loss handling frame abort timeout property is not available for write access. Check the access status of the loss handling resend request timeout via peak_Acquisition_LossHandling_FrameAbortTimeout_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER timeout 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.

Since

1.9

peak_Acquisition_LossHandling_FrameAbortTimeout_GetAccessStatus()

peak_access_status peak_Acquisition_LossHandling_FrameAbortTimeout_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the loss handling frame abort timeout access status.

Provides the current access status for frame abort timeout.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The frame abort timeout property is readable and writeable.

PEAK_ACCESS_READONLY The frame abort timeout property can be applied only.

PEAK_ACCESS_WRITEONLY The frame abort timeout property can be stored only.

PEAK_ACCESS_GFA_LOCK The frame abort timeout property is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The frame abort timeout property is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The frame abort timeout property 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.

Since

1.9

peak_Acquisition_LossHandling_FrameAbortTimeout_GetRange()

peak_status peak_Acquisition_LossHandling_FrameAbortTimeout_GetRange	(	peak_camera_handle	hCam,
		int64_t *	minTimeout,
		int64_t *	maxTimeout,
		int64_t *	incTimeout )

Get the frame abort timeout range of valid values.

Queries the current range of valid values for the loss handling frame abort timeout.

Parameters

[in]	hCam	The camera handle.
[out]	minTimeout	The minimum frame abort timeout in milliseconds.
[out]	maxTimeout	The maximum frame abort timeout in milliseconds.
[out]	incTimeout	The frame rate increment in milliseconds.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The loss handling frame abort timeout control is not accessible. Check the access status via peak_Acquisition_LossHandling_FrameAbortTimeout_GetAccessStatus incExtent 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.

Since

1.9

peak_Acquisition_LossHandling_FrameAbortTimeout_Set()

peak_status peak_Acquisition_LossHandling_FrameAbortTimeout_Set	(	peak_camera_handle	hCam,
		int64_t	timeout )

Set the loss handling frame abort timeout.

Writes the loss handling frame abort timeout.

Parameters

[in]	hCam	The camera handle.
[in]	timeout	The loss handling frame abort timeout in milliseconds

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE timeout is out of range. Check the range of valid values via peak_Acquisition_LossHandling_FrameAbortTimeout_GetRange.

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

Since

1.9

peak_Acquisition_LossHandling_Mode_Get()

peak_status peak_Acquisition_LossHandling_Mode_Get	(	peak_camera_handle	hCam,
		peak_loss_handling_mode *	mode )

Get the loss handling mode.

Reads the current loss handling mode.

Parameters

[in]	hCam	The camera handle.
[out]	mode	The loss handling mode.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The loss handling mode property is not available for read access. Check the access status of the loss handling mode via peak_Acquisition_LossHandling_Mode_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER mode 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.

Since

1.9

peak_Acquisition_LossHandling_Mode_GetAccessStatus()

peak_access_status peak_Acquisition_LossHandling_Mode_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the loss handling mode access status.

Provides the current access status for the loss handling mode.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The loss handling mode property is readable and writeable.

PEAK_ACCESS_READONLY The loss handling mode property can be applied only.

PEAK_ACCESS_WRITEONLY The loss handling mode property can be stored only.

PEAK_ACCESS_GFA_LOCK The loss handling mode property is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The loss handling mode property is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The loss handling mode property 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.

Since

1.9

peak_Acquisition_LossHandling_Mode_GetList()

peak_status peak_Acquisition_LossHandling_Mode_GetList	(	peak_camera_handle	hCam,
		peak_loss_handling_mode *	lossHandlingModeList,
		size_t *	lossHandlingModesCount )

Get the list of currently usable loss handling modes.

Queries the list of currently selectable loss handling modes.

The list of usable loss handling modes may depend on the camera configuration and interface technology.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[out]	lossHandlingModeList	Pointer to a user allocated array buffer to receive the loss handling mode list. If this parameter is NULL, lossHandlingModesCount will contain the current number of loss handling modes. The required size of lossHandlingModeList in bytes is lossHandlingModesCount x sizeof(peak_loss_handling_mode).
[in,out]	lossHandlingModesCount	lossHandlingModeList equal NULL: out: minimal number of loss handling modes lossHandlingModeList must be large enough to hold lossHandlingModeList unequal NULL: in: number of loss handling modes lossHandlingModeList can hold out: number of loss handling modes filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_BUFFER_TOO_SMALL lossHandlingModeList is not NULL and the value of *lossHandlingModesCount is too small to receive the expected amount of data.

PEAK_STATUS_ACCESS_DENIED The loss handling mode feature is not supported or the GFA write mode is enabled.

PEAK_STATUS_INVALID_PARAMETER lossHandlingModesCount 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.

Since

1.9

peak_Acquisition_LossHandling_Mode_Set()

peak_status peak_Acquisition_LossHandling_Mode_Set	(	peak_camera_handle	hCam,
		peak_loss_handling_mode	mode )

Set the loss handling mode.

Writes the desired loss handling mode.

Parameters

[in]	hCam	The camera handle.
[in]	mode	The loss handling mode to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The loss handling mode property is not available for write access. Check the access status of the loss handling mode via peak_Acquisition_LossHandling_Mode_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER mode is an invalid loss handling mode. Check peak_loss_handling_mode.

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.

Since

1.9

peak_Acquisition_LossHandling_ResendRequestTimeout_Get()

peak_status peak_Acquisition_LossHandling_ResendRequestTimeout_Get	(	peak_camera_handle	hCam,
		int64_t *	timeout )

Get the loss handling resend request timeout.

Reads the desired loss handling resend request timeout.

Parameters

[in]	hCam	The camera handle.
[in]	timeout	The loss handling resend request timeout.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The loss handling resend request timeout property is not available for write access. Check the access status of the loss handling resend request timeout via peak_Acquisition_LossHandling_ResendRequestTimeout_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER timeout 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.

Since

1.9

peak_Acquisition_LossHandling_ResendRequestTimeout_GetAccessStatus()

peak_access_status peak_Acquisition_LossHandling_ResendRequestTimeout_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the loss handling resend request timeout access status.

Provides the current access status for the resend request timeout.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The loss handling resend request timeout property is readable and writeable.

PEAK_ACCESS_READONLY The loss handling resend request timeout property can be applied only.

PEAK_ACCESS_WRITEONLY The loss handling resend request timeout property can be stored only.

PEAK_ACCESS_GFA_LOCK The loss handling resend request timeout property is not accessible because the GFA write access is enabled.

PEAK_ACCESS_NONE The loss handling resend request timeout property is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The loss handling resend request timeout property 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.

Since

1.9

peak_Acquisition_LossHandling_ResendRequestTimeout_GetRange()

peak_status peak_Acquisition_LossHandling_ResendRequestTimeout_GetRange	(	peak_camera_handle	hCam,
		int64_t *	minTimeout,
		int64_t *	maxTimeout,
		int64_t *	incTimeout )

Get the current range of valid loss handling resend request timeout values.

Queries the current range of valid values for the frame request timeout 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]	minTimeout	The minimum loss handling resend request timeout in milliseconds.
[out]	maxTimeout	The maximum loss handling resend request timeout in milliseconds.
[out]	incTimeout	The increment loss handling resend request timeout in milliseconds.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The loss handling resend request timeout is not accessible. Check the access status via peak_Acquisition_LossHandling_ResendRequestTimeout_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER At least one of minTimeout, maxTimeout, and incTimeout 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.

Since

1.9

peak_Acquisition_LossHandling_ResendRequestTimeout_Set()

peak_status peak_Acquisition_LossHandling_ResendRequestTimeout_Set	(	peak_camera_handle	hCam,
		int64_t	timeout )

Set the loss handling resend request timeout.

Writes the desired loss handling resend request timeout.

Parameters

[in]	hCam	The camera handle.
[in]	timeout	The loss handling resend request timeout to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The loss handling resend request timeout property is not available for write access. Check the access status of the loss handling resend request timeout via peak_Acquisition_LossHandling_ResendRequestTimeout_GetAccessStatus.

PEAK_STATUS_OUT_OF_RANGE timeout is out of range. Check the range of valid values via peak_Acquisition_LossHandling_Mode_GetList.

PEAK_STATUS_INVALID_PARAMETER timeout is an invalid loss handling resend request timeout.

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.

Since

1.9