Trigger delay property

Trigger delay refers to the time interval between the receipt of a trigger signal and the actual moment the camera captures an image. More...

Functions
peak_access_status	peak_Trigger_Delay_GetAccessStatus (peak_camera_handle hCam)
	Query the trigger delay property access status.
peak_status	peak_Trigger_Delay_GetRange (peak_camera_handle hCam, double *minTriggerDelay_us, double *maxTriggerDelay_us, double *incTriggerDelay_us)
	Get the current range of valid trigger delay values.
peak_status	peak_Trigger_Delay_Set (peak_camera_handle hCam, double triggerDelay_us)
	Set the trigger delay.
peak_status	peak_Trigger_Delay_Get (peak_camera_handle hCam, double *triggerDelay_us)
	Get the trigger delay.

Detailed Description

Trigger delay refers to the time interval between the receipt of a trigger signal and the actual moment the camera captures an image.

This delay can be adjusted to synchronize the image capture with other events or processes, ensuring that the camera captures the desired moment after the trigger signal is received.

Trigger delay is often used in high-speed or time-sensitive applications where precise timing is critical.

Function Documentation

peak_Trigger_Delay_Get()

peak_status peak_Trigger_Delay_Get	(	peak_camera_handle	hCam,
		double *	triggerDelay_us
	)

Get the trigger delay.

Reads the current trigger delay.

Parameters

[in]	hCam	The camera handle.
[out]	triggerDelay_us	The trigger delay in microseconds.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

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

PEAK_STATUS_INVALID_PARAMETER triggerDelay_us 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_Delay_GetAccessStatus()

peak_access_status peak_Trigger_Delay_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the trigger delay property access status.

Provides the current access status for the trigger delay 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 delay property is readable and writeable.

PEAK_ACCESS_READONLY The trigger delay property is readable only.

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

PEAK_ACCESS_NONE The trigger delay property is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The trigger delay 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_Delay_GetRange()

peak_status peak_Trigger_Delay_GetRange	(	peak_camera_handle	hCam,
		double *	minTriggerDelay_us,
		double *	maxTriggerDelay_us,
		double *	incTriggerDelay_us
	)

Get the current range of valid trigger delay values.

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

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

Parameters

[in]	hCam	The camera handle.
[out]	minTriggerDelay_us	The minimum trigger delay value.
[out]	maxTriggerDelay_us	The maximum trigger delay value.
[out]	incTriggerDelay_us	The trigger delay value increment.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The trigger delay property is not accessible. Check the access status of the trigger delay via peak_Trigger_Delay_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER At least one of minTriggerDelay_us, maxTriggerDelay_us, and incTriggerDelay_us 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_Delay_Set()

peak_status peak_Trigger_Delay_Set	(	peak_camera_handle	hCam,
		double	triggerDelay_us
	)

Set the trigger delay.

Writes the desired trigger delay.

Parameters

[in]	hCam	The camera handle.
[in]	triggerDelay_us	The trigger delay in microseconds to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE triggerDelay_us is out of range. Check the range of valid values via peak_Trigger_Delay_GetRange.

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