Kodi Documentation  18.0
Kodi is an open source media player and entertainment hub.
ADDON::Interface_Filesystem Struct Reference

#include <Filesystem.h>

Static Public Member Functions

static void Init (AddonGlobalInterface *addonInterface)
 
static void DeInit (AddonGlobalInterface *addonInterface)
 
static bool can_open_directory (void *kodiBase, const char *url)
 callback functions from add-on to kodi More...
 
static bool create_directory (void *kodiBase, const char *path)
 
static bool directory_exists (void *kodiBase, const char *path)
 
static bool remove_directory (void *kodiBase, const char *path)
 
static bool get_directory (void *kodiBase, const char *path, const char *mask, VFSDirEntry **items, unsigned int *num_items)
 
static void free_directory (void *kodiBase, VFSDirEntry *items, unsigned int num_items)
 
static bool file_exists (void *kodiBase, const char *filename, bool useCache)
 
static int stat_file (void *kodiBase, const char *filename, struct __stat64 *buffer)
 
static bool delete_file (void *kodiBase, const char *filename)
 
static bool rename_file (void *kodiBase, const char *filename, const char *newFileName)
 
static bool copy_file (void *kodiBase, const char *filename, const char *dest)
 
static char * get_file_md5 (void *kodiBase, const char *filename)
 
static char * get_cache_thumb_name (void *kodiBase, const char *filename)
 
static char * make_legal_filename (void *kodiBase, const char *filename)
 
static char * make_legal_path (void *kodiBase, const char *path)
 
static char * translate_special_protocol (void *kodiBase, const char *strSource)
 
static voidopen_file (void *kodiBase, const char *filename, unsigned int flags)
 
static voidopen_file_for_write (void *kodiBase, const char *filename, bool overwrite)
 
static ssize_t read_file (void *kodiBase, void *file, void *ptr, size_t size)
 
static bool read_file_string (void *kodiBase, void *file, char *szLine, int lineLength)
 
static ssize_t write_file (void *kodiBase, void *file, const void *ptr, size_t size)
 
static void flush_file (void *kodiBase, void *file)
 
static int64_t seek_file (void *kodiBase, void *file, int64_t position, int whence)
 
static int truncate_file (void *kodiBase, void *file, int64_t size)
 
static int64_t get_file_position (void *kodiBase, void *file)
 
static int64_t get_file_length (void *kodiBase, void *file)
 
static double get_file_download_speed (void *kodiBase, void *file)
 
static void close_file (void *kodiBase, void *file)
 
static int get_file_chunk_size (void *kodiBase, void *file)
 
static char ** get_property_values (void *kodiBase, void *file, int type, const char *name, int *numValues)
 
static voidcurl_create (void *kodiBase, const char *url)
 
static bool curl_add_option (void *kodiBase, void *file, int type, const char *name, const char *value)
 
static bool curl_open (void *kodiBase, void *file, unsigned int flags)
 

Member Function Documentation

§ can_open_directory()

bool ADDON::Interface_Filesystem::can_open_directory ( void kodiBase,
const char *  url 
)
static

callback functions from add-on to kodi

Note
For add of new functions use the "_" style to identify direct a add-on callback function. Everything with CamelCase is only for the usage in Kodi only.

The parameter kodiBase is used to become the pointer for a CAddonDll class.

§ close_file()

void ADDON::Interface_Filesystem::close_file ( void kodiBase,
void file 
)
static

§ copy_file()

bool ADDON::Interface_Filesystem::copy_file ( void kodiBase,
const char *  filename,
const char *  dest 
)
static

§ create_directory()

bool ADDON::Interface_Filesystem::create_directory ( void kodiBase,
const char *  path 
)
static

§ curl_add_option()

bool ADDON::Interface_Filesystem::curl_add_option ( void kodiBase,
void file,
int  type,
const char *  name,
const char *  value 
)
static

§ curl_create()

void * ADDON::Interface_Filesystem::curl_create ( void kodiBase,
const char *  url 
)
static

§ curl_open()

bool ADDON::Interface_Filesystem::curl_open ( void kodiBase,
void file,
unsigned int  flags 
)
static

§ DeInit()

void ADDON::Interface_Filesystem::DeInit ( AddonGlobalInterface addonInterface)
static

§ delete_file()

bool ADDON::Interface_Filesystem::delete_file ( void kodiBase,
const char *  filename 
)
static

§ directory_exists()

bool ADDON::Interface_Filesystem::directory_exists ( void kodiBase,
const char *  path 
)
static

§ file_exists()

bool ADDON::Interface_Filesystem::file_exists ( void kodiBase,
const char *  filename,
bool  useCache 
)
static

§ flush_file()

void ADDON::Interface_Filesystem::flush_file ( void kodiBase,
void file 
)
static

§ free_directory()

void ADDON::Interface_Filesystem::free_directory ( void kodiBase,
VFSDirEntry items,
unsigned int  num_items 
)
static

§ get_cache_thumb_name()

char * ADDON::Interface_Filesystem::get_cache_thumb_name ( void kodiBase,
const char *  filename 
)
static

§ get_directory()

bool ADDON::Interface_Filesystem::get_directory ( void kodiBase,
const char *  path,
const char *  mask,
VFSDirEntry **  items,
unsigned int *  num_items 
)
static

§ get_file_chunk_size()

int ADDON::Interface_Filesystem::get_file_chunk_size ( void kodiBase,
void file 
)
static

§ get_file_download_speed()

double ADDON::Interface_Filesystem::get_file_download_speed ( void kodiBase,
void file 
)
static

§ get_file_length()

int64_t ADDON::Interface_Filesystem::get_file_length ( void kodiBase,
void file 
)
static

§ get_file_md5()

char * ADDON::Interface_Filesystem::get_file_md5 ( void kodiBase,
const char *  filename 
)
static

§ get_file_position()

int64_t ADDON::Interface_Filesystem::get_file_position ( void kodiBase,
void file 
)
static

§ get_property_values()

char ** ADDON::Interface_Filesystem::get_property_values ( void kodiBase,
void file,
int  type,
const char *  name,
int *  numValues 
)
static

§ Init()

void ADDON::Interface_Filesystem::Init ( AddonGlobalInterface addonInterface)
static

§ make_legal_filename()

char * ADDON::Interface_Filesystem::make_legal_filename ( void kodiBase,
const char *  filename 
)
static

§ make_legal_path()

char * ADDON::Interface_Filesystem::make_legal_path ( void kodiBase,
const char *  path 
)
static

§ open_file()

void * ADDON::Interface_Filesystem::open_file ( void kodiBase,
const char *  filename,
unsigned int  flags 
)
static

§ open_file_for_write()

void * ADDON::Interface_Filesystem::open_file_for_write ( void kodiBase,
const char *  filename,
bool  overwrite 
)
static

§ read_file()

ssize_t ADDON::Interface_Filesystem::read_file ( void kodiBase,
void file,
void ptr,
size_t  size 
)
static

§ read_file_string()

bool ADDON::Interface_Filesystem::read_file_string ( void kodiBase,
void file,
char *  szLine,
int  lineLength 
)
static

§ remove_directory()

bool ADDON::Interface_Filesystem::remove_directory ( void kodiBase,
const char *  path 
)
static

§ rename_file()

bool ADDON::Interface_Filesystem::rename_file ( void kodiBase,
const char *  filename,
const char *  newFileName 
)
static

§ seek_file()

int64_t ADDON::Interface_Filesystem::seek_file ( void kodiBase,
void file,
int64_t  position,
int  whence 
)
static

§ stat_file()

int ADDON::Interface_Filesystem::stat_file ( void kodiBase,
const char *  filename,
struct __stat64 buffer 
)
static

§ translate_special_protocol()

char * ADDON::Interface_Filesystem::translate_special_protocol ( void kodiBase,
const char *  strSource 
)
static

§ truncate_file()

int ADDON::Interface_Filesystem::truncate_file ( void kodiBase,
void file,
int64_t  size 
)
static

§ write_file()

ssize_t ADDON::Interface_Filesystem::write_file ( void kodiBase,
void file,
const void ptr,
size_t  size 
)
static

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