Conscience Core
Public Member Functions | Static Public Member Functions | List of all members
conscience_core::media_capture::CscCaptureEngine Class Reference

#include <CscCaptureEngine.h>

Public Member Functions

 CscCaptureEngine (const string &logPrefix="")
 
virtual ~CscCaptureEngine ()
 
void open (ptr< CscEntityVideoSource > videoSource)
 
Mat & getCurrentFrame ()
 
Mat getCurrentFrameClone ()
 
Mat & getProcessedFrame ()
 
Mat getProcessedFrameClone ()
 
Mat & getProcessedFrameMini ()
 
void close ()
 
bool isOpened () const
 
bool isOpening () const
 
bool isClosed () const
 
void populateProcessedImage (Mat image)
 
void updateCaptureProp (int prop, float value)
 
float getCapturePropValue (int prop)
 
optional< ResolutiongetRequestedResolution () const
 
optional< ResolutiongetActualResolution () const
 
CscEntityVideoSourceType getSourceType () const
 

Static Public Member Functions

static void writeImage (string path, Mat &image)
 

Constructor & Destructor Documentation

◆ CscCaptureEngine()

conscience_core::media_capture::CscCaptureEngine::CscCaptureEngine ( const string &  logPrefix = "")

◆ ~CscCaptureEngine()

conscience_core::media_capture::CscCaptureEngine::~CscCaptureEngine ( )
virtual

Member Function Documentation

◆ close()

void conscience_core::media_capture::CscCaptureEngine::close ( )

Closes video stream and release underlying resources. One must then call open(videoSource) to open a new stream on this capture engine.

◆ getActualResolution()

optional<Resolution> conscience_core::media_capture::CscCaptureEngine::getActualResolution ( ) const
inline

◆ getCapturePropValue()

float conscience_core::media_capture::CscCaptureEngine::getCapturePropValue ( int  prop)

◆ getCurrentFrame()

Mat & conscience_core::media_capture::CscCaptureEngine::getCurrentFrame ( )

Image as BGR

◆ getCurrentFrameClone()

Mat conscience_core::media_capture::CscCaptureEngine::getCurrentFrameClone ( )

get a thread safe copy of current frame - BGR

◆ getProcessedFrame()

Mat & conscience_core::media_capture::CscCaptureEngine::getProcessedFrame ( )

Image as BGR

◆ getProcessedFrameClone()

Mat conscience_core::media_capture::CscCaptureEngine::getProcessedFrameClone ( )

get a thread safe copy of processed frame - BGR

◆ getProcessedFrameMini()

Mat & conscience_core::media_capture::CscCaptureEngine::getProcessedFrameMini ( )

◆ getRequestedResolution()

optional<Resolution> conscience_core::media_capture::CscCaptureEngine::getRequestedResolution ( ) const
inline

◆ getSourceType()

CscEntityVideoSourceType conscience_core::media_capture::CscCaptureEngine::getSourceType ( ) const

◆ isClosed()

bool conscience_core::media_capture::CscCaptureEngine::isClosed ( ) const

Returns true if stream is closed

◆ isOpened()

bool conscience_core::media_capture::CscCaptureEngine::isOpened ( ) const

Returns true if stream is fully opened

◆ isOpening()

bool conscience_core::media_capture::CscCaptureEngine::isOpening ( ) const

Returns true if stream is currently trying to open

◆ open()

void conscience_core::media_capture::CscCaptureEngine::open ( ptr< CscEntityVideoSource videoSource)

Opens given video source for this capture engine. Use CscEntityVideoSource::xxx() to build a videoSource

Exceptions
Willthrow a CannotOpenVideoStreamException if videoSource cannot be opened

◆ populateProcessedImage()

void conscience_core::media_capture::CscCaptureEngine::populateProcessedImage ( Mat  image)

◆ updateCaptureProp()

void conscience_core::media_capture::CscCaptureEngine::updateCaptureProp ( int  prop,
float  value 
)

◆ writeImage()

void conscience_core::media_capture::CscCaptureEngine::writeImage ( string  path,
Mat &  image 
)
static

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