XFILE::CMusicFileDirectory Class Reference

#include <MusicFileDirectory.h>

Inheritance diagram for XFILE::CMusicFileDirectory:

Public Member Functions
	CMusicFileDirectory (void)
	~CMusicFileDirectory (void) override
bool	GetDirectory (const CURL &url, CFileItemList &items) override
	Get the items of the directory strPath.
bool	Exists (const CURL &url) override
	Check for directory existence.
bool	ContainsFiles (const CURL &url) override
bool	AllowAll () const override
	Whether to allow all files/folders to be listed.
Public Member Functions inherited from XFILE::IFileDirectory
	~IFileDirectory () override=default
Public Member Functions inherited from XFILE::IDirectory
	IDirectory ()
virtual	~IDirectory (void)
virtual float	GetProgress () const
	Retrieve the progress of the current directory fetch (if possible).
virtual void	CancelDirectory ()
	Cancel the current directory fetch (if possible).
virtual bool	Create (const CURL &url)
	Create the directory.
virtual bool	Remove (const CURL &url)
	Removes the directory.
virtual bool	RemoveRecursive (const CURL &url)
	Recursively removes the directory.
virtual bool	IsAllowed (const CURL &url) const
	Whether this file should be listed.
virtual DIR_CACHE_TYPE	GetCacheType (const CURL &url) const
	How this directory should be cached.
void	SetMask (const std::string &strMask)
	Set a mask of extensions for the files in the directory.
void	SetFlags (int flags)
	Set the flags for this directory handler.
bool	ProcessRequirements ()
	Process additional requirements before the directory fetch is performed. Some directory fetches may require authentication, keyboard input etc. The IDirectory subclass should call GetKeyboardInput, SetErrorDialog or RequireAuthentication and then return false from the GetDirectory method. CDirectory will then prompt for input from the user, before re-calling the GetDirectory method.
virtual bool	Resolve (CFileItem &item) const
	Resolves a given item to a playable item.

Protected Member Functions
virtual bool	Load (const std::string &strFileName, MUSIC_INFO::CMusicInfoTag &tag, EmbeddedArt *art=nullptr)
virtual int	GetTrackCount (const std::string &strPath)=0
Protected Member Functions inherited from XFILE::IDirectory
bool	GetKeyboardInput (const CVariant &heading, std::string &input, bool hiddenInput=false)
	Prompt the user for some keyboard input Call this method from the GetDirectory method to retrieve additional input from the user. If this function returns false then no input has been received, and the GetDirectory call should return false.
void	SetErrorDialog (const CVariant &heading, const CVariant &line1, const CVariant &line2=0, const CVariant &line3=0)
	Show an error dialog on failure of GetDirectory call Call this method from the GetDirectory method to set an error message to be shown to the user.
void	RequireAuthentication (const CURL &url)
	Prompt the user for authentication of a URL. Call this method from the GetDirectory method when authentication is required from the user, before returning false from the GetDirectory call. The user will be prompted for authentication, and GetDirectory will be re-called.

Protected Attributes
std::string	m_strExt
MUSIC_INFO::CMusicInfoTag	m_tag
Protected Attributes inherited from XFILE::IDirectory
std::string	m_strFileMask
	Holds the file mask specified by SetMask()
int	m_flags
	Directory flags - see DIR_FLAG.
CVariant	m_requirements

Additional Inherited Members
Static Public Member Functions inherited from XFILE::IDirectory
static void	RegisterProfileManager (const CProfileManager &profileManager)
static void	UnregisterProfileManager ()
Static Protected Attributes inherited from XFILE::IDirectory
static const CProfileManager *	m_profileManager = nullptr

Constructor & Destructor Documentation

CMusicFileDirectory()

CMusicFileDirectory::CMusicFileDirectory ( void )

default

~CMusicFileDirectory()

CMusicFileDirectory::~CMusicFileDirectory ( void )

overridedefault

Member Function Documentation

AllowAll()

bool XFILE::CMusicFileDirectory::AllowAll ( ) const

inlineoverridevirtual

Whether to allow all files/folders to be listed.

Returns

Returns true if all files/folder should be listed.

Reimplemented from XFILE::IDirectory.

ContainsFiles()

bool CMusicFileDirectory::ContainsFiles ( const CURL & url )

overridevirtual

Implements XFILE::IFileDirectory.

Exists()

bool CMusicFileDirectory::Exists ( const CURL & url )

overridevirtual

Check for directory existence.

Parameters

url	Directory to check.

Returns

Returns true, if directory exists

See also

CDirectoryFactory

Reimplemented from XFILE::IDirectory.

GetDirectory()

bool CMusicFileDirectory::GetDirectory ( const CURL & url, CFileItemList & items )

overridevirtual

Get the items of the directory strPath.

Parameters

url	Directory to read.
items	Retrieves the directory entries.

Returns

Returns true, if successful.

See also

CDirectoryFactory

Implements XFILE::IDirectory.

GetTrackCount()

virtual int XFILE::CMusicFileDirectory::GetTrackCount ( const std::string & strPath )

protectedpure virtual

Implemented in KODI::ADDONS::CAudioDecoder.

Load()

virtual bool XFILE::CMusicFileDirectory::Load ( const std::string & strFileName, MUSIC_INFO::CMusicInfoTag & tag, EmbeddedArt * art = nullptr )

inlineprotectedvirtual

Reimplemented in KODI::ADDONS::CAudioDecoder.

Member Data Documentation

m_strExt

std::string XFILE::CMusicFileDirectory::m_strExt

protected

m_tag

MUSIC_INFO::CMusicInfoTag XFILE::CMusicFileDirectory::m_tag

protected

---

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

• MusicFileDirectory.h
• MusicFileDirectory.cpp