imgSessionTriggerConfigure
- Updated2023-02-21
- 2 minute(s) read
Usage
rval imgSessionTriggerConfigure(SESSION_ID sid, uInt32 trigger, uInt32 polarity, uInt32 timeout, uInt32 action);
Purpose
Configures an acquisition to start based on an external trigger.
 |
Note This function is obsolete. The replacement function is imgSessionTriggerConfigure2, which incorporates the functionality of imgSessionTriggerConfigure but also returns additional information. |
Parameters
| Name | Type | Direction |
| sid | SESSION_ID | input |
| trigger | uInt32 | input |
| polarity | uInt32 | input |
| timeout | uInt32 | input |
| action | uInt32 | input |
| rval | Int32 | output |
Parameter Discussion
sid: valid SESSION_ID.
trigger: trigger line to use. trigger can be one of the following constants:
| IMG_EXT_TRIG0 | IMG_EXT_RTSI2 |
| IMG_EXT_TRIG1 | IMG_EXT_RTSI3 |
| IMG_EXT_TRIG2 | IMG_EXT_RTSI4 |
| IMG_EXT_TRIG3 | IMG_EXT_RTSI5 |
| IMG_EXT_RTSI0 | IMG_EXT_RTSI6 |
| IMG_EXT_RTSI1 |
|
Note IMG_EXT_TRIG ‹0..3› refers to the external trigger lines of the image acquisition device. IMG_EXT_RTSI ‹0..6› refers to the internal pins on the RTSI controller of the image acquisition device. |
polarity: polarity of the trigger line. polarity can be one of the following constants:
| IMG_TRIG_POLAR_ACTIVEL | Triggers on a falling edge. |
| IMG_TRIG_POLAR_ACTIVEH | Triggers on a rising edge. |
timeout: time, in milliseconds, to wait for the trigger to occur. Use IMG_TIMEOUT_INFINITE to wait indefinitely.
action: action to take when the trigger edge occurs. The following are valid values for action:
| IMG_TRIG_ACTION_NONE | Clears the trigger. |
| IMG_TRIG_ACTION_CAPTURE | Starts acquiring. |
| IMG_TRIG_ACTION_BUFLIST | Acquires the buffer list once. |
| IMG_TRIG_ACTION_BUFFER | Acquires a single image. |
Return Value
This function returns 0 on success. On failure, this function returns an error code. For information about the error code, call imgShowError.
For more information, refer to the Obsolete functions topic.