Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
No Matches
XFILE::CUPnPDirectory Class Reference

#include <UPnPDirectory.h>

Inheritance diagram for XFILE::CUPnPDirectory:

Public Member Functions

 CUPnPDirectory (void)=default
 ~CUPnPDirectory (void) override=default
bool GetDirectory (const CURL &url, CFileItemList &items) override
 Get the items of the directory strPath.
bool AllowAll () const override
 Whether to allow all files/folders to be listed.
bool Resolve (CFileItem &item) const override
 Resolves a given item to a playable item.
- 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 Exists (const CURL &url)
 Check for directory existence.
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.

Static Public Member Functions

static std::string GetFriendlyName (const CURL &url)
static bool GetResource (const CURL &path, CFileItem &item)
- Static Public Member Functions inherited from XFILE::IDirectory
static void RegisterProfileManager (const CProfileManager &profileManager)
static void UnregisterProfileManager ()

Additional Inherited Members

- 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 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
- Static Protected Attributes inherited from XFILE::IDirectory
static const CProfileManagerm_profileManager = nullptr

Constructor & Destructor Documentation

◆ CUPnPDirectory()

XFILE::CUPnPDirectory::CUPnPDirectory ( void )

◆ ~CUPnPDirectory()

XFILE::CUPnPDirectory::~CUPnPDirectory ( void )

Member Function Documentation

◆ AllowAll()

bool XFILE::CUPnPDirectory::AllowAll ( ) const

Whether to allow all files/folders to be listed.

Returns true if all files/folder should be listed.

Reimplemented from XFILE::IDirectory.

◆ GetDirectory()

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

Get the items of the directory strPath.

urlDirectory to read.
itemsRetrieves the directory entries.
Returns true, if successful.
See also

Implements XFILE::IDirectory.

◆ GetFriendlyName()

std::string XFILE::CUPnPDirectory::GetFriendlyName ( const CURL & url)

◆ GetResource()

bool XFILE::CUPnPDirectory::GetResource ( const CURL & path,
CFileItem & item )

◆ Resolve()

bool CUPnPDirectory::Resolve ( CFileItem & item) const

Resolves a given item to a playable item.

Some directories (e.g. dvd, bluray, plugins etc) need to be translated/resolved to the actual playback url
itemThe item being manipulated (which the path points to a vfs protocol implementation)
true if the item was resolved, false if it failed to resolve

Reimplemented from XFILE::IDirectory.

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