KODI::GUILIB::GUIINFO::CGUIInfoProvider Class Reference

#include <GUIInfoProvider.h>

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

Public Member Functions
	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
virtual bool	InitCurrentItem (CFileItem *item)=0
	Init a new current guiinfo manager item. Gets called whenever the active guiinfo manager item changes.
virtual bool	GetLabel (std::string &value, const CFileItem *item, int contextWindow, const CGUIInfo &info, std::string *fallback) const =0
	Get a GUIInfoManager label string.
virtual bool	GetInt (int &value, const CGUIListItem *item, int contextWindow, const CGUIInfo &info) const =0
	Get a GUIInfoManager integer value.
virtual bool	GetBool (bool &value, const CGUIListItem *item, int contextWindow, const CGUIInfo &info) const =0
	Get a GUIInfoManager bool value.

Protected Attributes
VideoStreamInfo	m_videoInfo
AudioStreamInfo	m_audioInfo
SubtitleStreamInfo	m_subtitleInfo

Constructor & Destructor Documentation

CGUIInfoProvider()

KODI::GUILIB::GUIINFO::CGUIInfoProvider::CGUIInfoProvider ( )

default

~CGUIInfoProvider()

KODI::GUILIB::GUIINFO::CGUIInfoProvider::~CGUIInfoProvider ( )

overridedefault

Member Function Documentation

GetFallbackLabel()

bool KODI::GUILIB::GUIINFO::CGUIInfoProvider::GetFallbackLabel ( std::string & value, const CFileItem * item, int contextWindow, const CGUIInfo & info, std::string * fallback )

inlineoverridevirtual

Get a GUIInfoManager label fallback string. Will be called if none of the registered provider's GetLabel() implementation has returned success.

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.

Reimplemented in KODI::GUILIB::GUIINFO::CMusicGUIInfo, KODI::GUILIB::GUIINFO::CVideoGUIInfo, and PVR::CPVRGUIInfo.

UpdateAVInfo()

void KODI::GUILIB::GUIINFO::CGUIInfoProvider::UpdateAVInfo ( const AudioStreamInfo & audioInfo, const VideoStreamInfo & videoInfo, const SubtitleStreamInfo & subtitleInfo )

inlineoverridevirtual

Set new audio/video stream info data.

Parameters

audioInfo	New audio stream info.
videoInfo	New video stream info.

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

Member Data Documentation

m_audioInfo

AudioStreamInfo KODI::GUILIB::GUIINFO::CGUIInfoProvider::m_audioInfo

protected

m_subtitleInfo

SubtitleStreamInfo KODI::GUILIB::GUIINFO::CGUIInfoProvider::m_subtitleInfo

protected

m_videoInfo

VideoStreamInfo KODI::GUILIB::GUIINFO::CGUIInfoProvider::m_videoInfo

protected

---

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

• GUIInfoProvider.h