is_Trigger

USB 2.0

USB 3.0

GigE

USB 2.0

USB 3.0

GigE

Syntax

INT is_Trigger (HIDS hCam, UINT nCommand, void* pParam, UINT cbSizeOfParam)

Description

is_Trigger() activates the burst trigger mode in GigE uEye cameras. In burst trigger mode, the camera captures a series of images in rapid succession on receipt of a single trigger signal. The trigger signal can be generated by the software (is_FreezeVideo()) or transmitted via the digital input of the camera. The burst images are captured and transferred at maximum speed. The maximum speed depends on the pixel clock parameter (see is_PixelClock()) and the exposure time parameter (see is_Exposure()). is_Transfer() allows adjusting the latency of image data transfer.

The nCommand input parameter is used to select the function mode. The pParam input parameter depends on the selected function mode. If you select functions for setting or returning a value, pParam contains a pointer to a variable of the UINT type. The size of the memory area to which pParam refers is specified in the cbSizeOfParam input parameter.

Hinweis

This function is currently only supported by the GigE uEye camera series.

Hinweis

Note on the uEye trigger functions

In a future version of the uEye API, all trigger functions will be combined in a single is_Trigger() function. The following functions will then be obsolete:

•is_SetExternalTrigger()

•is_ForceTrigger()

•is_SetTriggerCounter()

•is_SetTriggerDelay()

•is_TriggerDebounce()

Hinweis

Note on trigger delay in burst trigger mode

If you set a trigger delay with the is_SetTriggerDelay() function, the delay will only apply to the first image after each trigger signal.

Input parameters

hCam

Camera handle

IS_TRIGGER_CMD_GET_BURST_SIZE_SUPPORTED

Indicates whether the camera supports the burst trigger mode.

•pParam: Pointer to variable of type UINT.

•nSizeOfParam: 4

Example 1

IS_TRIGGER_CMD_GET_BURST_SIZE_RANGE

Returns the value range, the default value and the increment for the number of images in a burst.

•pParam: Pointer to variable of type RANGE_OF_VALUES_U32 returning the values.

•nSizeOfParam: sizeof (RANGE_OF_VALUES_U32)

IS_TRIGGER_CMD_GET_BURST_SIZE

Returns the currently set number of images in a burst.

•pParam: Pointer to variable of type UINT returning the current value.

•nSizeOfParam: 4

Example 2

IS_TRIGGER_CMD_SET_BURST_SIZE

Sets the number of images in a burst.

•pParam: Pointer to variable of type UINT that passes the value to be set.

•nSizeOfParam: 4

pParam

Pointer to a function parameter, whose function depends on nCommand.

cbSizeOfParam

Size (in bytes) of the memory area to which pParam refers.

Contents of the RANGE_OF_VALUES_U32 structure

UINT	u32Minimum	Minimum value
UINT	u32Maximum	Maximum value
UINT	u32Increment	Increment
UINT	u32Default	Default value

Return values

IS_INVALID_CAMERA_HANDLE	Invalid camera handle
IS_INVALID_PARAMETER	One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode.
IS_NO_SUCCESS	General error message
IS_NOT_SUPPORTED	The camera model used here does not support this function or setting.
IS_SUCCESS	Function executed successfully

Related functions

•is_SetExternalTrigger()

•is_ForceTrigger()

•is_SetTriggerCounter()

•is_SetTriggerDelay()

•is_TriggerDebounce()

Example 1

UINT nTriggerBurstSizeSupported = 0;

INT nRet = is_Trigger(m_hCam,

IS_TRIGGER_CMD_GET_BURST_SIZE_SUPPORTED,

(void*)&nTriggerBurstSizeSupported,

sizeof(nTriggerBurstSizeSupported)

);

if (nRet == IS_SUCCESS)

{

// Burst size supported

if (nTriggerBurstSizeSupported == 1)

{

RANGE_OF_VALUES_U32 rangeBurstSize;

nRet = is_Trigger(m_hCam,

IS_TRIGGER_CMD_GET_BURST_SIZE_RANGE,

(void*)&rangeBurstSize,

sizeof(rangeBurstSize)

);

if (nRet == IS_SUCCESS)

{

UINT nMin, nMax;

nMin = rangeBurstSize.u32Minimum;

nMax = rangeBurstSize.u32Maximum;

}

Example 2

UINT nTriggerBurstSize = 0;

INT nRet = is_Trigger(m_hCam,

IS_TRIGGER_CMD_GET_BURST_SIZE,

(void*)&nTriggerBurstSize,

sizeof(nTriggerBurstSize)

);

nRet = is_Trigger(m_hCam,

IS_TRIGGER_CMD_SET_BURST_SIZE,

(void*)&nTriggerBurstSize,

sizeof(nTriggerBurstSize)

);

Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!

For technical questions please contact you local distributor or use the support form on our website.

Home > C: Programming > Function descriptions >	History back Previous chapter Next chapter Print
is_Trigger