JAI_GrabImage_WithTimeout


Captures an image using a JAI device with timeout.

Syntax

C++
Python
 
def JAI_GrabImage_WithTimeout(
	state: JAI_State,
	inTimeout: int,
	/,
	*,
	inDeviceID: str | None = None,
	inInputQueueSize: int = 12,
	inPixelFormat: EBUSPixelFormat | None = None,
	inAoi: Box | None = None,
	inAcquisitionMode: EBUSAcquisitionMode | None = None,
	inAcquisitionFrameCount: int | None = None,
	inFrameRate: float | None = None,
	inExposureAuto: EBUSAutoExposureMode | None = None,
	inExposureTime: float | None = None,
	inGainAuto: EBUSAutoGainMode | None = None,
	inGain: float | None = None,
	inTriggerSource: EBUSTriggerSource | None = None,
	inTriggerActivation: EBUSTriggerActivation | None = None,
	inSkipInvalidFrames: bool = True,
	inTryReconnection: bool = True
)
-> (
	outResult: bool,
	outImage: Image | None,
	outFrameData: EBUSFrameData | None
)

Parameters

Name Type Range Default Description
Input will be modified ioState JAI_State
Input value inDeviceID str | None None Device identifying number
Input value inTimeout int 100 - Maximum time to wait for frame in milliseconds
Input value inInputQueueSize int 1 - 12 Capacity of output frames queue
Input value inPixelFormat EBUSPixelFormat | None None Image pixel format
Input value inAoi Box | None None Area of interest
Input value inAcquisitionMode EBUSAcquisitionMode | None None Acquisition mode
Input value inAcquisitionFrameCount int | None 1 - 65535 None Number of frames to acquire in MultiFrame acquisition mode
Input value inFrameRate float | None 0.125D - None Acquisition frame rate
Input value inExposureAuto EBUSAutoExposureMode | None None Automatic exposure mode
Input value inExposureTime float | None 1.0D - None Exposure time in us
Input value inGainAuto EBUSAutoGainMode | None None Automatic gain mode
Input value inGain float | None 1.0D - None Gain as an absolute physical value
Input value inTriggerSource EBUSTriggerSource | None None Trigger source
Input value inTriggerActivation EBUSTriggerActivation | None None Trigger activation mode
Input value inSkipInvalidFrames bool True Skipping invalid images
Input value inTryReconnection bool True Try to reconnect if the camera is disconnected
Output value outImage Image | None Captured frame
Output value outFrameData EBUSFrameData | None Captured frame data