Trigger burst property

Functions
peak_access_status	peak_Trigger_Burst_GetAccessStatus (peak_camera_handle hCam)
	Query the trigger burst property access status.
peak_status	peak_Trigger_Burst_GetRange (peak_camera_handle hCam, uint32_t *minTriggerBurst, uint32_t *maxTriggerBurst, uint32_t *incTriggerBurst)
	Get the current range of valid trigger burst values.
peak_status	peak_Trigger_Burst_Set (peak_camera_handle hCam, uint32_t triggerBurst)
	Set the trigger burst.
peak_status	peak_Trigger_Burst_Get (peak_camera_handle hCam, uint32_t *triggerBurst)
	Get the trigger burst.

Detailed Description

Trigger burst property related functions.

Function Documentation

peak_Trigger_Burst_Get()

peak_status peak_Trigger_Burst_Get	(	peak_camera_handle	hCam,
		uint32_t *	triggerBurst
	)

Get the trigger burst.

Reads the current trigger burst.

Parameters

[in]	hCam	The camera handle.
[out]	triggerBurst	The trigger burst.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The trigger burst property is not available for read access. Check the access status of the trigger burst via peak_Trigger_Burst_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER triggerBurst 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_Trigger_Burst_GetAccessStatus()

peak_access_status peak_Trigger_Burst_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the trigger burst property access status.

Provides the current access status for the trigger burst property for the configured trigger mode.

This function implements the Access Status Query principle.

Parameters

[in]

hCam

The camera handle.

Returns

PEAK_ACCESS_READWRITE The trigger burst property is readable and writeable.

PEAK_ACCESS_READONLY The trigger burst property is readable only.

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

PEAK_ACCESS_NONE The trigger burst property is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The trigger burst 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_ACCESS_DENIED The trigger feature is not accessible. Check the access status of the trigger feature via peak_Trigger_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.

peak_Trigger_Burst_GetRange()

peak_status peak_Trigger_Burst_GetRange	(	peak_camera_handle	hCam,
		uint32_t *	minTriggerBurst,
		uint32_t *	maxTriggerBurst,
		uint32_t *	incTriggerBurst
	)

Get the current range of valid trigger burst values.

Queries the current range of valid values for the trigger burst for the configured trigger mode.

The range of valid trigger burst values may depend on the trigger mode, the camera configuration, and the camera status.

Parameters

[in]	hCam	The camera handle.
[out]	minTriggerBurst	The minimum trigger burst value.
[out]	maxTriggerBurst	The maximum trigger burst value.
[out]	incTriggerBurst	The trigger burst value increment.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The trigger burst property is not accessible. Check the access status of the trigger burst via peak_Trigger_Burst_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER At least one of minTriggerBurst, maxTriggerBurst, and incTriggerBurst 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_Trigger_Burst_Set()

peak_status peak_Trigger_Burst_Set	(	peak_camera_handle	hCam,
		uint32_t	triggerBurst
	)

Set the trigger burst.

Writes the desired trigger burst.

Parameters

[in]	hCam	The camera handle.
[in]	triggerBurst	The trigger burst.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE triggerBurst is out of range. Check the range of valid values via peak_Trigger_Burst_GetRange.

PEAK_STATUS_ACCESS_DENIED The trigger burst property is not available for write access. Check the access status of the trigger burst via peak_Trigger_Burst_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.