Back to Adaptive Vision Library website
You are here: Start » Function Reference » NET SynView » SynView_GrabImage_WithTimeout
Captures a frame using SynView; returns Nil if no frame comes in the specified time.
Syntax
bool avl::SynView_GrabImage_WithTimeout ( SynView_GrabImage_WithTimeoutState& ioState, atl::Optional<const atl::String&> inDeviceID, avl::SynViewColorFormat::Type inColorFormat, int inTimeout, const avl::SynViewAcquisitionParams& inAcquisitionParams, const avl::SynViewImageFormatParams& inImageFormatParams, const avl::SynViewAnalogParams& inAnalogParams, atl::Conditional<avl::Image>& outImage )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
ioState | SynView_GrabImage_WithTimeoutState& | Object used to maintain state of the function. | |||
inDeviceID | Optional<const String&> | NIL | Tries to find the camera in all available IDs (UserID, VendorName, ModelName...) | ||
inColorFormat | SynViewColorFormat::Type | Image color format | |||
inTimeout | int | 100 - 3600000 | 5000 | Maximum time to wait for frame in milliseconds | |
inAcquisitionParams | const SynViewAcquisitionParams& | ||||
inImageFormatParams | const SynViewImageFormatParams& | ||||
inAnalogParams | const SynViewAnalogParams& | ||||
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.