IC Imaging Control .NET

FrameSnapSink.SnapSingle Method

FrameSnapSink.SnapSingle Method

Waits for a single image to arrive and then returns the result
public IFrameQueueBuffer SnapSingle( TimeSpan timeout ); public IFrameQueueBuffer SnapSingle( IFrameQueueBuffer bufferToSnapInto, TimeSpan timeout );
Parameter Description

Contains the maximum time the sink waits for a new image to arrive. When the timeout elapses ICException is thrown.

Note: This time does not take into account any time it spends on creating IFrameQueueBuffer instances.


A target buffer to copy the arriving data into. This buffer must have the same FrameType as the sink. If not a ICException is thrown.


On success returns a IFrameQueueBuffer that was filled with the data of the frame that just came in.

When no IFrameQueueBuffer was passed in, the sink creates a FrameQueueBuffer before waiting for a new image from the device.


Introduced in version 3.5

See also : FrameSnapSink, IFrameQueueBuffer, ICException

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