INDI::RecorderInterface Class Reference

The RecorderInterface class is the base class for recorders. More...

#include <recorderinterface.h>

Inheritance diagram for INDI::RecorderInterface:

Public Member Functions
	RecorderInterface ()=default
virtual	~RecorderInterface ()=default
virtual const char *	getName ()
virtual const char *	getExtension ()=0
virtual bool	setPixelFormat (INDI_PIXEL_FORMAT pixelFormat, uint8_t pixelDepth=8)=0
virtual bool	setSize (uint16_t width, uint16_t height)=0
virtual bool	setFPS (float FPS)
virtual bool	open (const char *filename, char *errmsg)=0
virtual bool	close ()=0
virtual bool	writeFrame (const uint8_t *frame, uint32_t nbytes, uint64_t timestamp)=0
virtual void	setStreamEnabled (bool enable)=0

Protected Attributes
const char *	name
float	m_FPS = 1

Detailed Description

The RecorderInterface class is the base class for recorders.

Definition at line 56 of file recorderinterface.h.

Constructor & Destructor Documentation

RecorderInterface()

INDI::RecorderInterface::RecorderInterface ( )

default

~RecorderInterface()

virtual INDI::RecorderInterface::~RecorderInterface ( )

virtualdefault

Member Function Documentation

close()

virtual bool INDI::RecorderInterface::close ( )

pure virtual

Implemented in INDI::TheoraRecorder, and INDI::SER_Recorder.

getExtension()

virtual const char* INDI::RecorderInterface::getExtension ( )

pure virtual

Implemented in INDI::TheoraRecorder, and INDI::SER_Recorder.

getName()

const char * INDI::RecorderInterface::getName ( )

virtual

Definition at line 33 of file recorderinterface.cpp.

open()

virtual bool INDI::RecorderInterface::open ( const char *  filename, char *  errmsg  )

pure virtual

Implemented in INDI::TheoraRecorder, and INDI::SER_Recorder.

setFPS()

virtual bool INDI::RecorderInterface::setFPS ( float  FPS )

inlinevirtual

Definition at line 69 of file recorderinterface.h.

setPixelFormat()

virtual bool INDI::RecorderInterface::setPixelFormat ( INDI_PIXEL_FORMAT  pixelFormat, uint8_t  pixelDepth = 8  )

pure virtual

Implemented in INDI::TheoraRecorder, and INDI::SER_Recorder.

setSize()

virtual bool INDI::RecorderInterface::setSize ( uint16_t  width, uint16_t  height  )

pure virtual

Implemented in INDI::TheoraRecorder, and INDI::SER_Recorder.

setStreamEnabled()

virtual void INDI::RecorderInterface::setStreamEnabled ( bool  enable )

pure virtual

Implemented in INDI::TheoraRecorder, and INDI::SER_Recorder.

writeFrame()

virtual bool INDI::RecorderInterface::writeFrame ( const uint8_t *  frame, uint32_t  nbytes, uint64_t  timestamp  )

pure virtual

Implemented in INDI::TheoraRecorder, and INDI::SER_Recorder.

Member Data Documentation

m_FPS

float INDI::RecorderInterface::m_FPS = 1

protected

Definition at line 85 of file recorderinterface.h.

name

const char* INDI::RecorderInterface::name

protected

Definition at line 84 of file recorderinterface.h.

---

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

• recorderinterface.h
• recorderinterface.cpp