Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CNfoFile Class Reference

#include <NfoFile.h>

Public Member Functions

virtual ~CNfoFile ()
 
CInfoScanner::InfoType Create (const std::string &nfoPath, const ADDON::ScraperPtr &info)
 
CInfoScanner::InfoType Reparse (int index)
 Re-parse the already loaded document, starting at its nth <movie> element. Only valid after a successful Create(), and only for movie documents - nothing else can hold more than one entry.
 
template<class T >
bool GetDetails (T &details, const char *document=nullptr, bool prioritise=false) const
 
void Close ()
 
void SetScraperInfo (ADDON::ScraperPtr info)
 
ADDON::ScraperPtr GetScraperInfo ()
 
const CScraperUrlScraperUrl () const
 
int GetBlurayPlaylist () const
 The bluray playlist given by a <playlist> element, if any. Read from the same (indexed) element as GetDetails(), so multi-version nfos give the playlist belonging to the version that was parsed.
 

Constructor & Destructor Documentation

◆ ~CNfoFile()

virtual CNfoFile::~CNfoFile ( )
inlinevirtual

Member Function Documentation

◆ Close()

void CNfoFile::Close ( )

◆ Create()

CInfoScanner::InfoType CNfoFile::Create ( const std::string & nfoPath,
const ADDON::ScraperPtr & info )

◆ GetBlurayPlaylist()

int CNfoFile::GetBlurayPlaylist ( ) const

The bluray playlist given by a <playlist> element, if any. Read from the same (indexed) element as GetDetails(), so multi-version nfos give the playlist belonging to the version that was parsed.

Returns
the playlist number, or -1 if the nfo does not specify one

◆ GetDetails()

template<class T >
bool CNfoFile::GetDetails ( T & details,
const char * document = nullptr,
bool prioritise = false ) const
inline

◆ GetScraperInfo()

ADDON::ScraperPtr CNfoFile::GetScraperInfo ( )
inline

◆ Reparse()

CInfoScanner::InfoType CNfoFile::Reparse ( int index)

Re-parse the already loaded document, starting at its nth <movie> element. Only valid after a successful Create(), and only for movie documents - nothing else can hold more than one entry.

Parameters
index1-based index of the <movie> element to parse
Returns
the parse result, NONE if the document holds no such element

◆ ScraperUrl()

const CScraperUrl & CNfoFile::ScraperUrl ( ) const
inline

◆ SetScraperInfo()

void CNfoFile::SetScraperInfo ( ADDON::ScraperPtr info)
inline

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