mvGenTLAcquire_GrabImage_WithTimeout


Captures a frame from MATRIX VISION cameras using mvGenTLAcquire SDK.

Syntax

C++
Python
 
def mvGenTLAcquire_GrabImage_WithTimeout(
	state: MvGenTLAcquireState,
	/,
	*,
	inDeviceID: str | None = None,
	inTimeout: int = 100,
	inPixelFormat: MVGenTLPixelFormat | None = None,
	inExposureTime: int | None = None,
	inGain: float | None = None,
	inFrameRate: float | None = None,
	inAoi: Box | None = None,
	inTriggerMode: MvIMPACTTriggerActivation = MvIMPACTTriggerActivation.Off,
	inTriggerSource: MvIMPACTTriggerSource = MvIMPACTTriggerSource.Line4
)
-> (
	outResult: bool,
	outImage: Image | None
)

Parameters

Name Type Range Default Description
Input will be modified ioState MvGenTLAcquireState
Input value inDeviceID str | None None Device name or serial number of device
Input value inTimeout int 10 - 100 Maximum time to wait for frame in milliseconds
Input value inPixelFormat MVGenTLPixelFormat | None None Pixel format of output image
Input value inExposureTime int | None 1 - + None Exposure time value
Input value inGain float | None None Gain value
Input value inFrameRate float | None 1.0 - None Frame rate in FPS
Input value inAoi Box | None None Required fragment of image to stream
Input value inTriggerMode MvIMPACTTriggerActivation MvIMPACTTriggerActivation.Off Trigger mode
Input value inTriggerSource MvIMPACTTriggerSource MvIMPACTTriggerSource.Line4 Source of trigger
Output value outImage Image | None Captured frame

Multithreaded environment

This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.