X2 Standard  Version 1.25
List of all members
VideoDriverInterface Class Referenceabstract
Inheritance diagram for VideoDriverInterface:
DriverRootInterface LinkInterface HardwareInfoInterface DriverInfoInterface

Public Member Functions

DriverRootInterface Implementation
virtual DeviceType deviceType (void)
 
virtual int queryAbstraction (const char *pszName, void **ppVal)=0
 
LinkInterface Implementation
virtual int establishLink (void)=0
 
virtual int terminateLink (void)=0
 
virtual bool isLinked (void) const =0
 
HardwareInfoInterface Implementation
virtual void deviceInfoNameShort (BasicStringInterface &) const
 
virtual void deviceInfoNameLong (BasicStringInterface &) const
 
virtual void deviceInfoDetailedDescription (BasicStringInterface &) const
 
virtual void deviceInfoFirmwareVersion (BasicStringInterface &)
 
virtual void deviceInfoModel (BasicStringInterface &)
 
DriverInfoInterface Implementation
virtual void driverInfoDetailedInfo (BasicStringInterface &) const
 
virtual double driverInfoVersion (void) const
 
virtual int getChipSize (int &nW, int &nH, int &nBpp)=0
 
virtual int readoutPreviewFrame (const int &nWidth, const int &nHeight, const int &nBpp, unsigned char *pMem)=0
 
virtual int getControlCount (int &nControls)=0
 
virtual int getControlData (const int nIndex, BasicStringInterface &sName, double &dMin, double &dMax, double &dDefault, double &dValue)=0
 
virtual int setControlData (const int nIndex, const double dValue)=0
 

Additional Inherited Members

- Public Types inherited from DriverRootInterface
enum  DeviceType {
  DT_UNKNOWN = 0, DT_MOUNT = 1, DT_FOCUSER = 2, DT_CAMERA = 3,
  DT_FILTERWHEEL = 4, DT_DOME = 5, DT_ROTATOR = 6, DT_WEATHER = 7,
  DT_GPSTFP = 8, DT_VIDEO = 9, DT_OTA =10, DT_AO =11,
  DT_POWERCONTROL =12, DT_PRIVATE_A =13
}
 

Member Function Documentation

◆ deviceInfoDetailedDescription()

virtual void VideoDriverInterface::deviceInfoDetailedDescription ( BasicStringInterface str) const
inlinevirtual

Return a detailed device description.

Implements HardwareInfoInterface.

◆ deviceInfoFirmwareVersion()

virtual void VideoDriverInterface::deviceInfoFirmwareVersion ( BasicStringInterface str)
inlinevirtual

Return the firmware version, if available.

Implements HardwareInfoInterface.

◆ deviceInfoModel()

virtual void VideoDriverInterface::deviceInfoModel ( BasicStringInterface str)
inlinevirtual

Return the device model name.

Implements HardwareInfoInterface.

◆ deviceInfoNameLong()

virtual void VideoDriverInterface::deviceInfoNameLong ( BasicStringInterface str) const
inlinevirtual

Return a detailed device name.

Implements HardwareInfoInterface.

◆ deviceInfoNameShort()

virtual void VideoDriverInterface::deviceInfoNameShort ( BasicStringInterface str) const
inlinevirtual

Return a short device name.

Implements HardwareInfoInterface.

◆ deviceType()

virtual DeviceType VideoDriverInterface::deviceType ( void  )
inlinevirtual

Returns the type of device.

Implements DriverRootInterface.

◆ driverInfoDetailedInfo()

virtual void VideoDriverInterface::driverInfoDetailedInfo ( BasicStringInterface str) const
inlinevirtual

Return detailed information about the driver.

Implements DriverInfoInterface.

◆ driverInfoVersion()

virtual double VideoDriverInterface::driverInfoVersion ( void  ) const
inlinevirtual

Return a version number.

Implements DriverInfoInterface.

◆ establishLink()

virtual int VideoDriverInterface::establishLink ( void  )
pure virtual

Connect (link) to the device.

Implements LinkInterface.

◆ getChipSize()

virtual int VideoDriverInterface::getChipSize ( int &  nW,
int &  nH,
int &  nBpp 
)
pure virtual

Return the physical size of the camera's detector.

◆ getControlCount()

virtual int VideoDriverInterface::getControlCount ( int &  nControls)
pure virtual

Return the number of dynamic controls avaliable on this device.

◆ getControlData()

virtual int VideoDriverInterface::getControlData ( const int  nIndex,
BasicStringInterface sName,
double &  dMin,
double &  dMax,
double &  dDefault,
double &  dValue 
)
pure virtual

Return the name, minimum, maximum, and current values of a specified control index.

◆ isLinked()

virtual bool VideoDriverInterface::isLinked ( void  ) const
pure virtual

Return true if there is a connection, otherwise return false.

Implements LinkInterface.

◆ queryAbstraction()

virtual int VideoDriverInterface::queryAbstraction ( const char *  pszName,
void **  ppVal 
)
pure virtual

Return a pointer to well defined interface.

Implements DriverRootInterface.

◆ readoutPreviewFrame()

virtual int VideoDriverInterface::readoutPreviewFrame ( const int &  nWidth,
const int &  nHeight,
const int &  nBpp,
unsigned char *  pMem 
)
pure virtual

Return an single image snapshot from the active video stream.

◆ setControlData()

virtual int VideoDriverInterface::setControlData ( const int  nIndex,
const double  dValue 
)
pure virtual

Set a new value for the specified control index.

◆ terminateLink()

virtual int VideoDriverInterface::terminateLink ( void  )
pure virtual

Disconnect from the device.

Implements LinkInterface.


The documentation for this class was generated from the following file:
X2 Examples
(C) 2023 Software Bisque, Inc. All rights reserved.