enum OpenFileFlags

Flags to define way how file becomes opened
The values can be used together, e.g. file.Open("myfile", ADDON_READ_TRUNCATED | ADDON_READ_CHUNKED); More...

Typedefs
typedef enum OpenFileFlags	OpenFileFlags

Enumerations
enum	OpenFileFlags {   ADDON_READ_TRUNCATED = 0x01 , ADDON_READ_CHUNKED = 0x02 , ADDON_READ_CACHED = 0x04 , ADDON_READ_NO_CACHE = 0x08 ,   ADDON_READ_BITRATE = 0x10 , ADDON_READ_MULTI_STREAM = 0x20 , ADDON_READ_AUDIO_VIDEO = 0x40 , ADDON_READ_AFTER_WRITE = 0x80 ,   ADDON_READ_REOPEN = 0x100 , ADDON_READ_NO_BUFFER = 0x200 }

Detailed Description

Flags to define way how file becomes opened
The values can be used together, e.g. file.Open("myfile", ADDON_READ_TRUNCATED | ADDON_READ_CHUNKED);

Used on kodi::vfs::CFile::OpenFile().

Typedef Documentation

OpenFileFlags

typedef enum OpenFileFlags OpenFileFlags

Enumeration Type Documentation

OpenFileFlags

enum OpenFileFlags

Enumerator
ADDON_READ_TRUNCATED	0000 0000 0001 : Indicate that caller can handle truncated reads, where function returns before entire buffer has been filled.
ADDON_READ_CHUNKED	0000 0000 0010 : Indicate that that caller support read in the minimum defined chunk size, this disables internal cache then. This flag is deprecated, instead use ADDON_READ_NO_CACHE to disable FileCache and ADDON_READ_NO_BUFFER to disable StreamBuffer. On the contrary to explicitly indicate that the file has audio/video content (suitable for caching), use the ADDON_READ_AUDIO_VIDEO flag.
ADDON_READ_CACHED	0000 0000 0100 : Use cache to access this file.
ADDON_READ_NO_CACHE	0000 0000 1000 : Open without caching. regardless to file type.
ADDON_READ_BITRATE	0000 0001 0000 : Calculate bitrate for file while reading.
ADDON_READ_MULTI_STREAM	0000 0010 0000 : Indicate to the caller we will seek between multiple streams in the file frequently.
ADDON_READ_AUDIO_VIDEO	0000 0100 0000 : Indicate to the caller file is audio and/or video and is suitable for caching with FileCache or StreamBuffer. The final method used will depend on the user's settings and file location, e.g. user can disable FileCache. This flag ensures that at least the buffer size necessary to read with the appropriate chunk size will be used.
ADDON_READ_AFTER_WRITE	0000 1000 0000 : Indicate that caller will do write operations before reading.
ADDON_READ_REOPEN	0001 0000 0000 : Indicate that caller want to reopen a file if its already open.
ADDON_READ_NO_BUFFER	0010 0000 0000 : Indicate that caller want open a file without intermediate buffer regardless to file type.