Back to Aurora Vision Studio website

You are here: Start » Filter Reference » GigE Vision » GigEVision_StopAcquisition

GigEVision_StopAcquisition


Module: Genicam

Stops image acquisition in a device.

Name Type Description
Input value inAddress GevAddress GigE Vision Device identifying address (IP, MAC or Serial Number)

Description

This filter is intended for stopping acquisition in a GigE Vision® compliant, single stream video transmitter. It is only needed when implementing explicit stopping and starting of the image acquisition during a program lifetime.

This filter will usually be executed when image acquisition in a camera is already active (after filters like GigEVision_GrabImage or GigEVision_StartAcquisition has been executed). After its execution the image acquisition in a camera and on the application level will be stopped and all image data remaining in the input queue will be discarded. Image acquisition can be reestablished later by executing the GigEVision_GrabImage, GigEVision_GrabImage_WithTimeout or GigEVision_StartAcquisition filters (pixel format and image input queue size parameters will be configured again by those filters).

This filter can be used to stop an image acquisition in order to change some of the camera configuration parameters (that are locked during acquisition), to stop image acquisition after all frames has been received in Single Frame or Multi Frame acquisition modes (image acquisition must be stopped before starting it to receive next batch of frames in those modes), or to stop image acquisition in a camera when the application enters a state where image from a given camera is not needed.

This filter has no effect when invoked while the camera is not in the image acquisition state.

Device address (inAddress port) is a textual definition of either IP, MAC or serial number. Use Device Manager (click "..." button in filter properties) to select appropriate address of connected device. For information on address type meaning and selecting device address see Device manager section in user manual.

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.

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

To learn more about camera acquisition thread works please go to this article.

Complexity Level

This filter is available on Advanced Complexity Level.

See Also

  • Application Notes - set of documents about connecting devices or establishing communication with Aurora Vision Studio.