Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
kodi::addon::Peripheral Class Reference

#include <PeripheralUtils.h>

Inheritance diagram for kodi::addon::Peripheral:
kodi::addon::Joystick

Public Member Functions

 Peripheral (PERIPHERAL_TYPE type=PERIPHERAL_TYPE_UNKNOWN, const std::string &strName="")
 
 Peripheral (const PERIPHERAL_INFO &info)
 
virtual ~Peripheral (void)=default
 
PERIPHERAL_TYPE Type (void) const
 
const std::string & Name (void) const
 
uint16_t VendorID (void) const
 
uint16_t ProductID (void) const
 
unsigned int Index (void) const
 
bool IsVidPidKnown (void) const
 
void SetType (PERIPHERAL_TYPE type)
 
void SetName (const std::string &strName)
 
void SetVendorID (uint16_t vendorId)
 
void SetProductID (uint16_t productId)
 
void SetIndex (unsigned int index)
 
void ToStruct (PERIPHERAL_INFO &info) const
 

Static Public Member Functions

static void FreeStruct (PERIPHERAL_INFO &info)
 

Detailed Description

ADDON::Peripheral

Wrapper class providing peripheral information. Classes can extend Peripheral to inherit peripheral properties.

Constructor & Destructor Documentation

◆ Peripheral() [1/2]

kodi::addon::Peripheral::Peripheral ( PERIPHERAL_TYPE  type = PERIPHERAL_TYPE_UNKNOWN,
const std::string &  strName = "" 
)
inline

◆ Peripheral() [2/2]

kodi::addon::Peripheral::Peripheral ( const PERIPHERAL_INFO info)
inlineexplicit

◆ ~Peripheral()

virtual kodi::addon::Peripheral::~Peripheral ( void  )
virtualdefault

Member Function Documentation

◆ FreeStruct()

static void kodi::addon::Peripheral::FreeStruct ( PERIPHERAL_INFO info)
inlinestatic

◆ Index()

unsigned int kodi::addon::Peripheral::Index ( void  ) const
inline

◆ IsVidPidKnown()

bool kodi::addon::Peripheral::IsVidPidKnown ( void  ) const
inline

◆ Name()

const std::string & kodi::addon::Peripheral::Name ( void  ) const
inline

◆ ProductID()

uint16_t kodi::addon::Peripheral::ProductID ( void  ) const
inline

◆ SetIndex()

void kodi::addon::Peripheral::SetIndex ( unsigned int  index)
inline

◆ SetName()

void kodi::addon::Peripheral::SetName ( const std::string &  strName)
inline

◆ SetProductID()

void kodi::addon::Peripheral::SetProductID ( uint16_t  productId)
inline

◆ SetType()

void kodi::addon::Peripheral::SetType ( PERIPHERAL_TYPE  type)
inline

◆ SetVendorID()

void kodi::addon::Peripheral::SetVendorID ( uint16_t  vendorId)
inline

◆ ToStruct()

void kodi::addon::Peripheral::ToStruct ( PERIPHERAL_INFO info) const
inline

◆ Type()

PERIPHERAL_TYPE kodi::addon::Peripheral::Type ( void  ) const
inline

◆ VendorID()

uint16_t kodi::addon::Peripheral::VendorID ( void  ) const
inline

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