![]() |
Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
|
Node in the controller tree. More...
#include <ControllerNode.h>
Public Member Functions | |
CControllerNode () | |
CControllerNode (const CControllerNode &other) | |
CControllerNode (CControllerNode &&other)=default | |
CControllerNode & | operator= (const CControllerNode &rhs) |
CControllerNode & | operator= (CControllerNode &&rhs) noexcept |
~CControllerNode () | |
void | Clear () |
const ControllerPtr & | GetController () const |
Controller profile of this code. | |
void | SetController (ControllerPtr controller) |
void | GetControllers (ControllerVector &controllers) const |
const std::string & | GetPortAddress () const |
Address given to the controller's port by the implementation. | |
void | SetPortAddress (std::string portAddress) |
const std::string & | GetControllerAddress () const |
Address given to the controller node by the implementation. | |
void | SetControllerAddress (std::string controllerAddress) |
const CControllerHub & | GetHub () const |
Collection of ports on this controller. | |
CControllerHub & | GetHub () |
void | SetHub (CControllerHub hub) |
bool | IsValid () const |
Check if this node has a valid controller profile. | |
bool | IsControllerAccepted (const std::string &controllerId) const |
Check to see if a controller is compatible with a controller port. | |
bool | IsControllerAccepted (const std::string &portAddress, const std::string &controllerId) const |
Check to see if a controller is compatible with a controller port. | |
bool | ProvidesInput () const |
Check if this node provides input. | |
void | GetInputPorts (std::vector< std::string > &activePorts) const |
Get a list of ports that accept player input. | |
Node in the controller tree.
The node identifies the controller profile, and optionally the available controller ports.
CControllerNode::CControllerNode | ( | ) |
|
inline |
|
default |
|
default |
void CControllerNode::Clear | ( | ) |
|
inline |
Controller profile of this code.
|
inline |
Address given to the controller node by the implementation.
void CControllerNode::GetControllers | ( | ControllerVector & | controllers | ) | const |
|
inline |
|
inline |
Collection of ports on this controller.
void CControllerNode::GetInputPorts | ( | std::vector< std::string > & | activePorts | ) | const |
Get a list of ports that accept player input.
[out] | inputPorts | The list of input ports |
|
inline |
Address given to the controller's port by the implementation.
bool CControllerNode::IsControllerAccepted | ( | const std::string & | controllerId | ) | const |
Check to see if a controller is compatible with a controller port.
controllerId | The ID of the controller |
bool CControllerNode::IsControllerAccepted | ( | const std::string & | portAddress, |
const std::string & | controllerId ) const |
Check to see if a controller is compatible with a controller port.
portAddress | The port address |
controllerId | The ID of the controller |
|
inline |
Check if this node has a valid controller profile.
|
noexcept |
CControllerNode & CControllerNode::operator= | ( | const CControllerNode & | rhs | ) |
bool CControllerNode::ProvidesInput | ( | ) | const |
Check if this node provides input.
void CControllerNode::SetController | ( | ControllerPtr | controller | ) |
void CControllerNode::SetControllerAddress | ( | std::string | controllerAddress | ) |
void CControllerNode::SetHub | ( | CControllerHub | hub | ) |
void CControllerNode::SetPortAddress | ( | std::string | portAddress | ) |