CVB.Net 14.0
VideoDevice Class Reference

A Device representing a video stream from the hard disk. More...

Inherits Device.

Static Public Attributes

static readonly UsTimeSpan DefaultTimeoutValue = UsTimeSpan.FromMilliseconds(1500)
 Default timeout value for the Stream.WaitFor(UsTimeSpan) methods.
 

Protected Member Functions

override void Dispose (bool disposing)
 Additionally disposes the associated VideoImage if present. More...
 
- Protected Member Functions inherited from Device
 Device (IntPtr handle, string resourceLocator)
 Creates the device from the given CVB object handle . More...
 
virtual void Dispose (bool disposing)
 IDispose helper function. More...
 

Properties

PlaybackMode PlaybackMode [get, set]
 Gets or sets how images are delivered by the stream. More...
 
override int StreamCount [get]
 Number of streams of this device.
 
override Stream Stream [get]
 The stream of this device.
 
double ReplayRateMin [get]
 Gets the minimal possible replay rate.
 
double ReplayRateMax [get]
 Gets the maximal possible replay rate.
 
double ReplayRate [get, set]
 Gets or sets the current replay rate. More...
 
VideoImage VideoImage [get]
 Gets the VideoImage of this video device. More...
 
override DeviceImage DeviceImage [get]
 Alias for the VideoImage property.
 
- Properties inherited from Device
bool IsDisposed [get]
 Tests if the native handle has already been disposed. More...
 
IntPtr Handle [get]
 Gets the native CVB object handle. More...
 
string ResourceLocator [get]
 Gets the access token or path of the file name including its extension. More...
 
virtual Guid DriverGuid [get]
 Get the globally unique identifier of a CVB driver. More...
 
virtual TriggerState TriggerMode [get, set]
 Gets or sets the trigger mode of the device if possible. More...
 
abstract int StreamCount [get]
 Number of streams this device has.
 
abstract Driver.Stream Stream [get]
 Convenience property to access the first stream if present. More...
 
abstract DeviceImage DeviceImage [get]
 Gets, if available, the device image pointing to the latest synchronized image. More...
 
virtual IDeviceControl DeviceControl [get]
 Gets the IDeviceControl interface if present. More...
 
virtual IDigitalIO DigitalIO [get]
 Gets the IDigitalIO interface object if present. More...
 
virtual ISoftwareTrigger SoftwareTrigger [get]
 Gets the ISoftwareTrigger interface object if present. More...
 
DeviceNodeMapDictionary NodeMaps [get]
 Gets the dictionary holding all available NodeMaps. More...
 
virtual IRegPort RegPort [get]
 Gets the register port interface of this device if present. More...
 
virtual IImageRect ImageRect [get]
 Gets the IImageRect interface object if present. More...
 
NotifyDictionary Notify [get]
 Gets the INotify INotifyObservables if present. More...
 
virtual ConnectionState ConnectionState [get, protected set]
 Gets the current Cvb.ConnectionState of this Device object.
 
- Properties inherited from INativeHandle
IntPtr Handle [get]
 The native handle of the object.
 
bool IsDisposed [get]
 Possibility to check whether the object has already been disposed of.
 

Additional Inherited Members

- Public Member Functions inherited from Device
void Dispose ()
 IDisposable implementation. More...
 
- Protected Attributes inherited from Device
readonly object LockAnchor = new object()
 Lock anchor for device specific thread synchronization.
 
- Events inherited from Device
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method. More...
 
EventHandler< PropertyValueChangedEventArgs< IntPtr > > HandleChange
 Fired if the native Handle changes due to an operation. More...
 
EventHandler< ConnectionStateChangeEventArgsConnectionStateChanged
 Event that is fired when the ConnectionState changes.
 
- Events inherited from INativeHandle
NativeHandleEventDelegate ObjectDisposing
 Raised when this object is about to be disposed via the IDisposable.Dispose method.
More...
 

Detailed Description

A Device representing a video stream from the hard disk.

Member Function Documentation

◆ Dispose()

override void Dispose ( bool  disposing)
protectedvirtual

Additionally disposes the associated VideoImage if present.

Parameters
disposing

Reimplemented from Device.

Property Documentation

◆ PlaybackMode

Gets or sets how images are delivered by the stream.

Exceptions
InvalidOperationExceptionChanging the acquisition interface while grabbing is not allowed.

◆ ReplayRate

double ReplayRate
getset

Gets or sets the current replay rate.

The replay rate must be in between ReplayRateMin and ReplayRateMax and is a factor that is applied to the individual frame time.

◆ VideoImage

Gets the VideoImage of this video device.

The returned video image always points to the current location of the video stream.