Back to FabImage Library website

You are here: Start » Function Reference » GigE Vision » GigEVision_StartAcquisition

GigEVision_StartAcquisition


Header: Genicam.h
Namespace: fil
Module: Genicam

Initializes and starts image acquisition in a device.

Applications: Typically used for initialization of multi-camera systems.

Syntax

C++
C#
 
void fil::GigEVision_StartAcquisition
(
	GigEHandle inDeviceHandle,
	const ftl::String& inPixelFormat,
	int inInputQueueSize = 1
)

Parameters

Name Type Range Default Description
Input value
 inDeviceHandle GigEHandle Handle of an opened device that should start acquisition.
Input value
 inPixelFormat const String& Pixel format name in GenICam naming convention that will be configured as device stream PixelFormat parameter.
Input value
 inInputQueueSize int 1 - 400 1 Capacity of queue of input frames.

Description

This function sets up the device to stream with specified pixel format, prepares internal buffers for stream and starts acquisition in device by executing StartAcquisition command.

Set inPixelFormat parameter to empty string to leave current device pixel format unchanged.

Use GigEVision_GetPixelFormats function to determine device supported pixel formats and their names.

Do not access GenICam StartAcquisition and StopAcquisition commands directly, always use GigEVision_StartAcquisition and GigEVision_StopAcquisition functions so that the library state can stay in sync with device state.

Exceptions

This function will throw an exception in the following situations:

  • Device handle is invalid.
  • Device is not a video transmitter.
  • Specified pixel format name is not supported by device.
  • Device connection is lost.
  • Other unexpected GenICam error or device setup error occurred.

See Also