2. Joystick operations

Detailed Description

Joystick operations to handle control about.

---

Joystick parts in interface:
Copy this to your project and extend with your parts or leave functions complete away where not used or supported.

Header parts:

PERIPHERAL_ERROR GetJoystickInfo(unsigned int index, kodi::addon::Joystick& info) override;
PERIPHERAL_ERROR GetFeatures(const kodi::addon::Joystick& joystick, const std::string& controller_id, std::vector<kodi::addon::JoystickFeature>& features) override;
PERIPHERAL_ERROR MapFeatures(const kodi::addon::Joystick& joystick, const std::string& controller_id, const std::vector<kodi::addon::JoystickFeature>& features) override;
PERIPHERAL_ERROR GetIgnoredPrimitives(const kodi::addon::Joystick& joystick, std::vector<kodi::addon::DriverPrimitive>& primitives) override;
PERIPHERAL_ERROR SetIgnoredPrimitives(const kodi::addon::Joystick& joystick, const std::vector<kodi::addon::DriverPrimitive>& primitives) override;
void SaveButtonMap(const kodi::addon::Joystick& joystick) override;
void RevertButtonMap(const kodi::addon::Joystick& joystick) override;
void ResetButtonMap(const kodi::addon::Joystick& joystick, const std::string& controller_id) override;
void PowerOffJoystick(unsigned int index) override;

Source parts:

PERIPHERAL_ERROR CMyInstance::GetJoystickInfo(unsigned int index, kodi::addon::Joystick& info)
{
  return PERIPHERAL_ERROR_NOT_IMPLEMENTED;
}
 
PERIPHERAL_ERROR CMyInstance::GetFeatures(const kodi::addon::Joystick& joystick, const std::string& controller_id, std::vector<kodi::addon::JoystickFeature>& features)
{
  return PERIPHERAL_ERROR_NOT_IMPLEMENTED;
}
 
PERIPHERAL_ERROR CMyInstance::MapFeatures(const kodi::addon::Joystick& joystick, const std::string& controller_id, const std::vector<kodi::addon::JoystickFeature>& features)
{
  return PERIPHERAL_ERROR_NOT_IMPLEMENTED;
}
 
PERIPHERAL_ERROR CMyInstance::GetIgnoredPrimitives(const kodi::addon::Joystick& joystick, std::vector<kodi::addon::DriverPrimitive>& primitives)
{
  return PERIPHERAL_ERROR_NOT_IMPLEMENTED;
}
 
PERIPHERAL_ERROR CMyInstance::SetIgnoredPrimitives(const kodi::addon::Joystick& joystick, const std::vector<kodi::addon::DriverPrimitive>& primitives)
{
  return PERIPHERAL_ERROR_NOT_IMPLEMENTED;
}
 
void CMyInstance::SaveButtonMap(const kodi::addon::Joystick& joystick)
{
  
}
 
void CMyInstance::RevertButtonMap(const kodi::addon::Joystick& joystick)
{
  
}
 
void CMyInstance::ResetButtonMap(const kodi::addon::Joystick& joystick, const std::string& controller_id)
{
  
}
 
void CMyInstance::PowerOffJoystick(unsigned int index)
{
  
}

Modules
	Group header include
	Group source include

Function Documentation

GetJoystickInfo()

virtual PERIPHERAL_ERROR GetJoystickInfo ( unsigned int  index, kodi::addon::Joystick &  info  )

inlinevirtual

Get extended info about an attached joystick.

Parameters

[in]	index	The joystick's driver index
[out]	info	The container for the allocated joystick info

Returns

PERIPHERAL_NO_ERROR if successful

---

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

Name	Type	Class	Set call	Get call
Joystick provider	const std::string&	Joystick	SetProvider	Provider
Joystick requested port	int	Joystick	SetRequestedPort	RequestedPort
Joystick button count	unsigned int	Joystick	SetButtonCount	ButtonCount
Joystick hat count	unsigned int	Joystick	SetHatCount	HatCount
Joystick axis count	unsigned int	Joystick	SetAxisCount	AxisCount
Joystick motor count	unsigned int	Joystick	SetMotorCount	MotorCount
Joystick support power off	bool	Joystick	SetSupportsPowerOff	SupportsPowerOff
Peripheral type	PERIPHERAL_TYPE	Peripheral	SetType	Type
Peripheral name	const std::string&	Peripheral	SetName	Name
Peripheral vendor id	uint16_t	Peripheral	SetVendorID	VendorID
Peripheral product id	uint16_t	Peripheral	SetProductID	ProductID
Peripheral index	unsigned int	Peripheral	SetIndex	Index

Further are following included:

• Joystick(const std::string& provider = "", const std::string& strName = "")
• Joystick& operator=(const Joystick& rhs)
• IsVidPidKnown(): To check VID and PID are known.

GetFeatures()

virtual PERIPHERAL_ERROR GetFeatures ( const kodi::addon::Joystick &  joystick, const std::string &  controller_id, std::vector< kodi::addon::JoystickFeature > &  features  )

inlinevirtual

Get the features that allow translating the joystick into the controller profile.

Parameters

[in]	joystick	The device's joystick properties; unknown values may be left at their default
[in]	controller_id	The controller profile being requested, e.g. game.controller.default
[out]	features	The array of allocated features

Returns

PERIPHERAL_NO_ERROR if successful

MapFeatures()

virtual PERIPHERAL_ERROR MapFeatures ( const kodi::addon::Joystick &  joystick, const std::string &  controller_id, const std::vector< kodi::addon::JoystickFeature > &  features  )

inlinevirtual

Add or update joystick features.

Parameters

[in]	joystick	The device's joystick properties; unknown values may be left at their default
[in]	controller_id	The game controller profile being updated
[in]	features	The array of features

Returns

PERIPHERAL_NO_ERROR if successful

GetIgnoredPrimitives()

virtual PERIPHERAL_ERROR GetIgnoredPrimitives ( const kodi::addon::Joystick &  joystick, std::vector< kodi::addon::DriverPrimitive > &  primitives  )

inlinevirtual

Get the driver primitives that should be ignored while mapping the device.

Parameters

[in]	joystick	The device's joystick properties; unknown values may be left at their default
[out]	primitives	The array of allocated driver primitives to be ignored

Returns

PERIPHERAL_NO_ERROR if successful

SetIgnoredPrimitives()

virtual PERIPHERAL_ERROR SetIgnoredPrimitives ( const kodi::addon::Joystick &  joystick, const std::vector< kodi::addon::DriverPrimitive > &  primitives  )

inlinevirtual

Set the list of driver primitives that are ignored for the device.

Parameters

[in]	joystick	The device's joystick properties; unknown values may be left at their default
[in]	primitives	The array of driver primitives to ignore

Returns

PERIPHERAL_NO_ERROR if successful

SaveButtonMap()

virtual void SaveButtonMap ( const kodi::addon::Joystick &  joystick )

inlinevirtual

Save the button map for the given joystick.

Parameters

[in]

joystick

The device's joystick properties

RevertButtonMap()

virtual void RevertButtonMap ( const kodi::addon::Joystick &  joystick )

inlinevirtual

Revert the button map to the last time it was loaded or committed to disk.

Parameters

[in]

joystick

The device's joystick properties

ResetButtonMap()

virtual void ResetButtonMap ( const kodi::addon::Joystick &  joystick, const std::string &  controller_id  )

inlinevirtual

Reset the button map for the given joystick and controller profile ID.

Parameters

[in]	joystick	The device's joystick properties
[in]	controller_id	The game controller profile being reset

PowerOffJoystick()

virtual void PowerOffJoystick ( unsigned int  index )

inlinevirtual

Powers off the given joystick if supported.

Parameters

[in]

index

The joystick's driver index