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

#include <SystemGUIInfo.h>

Inheritance diagram for KODI::GUILIB::GUIINFO::CSystemGUIInfo:
KODI::GUILIB::GUIINFO::CGUIInfoProvider KODI::GUILIB::GUIINFO::IGUIInfoProvider

Public Member Functions

 CSystemGUIInfo ()
 
 ~CSystemGUIInfo () override=default
 
bool InitCurrentItem (CFileItem *item) override
 Init a new current guiinfo manager item. Gets called whenever the active guiinfo manager item changes.
 
bool GetLabel (std::string &value, const CFileItem *item, int contextWindow, const CGUIInfo &info, std::string *fallback) const override
 Get a GUIInfoManager label string.
 
bool GetInt (int &value, const CGUIListItem *item, int contextWindow, const CGUIInfo &info) const override
 Get a GUIInfoManager integer value.
 
bool GetBool (bool &value, const CGUIListItem *item, int contextWindow, const CGUIInfo &info) const override
 Get a GUIInfoManager bool value.
 
float GetFPS () const
 
void UpdateFPS ()
 
- Public Member Functions inherited from KODI::GUILIB::GUIINFO::CGUIInfoProvider
 CGUIInfoProvider ()=default
 
 ~CGUIInfoProvider () override=default
 
bool GetFallbackLabel (std::string &value, const CFileItem *item, int contextWindow, const CGUIInfo &info, std::string *fallback) override
 Get a GUIInfoManager label fallback string. Will be called if none of the registered provider's GetLabel() implementation has returned success.
 
void UpdateAVInfo (const AudioStreamInfo &audioInfo, const VideoStreamInfo &videoInfo, const SubtitleStreamInfo &subtitleInfo) override
 Set new audio/video stream info data.
 
- Public Member Functions inherited from KODI::GUILIB::GUIINFO::IGUIInfoProvider
virtual ~IGUIInfoProvider ()=default
 

Additional Inherited Members

- Protected Attributes inherited from KODI::GUILIB::GUIINFO::CGUIInfoProvider
VideoStreamInfo m_videoInfo
 
AudioStreamInfo m_audioInfo
 
SubtitleStreamInfo m_subtitleInfo
 

Constructor & Destructor Documentation

◆ CSystemGUIInfo()

CSystemGUIInfo::CSystemGUIInfo ( )

◆ ~CSystemGUIInfo()

KODI::GUILIB::GUIINFO::CSystemGUIInfo::~CSystemGUIInfo ( )
overridedefault

Member Function Documentation

◆ GetBool()

bool CSystemGUIInfo::GetBool ( bool & value,
const CGUIListItem * item,
int contextWindow,
const CGUIInfo & info ) const
overridevirtual

Get a GUIInfoManager bool value.

Parameters
valueWill be filled with the requested value.
itemThe item to get the value for. Can be nullptr.
contextWindowThe context window. Can be 0.
infoThe GUI info (label id + additional data).
Returns
True if the value was filled successfully, false otherwise.

Implements KODI::GUILIB::GUIINFO::IGUIInfoProvider.

◆ GetFPS()

float KODI::GUILIB::GUIINFO::CSystemGUIInfo::GetFPS ( ) const
inline

◆ GetInt()

bool CSystemGUIInfo::GetInt ( int & value,
const CGUIListItem * item,
int contextWindow,
const CGUIInfo & info ) const
overridevirtual

Get a GUIInfoManager integer value.

Parameters
valueWill be filled with the requested value.
itemThe item to get the value for. Can be nullptr.
contextWindowThe context window. Can be 0.
infoThe GUI info (label id + additional data).
Returns
True if the value was filled successfully, false otherwise.

Implements KODI::GUILIB::GUIINFO::IGUIInfoProvider.

◆ GetLabel()

bool CSystemGUIInfo::GetLabel ( std::string & value,
const CFileItem * item,
int contextWindow,
const CGUIInfo & info,
std::string * fallback ) const
overridevirtual

Get a GUIInfoManager label string.

Parameters
valueWill be filled with the requested value.
itemThe item to get the value for. Can be nullptr.
contextWindowThe context window. Can be 0.
infoThe GUI info (label id + additional data).
fallbackA fallback value. Can be nullptr.
Returns
True if the value was filled successfully, false otherwise.

Implements KODI::GUILIB::GUIINFO::IGUIInfoProvider.

◆ InitCurrentItem()

bool CSystemGUIInfo::InitCurrentItem ( CFileItem * item)
overridevirtual

Init a new current guiinfo manager item. Gets called whenever the active guiinfo manager item changes.

Parameters
itemThe new item.
Returns
True if the item was inited by the provider, false otherwise.

Implements KODI::GUILIB::GUIINFO::IGUIInfoProvider.

◆ UpdateFPS()

void CSystemGUIInfo::UpdateFPS ( )

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