Instrument Neutral Distributed Interface INDI  1.9.5
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

◆ RecorderInterface()

INDI::RecorderInterface::RecorderInterface ( )

◆ ~RecorderInterface()

virtual INDI::RecorderInterface::~RecorderInterface ( )

Member Function Documentation

◆ close()

virtual bool INDI::RecorderInterface::close ( )
pure virtual

◆ getExtension()

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

◆ getName()

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

Definition at line 33 of file recorderinterface.cpp.

◆ open()

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

◆ setFPS()

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

Definition at line 69 of file recorderinterface.h.

◆ setPixelFormat()

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

◆ setSize()

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

◆ setStreamEnabled()

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

◆ writeFrame()

virtual bool INDI::RecorderInterface::writeFrame ( const uint8_t *  frame,
uint32_t  nbytes 
pure virtual

Member Data Documentation

◆ m_FPS

float INDI::RecorderInterface::m_FPS = 1

Definition at line 81 of file recorderinterface.h.

◆ name

const char* INDI::RecorderInterface::name

Definition at line 80 of file recorderinterface.h.

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