AVIRecordingStrategy Class Reference

Concrete strategy for a AVI video recording. More...

#include <VisionX/libraries/imrec/record/strats/AVIRecordingStrategy.h>

+ Inheritance diagram for AVIRecordingStrategy:

Public Member Functions

 AVIRecordingStrategy ()
 
 AVIRecordingStrategy (const std::filesystem::path &filePath, const std::string &name, double fps)
 
void recordFrame (const cv::Mat &frame, std::chrono::microseconds timestamp) override
 Adds the given frame to the recording. More...
 
void startRecording () override
 Starts the recording manually if constructed empty. More...
 
void stopRecording () override
 Stops the recording. More...
 
 ~AVIRecordingStrategy () override
 
- Public Member Functions inherited from AbstractRecordingStrategy
 AbstractRecordingStrategy ()
 Default constructor to start the recording manually. More...
 
 AbstractRecordingStrategy (const std::filesystem::path &filePath)
 Constructor for any recording strategy, immediately starting the recording. More...
 
virtual std::filesystem::path getDotExtension () const
 Gets the extension plus preceeded dot of the configured file (e.g. More...
 
virtual std::filesystem::path getFilePath () const
 Gets the raw file path for the recording as configured. More...
 
virtual std::filesystem::path getMetadataPath () const
 
virtual std::filesystem::path getPath () const
 Gets the path to the recording without filename. More...
 
virtual std::filesystem::path getStem () const
 Gets the stem of the configured file (filename without extension) More...
 
virtual bool isRecording () const
 Indicates whether this instance is already initialised for recording. More...
 
virtual void recordFrame (const CByteImage &frame, std::chrono::microseconds timestamp)
 Adds the given frame to the recording. More...
 
virtual void writeMetadataDatetime (const std::string &var_name, std::chrono::microseconds timestamp)
 
virtual std::tuple< unsigned int, std::string > writeMetadataFrame (const CByteImage &frame, std::chrono::microseconds timestamp)
 
virtual std::tuple< unsigned int, std::string > writeMetadataFrame (const cv::Mat &frame, std::chrono::microseconds timestamp)
 
virtual void writeMetadataLine (const std::string &var_name, std::string_view var_type, std::string_view var_value)
 
virtual ~AbstractRecordingStrategy ()
 Destructor. More...
 

Protected Attributes

std::unique_ptr< cv::VideoWriter > m_avi_video_writer
 
double m_fps
 
- Protected Attributes inherited from AbstractRecordingStrategy
std::filesystem::path m_file_path
 Path to where the recording file should be written to. More...
 

Detailed Description

Concrete strategy for a AVI video recording.

Definition at line 48 of file AVIRecordingStrategy.h.

Constructor & Destructor Documentation

◆ AVIRecordingStrategy() [1/2]

Definition at line 35 of file AVIRecordingStrategy.cpp.

◆ AVIRecordingStrategy() [2/2]

AVIRecordingStrategy ( const std::filesystem::path &  filePath,
const std::string &  name,
double  fps 
)

Definition at line 41 of file AVIRecordingStrategy.cpp.

◆ ~AVIRecordingStrategy()

~AVIRecordingStrategy ( )
override

Definition at line 55 of file AVIRecordingStrategy.cpp.

Member Function Documentation

◆ recordFrame()

void recordFrame ( const cv::Mat &  frame,
std::chrono::microseconds  timestamp 
)
overridevirtual

Adds the given frame to the recording.

Parameters
frameFrame to be added

Reimplemented from AbstractRecordingStrategy.

Definition at line 70 of file AVIRecordingStrategy.cpp.

+ Here is the call graph for this function:

◆ startRecording()

void startRecording ( )
overridevirtual

Starts the recording manually if constructed empty.

Parameters
filePathPath to where the recording file should be written to
fpsAmount of frames being recorded per second

Reimplemented from AbstractRecordingStrategy.

Definition at line 62 of file AVIRecordingStrategy.cpp.

+ Here is the call graph for this function:

◆ stopRecording()

void stopRecording ( )
overridevirtual

Stops the recording.

Reimplemented from AbstractRecordingStrategy.

Definition at line 92 of file AVIRecordingStrategy.cpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_avi_video_writer

std::unique_ptr<cv::VideoWriter> m_avi_video_writer
protected

Definition at line 55 of file AVIRecordingStrategy.h.

◆ m_fps

double m_fps
protected

Definition at line 54 of file AVIRecordingStrategy.h.


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