Instrument Neutral Distributed Interface INDI  1.6.0
Public Member Functions | Protected Attributes | List of all members
INDI::RecorderInterface Class Referenceabstract

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

#include <recorderinterface.h>

Inheritance diagram for INDI::RecorderInterface:
INDI::SER_Recorder INDI::TheoraRecorder

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)=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

INDI::RecorderInterface::RecorderInterface ( )
default
virtual INDI::RecorderInterface::~RecorderInterface ( )
virtualdefault

Member Function Documentation

virtual bool INDI::RecorderInterface::close ( )
pure virtual
virtual const char* INDI::RecorderInterface::getExtension ( )
pure virtual
const char * INDI::RecorderInterface::getName ( )
virtual

Definition at line 33 of file recorderinterface.cpp.

virtual bool INDI::RecorderInterface::open ( const char *  filename,
char *  errmsg 
)
pure virtual
virtual bool INDI::RecorderInterface::setFPS ( float  FPS)
inlinevirtual

Definition at line 69 of file recorderinterface.h.

virtual bool INDI::RecorderInterface::setPixelFormat ( INDI_PIXEL_FORMAT  pixelFormat,
uint8_t  pixelDepth = 8 
)
pure virtual
virtual bool INDI::RecorderInterface::setSize ( uint16_t  width,
uint16_t  height 
)
pure virtual
virtual void INDI::RecorderInterface::setStreamEnabled ( bool  enable)
pure virtual
virtual bool INDI::RecorderInterface::writeFrame ( const uint8_t *  frame,
uint32_t  nbytes 
)
pure virtual

Member Data Documentation

float INDI::RecorderInterface::m_FPS = 1
protected

Definition at line 81 of file recorderinterface.h.

const char* INDI::RecorderInterface::name
protected

Definition at line 80 of file recorderinterface.h.


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