FrameSnapSink.SnapSequence Method

Waits for several images to arrive and then returns the result.

Syntax:

[C#]
public IFrameQueueBuffer[]  SnapSequence( int count, TimeSpan timeout );
public IFrameQueueBuffer[]  SnapSequence( IEnumerable<IFrameQueueBuffer> buffersToSnapInto, TimeSpan timeout );

Parameter		Description


timeout		The time the sink waits for the new images to arrive. When the timeout elapses the buffers that were copied are returned.
count		The count of frames to create via and wait for.
buffersToSnapInto		A list of target buffers to copy the arriving data into. These buffers all must have the same FrameType as the sink. If not a ICException is thrown.

Returns:

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

When no IFrameQueueBuffer array was passed in, the sink creates this list of FrameQueueBuffers before waiting for new images from the device.

When the timeout elapsed, the buffers already filled are returned. This maybe fewer then requested via count or passed in via buffersToSnapInto.

Information:

Introduced in version 3.5

Example:

The following example shows how to use SnapSequence and reuse buffers to avoid allocating memory twice.

[C#]
FrameSnapSink sink = new FrameSnapSink(MediaSubtypes.RGB32);
ICImagingControl1.Sink = sink;
ICImagingControl1.LiveStart();
int index = 0;
IFrameQueueBuffer[] lst = sink.SnapSequence(5, TimeSpan.FromSeconds(5));
foreach( IFrameQueueBuffer frame in lst )
{
    // do something with each buffer
    frame.SaveAsBitmap(String.Format("test_{0}.bmp", index++));
}
// reusing buffers in a snap sink
IFrameQueueBuffer[] lst2 = sink.SnapSequence(lst, TimeSpan.FromSeconds(5));
// save the next buffer sequence
foreach( IFrameQueueBuffer frame in lst2 )
{
    // do something with each buffer
    frame.SaveAsBitmap(String.Format("test_{0}.bmp", index++));
}

<< FrameSnapSink