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

The EncoderInterface class is the base class for video streaming encoders. More...

#include <encoderinterface.h>

Inheritance diagram for INDI::EncoderInterface:
INDI::MJPEGEncoder INDI::RawEncoder

Public Member Functions

 EncoderInterface ()=default
 
virtual ~EncoderInterface ()=default
 
virtual void init (CCD *activeCCD)
 
virtual bool setPixelFormat (INDI_PIXEL_FORMAT pixelFormat, uint8_t pixelDepth)
 
virtual bool setSize (uint16_t width, uint16_t height)
 
virtual bool upload (IBLOB *bp, const uint8_t *buffer, uint32_t nbytes, bool isCompressed=false)=0
 
const char * getName ()
 

Protected Attributes

const char * name
 
CCDcurrentCCD = nullptr
 
INDI_PIXEL_FORMAT pixelFormat
 
uint8_t pixelDepth = 8
 
uint16_t rawWidth
 
uint16_t rawHeight
 

Detailed Description

The EncoderInterface class is the base class for video streaming encoders.

Definition at line 41 of file encoderinterface.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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

Definition at line 34 of file encoderinterface.cpp.

void INDI::EncoderInterface::init ( CCD activeCCD)
virtual

Definition at line 39 of file encoderinterface.cpp.

bool INDI::EncoderInterface::setPixelFormat ( INDI_PIXEL_FORMAT  pixelFormat,
uint8_t  pixelDepth 
)
virtual

Definition at line 51 of file encoderinterface.cpp.

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

Definition at line 44 of file encoderinterface.cpp.

virtual bool INDI::EncoderInterface::upload ( IBLOB bp,
const uint8_t *  buffer,
uint32_t  nbytes,
bool  isCompressed = false 
)
pure virtual

Implemented in INDI::MJPEGEncoder, and INDI::RawEncoder.

Member Data Documentation

CCD* INDI::EncoderInterface::currentCCD = nullptr
protected

Definition at line 59 of file encoderinterface.h.

const char* INDI::EncoderInterface::name
protected

Definition at line 58 of file encoderinterface.h.

uint8_t INDI::EncoderInterface::pixelDepth = 8
protected

Definition at line 61 of file encoderinterface.h.

INDI_PIXEL_FORMAT INDI::EncoderInterface::pixelFormat
protected

Definition at line 60 of file encoderinterface.h.

uint16_t INDI::EncoderInterface::rawHeight
protected

Definition at line 62 of file encoderinterface.h.

uint16_t INDI::EncoderInterface::rawWidth
protected

Definition at line 62 of file encoderinterface.h.


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