IC Imaging Control C++

FrameSnapSink::snapSequence Method

FrameSnapSink::snapSequence Method

This method lets the FrameSnapSink copy the next images to be recevied from the device into a collection of FrameQueueBuffers.
tFrameQueueBufferList  snapSequence( size_t count, int64_t timeout_in_ms = -1 );
Error                  snapSequence( tFrameQueueBufferList& rval, size_t count, int64_t timeout_in_ms = -1 );

Parameter Description

The number of images requested


Specifies the time the sink should wait for all images to be received from the device before returning with an timeout error.


This parameter will be filled with pointers to image buffers containing the images received from the device. If rval already contains pointers to image buffers, these image buffers are filled. Otherwise, the buffers allocated by a previous call to allocAndQueueBufferCache are used.

Return Value:

The first overload returns a list of pointer to filled buffers. If not all buffers could be filled before the timeout elapsed, this list might be shorter than count.

The second overload returns an error value describing whether the function call succeeded.


The buffers are either pre-allocated by calling allocAndQueueBufferCache, or supplied as the in/out parameter rval.

This method blocks until either all images have been received, or the specified timeout has elapsed.

This function can only be called after the device was started by calling Grabber::startLive.

See also: FrameSnapSink, FrameSnapSink::allocAndQueueBufferCache

<< FrameSnapSink

Get in touch with us

About The Imaging Source

Established in 1990, The Imaging Source is one of the leading manufacturers of industrial cameras, frame grabbers and video converters for production automation, quality assurance, logistics, medicine, science and security.

Our comprehensive range of cameras with USB 3.1, USB 3.0, USB 2.0, GigE interfaces and other innovative machine vision products are renowned for their high quality and ability to meet the performance requirements of demanding applications.

Automated Imaging Association ISO 9001:2015 certified

Contact us