Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
KODI::VIDEO::IVideoInfoTagLoader Class Referenceabstract

Base class for video tag loaders. More...

#include <IVideoInfoTagLoader.h>

Inheritance diagram for KODI::VIDEO::IVideoInfoTagLoader:
CVideoTagLoaderFFmpeg CVideoTagLoaderNFO CVideoTagLoaderPlugin

Public Member Functions

 IVideoInfoTagLoader (const CFileItem &item, ADDON::ScraperPtr info, bool lookInFolder)
 Constructor.
 
virtual ~IVideoInfoTagLoader ()=default
 
virtual bool HasInfo () const =0
 Returns true if we have info to provide.
 
virtual CInfoScanner::INFO_TYPE Load (CVideoInfoTag &tag, bool prioritise, std::vector< EmbeddedArt > *art=nullptr)=0
 Load tag from file.
 
const CScraperUrlScraperUrl () const
 Returns url associated with obtained URL (NFO_URL et al).
 
const ADDON::ScraperPtr GetAddonInfo () const
 Returns current scaper info.
 

Protected Attributes

const CFileItemm_item
 Reference to item to load for.
 
ADDON::ScraperPtr m_info
 Scraper info.
 
CScraperUrl m_url
 URL for scraper.
 

Detailed Description

Base class for video tag loaders.

Constructor & Destructor Documentation

◆ IVideoInfoTagLoader()

KODI::VIDEO::IVideoInfoTagLoader::IVideoInfoTagLoader ( const CFileItem & item,
ADDON::ScraperPtr info,
bool lookInFolder )
inline

Constructor.

Parameters
itemThe item to load info for
infoScraper info
llokInFolderTrue to look in folder holding file

◆ ~IVideoInfoTagLoader()

virtual KODI::VIDEO::IVideoInfoTagLoader::~IVideoInfoTagLoader ( )
virtualdefault

Member Function Documentation

◆ GetAddonInfo()

const ADDON::ScraperPtr KODI::VIDEO::IVideoInfoTagLoader::GetAddonInfo ( ) const
inline

Returns current scaper info.

◆ HasInfo()

virtual bool KODI::VIDEO::IVideoInfoTagLoader::HasInfo ( ) const
pure virtual

Returns true if we have info to provide.

Implemented in CVideoTagLoaderFFmpeg, CVideoTagLoaderNFO, and CVideoTagLoaderPlugin.

◆ Load()

virtual CInfoScanner::INFO_TYPE KODI::VIDEO::IVideoInfoTagLoader::Load ( CVideoInfoTag & tag,
bool prioritise,
std::vector< EmbeddedArt > * art = nullptr )
pure virtual

Load tag from file.

tag Tag to load info into

prioritise True to prioritise data over existing data in tag

Returns
True if tag was read, false otherwise

Implemented in CVideoTagLoaderNFO, CVideoTagLoaderPlugin, and CVideoTagLoaderFFmpeg.

◆ ScraperUrl()

const CScraperUrl & KODI::VIDEO::IVideoInfoTagLoader::ScraperUrl ( ) const
inline

Returns url associated with obtained URL (NFO_URL et al).

Member Data Documentation

◆ m_info

ADDON::ScraperPtr KODI::VIDEO::IVideoInfoTagLoader::m_info
protected

Scraper info.

◆ m_item

const CFileItem& KODI::VIDEO::IVideoInfoTagLoader::m_item
protected

Reference to item to load for.

◆ m_url

CScraperUrl KODI::VIDEO::IVideoInfoTagLoader::m_url
protected

URL for scraper.


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