Companion  1.0.0
Companion is an object recognition framework written with OpenCV.
Public Member Functions | List of all members
Companion::Input::Video Class Reference

#include <Video.h>

Inheritance diagram for Companion::Input::Video:
Inheritance graph
[legend]
Collaboration diagram for Companion::Input::Video:
Collaboration graph
[legend]

Public Member Functions

 Video (int device)
 
 Video (std::string url)
 
virtual ~Video ()=default
 
cv::Mat ObtainImage ()
 
bool IsFinished ()
 
void Finish ()
 

Detailed Description

Video streaming OpenCV realization to obtain images from a video or a live stream.

Author
Andreas Sekulski, Dimitri Kotlovsky

Constructor & Destructor Documentation

◆ Video() [1/2]

Companion::Input::Video::Video ( int  device)

Connect to a given physical video device.

Parameters
deviceDevice number to connect to.
Exceptions
Companion::Error::Codeif wrong device number is selected.

◆ Video() [2/2]

Companion::Input::Video::Video ( std::string  url)

Play a video stream from the given URL.

Parameters
urlPath to video stream.
Exceptions
Companion::Error::Codeif invalid URL is used.

◆ ~Video()

virtual Companion::Input::Video::~Video ( )
virtualdefault

Destructor.

Member Function Documentation

◆ Finish()

void Companion::Input::Video::Finish ( )
virtual

Stop this video stream.

Implements Companion::Input::Stream.

◆ IsFinished()

bool Companion::Input::Video::IsFinished ( )
virtual

Indicator if stream has finished.

Returns
True if video has finished otherwise false.

Implements Companion::Input::Stream.

◆ ObtainImage()

cv::Mat Companion::Input::Video::ObtainImage ( )
virtual

Obtain next image from open video stream.

Returns
An empty cv::Mat object if no image is obtained otherwise a cv::Mat entity from the obtained image.

Implements Companion::Input::Stream.


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