JompegRecord Class Reference

An jo_mpeg based Record. More...

#include <jompegRecord.h>

Inheritance diagram for JompegRecord:

Collaboration diagram for JompegRecord:

Public Member Functions
	JompegRecord (std::filesystem::path file, glm::ivec2 resolution, uint8_t fps)
	Construct a new jo_mpeg based Record from a file path, resolution and fps.
	~JompegRecord ()
void	open ()
	Open the video file.
void	close ()
	Close the video file.
Public Member Functions inherited from Record
	Record (std::filesystem::path file, glm::ivec2 resolution, uint8_t fps)
	Construct a new Record from a file path, resolution and fps.
virtual	~Record ()
void	queueFrame (std::vector< uint8_t > pixels)
	Enqueue a frame to be written.
uint8_t	queueSize ()
	Number of frames yet to be sent for writing.
uint64_t	framesLeft ()
	Number of frame left to be written in total.
void	writeFrames ()
	Send the frames in the buffer for writing.
bool	isWriting () const
	If the video is being written to in the background.
bool	isOpen () const
	If the file is open.
bool	finalise ()
	Check if finalised.

Additional Inherited Members
Protected Member Functions inherited from Record
void	writeBuffer ()
Protected Attributes inherited from Record
std::filesystem::path	file
glm::ivec2	resolution
uint8_t	fps
bool	fileOpen = false
bool	writing = false
std::vector< std::vector< uint8_t > >	inBuffer
std::vector< std::vector< uint8_t > >	outBuffer

Detailed Description

An jo_mpeg based Record.

Remarks

Records to mpg.

Generally lower quality than FFmpeg but no additional runtime dependencies are required.

Constructor & Destructor Documentation

JompegRecord()

JompegRecord::JompegRecord ( std::filesystem::path  file, glm::ivec2  resolution, uint8_t  fps  )

inline

Construct a new jo_mpeg based Record from a file path, resolution and fps.

Parameters

file	the video file path.
resolution	the resolution.
fps	the frames per second.

~JompegRecord()

JompegRecord::~JompegRecord ( )

inline

Member Function Documentation

close()

void JompegRecord::close ( )

inlinevirtual

Close the video file.

Remarks

including trailer writing etc.

Implements Record.

open()

void JompegRecord::open ( )

inlinevirtual

Open the video file.

Remarks

including header writing etc.

Implements Record.

---

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

• include/jompegRecord.h