Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » GenICam » GenICam_StartAcquisition


Initializes and starts image acquisition in a camera.

Name Type Range Description
inAddress GenAddress GenTL Provider module and device identifying address
inPixelFormat GenPixelFormat Requested Pixel Format in GenICam pixel naming convention
inInputQueueSize Integer 1 - 200 Number of incoming frames that can be buffered before the application is able to process them


Typically used for establishing camera connectivity before the first trigger event. Especially important for multiple-camera systems.


This filter is intended for establishing connection with a general camera device using dedicated driver software through a GenTL compliant interface, to initialize image streaming. It is only needed when explicit image acquisition start is required in the initial phase of a program. For example, it can be used to prepare a camera, running in triggered mode, to be able to capture trigger signals before the first invoke of GenICam_GrabImage or to start multiple cameras in sync before the acquisition phase.

The use of this filter is not obligatory. GenICam_GrabImage or GenICam_GrabImage_WithTimeout] filters will initialize and start image acquisition upon their first invoke. When this filter is used, the inPixelFormat parameter of subsequent GenICam_GrabImage and GenICam_GrabImage_WithTimeout filters has no effect.

This filter has no effect when invoked for the second time and when invoked after image grabbing filters unless acquisition has been explicitly stopped using GenICam_StopAcquisition.

Device address (inAddress port) is a structure of information defining unique device and its GenTL provider module in the system. It is recommended to use the GenTL Device Manager (click the "..." button in Filter Properties) to select the appropriate device, connected to the local system, whose identification information will be used.

Device address consists of the following fields:

  • VendorName - Vendor name of the GenTL provider module, which will be used to communicate with the device.
  • TLType - Identification code of interface transport technology type (for example "GEV", "IIDC", "UVC", "USB3", "PCI", "Custom"). The exact code depends on the GenTL provider module.
  • DeviceID - Unique ID of the device in the selected interface technology of the used provider module. The format of this field must be always an exact ID string and depends on the used GenTL provider module.

This filter will interpret the value of inAddress port only during the first iteration of its parent Task, when the connection to the device is established. During the next iterations the filter will use previously established connection and subsequent changes in the device address will be ignored.

Pixel format is a textual name of image pixel (color) format. The format name must correspond to one of the format names supported by the connected device or an error will be raised at program runtime. Use the GenTL Device Manager (click the "..." button in Filter Properties) to select a format name from the list of the formats supported by the connected device.

For general information about working with Gen TL devices, please refer to the following article.


  • Use this filter BEFORE the main task (the main loop) of your application.
  • Interactively select a camera available in your network by defining the inAddress input.
  • Choose inPixelFormat from those supported by your camera.

Complexity Level

This filter is available on Advanced Complexity Level.

See Also

  • GenICam_GrabImage – Captures an image stream from a camera using a GenICam GenTL provider library.
  • GenICam_GrabImage_WithTimeout – Captures an image stream from a camera using a GenICam GenTL provider library; returns Nil if no frame comes in the specified time.