Represents one acquisition stream of a Device.
Inheritance Hierarchy
Stemmer.Cvb.DriverStream
Stemmer.Cvb.DriverIndexedStream
Namespace: Stemmer.Cvb.Driver
Assembly: Stemmer.Cvb (in Stemmer.Cvb.dll) Version: 14.0.0.0
Syntax
public abstract class Stream : IAcquisition, IDeviceInterface, IObservable<StreamImage>, IDisposable
The Stream type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | AcquisitionInterface |
Gets or sets the acquisition interface to use on this stream.
|
| IsIndexed |
Gets whether this stream is an IndexedStream.
|
| IsRunning |
Gets whether the acquisition is currently active.
|
| Parent |
Gets the parent Device.
|
| RingBuffer |
Gets the IRingBuffer interface object if present.
|
| Statistics |
Gets the available device statistics
|
Methods
| Name | Description | |
|---|---|---|
 | Abort |
Stops the acquisition of images immediately.
|
| Dispose |
IDisposable implementation.
|
 | Dispose(Boolean) |
IDispose helper function.
|
| Equals | (Inherited from Object.) |
| Finalize |
Finalizer.
(Overrides ObjectFinalize.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetSnapshot |
Acquires a single image and returns it.
|
| GetTimedSnapshot(UsTimeSpan) |
Acquires a single image and returns it.
|
| GetTimedSnapshot(UsTimeSpan, WaitStatus) |
As GetTimedSnapshot(UsTimeSpan), but does not throw on
timeout.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MakeSnapshotImage |
Factory function for creating the returned image from the acquisition
engine.
|
| MakeStreamImage |
Factory function for creating the returned image from the acquisition
engine.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ObservableAcquisitionLoop |
This is the acquisition loop for
Subscribe(IObserverStreamImage)d observers.
|
| SendCompleteToObservers |
Calls OnCompleted on all subscribed
observers.
|
| SendErrorToObservers |
Calls OnError(Exception) on all subscribed
observers.
|
| SendImageToObservers |
Calls OnNext(T) with the given
image.
|
| Start |
Starts the acquisition.
|
| Stop |
Stops the acquisition.
|
| Subscribe |
Notifies this stream that the given observer is to
receive new image notifications.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TryAbort |
Tries to stop the acquisition of images immediately.
|
| TryStop |
Tries to stop the acquisition of images.
|
| Wait |
Waits for indefinitely for the next acquired image and returns it.
|
| Wait(WaitStatus) |
Waits for indefinitely for the next acquired image and returns it.
|
| WaitFor(UsTimeSpan) |
Waits for the given timeSpan for the next acquired
image.
|
| WaitFor(UsTimeSpan, WaitStatus) |
As WaitFor(UsTimeSpan), but does not throw on timeout.
|
Fields
| Name | Description | |
|---|---|---|
  | MaxTimeoutValue |
Gets the maximal timeout a device normally supports.
|
Extension Methods
| Name | Description | |
|---|---|---|
 | GetSnapshotAsync |
Acquires a single image and returns it.
(Defined by AcquisitionExtensions.) |
| GetTimedSnapshotAsync |
Acquires a single image and returns it.
(Defined by AcquisitionExtensions.) |
| WaitAsync |
Waits infinitely for the next acquired image and returns it.
(Defined by AcquisitionExtensions.) |
| WaitForAsync |
Waits for the given timeSpan for the next acquired
image.
(Defined by AcquisitionExtensions.) |
See Also