|
Kodi Docs 20.0
Kodi is an open source media player and entertainment hub.
|
#include <Peripheral.h>
Public Member Functions | |
| CInstancePeripheral () | |
| Peripheral class constructor. More... | |
| CInstancePeripheral (KODI_HANDLE instance, const std::string &kodiVersion="") | |
| Peripheral addon class constructor used to support multiple instance types. More... | |
| ~CInstancePeripheral () override=default | |
| Destructor. More... | |
| virtual void | GetCapabilities (kodi::addon::PeripheralCapabilities &capabilities) |
| Get the list of features that this add-on provides. More... | |
| virtual PERIPHERAL_ERROR | PerformDeviceScan (std::vector< std::shared_ptr< kodi::addon::Peripheral > > &scan_results) |
| Perform a scan for joysticks. More... | |
| virtual PERIPHERAL_ERROR | GetEvents (std::vector< kodi::addon::PeripheralEvent > &events) |
| Get all events that have occurred since the last call to GetEvents(). More... | |
| virtual bool | SendEvent (const kodi::addon::PeripheralEvent &event) |
| Send an input event to the peripheral. More... | |
| virtual PERIPHERAL_ERROR | GetJoystickInfo (unsigned int index, kodi::addon::Joystick &info) |
| Get extended info about an attached joystick. More... | |
| virtual PERIPHERAL_ERROR | GetFeatures (const kodi::addon::Joystick &joystick, const std::string &controller_id, std::vector< kodi::addon::JoystickFeature > &features) |
| Get the features that allow translating the joystick into the controller profile. More... | |
| virtual PERIPHERAL_ERROR | MapFeatures (const kodi::addon::Joystick &joystick, const std::string &controller_id, const std::vector< kodi::addon::JoystickFeature > &features) |
| Add or update joystick features. More... | |
| virtual PERIPHERAL_ERROR | GetIgnoredPrimitives (const kodi::addon::Joystick &joystick, std::vector< kodi::addon::DriverPrimitive > &primitives) |
| Get the driver primitives that should be ignored while mapping the device. More... | |
| virtual PERIPHERAL_ERROR | SetIgnoredPrimitives (const kodi::addon::Joystick &joystick, const std::vector< kodi::addon::DriverPrimitive > &primitives) |
| Set the list of driver primitives that are ignored for the device. More... | |
| virtual void | SaveButtonMap (const kodi::addon::Joystick &joystick) |
| Save the button map for the given joystick. More... | |
| virtual void | RevertButtonMap (const kodi::addon::Joystick &joystick) |
| Revert the button map to the last time it was loaded or committed to disk. More... | |
| virtual void | ResetButtonMap (const kodi::addon::Joystick &joystick, const std::string &controller_id) |
| Reset the button map for the given joystick and controller profile ID. More... | |
| virtual void | PowerOffJoystick (unsigned int index) |
| Powers off the given joystick if supported. More... | |
| const std::string | AddonPath () const |
| Used to get the full path where the add-on is installed. More... | |
| const std::string | UserPath () const |
| Used to get the full path to the add-on's user profile. More... | |
| void | TriggerScan (void) |
| Trigger a scan for peripherals. More... | |
| void | RefreshButtonMaps (const std::string &deviceName="", const std::string &controllerId="") |
| Notify the frontend that button maps have changed. More... | |
| unsigned int | FeatureCount (const std::string &controllerId, JOYSTICK_FEATURE_TYPE type=JOYSTICK_FEATURE_TYPE_UNKNOWN) |
| Return the number of features belonging to the specified controller. More... | |
| JOYSTICK_FEATURE_TYPE | FeatureType (const std::string &controllerId, const std::string &featureName) |
| Return the type of the feature. More... | |
Public Member Functions inherited from kodi::addon::IAddonInstance | |
| IAddonInstance (ADDON_TYPE type, const std::string &version) | |
| virtual | ~IAddonInstance ()=default |
| virtual ADDON_STATUS | CreateInstance (int instanceType, const std::string &instanceID, KODI_HANDLE instance, const std::string &version, KODI_HANDLE &addonInstance) |
Additional Inherited Members | |
Public Attributes inherited from kodi::addon::IAddonInstance | |
| const ADDON_TYPE | m_type |
| const std::string | m_kodiVersion |
| std::string | m_id |