xbmc
Public Member Functions | Protected Attributes | List of all members
KODI::GUILIB::GUIINFO::CGUIInfoProvider Class Reference
Inheritance diagram for KODI::GUILIB::GUIINFO::CGUIInfoProvider:
Inheritance graph
[legend]
Collaboration diagram for KODI::GUILIB::GUIINFO::CGUIInfoProvider:
Collaboration graph
[legend]

Public Member Functions

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. More...
 
void UpdateAVInfo (const AudioStreamInfo &audioInfo, const VideoStreamInfo &videoInfo, const SubtitleStreamInfo &subtitleInfo) override
 Set new audio/video stream info data. More...
 
- Public Member Functions inherited from KODI::GUILIB::GUIINFO::IGUIInfoProvider
virtual bool InitCurrentItem (CFileItem *item)=0
 Init a new current guiinfo manager item. Gets called whenever the active guiinfo manager item changes. More...
 
virtual bool GetLabel (std::string &value, const CFileItem *item, int contextWindow, const CGUIInfo &info, std::string *fallback) const =0
 Get a GUIInfoManager label string. More...
 
virtual bool GetInt (int &value, const CGUIListItem *item, int contextWindow, const CGUIInfo &info) const =0
 Get a GUIInfoManager integer value. More...
 
virtual bool GetBool (bool &value, const CGUIListItem *item, int contextWindow, const CGUIInfo &info) const =0
 Get a GUIInfoManager bool value. More...
 

Protected Attributes

VideoStreamInfo m_videoInfo
 
AudioStreamInfo m_audioInfo
 
SubtitleStreamInfo m_subtitleInfo
 

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
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.

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

◆ 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
audioInfoNew audio stream info.
videoInfoNew video stream info.

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


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