Back to Adaptive Vision Library website
You are here: Start » Function Reference » SiliconSoftware » SiliconSoftware_GrabImage_WithTimeout
Header: | ThirdPartySdk.h |
---|---|
Namespace: | avl |
Captures a frame using Silicon Software board.
Syntax
bool avl::SiliconSoftware_GrabImage_WithTimeout ( SiliconSoftware_State& ioState, atl::Optional<int> inDeviceIndex, atl::Optional<const atl::String&> inAppletPath, int inPort, int inTimeout, int inInputQueueSize, atl::Optional<const atl::File&> inConfigurationFile, atl::Conditional<avl::Image>& outImage )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
ioState | SiliconSoftware_State& | Object used to maintain state of the function. | |||
inDeviceIndex | Optional<int> | 0 - | NIL | Device identifying number | |
inAppletPath | Optional<const String&> | NIL | Applet to load | ||
inPort | int | 0 - | DMA port | ||
inTimeout | int | 1 - | 2 | Maximum time to wait for frame in seconds | |
inInputQueueSize | int | 4 - 200 | 5 | Capacity of output frames queue | |
inConfigurationFile | Optional<const File&> | NIL | Configuration file path | ||
outImage | Conditional<Image>& | Captured frame |
Multithreaded environment
This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.