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

AvsFilter_GigEVision_StartAcquisition

This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header:	Genicam.h
Namespace:	avs

Initializes and starts image acquisition in a device.

Syntax

void avs::AvsFilter_GigEVision_StartAcquisition
(
	GigEVision_GrabImage_State& ioState,
	const avl::GevAddress& inAddress,
	const avl::GevPixelFormat& inPixelFormat,
	int inInputQueueSize
)

Parameters

Name	Type	Range	Default	Description
ioState	GigEVision_GrabImage_State&			Object used to maintain state of the function.
inAddress	const GevAddress&			GigE Vision Device identifying address (IP, MAC or Serial Number)
inPixelFormat	const GevPixelFormat&		\"Mono8\"	Requested Pixel Format in GenICam pixel naming convention
inInputQueueSize	int	1 - 400	1	Number of incoming frames that can be buffered before the application is able to process them

Description

This filter is intended for establishing connection with a GigE Vision® compliant, single stream video transmitter and to initialize image streaming. It is only needed when explicit image acquisition start is required in the initial phase of a program or when explicitly stopping and starting the image acquisition during a program lifetime. For example, it can be used to prepare a camera, running in a triggered mode, to be able to capture trigger signals before the first invoke of AvsFilter_GigEVision_GrabImage or to start multiple cameras in sync before the acquisition phase.

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 GigEVision_StopAcquisition.

Device address (inAddress port) is a textual definition of either IP, MAC or serial number. Use Device Manager to select appropriate address of connected device.

This filter will interpret the value of inAddress port only during the first iteration, 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 Device Manager to select a format name from the list of formats supported by the connected device.

For general information about working with GigE Vision devices, please refer to the following article.

Hints

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.