ICImagingControl_StartAcquisition


Initializes and starts image acquisition in a camera.

Syntax

C++
Python
 
def ICImagingControl_StartAcquisition(
	state: ICImagingControlState,
	/,
	*,
	inDeviceID: str | None = None,
	inInputQueueSize: int = 3,
	inPixelFormat: ICImagingControlColorFormat = ICImagingControlColorFormat.BGR8,
	inBinning: int | None = None,
	inSkipping: int | None = None,
	inRoi: Box | None = None,
	inFrameRate: float | None = None,
	inGain: int | None = None,
	inGainAuto: bool | None = None,
	inExposure: float | None = None,
	inExposureAuto: bool | None = None,
	inGamma: int | None = None,
	inSharpness: int | None = None,
	inFocus: int | None = None
)
-> None

Parameters

Name Type Range Default Description
Input will be modified ioState ICImagingControlState
Input value inDeviceID str | None None Serial number, display name, unique name or base name of the camera
Input value inInputQueueSize int 1 - + 3
Input value inPixelFormat ICImagingControlColorFormat ICImagingControlColorFormat.BGR8 Pixel format
Input value inBinning int | None 2 - 64 None Skipping factor
Input value inSkipping int | None 2 - 64 None Binning factor
Input value inRoi Box | None None Hardware Region of Interest
Input value inFrameRate float | None 0.5 - None Camera frame rate
Input value inGain int | None 0 - + None Gain value
Input value inGainAuto bool | None None Enable auto gain
Input value inExposure float | None 0.0D - None Exposure time
Input value inExposureAuto bool | None None Enable auto exposure
Input value inGamma int | None 0 - + None Gamma value
Input value inSharpness int | None 0 - + None Sharpness value
Input value inFocus int | None 0 - + None Focus value

Multithreaded environment

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