Trigger edge property

Enumerations
enum	peak_trigger_edge { PEAK_TRIGGER_EDGE_INVALID, PEAK_TRIGGER_EDGE_RISING, PEAK_TRIGGER_EDGE_FALLING, PEAK_TRIGGER_EDGE_ANY }
	peak Trigger edge More...

Functions
peak_access_status	peak_Trigger_Edge_GetAccessStatus (peak_camera_handle hCam)
	Query the trigger edge property access status. More...
peak_status	peak_Trigger_Edge_GetList (peak_camera_handle hCam, peak_trigger_edge *triggerEdgeList, size_t *triggerEdgeCount)
	Get the list of currently selectable trigger edges. More...
peak_status	peak_Trigger_Edge_Set (peak_camera_handle hCam, peak_trigger_edge triggerEdge)
	Set the trigger edge. More...
peak_status	peak_Trigger_Edge_Get (peak_camera_handle hCam, peak_trigger_edge *triggerEdge)
	Get the trigger edge. More...

Detailed Description

Trigger edge property related functions.

Enumeration Type Documentation

peak_trigger_edge

enum peak_trigger_edge

peak Trigger edge

The trigger edge specifies which edge of an electrical signal initiates a trigger.

Note

The trigger edge is not effective for software trigger.

Enumerator
PEAK_TRIGGER_EDGE_INVALID	Invalid trigger edge. Use this value for the initialization of variables of type peak_trigger_edge.
PEAK_TRIGGER_EDGE_RISING	Rising edge. A trigger is raised by the electrical signal changing from low level to high level.
PEAK_TRIGGER_EDGE_FALLING	Falling edge. A trigger is raised by the electrical signal changing from high level to low level.
PEAK_TRIGGER_EDGE_ANY	Any edge. A trigger is raised by the electrical signal changing its level in any direction.

Function Documentation

peak_Trigger_Edge_Get()

peak_status peak_Trigger_Edge_Get	(	peak_camera_handle	hCam,
		peak_trigger_edge *	triggerEdge
	)

Get the trigger edge.

Reads the current trigger edge.

Parameters

[in]	hCam	The camera handle.
[out]	triggerEdge	The trigger edge.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

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

PEAK_STATUS_INVALID_PARAMETER triggerEdge 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_Edge_GetAccessStatus()

peak_access_status peak_Trigger_Edge_GetAccessStatus

(

peak_camera_handle

hCam

)

Query the trigger edge property access status.

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

PEAK_ACCESS_READONLY The trigger edge property is readable only.

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

PEAK_ACCESS_NONE The trigger edge property is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The trigger edge 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_Edge_GetList()

peak_status peak_Trigger_Edge_GetList	(	peak_camera_handle	hCam,
		peak_trigger_edge *	triggerEdgeList,
		size_t *	triggerEdgeCount
	)

Get the list of currently selectable trigger edges.

Queries the list of currently selectable trigger edges for the configured trigger mode.

The list of selectable trigger edges may depend on the trigger mode, the camera configuration, and the camera status.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[out]	triggerEdgeList	Pointer to a user allocated array buffer to receive the trigger edge list. If this parameter is NULL, triggerEdgeCount will contain the current number of trigger edges. The required size of triggerEdgeList in bytes is triggerEdgeCount x sizeof(peak_trigger_edge).
[in,out]	triggerEdgeCount	triggerEdgeList equal NULL: out: minimal number of pixel formats triggerEdgeList must be large enough to hold triggerEdgeList unequal NULL: in: number of trigger edges triggerEdgeList can hold out: number of trigger edges filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

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

PEAK_STATUS_ACCESS_DENIED The trigger edge property is not accessible. Check the access status of the trigger edge via peak_Trigger_Edge_GetAccessStatus.

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

Note

Consider that the trigger edge list might change between the size query call and the list query call.
This may be the case if the trigger mode, the camera configuration, or the camera status have changed in the time between the two function calls.

peak_Trigger_Edge_Set()

peak_status peak_Trigger_Edge_Set	(	peak_camera_handle	hCam,
		peak_trigger_edge	triggerEdge
	)

Set the trigger edge.

Writes the desired trigger edge.

Parameters

[in]	hCam	The camera handle.
[in]	triggerEdge	The trigger edge to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The trigger edge property is not available for write access. Check the access status of the trigger edge via peak_Trigger_Edge_GetAccessStatus.

PEAK_STATUS_OUT_OF_RANGE triggerEdge is out of range. Check the range of valid values via peak_Trigger_Edge_GetList.

PEAK_STATUS_INVALID_PARAMETER triggerEdge is an invalid trigger edge. Check peak_trigger_edge.

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.