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	CBlurayDiscCache
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	CDiscDirectoryHelper
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
struct	ChapterInformation
class	CHTTPDirectory
class	CImageFile
class	CISO9660Directory
class	CISO9660File
class	CLibraryDirectory
struct	ClipInfo
struct	ClipInformation
class	CMultiPathDirectory
class	CMultiPathFile
class	CMusicDatabaseDirectory
class	CMusicDatabaseFile
class	CMusicFileDirectory
class	CMusicSearchDirectory
class	CNFSDirectory
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	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
struct	DiscStreamInfo
class	IDirectory
	Interface to the directory on a file system. More...
class	IFile
class	IFileCallback
class	IFileDirectory
class	IPipeListener
class	Pipe
class	PipesManager
struct	PlayItemInformation
struct	PlaylistInfo
struct	PlaylistInformation
struct	PlaylistMarkInformation
struct	ProgramInformation
struct	SCacheStatus
struct	SNativeIoControl
struct	StreamInformation
struct	SubPathInformation
struct	SubPlayItemInformation

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 > >
using	PlaylistMap = std::map< unsigned int, PlaylistInfo >
using	ClipMap = std::map< unsigned int, ClipInfo >

Enumerations
enum class	BLURAY_PLAYBACK_TYPE : unsigned int { SEQUENTIAL = 1 , RANDOM , SHUFFLE }
enum class	BLURAY_CONNECTION : unsigned int { SEAMLESS = 1 , NONSEAMLESS = 5 , BRANCHING = 6 }
enum class	BLURAY_SUBPATH_TYPE : unsigned int {   PRIMARY_AUDIO_SLIDESHOW = 2 , INTERACTIVE_GRAPHICS_PRESENTATION_MENU , TEXT_SUBTITLE_PRESENTATION , OUTOFMUX_SYNCHRONOUS ,   OUTOFMUX_ASYNCHRONOUS_PIP , INMUX_SYNCHRONOUS_PIP , STEREOSCOPIC_VIDEO , STEREOSCOPIC_INTERACTIVE_GRAPHICS_MENU ,   DOLBY_VISION_LAYER }
enum class	BLURAY_STREAM_TYPE : unsigned int { PLAYITEM = 1 , SUBPATH , SUBPATH_INMUX_SYNCHRONOUS_PIP , SUBPATH_DOLBY_VISION_LAYER }
enum class	BLURAY_MARK_TYPE : unsigned int { ENTRY = 1 , LINK }
enum class	STREAM_TYPE : unsigned int {   VIDEO_STREAM = 0 , AUDIO_STREAM , PRESENTATION_GRAPHIC_STREAM , INTERACTIVE_GRAPHIC_STREAM ,   SECONDARY_VIDEO_STREAM , SECONDARY_AUDIO_STREAM , PICTURE_IN_PICTURE_SUBTITLE_STREAM , DOLBY_VISION_STREAM }
enum class	GetTitles : uint8_t { GET_TITLES_ONE = 0 , GET_TITLES_MAIN , GET_TITLES_EPISODES , GET_TITLES_ALL }
enum class	SortTitles : uint8_t { SORT_TITLES_NONE = 0 , SORT_TITLES_EPISODE , SORT_TITLES_MOVIE }
enum class	AddMenuOption : bool { NO_MENU , ADD_MENU }
enum class	ENCODING_TYPE : uint8_t {   VIDEO_MPEG1 = 0x01 , VIDEO_MPEG2 = 0x02 , AUDIO_MPEG1 = 0x03 , AUDIO_MPEG2 = 0x04 ,   AUDIO_LPCM = 0x80 , AUDIO_AC3 = 0x81 , AUDIO_DTS = 0x82 , AUDIO_TRUHD = 0x83 ,   AUDIO_AC3PLUS = 0x84 , AUDIO_DTSHD = 0x85 , AUDIO_DTSHD_MASTER = 0x86 , VIDEO_VC1 = 0xea ,   VIDEO_H264 = 0x1b , VIDEO_HEVC = 0x24 , SUB_PG = 0x90 , SUB_IG = 0x91 ,   SUB_TEXT = 0x92 , AUDIO_AC3PLUS_SECONDARY = 0xa1 , AUDIO_DTSHD_SECONDARY = 0xa2 }
enum class	ASPECT_RATIO : uint8_t { RATIO_4_3 = 2 , RATIO_16_9 = 3 }
enum class	CacheType { NEVER = 0 , ONCE , 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 }
	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 class	CacheBufferMode {   INTERNET = 0 , ALL = 1 , TRUE_INTERNET = 2 , NONE = 3 ,   NETWORK = 4 }
enum class	IOControl {   NATIVE = 1 , SEEK_POSSIBLE = 2 , CACHE_STATUS = 3 , CACHE_SETRATE = 4 ,   SET_CACHE = 8 , SET_RETRY = 16 }
enum class	CURLOptionType { OPTION , PROTOCOL , CREDENTIALS , HEADER }
enum class	FileProperty {   RESPONSE_PROTOCOL , RESPONSE_HEADER , CONTENT_TYPE , CONTENT_CHARSET ,   MIME_TYPE , 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

ClipMap

using XFILE::ClipMap = typedef std::map<unsigned int, ClipInfo>

DirectorizeEntries

template<class TEntry >

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

DirectorizeEntry

template<class TEntry >

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

DirectorizeEntryToFileItemFunction

template<class TEntry >

using XFILE::DirectorizeEntryToFileItemFunction = typedef 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.

PlaylistMap

using XFILE::PlaylistMap = typedef std::map<unsigned int, PlaylistInfo>

Enumeration Type Documentation

AddMenuOption

enum class XFILE::AddMenuOption : bool

strong

Enumerator
NO_MENU
ADD_MENU

ASPECT_RATIO

enum class XFILE::ASPECT_RATIO : uint8_t

strong

Enumerator
RATIO_4_3
RATIO_16_9

BLURAY_CONNECTION

enum class XFILE::BLURAY_CONNECTION : unsigned int

strong

Enumerator
SEAMLESS
NONSEAMLESS
BRANCHING

BLURAY_MARK_TYPE

enum class XFILE::BLURAY_MARK_TYPE : unsigned int

strong

Enumerator
ENTRY
LINK

BLURAY_PLAYBACK_TYPE

enum class XFILE::BLURAY_PLAYBACK_TYPE : unsigned int

strong

Enumerator
SEQUENTIAL
RANDOM
SHUFFLE

BLURAY_STREAM_TYPE

enum class XFILE::BLURAY_STREAM_TYPE : unsigned int

strong

Enumerator
PLAYITEM
SUBPATH
SUBPATH_INMUX_SYNCHRONOUS_PIP
SUBPATH_DOLBY_VISION_LAYER

BLURAY_SUBPATH_TYPE

enum class XFILE::BLURAY_SUBPATH_TYPE : unsigned int

strong

Enumerator
PRIMARY_AUDIO_SLIDESHOW
INTERACTIVE_GRAPHICS_PRESENTATION_MENU
TEXT_SUBTITLE_PRESENTATION
OUTOFMUX_SYNCHRONOUS
OUTOFMUX_ASYNCHRONOUS_PIP
INMUX_SYNCHRONOUS_PIP
STEREOSCOPIC_VIDEO
STEREOSCOPIC_INTERACTIVE_GRAPHICS_MENU
DOLBY_VISION_LAYER

CacheBufferMode

enum class XFILE::CacheBufferMode

strong

Enumerator
INTERNET
ALL
TRUE_INTERNET
NONE
NETWORK

CacheType

enum class XFILE::CacheType

strong

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

CURLOptionType

enum class XFILE::CURLOptionType

strong

Enumerator
OPTION	Set a general option
PROTOCOL	Set a protocol option (see below)
CREDENTIALS	Set User and password
HEADER	Add a Header

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)

ENCODING_TYPE

enum class XFILE::ENCODING_TYPE : uint8_t

strong

Enumerator
VIDEO_MPEG1
VIDEO_MPEG2
AUDIO_MPEG1
AUDIO_MPEG2
AUDIO_LPCM
AUDIO_AC3
AUDIO_DTS
AUDIO_TRUHD
AUDIO_AC3PLUS
AUDIO_DTSHD
AUDIO_DTSHD_MASTER
VIDEO_VC1
VIDEO_H264
VIDEO_HEVC
SUB_PG
SUB_IG
SUB_TEXT
AUDIO_AC3PLUS_SECONDARY
AUDIO_DTSHD_SECONDARY

FileProperty

enum class XFILE::FileProperty

strong

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
RESPONSE_PROTOCOL	Get response protocol line
RESPONSE_HEADER	Get response Header value
CONTENT_TYPE	Get file content-type
CONTENT_CHARSET	Get file content charset
MIME_TYPE	Get file mime type
EFFECTIVE_URL	Get effective URL for redirected streams

GetTitles

enum class XFILE::GetTitles : uint8_t

strong

Enumerator
GET_TITLES_ONE
GET_TITLES_MAIN
GET_TITLES_EPISODES
GET_TITLES_ALL

IOControl

enum class XFILE::IOControl

strong

Enumerator
NATIVE	SNativeIoControl structure, containing what should be passed to native ioctrl
SEEK_POSSIBLE	return 0 if known not to work, 1 if it should work
CACHE_STATUS	SCacheStatus structure
CACHE_SETRATE	unsigned int with speed limit for caching in bytes per second
SET_CACHE	CFileCache
SET_RETRY	Enable/disable retry within the protocol handler (if supported)

SortTitles

enum class XFILE::SortTitles : uint8_t

strong

Enumerator
SORT_TITLES_NONE
SORT_TITLES_EPISODE
SORT_TITLES_MOVIE

STREAM_TYPE

enum class XFILE::STREAM_TYPE : unsigned int

strong

Enumerator
VIDEO_STREAM
AUDIO_STREAM
PRESENTATION_GRAPHIC_STREAM
INTERACTIVE_GRAPHIC_STREAM
SECONDARY_VIDEO_STREAM
SECONDARY_AUDIO_STREAM
PICTURE_IN_PICTURE_SUBTITLE_STREAM
DOLBY_VISION_STREAM

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::SHADERDLL,
    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,
}