Loading...
Searching...
No Matches
cv::v4d::Sink Class Reference

#include <opencv2/v4d/sink.hpp>

Public Member Functions

 Sink ()
 
 Sink (std::function< bool(const uint64_t &, const cv::UMat &)> consumer)
 
virtual ~Sink ()
 
bool isOpen ()
 
bool isReady ()
 
bool isThreadSafe ()
 
void operator() (const uint64_t &seq, const cv::UMat &frame)
 
void setThreadSafe (bool ts)
 

Detailed Description

A Sink object represents a way to write data produced by V4D (e.g. a video-file).

Constructor & Destructor Documentation

◆ Sink() [1/2]

cv::v4d::Sink::Sink ( std::function< bool(const uint64_t &, const cv::UMat &)>  consumer)

Consturcts the Sink object from a consumer functor.

Parameters
consumerA function object that consumes a UMat frame (e.g. writes it to a video file).

◆ Sink() [2/2]

cv::v4d::Sink::Sink ( )

Constucts a null Sink that is never open or ready

◆ ~Sink()

virtual cv::v4d::Sink::~Sink ( )
virtual

Default destructor

Member Function Documentation

◆ isOpen()

bool cv::v4d::Sink::isOpen ( )

Determines if the sink is open.

Returns
true if the sink is open.

◆ isReady()

bool cv::v4d::Sink::isReady ( )

Signals if the sink is ready to consume data.

Returns
true if the sink is ready.

◆ isThreadSafe()

bool cv::v4d::Sink::isThreadSafe ( )

◆ operator()()

void cv::v4d::Sink::operator() ( const uint64_t seq,
const cv::UMat frame 
)

The sink operator. It accepts a UMat frame to pass to the consumer

Parameters
frameThe frame to pass to the consumer. (e.g. VideoWriter)

◆ setThreadSafe()

void cv::v4d::Sink::setThreadSafe ( bool  ts)

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