OpenPose  1.0.0rc2
OpenPose: A Real-Time Multi-Person Key-Point Detection And Multi-Threading C++ Library
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Macros
Public Member Functions | List of all members
op::VideoReader Class Reference

#include <videoReader.hpp>

Inherits op::VideoCaptureReader.

Public Member Functions

 VideoReader (const std::string &videoPath)
 
std::string getFrameName ()
 
double get (const int capProperty)
 
void set (const int capProperty, const double value)
 
- Public Member Functions inherited from op::VideoCaptureReader
 VideoCaptureReader (const int index, const bool throwExceptionIfNoOpened)
 
 VideoCaptureReader (const std::string &path, const ProducerType producerType)
 
virtual ~VideoCaptureReader ()
 
bool isOpened () const
 
void release ()
 
double get (const ProducerProperty property)
 
void set (const ProducerProperty property, const double value)
 
- Public Member Functions inherited from op::Producer
 Producer (const ProducerType type)
 
virtual ~Producer ()
 
cv::Mat getFrame ()
 
void setProducerFpsMode (const ProducerFpsMode fpsMode)
 
ProducerType getType ()
 

Additional Inherited Members

- Protected Member Functions inherited from op::Producer
void checkFrameIntegrity (cv::Mat &frame)
 
void flipAndRotate (cv::Mat &cvMat) const
 
void ifEndedResetOrRelease ()
 
void keepDesiredFrameRate ()
 

Detailed Description

VideoReader is a wrapper of the cv::VideoCapture class for video. It allows controlling a video (e.g. extracting frames, setting resolution & fps, etc).

Constructor & Destructor Documentation

op::VideoReader::VideoReader ( const std::string &  videoPath)
explicit

Constructor of VideoReader. It opens the video as a wrapper of cv::VideoCapture. It includes a flag to indicate whether the video should be repeated once it is completely read.

Parameters
videoPathconst std::string parameter with the full video path location.

Member Function Documentation

double op::VideoReader::get ( const int  capProperty)
inlinevirtual

This function is a wrapper of cv::VideoCapture::get. It allows getting different properties of the Producer (fps, width, height, etc.). See the OpenCV documentation for all the available properties.

Parameters
capPropertyint indicating the property to be modified.
Returns
double returning the property value.

Implements op::VideoCaptureReader.

std::string op::VideoReader::getFrameName ( )
virtual

This function returns a unique frame name (e.g. the frame number for video, the frame counter for webcam, the image name for image directory reader, etc.).

Returns
std::string with an unique frame name.

Implements op::VideoCaptureReader.

void op::VideoReader::set ( const int  capProperty,
const double  value 
)
inlinevirtual

This function is a wrapper of cv::VideoCapture::set. It allows setting different properties of the Producer (fps, width, height, etc.). See the OpenCV documentation for all the available properties.

Parameters
capPropertyint indicating the property to be modified.
valuedouble indicating the new value to be assigned.

Implements op::VideoCaptureReader.

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