Trigger divider property

A trigger divider is a setting that allows you to control the frequency of trigger signals by dividing the incoming trigger signal. More...

Functions
peak_access_status	peak_Trigger_Divider_GetAccessStatus (peak_camera_handle hCam)
	Query the trigger divider property access status.
peak_status	peak_Trigger_Divider_GetRange (peak_camera_handle hCam, uint32_t *minTriggerDivider, uint32_t *maxTriggerDivider, uint32_t *incTriggerDivider)
	Get the current range of valid trigger divider values.
peak_status	peak_Trigger_Divider_Set (peak_camera_handle hCam, uint32_t triggerDivider)
	Set the trigger divider.
peak_status	peak_Trigger_Divider_Get (peak_camera_handle hCam, uint32_t *triggerDivider)
	Get the trigger divider.

Detailed Description

A trigger divider is a setting that allows you to control the frequency of trigger signals by dividing the incoming trigger signal.

It effectively reduces the rate at which the camera captures images, by triggering the camera every nth signal, where n is the divisor. For example, if the trigger divider is set to 2, the camera will capture an image every second trigger signal. This feature is useful for controlling image capture in applications where capturing images too frequently isn't necessary or efficient.

Function Documentation

peak_Trigger_Divider_Get()

peak_status peak_Trigger_Divider_Get	(	peak_camera_handle	hCam,
		uint32_t *	triggerDivider )

Get the trigger divider.

Reads the current trigger divider.

Parameters

[in]	hCam	The camera handle.
[out]	triggerDivider	The trigger divider.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

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

PEAK_STATUS_INVALID_PARAMETER triggerDivider 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.0

peak_Trigger_Divider_GetAccessStatus()

peak_access_status peak_Trigger_Divider_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the trigger divider property access status.

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

PEAK_ACCESS_READONLY The trigger divider property is readable only.

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

PEAK_ACCESS_NONE The trigger divider property is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The trigger divider 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.

Since

1.0

peak_Trigger_Divider_GetRange()

peak_status peak_Trigger_Divider_GetRange	(	peak_camera_handle	hCam,
		uint32_t *	minTriggerDivider,
		uint32_t *	maxTriggerDivider,
		uint32_t *	incTriggerDivider )

Get the current range of valid trigger divider values.

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

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

Parameters

[in]	hCam	The camera handle.
[out]	minTriggerDivider	The minimum trigger divider value.
[out]	maxTriggerDivider	The maximum trigger divider value.
[out]	incTriggerDivider	The trigger divider value increment.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The trigger divider property is not accessible. Check the access status of the trigger divider via peak_Trigger_Divider_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER At least one of minTriggerDivider, maxTriggerDivider, and incTriggerDivider 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.0

peak_Trigger_Divider_Set()

peak_status peak_Trigger_Divider_Set	(	peak_camera_handle	hCam,
		uint32_t	triggerDivider )

Set the trigger divider.

Writes the desired trigger divider.

Parameters

[in]	hCam	The camera handle.
[in]	triggerDivider	The trigger divider.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE triggerDivider is out of range. Check the range of valid values via peak_Trigger_Divider_GetRange.

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