op::IpCameraReader Class Reference

#include <ipCameraReader.hpp>

Inheritance diagram for op::IpCameraReader:

Public Member Functions
	IpCameraReader (const std::string &cameraPath, const std::string &cameraParameterPath="", const bool undistortImage=false)
virtual	~IpCameraReader ()
std::string	getNextFrameName ()
bool	isOpened () const
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, const std::string &cameraParameterPath, const bool undistortImage, const int numberViews)
	VideoCaptureReader (const std::string &path, const ProducerType producerType, const std::string &cameraParameterPath, const bool undistortImage, const int numberViews)
virtual	~VideoCaptureReader ()
void	release ()
Public Member Functions inherited from op::Producer
	Producer (const ProducerType type, const std::string &cameraParameterPath, const bool undistortImage, const int mNumberViews)
virtual	~Producer ()
Matrix	getFrame ()
std::vector< Matrix >	getFrames ()
virtual std::vector< Matrix >	getCameraMatrices ()
virtual std::vector< Matrix >	getCameraExtrinsics ()
virtual std::vector< Matrix >	getCameraIntrinsics ()
void	setProducerFpsMode (const ProducerFpsMode fpsMode)
ProducerType	getType ()
double	get (const ProducerProperty property)
void	set (const ProducerProperty property, const double value)

Additional Inherited Members
Protected Member Functions inherited from op::VideoCaptureReader
void	resetWebcam (const int index, const bool throwExceptionIfNoOpened)
Protected Member Functions inherited from op::Producer
void	checkFrameIntegrity (Matrix &frame)
void	ifEndedResetOrRelease ()
void	keepDesiredFrameRate ()

Detailed Description

IpCameraReader is a wrapper of the cv::VideoCapture class for IP camera streaming.

Definition at line 12 of file ipCameraReader.hpp.

Constructor & Destructor Documentation

IpCameraReader()

op::IpCameraReader::IpCameraReader ( const std::string &  cameraPath, const std::string &  cameraParameterPath = "", const bool  undistortImage = false  )

explicit

Constructor of IpCameraReader. It opens the IP camera as a wrapper of cv::VideoCapture.

Parameters

cameraPath

const std::string parameter with the full camera IP link.

~IpCameraReader()

virtual op::IpCameraReader::~IpCameraReader ( )

virtual

Member Function Documentation

get()

double op::IpCameraReader::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

capProperty

int indicating the property to be modified.

Returns

double returning the property value.

Implements op::VideoCaptureReader.

Definition at line 31 of file ipCameraReader.hpp.

getNextFrameName()

std::string op::IpCameraReader::getNextFrameName ( )

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.

isOpened()

bool op::IpCameraReader::isOpened ( ) const

inlinevirtual

This function returns whether the Producer instance is still opened and able to retrieve more frames.

Returns

bool indicating whether the Producer is opened.

Reimplemented from op::VideoCaptureReader.

Definition at line 26 of file ipCameraReader.hpp.

set()

void op::IpCameraReader::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

capProperty	int indicating the property to be modified.
value	double indicating the new value to be assigned.

Implements op::VideoCaptureReader.

Definition at line 36 of file ipCameraReader.hpp.

---

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

• include/openpose/producer/ipCameraReader.hpp