AcquisitionExtensionsWaitForAsync Method

CVB.Net Documentation
Waits for the given timeSpan for the next acquired image.

Namespace:  Stemmer.Cvb.Async
Assembly:  Stemmer.Cvb (in Stemmer.Cvb.dll) Version: 14.0.0.0
Syntax
Copy
public static Task<StreamImage> WaitForAsync(
	this IAcquisition acq,
	UsTimeSpan timeSpan
)

Parameters

acq
Type: Stemmer.Cvb.DriverIAcquisition
Stream to work on.
timeSpan
Type: Stemmer.Cvb.UtilitiesUsTimeSpan
Time span to wait for (millisecond granularity).

Return Value

Type: TaskStreamImage
Task to contain the grabbed image.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IAcquisition. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Remarks

Attention: it is generally not safe to call the wait method from different threads on the same object!

Dispose the returned Image when not needed anymore!

By default the returned image content is only guaranteed to stay unchanged until the next call to this method; afterwards the returned image is normally disposed. Thus it is normally not save to use this image in a display.

The returned image is not necessary the newest. If more images where acquired since the last call to this method, the content is the oldest not collected image buffer by default.

This method uses an asynchronous wrapper to make asynchronous handling easier with the CVB acquisition engine. As a side effect using this interface is not as efficient as calling WaitFor(UsTimeSpan) directly.

See Also

Reference

AcquisitionExtensions Class
Stemmer.Cvb.Async Namespace