Back to Adaptive Vision Library website
You are here: Start » Function Reference » MATRIX VISION » mvGenTLAcquire_GrabImage_WithTimeout
Captures a frame from MATRIX VISION cameras using mvGenTLAcquire SDK.
Syntax
bool avl::mvGenTLAcquire_GrabImage_WithTimeout ( mvGenTLAcquireState& ioState, atl::Optional<const atl::String&> inDeviceID, int inTimeout, avl::MVGenTLPixelFormat::Type inPixelFormat, atl::Optional<int> inExposureTime, atl::Optional<float> inGain, atl::Optional<float> inFrameRate, atl::Optional<const avl::Box&> inAoi, avl::MvIMPACTTriggerActivation::Type inTriggerMode, avl::MvIMPACTTriggerSource::Type inTriggerSource, atl::Conditional<avl::Image>& outImage )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
ioState | mvGenTLAcquireState& | Object used to maintain state of the function. | |||
inDeviceID | Optional<const String&> | NIL | Device name or serial number of device | ||
inTimeout | int | 10 - | Maximum time to wait for frame in milliseconds | ||
inPixelFormat | MVGenTLPixelFormat::Type | Pixel format of output image | |||
inExposureTime | Optional<int> | 1 - + | NIL | Exposure time value | |
inGain | Optional<float> | NIL | Gain value | ||
inFrameRate | Optional<float> | 1.0 - | NIL | Frame rate in FPS | |
inAoi | Optional<const Box&> | NIL | Required fragment of image to stream | ||
inTriggerMode | MvIMPACTTriggerActivation::Type | Trigger mode | |||
inTriggerSource | MvIMPACTTriggerSource::Type | Source of trigger | |||
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.