class PeripheralCapabilities

Peripheral add-on capabilities
This class is needed to tell Kodi which options are supported on the addon. More...

Classes
class	kodi::addon::PeripheralCapabilities

Functions
void	kodi::addon::PeripheralCapabilities::SetProvidesJoysticks (bool providesJoysticks)
	Set true if the add-on provides joysticks.
bool	kodi::addon::PeripheralCapabilities::GetProvidesJoysticks () const
	To get with SetProvidesJoysticks changed values.
void	kodi::addon::PeripheralCapabilities::SetProvidesJoystickRumble (bool providesJoystickRumble)
	Set true if the add-on provides joystick rumble.
bool	kodi::addon::PeripheralCapabilities::GetProvidesJoystickRumble () const
	To get with SetProvidesJoystickRumble changed values.
void	kodi::addon::PeripheralCapabilities::SetProvidesJoystickPowerOff (bool providesJoystickPowerOff)
	Set true if the add-on provides power off about joystick.
bool	kodi::addon::PeripheralCapabilities::GetProvidesJoystickPowerOff () const
	To get with SetProvidesJoystickPowerOff changed values.
void	kodi::addon::PeripheralCapabilities::SetProvidesButtonmaps (bool providesButtonmaps)
	Set true if the add-on provides button maps.
bool	kodi::addon::PeripheralCapabilities::GetProvidesButtonmaps () const
	To get with SetProvidesButtonmaps changed values.

Detailed Description

Peripheral add-on capabilities
This class is needed to tell Kodi which options are supported on the addon.

If a capability is set to true, then the corresponding methods from kodi::addon::CInstancePeripheral need to be implemented.

As default them all set to false.

Used on kodi::addon::CInstancePeripheral::GetCapabilities().

---

@ingroup cpp_kodi_addon_peripheral_Defs_PeripheralCapabilities

The following table contains values that can be set with class PeripheralCapabilities :

Name	Type	Set call	Get call
Provides joysticks	boolean	SetProvidesJoysticks	GetProvidesJoysticks
Provides joystick rumble	boolean	SetProvidesJoystickRumble	GetProvidesJoystickRumble
Provides joystick power off	boolean	SetProvidesJoystickPowerOff	GetProvidesJoystickPowerOff
Provides button maps	boolean	SetProvidesButtonmaps	GetProvidesButtonmaps

Function Documentation

GetProvidesButtonmaps()

bool kodi::addon::PeripheralCapabilities::GetProvidesButtonmaps ( ) const

inline

To get with SetProvidesButtonmaps changed values.

GetProvidesJoystickPowerOff()

bool kodi::addon::PeripheralCapabilities::GetProvidesJoystickPowerOff ( ) const

inline

To get with SetProvidesJoystickPowerOff changed values.

GetProvidesJoystickRumble()

bool kodi::addon::PeripheralCapabilities::GetProvidesJoystickRumble ( ) const

inline

To get with SetProvidesJoystickRumble changed values.

GetProvidesJoysticks()

bool kodi::addon::PeripheralCapabilities::GetProvidesJoysticks ( ) const

inline

To get with SetProvidesJoysticks changed values.

SetProvidesButtonmaps()

void kodi::addon::PeripheralCapabilities::SetProvidesButtonmaps ( bool providesButtonmaps )

inline

Set true if the add-on provides button maps.

SetProvidesJoystickPowerOff()

void kodi::addon::PeripheralCapabilities::SetProvidesJoystickPowerOff ( bool providesJoystickPowerOff )

inline

Set true if the add-on provides power off about joystick.

SetProvidesJoystickRumble()

void kodi::addon::PeripheralCapabilities::SetProvidesJoystickRumble ( bool providesJoystickRumble )

inline

Set true if the add-on provides joystick rumble.

SetProvidesJoysticks()

void kodi::addon::PeripheralCapabilities::SetProvidesJoysticks ( bool providesJoysticks )

inline

Set true if the add-on provides joysticks.