Definitions, structures and enumerators

Virtual file Server definition values More...

Classes
struct	STAT_STRUCTURE
	File information status. More...
struct	SSelectionEntry
	Selection entry structure More...

Typedefs
typedef enum OpenFileFlags	OpenFileFlags
typedef enum CURLOptiontype	CURLOptiontype
	CURL message types. More...
typedef enum FilePropertyTypes	FilePropertyTypes
	CURL message types. More...
typedef struct SSelectionEntry	SSelectionEntry
	Selection entry structure More...

Enumerations
enum	OpenFileFlags {   READ_TRUNCATED = 0x01 , READ_CHUNKED = 0x02 , READ_CACHED = 0x04 , READ_NO_CACHE = 0x08 ,   READ_BITRATE = 0x10 , READ_MULTI_STREAM = 0x20 , READ_AUDIO_VIDEO = 0x40 , READ_AFTER_WRITE = 0x80 ,   READ_REOPEN = 0x100 }
enum	CURLOptiontype { ADDON_CURL_OPTION_OPTION , ADDON_CURL_OPTION_PROTOCOL , ADDON_CURL_OPTION_CREDENTIALS , ADDON_CURL_OPTION_HEADER }
	CURL message types. More...
enum	FilePropertyTypes {   ADDON_FILE_PROPERTY_RESPONSE_PROTOCOL , ADDON_FILE_PROPERTY_RESPONSE_HEADER , ADDON_FILE_PROPERTY_CONTENT_TYPE , ADDON_FILE_PROPERTY_CONTENT_CHARSET ,   ADDON_FILE_PROPERTY_MIME_TYPE , ADDON_FILE_PROPERTY_EFFECTIVE_URL }
	CURL message types. More...

Detailed Description

Virtual file Server definition values

Dialog Select definition values

Typedef Documentation

CURLOptiontype

typedef enum CURLOptiontype CURLOptiontype

CURL message types.

Used on kodi::vfs::CFile::CURLAddOption()

FilePropertyTypes

typedef enum FilePropertyTypes FilePropertyTypes

CURL message types.

Used on kodi::vfs::CFile::GetPropertyValue() and kodi::vfs::CFile::GetPropertyValues()

OpenFileFlags

typedef enum OpenFileFlags OpenFileFlags

Flags to define way how file becomes opened with kodi::vfs::CFile::OpenFile()

The values can be used together, e.g. file.Open("myfile", READ_TRUNCATED | READ_CHUNKED);

SSelectionEntry

typedef struct SSelectionEntry SSelectionEntry

Selection entry structure

Enumeration Type Documentation

CURLOptiontype

enum CURLOptiontype

CURL message types.

Used on kodi::vfs::CFile::CURLAddOption()

Enumerator
ADDON_CURL_OPTION_OPTION	Set a general option.
ADDON_CURL_OPTION_PROTOCOL	Set a protocol option The following names for ADDON_CURL_OPTION_PROTOCOL are possible: Option name Description 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.
ADDON_CURL_OPTION_CREDENTIALS	Set User and password.
ADDON_CURL_OPTION_HEADER	Add a Header.

FilePropertyTypes

enum FilePropertyTypes

CURL message types.

Used on kodi::vfs::CFile::GetPropertyValue() and kodi::vfs::CFile::GetPropertyValues()

Enumerator
ADDON_FILE_PROPERTY_RESPONSE_PROTOCOL	Get protocol response line.
ADDON_FILE_PROPERTY_RESPONSE_HEADER	Get a response header.
ADDON_FILE_PROPERTY_CONTENT_TYPE	Get file content type.
ADDON_FILE_PROPERTY_CONTENT_CHARSET	Get file content charset.
ADDON_FILE_PROPERTY_MIME_TYPE	Get file mime type.
ADDON_FILE_PROPERTY_EFFECTIVE_URL	Get file effective URL (last one if redirected)

OpenFileFlags

enum OpenFileFlags

Flags to define way how file becomes opened with kodi::vfs::CFile::OpenFile()

The values can be used together, e.g. file.Open("myfile", READ_TRUNCATED | READ_CHUNKED);

Enumerator
READ_TRUNCATED	indicate that caller can handle truncated reads, where function returns before entire buffer has been filled
READ_CHUNKED	indicate that that caller support read in the minimum defined chunk size, this disables internal cache then
READ_CACHED	use cache to access this file
READ_NO_CACHE	open without caching. regardless to file type
READ_BITRATE	calcuate bitrate for file while reading
READ_MULTI_STREAM	indicate to the caller we will seek between multiple streams in the file frequently
READ_AUDIO_VIDEO	indicate to the caller file is audio and/or video (and e.g. may grow)
READ_AFTER_WRITE	indicate that caller will do write operations before reading
READ_REOPEN	indicate that caller want to reopen a file if its already open