Click or drag to resize
Accord.NET (logo)

XimeaVideoSource Class

The class provides continues access to XIMEA cameras.
Inheritance Hierarchy
SystemObject
  Accord.Video.XimeaXimeaVideoSource

Namespace:  Accord.Video.Ximea
Assembly:  Accord.Video.Ximea (in Accord.Video.Ximea.dll) Version: 3.8.0
Syntax
public class XimeaVideoSource : IVideoSource
Request Example View Source

The XimeaVideoSource type exposes the following members.

Constructors
  NameDescription
Public methodXimeaVideoSource
Initializes a new instance of the XimeaVideoSource class.
Top
Properties
  NameDescription
Public propertyBytesReceived
Received bytes count.
Public propertyFrameInterval
Time interval between frames.
Public propertyFramesReceived
Received frames count.
Public propertyIsRunning
State of the video source.
Public propertySource
A string identifying the video source.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetParamFloat
Get camera's parameter as float value.
Public methodGetParamInt
Get camera's parameter as integer value.
Public methodGetParamString
Get camera's parameter as string value.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetParam(String, Int32)
Set camera's parameter.
Public methodSetParam(String, Single)
Set camera's parameter.
Public methodSignalToStop
Signal video source to stop its work.
Public methodStart
Start video source.
Public methodStop
Stop video source.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWaitForStop
Wait for video source has stopped.
Top
Events
  NameDescription
Public eventNewFrame
New frame event.
Public eventPlayingFinished
Video playing finished event.
Public eventVideoSourceError
Video source error event.
Top
Extension Methods
  NameDescription
Public Extension MethodHasMethod
Checks whether an object implements a method with the given name.
(Defined by ExtensionMethods.)
Public Extension MethodIsEqual
Compares two objects for equality, performing an elementwise comparison if the elements are vectors or matrices.
(Defined by Matrix.)
Public Extension MethodTo(Type)Overloaded.
Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.)
Public Extension MethodToTOverloaded.
Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.)
Top
Remarks

The video source class is aimed to provide continues access to XIMEA camera, when images are continuosly acquired from camera and provided throw the NewFrame event. It just creates a background thread and gets new images from XIMEA camera keeping the specified time interval between image acquisition. Essentially it is a wrapper class around XimeaCamera providing IVideoSource interface.

Sample usage:

// create video source for the XIMEA camera with ID 0
XimeaVideoSource videoSource = new XimeaVideoSource( 0 );
// set event handlers
videoSource.NewFrame += new NewFrameEventHandler( video_NewFrame );
// start the video source
videoSource.Start( );

// set exposure time to 10 milliseconds
videoSource.SetParam( CameraParameter.Exposure, 10 * 1000 );

// ...

// New frame event handler, which is invoked on each new available video frame
private void video_NewFrame( object sender, NewFrameEventArgs eventArgs )
{
    // get new frame
    Bitmap bitmap = eventArgs.Frame;
    // process the frame
}
See Also