KODI::GUILIB::GUIINFO::CPlayerGUIInfo Class Reference

#include <PlayerGUIInfo.h>

Inheritance diagram for KODI::GUILIB::GUIINFO::CPlayerGUIInfo:

Public Member Functions
	CPlayerGUIInfo ()
	~CPlayerGUIInfo () override
CEventStream< PlayerShowInfoChangedEvent > &	Events ()
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.
void	SetShowTime (bool showtime)
void	SetShowInfo (bool showinfo)
bool	GetShowInfo () const
bool	ToggleShowInfo ()
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

CPlayerGUIInfo()

CPlayerGUIInfo::CPlayerGUIInfo

(

)

~CPlayerGUIInfo()

CPlayerGUIInfo::~CPlayerGUIInfo ( )

overridedefault

Member Function Documentation

Events()

CEventStream< PlayerShowInfoChangedEvent > & KODI::GUILIB::GUIINFO::CPlayerGUIInfo::Events ( )

inline

GetBool()

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

overridevirtual

Get a GUIInfoManager bool value.

Parameters

value	Will be filled with the requested value.
item	The item to get the value for. Can be nullptr.
contextWindow	The context window. Can be 0.
info	The GUI info (label id + additional data).

Returns

True if the value was filled successfully, false otherwise.

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

GetInt()

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

overridevirtual

Get a GUIInfoManager integer value.

Parameters

value	Will be filled with the requested value.
item	The item to get the value for. Can be nullptr.
contextWindow	The context window. Can be 0.
info	The GUI info (label id + additional data).

Returns

True if the value was filled successfully, false otherwise.

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

GetLabel()

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

overridevirtual

Get a GUIInfoManager label string.

Parameters

value	Will be filled with the requested value.
item	The item to get the value for. Can be nullptr.
contextWindow	The context window. Can be 0.
info	The GUI info (label id + additional data).
fallback	A fallback value. Can be nullptr.

Returns

True if the value was filled successfully, false otherwise.

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

GetShowInfo()

bool KODI::GUILIB::GUIINFO::CPlayerGUIInfo::GetShowInfo ( ) const

inline

InitCurrentItem()

bool CPlayerGUIInfo::InitCurrentItem ( CFileItem * item )

overridevirtual

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

Parameters

item	The new item.

Returns

True if the item was inited by the provider, false otherwise.

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

SetShowInfo()

void CPlayerGUIInfo::SetShowInfo

(

bool

showinfo

)

SetShowTime()

void KODI::GUILIB::GUIINFO::CPlayerGUIInfo::SetShowTime ( bool showtime )

inline

ToggleShowInfo()

bool CPlayerGUIInfo::ToggleShowInfo

(

)

---

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

• PlayerGUIInfo.h
• PlayerGUIInfo.cpp