My Project
Classes | Public Member Functions | Friends | List of all members
CaptureDSCapture Class Reference

Implementation of Capture interface for DSCapture plugin. More...

#include <CapturePluginDSCapture.h>

Inheritance diagram for CaptureDSCapture:
Capture

Public Member Functions

 CaptureDSCapture (const CaptureDevice captureDevice)
 Constructor. More...
 
 ~CaptureDSCapture ()
 Destructor.
 
bool start ()
 Starts the camera capture. More...
 
void stop ()
 Stops the camera capture.
 
cv::Mat captureImage ()
 Capture one image from the camera. More...
 
bool showSettingsDialog ()
 Show the settings dialog of the camera. More...
 
std::string SerializeId ()
 The identification of the class for serialization.
 
bool Serialize (Serialization *serialization)
 Performs serialization of the class members and configuration. More...
 
- Public Member Functions inherited from Capture
 Capture (const CaptureDevice captureDevice)
 Constructor. More...
 
virtual ~Capture ()
 Destructor.
 
CaptureDevice captureDevice ()
 The camera information associated to this capture object.
 
unsigned long xResolution ()
 The resolution along the x axis (horizontal).
 
unsigned long yResolution ()
 The resolution along the y axis (vertical).
 
bool isCapturing ()
 Test if the camera was properly initialized.
 
virtual void setResolution (const unsigned long xResolution, const unsigned long yResolution)
 Set the resolution. More...
 
virtual bool saveSettings (std::string filename)
 Save camera settings to a file. More...
 
virtual bool loadSettings (std::string filename)
 Load camera settings from a file. More...
 

Friends

class VideoSampler
 

Additional Inherited Members

- Protected Attributes inherited from Capture
CaptureDevice mCaptureDevice
 
unsigned long mXResolution
 
unsigned long mYResolution
 
bool mIsCapturing
 

Detailed Description

Implementation of Capture interface for DSCapture plugin.

Note
The DSCapture plugin is currently experimental and not included in the build by default.

Definition at line 63 of file CapturePluginDSCapture.h.

Constructor & Destructor Documentation

◆ CaptureDSCapture()

CaptureDSCapture ( const CaptureDevice  captureDevice)

Constructor.

Parameters
captureDeviceInformation of which camera to create.

Member Function Documentation

◆ captureImage()

cv::Mat captureImage ( )
virtual

Capture one image from the camera.

Do not modify this image.

Returns
The captured image.

Implements Capture.

◆ Serialize()

bool Serialize ( Serialization serialization)
virtual

Performs serialization of the class members and configuration.

Parameters
serializationThe Serialization object.
Returns
True if the serialization of the class was successful, false otherwise.

Implements Capture.

◆ showSettingsDialog()

bool showSettingsDialog ( )
virtual

Show the settings dialog of the camera.

Returns
True if the settings dialog was shown, false otherwise.

Implements Capture.

◆ start()

bool start ( )
virtual

Starts the camera capture.

Returns
True if the camera was properly initialized, false otherwise.

Implements Capture.


The documentation for this class was generated from the following file: