CCIMXDesktop
 
Loading...
Searching...
No Matches
CameraCapture Class Reference

The CameraCapture class handles camera video capturing. More...

#include <CameraCapture.h>

Inheritance diagram for CameraCapture:

Public Types

enum class  Error { CAMERA_UNEXISTED , CAMERA_UNOPENED , CAMERA_UNBIND_DISPLAY , CAMERA_MULTI_OPENED }
 Error enum lists possible camera error cases. More...
 

Signals

void cameraOpened (int index)
 Signal emitted when camera is opened.
 
void cameraClosed (int index)
 Signal emitted when camera is closed.
 
void errorOccur (CameraCapture::Error e)
 Signal emitted when an error occurs.
 

Public Member Functions

 Q_DISABLE_COPY (CameraCapture)
 Q_DISABLE_COPY disables copy constructor and assignment operator.
 
 CameraCapture (const int index, QObject *parent=nullptr)
 Constructor with camera index.
 
 ~CameraCapture ()
 Destructor.
 
void bind_display_widget (CameraDisplayWidget *widget)
 Bind a display widget for camera output.
 
void set_capture_delay_time (const int gap_time)
 Set capture delay time in milliseconds.
 
bool isActivate () const
 Check if the camera is active.
 
bool start ()
 Start the camera capture session.
 
bool close ()
 Close the camera capture session.
 

Detailed Description

The CameraCapture class handles camera video capturing.

Member Enumeration Documentation

◆ Error

enum class CameraCapture::Error
strong

Error enum lists possible camera error cases.

Enumerator
CAMERA_UNEXISTED 

Camera does not exist.

CAMERA_UNOPENED 

Camera not opened.

CAMERA_UNBIND_DISPLAY 

Camera not bound to display widget.

CAMERA_MULTI_OPENED 

Camera already opened.

Constructor & Destructor Documentation

◆ CameraCapture()

CameraCapture::CameraCapture ( const int  index,
QObject *  parent = nullptr 
)
explicit

Constructor with camera index.

Parameters
indexValid index of the camera.
parentOptional QObject parent.

Member Function Documentation

◆ bind_display_widget()

void CameraCapture::bind_display_widget ( CameraDisplayWidget widget)
inline

Bind a display widget for camera output.

Parameters
widgetPointer to CameraDisplayWidget.

◆ cameraClosed

void CameraCapture::cameraClosed ( int  index)
signal

Signal emitted when camera is closed.

Parameters
indexCamera index.

◆ cameraOpened

void CameraCapture::cameraOpened ( int  index)
signal

Signal emitted when camera is opened.

Parameters
indexCamera index.

◆ close()

bool CameraCapture::close ( )

Close the camera capture session.

Returns
True if closed successfully.

◆ errorOccur

void CameraCapture::errorOccur ( CameraCapture::Error  e)
signal

Signal emitted when an error occurs.

Parameters
eError type.

◆ isActivate()

bool CameraCapture::isActivate ( ) const

Check if the camera is active.

Returns
True if active.

◆ set_capture_delay_time()

void CameraCapture::set_capture_delay_time ( const int  gap_time)
inline

Set capture delay time in milliseconds.

Parameters
gap_timeDelay time in ms.

◆ start()

bool CameraCapture::start ( )

Start the camera capture session.

Returns
True if started successfully.

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