XFILE Namespace Reference

Namespaces
namespace	MUSICDATABASEDIRECTORY
namespace	VIDEODATABASEDIRECTORY

Classes
class	CAddonsDirectory
	Get access to shares and it's directories. More...
class	CAndroidAppDirectory
class	CAPKDirectory
class	CAPKFile
class	CAudioBookFileDirectory
class	CBlurayDirectory
class	CBlurayFile
class	CCacheStrategy
class	CCDDADirectory
class	CCircularCache
class	CCurlFile
class	CDAVCommon
class	CDAVDirectory
class	CDAVFile
class	CDirectory
	Wrappers for IDirectory. More...
class	CDirectoryCache
class	CDirectoryFactory
	Get access to a directory of a file system. More...
class	CDoubleCache
class	CDVDDirectory
	Abstracts a DVD virtual directory (dvd://) which in turn points to the actual physical drive. More...
class	CEventsDirectory
class	CFavouritesDirectory
class	CFile
class	CFileAndroidApp
class	CFileCache
class	CFileCDDA
class	CFileDirectoryFactory
class	CFileFactory
class	CFileStream
class	CFileStreamBuffer
class	CFTPDirectory
class	CHTTPDirectory
class	CImageFile
class	CISO9660Directory
class	CISO9660File
class	CLibraryDirectory
class	CMultiPathDirectory
class	CMultiPathFile
class	CMusicDatabaseDirectory
class	CMusicDatabaseFile
class	CMusicFileDirectory
class	CMusicSearchDirectory
class	CNFSDirectory
class	CNFSFile
class	COverrideDirectory
class	COverrideFile
class	CPipeFile
class	CPlaylistDirectory
class	CPlaylistFileDirectory
class	CPluginDirectory
class	CPluginFile
class	CPosixDirectory
class	CPosixFile
class	CPVRDirectory
class	CRedirectException
class	CResourceDirectory
class	CResourceFile
class	CRSSDirectory
class	CShoutcastFile
class	CSimpleFileCache
class	CSmartPlaylistDirectory
class	CSMBDirectory
class	CSMBFile
class	CSourcesDirectory
class	CSpecialProtocolDirectory
class	CSpecialProtocolFile
class	CStackDirectory
class	CTVOSDirectory
class	CTVOSFile
class	CUDFDirectory
class	CUDFFile
class	CUPnPDirectory
class	CUPnPFile
class	CVideoDatabaseDirectory
class	CVideoDatabaseFile
class	CVirtualDirectory
	Get access to shares and it's directories. More...
class	CWin32Directory
class	CWin32File
class	CWin32SMBDirectory
class	CWin32SMBFile
class	CWinLibraryDirectory
class	CWinLibraryFile
class	CXbtDirectory
class	CXbtFile
class	CXbtManager
class	CZeroconfDirectory
class	CZipDirectory
class	CZipFile
class	IDirectory
	Interface to the directory on a file system. More...
class	IFile
class	IFileCallback
class	IFileDirectory
class	IPipeListener
class	Pipe
class	PipesManager
struct	SCacheStatus
struct	SNativeIoControl

Typedefs
template<class TEntry >
using	DirectorizeEntryToFileItemFunction = CFileItemPtr(*)(const TEntry& entry, const std::string& label, const std::string& path, bool isFolder)
	Method definition to convert an entry to a CFileItemPtr.
template<class TEntry >
using	DirectorizeEntry = std::pair<std::string, TEntry>
template<class TEntry >
using	DirectorizeEntries = std::vector<DirectorizeEntry<TEntry>>

Enumerations
enum	DIR_CACHE_TYPE { DIR_CACHE_NEVER = 0 , DIR_CACHE_ONCE , DIR_CACHE_ALWAYS }
enum	DIR_FLAG {   DIR_FLAG_DEFAULTS = 0 , DIR_FLAG_NO_FILE_DIRS = (2 << 0) , DIR_FLAG_ALLOW_PROMPT = (2 << 1) , DIR_FLAG_NO_FILE_INFO = (2 << 2) ,   DIR_FLAG_GET_HIDDEN = (2 << 3) , DIR_FLAG_READ_CACHE = (2 << 4) , DIR_FLAG_BYPASS_CACHE = (2 << 5) }
	Available directory flags The defaults are to allow file directories, no prompting, retrieve file information, hide hidden files, and utilise the directory cache based on the implementation's wishes. More...
enum	CACHE_BUFFER_MODES {   CACHE_BUFFER_MODE_INTERNET = 0 , CACHE_BUFFER_MODE_ALL = 1 , CACHE_BUFFER_MODE_TRUE_INTERNET = 2 , CACHE_BUFFER_MODE_NONE = 3 ,   CACHE_BUFFER_MODE_NETWORK = 4 }
enum	EIoControl {   IOCTRL_NATIVE = 1 , IOCTRL_SEEK_POSSIBLE = 2 , IOCTRL_CACHE_STATUS = 3 , IOCTRL_CACHE_SETRATE = 4 ,   IOCTRL_SET_CACHE = 8 , IOCTRL_SET_RETRY = 16 }
enum	CURLOPTIONTYPE { CURL_OPTION_OPTION , CURL_OPTION_PROTOCOL , CURL_OPTION_CREDENTIALS , CURL_OPTION_HEADER }
enum	FileProperty {   FILE_PROPERTY_RESPONSE_PROTOCOL , FILE_PROPERTY_RESPONSE_HEADER , FILE_PROPERTY_CONTENT_TYPE , FILE_PROPERTY_CONTENT_CHARSET ,   FILE_PROPERTY_MIME_TYPE , FILE_PROPERTY_EFFECTIVE_URL }

Variables
const auto	CATEGORY_INFO_PROVIDERS = "category.infoproviders"
const auto	CATEGORY_LOOK_AND_FEEL = "category.lookandfeel"
const auto	CATEGORY_GAME_ADDONS = "category.gameaddons"
const auto	CATEGORY_EMULATORS = "category.emulators"
const auto	CATEGORY_STANDALONE_GAMES = "category.standalonegames"
const auto	CATEGORY_GAME_PROVIDERS = "category.gameproviders"
const auto	CATEGORY_GAME_RESOURCES = "category.gameresources"
const auto	CATEGORY_GAME_SUPPORT_ADDONS = "category.gamesupport"
const std::set< AddonType >	infoProviderTypes
const std::set< AddonType >	lookAndFeelTypes
const std::set< AddonType >	gameTypes

Typedef Documentation

DirectorizeEntries

template<class TEntry >

using XFILE::DirectorizeEntries = std::vector<DirectorizeEntry<TEntry>>

DirectorizeEntry

template<class TEntry >

using XFILE::DirectorizeEntry = std::pair<std::string, TEntry>

DirectorizeEntryToFileItemFunction

template<class TEntry >

using XFILE::DirectorizeEntryToFileItemFunction = CFileItemPtr(*)(const TEntry& entry, const std::string& label, const std::string& path, bool isFolder)

Method definition to convert an entry to a CFileItemPtr.

Parameters

entry	The entry to convert to a CFileItemPtr
label	The label of the entry
path	The path of the entry
isFolder	Whether the entry is a folder or not

Returns

The CFileItemPtr object created from the given entry and data.

Enumeration Type Documentation

CACHE_BUFFER_MODES

enum XFILE::CACHE_BUFFER_MODES

Enumerator
CACHE_BUFFER_MODE_INTERNET
CACHE_BUFFER_MODE_ALL
CACHE_BUFFER_MODE_TRUE_INTERNET
CACHE_BUFFER_MODE_NONE
CACHE_BUFFER_MODE_NETWORK

CURLOPTIONTYPE

enum XFILE::CURLOPTIONTYPE

Enumerator
CURL_OPTION_OPTION	Set a general option
CURL_OPTION_PROTOCOL	Set a protocol option (see below)
CURL_OPTION_CREDENTIALS	Set User and password
CURL_OPTION_HEADER	Add a Header

DIR_CACHE_TYPE

enum XFILE::DIR_CACHE_TYPE

Enumerator
DIR_CACHE_NEVER	Never cache this directory to memory.
DIR_CACHE_ONCE	Cache this directory to memory for each fetch (so that FileExists() checks are fast)
DIR_CACHE_ALWAYS	Always cache this directory to memory, so that each additional fetch of this folder will utilize the cache (until it's cleared)

DIR_FLAG

enum XFILE::DIR_FLAG

Available directory flags The defaults are to allow file directories, no prompting, retrieve file information, hide hidden files, and utilise the directory cache based on the implementation's wishes.

Enumerator
DIR_FLAG_DEFAULTS
DIR_FLAG_NO_FILE_DIRS	Don't convert files (zip, rar etc.) to directories.
DIR_FLAG_ALLOW_PROMPT	Allow prompting for further info (passwords etc.)
DIR_FLAG_NO_FILE_INFO	Don't read additional file info (stat for example)
DIR_FLAG_GET_HIDDEN	Get hidden files.
DIR_FLAG_READ_CACHE	Force reading from the directory cache (if available)
DIR_FLAG_BYPASS_CACHE	Completely bypass the directory cache (no reading, no writing)

EIoControl

enum XFILE::EIoControl

Enumerator
IOCTRL_NATIVE	SNativeIoControl structure, containing what should be passed to native ioctrl
IOCTRL_SEEK_POSSIBLE	return 0 if known not to work, 1 if it should work
IOCTRL_CACHE_STATUS	SCacheStatus structure
IOCTRL_CACHE_SETRATE	unsigned int with speed limit for caching in bytes per second
IOCTRL_SET_CACHE	CFileCache
IOCTRL_SET_RETRY	Enable/disable retry within the protocol handler (if supported)

FileProperty

enum XFILE::FileProperty

The following names for CURL_OPTION_PROTOCOL are possible:

accept-charset: Set the "accept-charset" header acceptencoding or encoding: Set the "accept-encoding" header active-remote: Set the "active-remote" header auth: Set the authentication method. Possible values: any, anysafe, digest, ntlm connection-timeout: Set the connection timeout in seconds cookie: Set the "cookie" header customrequest: Set a custom HTTP request like DELETE noshout: Set to true if kodi detects a stream as shoutcast by mistake. postdata: Set the post body (value needs to be base64 encoded). (Implicitly sets the request to POST) referer: Set the "referer" header user-agent: Set the "user-agent" header seekable: Set the stream seekable. 1: enable, 0: disable sslcipherlist: Set list of accepted SSL ciphers.

Enumerator
FILE_PROPERTY_RESPONSE_PROTOCOL	Get response protocol line
FILE_PROPERTY_RESPONSE_HEADER	Get response Header value
FILE_PROPERTY_CONTENT_TYPE	Get file content-type
FILE_PROPERTY_CONTENT_CHARSET	Get file content charset
FILE_PROPERTY_MIME_TYPE	Get file mime type
FILE_PROPERTY_EFFECTIVE_URL	Get effective URL for redirected streams

Variable Documentation

CATEGORY_EMULATORS

const auto XFILE::CATEGORY_EMULATORS = "category.emulators"

CATEGORY_GAME_ADDONS

const auto XFILE::CATEGORY_GAME_ADDONS = "category.gameaddons"

CATEGORY_GAME_PROVIDERS

const auto XFILE::CATEGORY_GAME_PROVIDERS = "category.gameproviders"

CATEGORY_GAME_RESOURCES

const auto XFILE::CATEGORY_GAME_RESOURCES = "category.gameresources"

CATEGORY_GAME_SUPPORT_ADDONS

const auto XFILE::CATEGORY_GAME_SUPPORT_ADDONS = "category.gamesupport"

CATEGORY_INFO_PROVIDERS

const auto XFILE::CATEGORY_INFO_PROVIDERS = "category.infoproviders"

CATEGORY_LOOK_AND_FEEL

const auto XFILE::CATEGORY_LOOK_AND_FEEL = "category.lookandfeel"

CATEGORY_STANDALONE_GAMES

const auto XFILE::CATEGORY_STANDALONE_GAMES = "category.standalonegames"

gameTypes

const std::set<AddonType> XFILE::gameTypes

Initial value:

= {
    AddonType::GAME_CONTROLLER,
    AddonType::GAMEDLL,
    AddonType::GAME,
    AddonType::RESOURCE_GAMES,
}

infoProviderTypes

const std::set<AddonType> XFILE::infoProviderTypes

Initial value:

= {
    AddonType::SCRAPER_ALBUMS,      AddonType::SCRAPER_ARTISTS, AddonType::SCRAPER_MOVIES,
    AddonType::SCRAPER_MUSICVIDEOS, AddonType::SCRAPER_TVSHOWS,
}

lookAndFeelTypes

const std::set<AddonType> XFILE::lookAndFeelTypes

Initial value:

= {
    AddonType::SKIN,
    AddonType::SCREENSAVER,
    AddonType::RESOURCE_IMAGES,
    AddonType::RESOURCE_LANGUAGE,
    AddonType::RESOURCE_UISOUNDS,
    AddonType::RESOURCE_FONT,
    AddonType::VISUALIZATION,
}