Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
KODI::JOYSTICK::CDriverReceiving Class Reference

Class to translate input events from higher-level features to driver primitives. More...

#include <DriverReceiving.h>

Inheritance diagram for KODI::JOYSTICK::CDriverReceiving:
KODI::JOYSTICK::IInputReceiver

Public Member Functions

 CDriverReceiving (IDriverReceiver *receiver, IButtonMap *buttonMap)
 
 ~CDriverReceiving () override=default
 
bool SetRumbleState (const FeatureName &feature, float magnitude) override
 Set the value of a rumble motor.
 
- Public Member Functions inherited from KODI::JOYSTICK::IInputReceiver
virtual ~IInputReceiver ()=default
 

Detailed Description

Class to translate input events from higher-level features to driver primitives.

A button map is used to translate controller features to driver primitives. The button map has been abstracted away behind the IButtonMap interface so that it can be provided by an add-on.

Constructor & Destructor Documentation

◆ CDriverReceiving()

CDriverReceiving::CDriverReceiving ( IDriverReceiver * receiver,
IButtonMap * buttonMap )

◆ ~CDriverReceiving()

KODI::JOYSTICK::CDriverReceiving::~CDriverReceiving ( )
overridedefault

Member Function Documentation

◆ SetRumbleState()

bool CDriverReceiving::SetRumbleState ( const FeatureName & feature,
float magnitude )
overridevirtual

Set the value of a rumble motor.

Parameters
featureThe name of the motor to rumble
magnitudeThe motor's new magnitude of vibration in the closed interval [0, 1]
Returns
True if the event was handled otherwise false

Implements KODI::JOYSTICK::IInputReceiver.


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