FrameSnapSink.SnapSingle Method |
|
Waits for a single image to arrive and then returns the result
|
| Syntax: |
|
[C#]
public IFrameQueueBuffer SnapSingle( TimeSpan timeout );
public IFrameQueueBuffer SnapSingle( IFrameQueueBuffer bufferToSnapInto, TimeSpan timeout );
|
|
|
|
|
| timeout |
|
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.
|
| bufferToSnapInto |
|
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.
|
|
| Returns: |
|
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.
|
| Information: | | Introduced in version 3.5
|
|
See also
: |
|
FrameSnapSink, IFrameQueueBuffer, ICException |