Kodi Development  20.0
for Binary and Script based Add-Ons
CInstanceVFS

Inherits IAddonInstance.

Classes

class  CVFSCallbacks
 

Public Member Functions

 CInstanceVFS (KODI_HANDLE instance, const std::string &kodiVersion="")
 VFS class constructor used to support multiple instance types. More...
 
virtual void ClearOutIdle ()
 Clear out any idle connections. More...
 
virtual bool Close (kodi::addon::VFSFileHandle context)
 Close a file. More...
 
virtual bool ContainsFiles (const kodi::addon::VFSUrl &url, std::vector< kodi::vfs::CDirEntry > &entries, std::string &rootPath)
 Check if file should be presented as a directory (multiple streams) More...
 
virtual bool CreateDirectory (const kodi::addon::VFSUrl &url)
 Create a directory. More...
 
virtual bool Delete (const kodi::addon::VFSUrl &url)
 Delete a file. More...
 
virtual bool DirectoryExists (const kodi::addon::VFSUrl &url)
 Check for directory existence. More...
 
virtual void DisconnectAll ()
 Disconnect all connections. More...
 
virtual bool Exists (const kodi::addon::VFSUrl &url)
 Check for file existence. More...
 
virtual int GetChunkSize (kodi::addon::VFSFileHandle context)
 Get chunk size of a file. More...
 
virtual bool GetDirectory (const kodi::addon::VFSUrl &url, std::vector< kodi::vfs::CDirEntry > &entries, CVFSCallbacks callbacks)
 List a directory. More...
 
virtual int64_t GetLength (kodi::addon::VFSFileHandle context)
 Get total size of a file. More...
 
virtual int64_t GetPosition (kodi::addon::VFSFileHandle context)
 Get current position in a file. More...
 
virtual bool IoControlGetCacheStatus (kodi::addon::VFSFileHandle context, kodi::vfs::CacheStatus &status)
 To check a running stream on file for state of his cache. More...
 
virtual bool IoControlGetSeekPossible (kodi::addon::VFSFileHandle context)
 To check seek possible on current stream by file. More...
 
virtual bool IoControlSetCacheRate (kodi::addon::VFSFileHandle context, unsigned int rate)
 Unsigned int with speed limit for caching in bytes per second. More...
 
virtual bool IoControlSetRetry (kodi::addon::VFSFileHandle context, bool retry)
 Enable/disable retry within the protocol handler (if supported). More...
 
virtual kodi::addon::VFSFileHandle Open (const kodi::addon::VFSUrl &url)
 Open a file for input. More...
 
virtual kodi::addon::VFSFileHandle OpenForWrite (const kodi::addon::VFSUrl &url, bool overWrite)
 Open a file for output. More...
 
virtual ssize_t Read (kodi::addon::VFSFileHandle context, uint8_t *buffer, size_t uiBufSize)
 Read from a file. More...
 
virtual bool RemoveDirectory (const kodi::addon::VFSUrl &url)
 Remove a directory. More...
 
virtual bool Rename (const kodi::addon::VFSUrl &url, const kodi::addon::VFSUrl &url2)
 Rename a file. More...
 
virtual int64_t Seek (kodi::addon::VFSFileHandle context, int64_t position, int whence)
 Seek in a file. More...
 
virtual int Stat (const kodi::addon::VFSUrl &url, kodi::vfs::FileStatus &buffer)
 Stat a file. More...
 
virtual int Truncate (kodi::addon::VFSFileHandle context, int64_t size)
 Truncate a file. More...
 
virtual ssize_t Write (kodi::addon::VFSFileHandle context, const uint8_t *buffer, size_t uiBufSize)
 Write to a file. More...
 
 ~CInstanceVFS () override=default
 Destructor. More...
 
- Public Member Functions inherited from IAddonInstance
virtual ADDON_STATUS CreateInstance (int instanceType, const std::string &instanceID, KODI_HANDLE instance, const std::string &version, KODI_HANDLE &addonInstance)
 
 IAddonInstance (ADDON_TYPE type, const std::string &version)
 

Additional Inherited Members

- Public Attributes inherited from IAddonInstance
std::string m_id
 
const std::string m_kodiVersion
 
const ADDON_TYPE m_type
 

The documentation for this class was generated from the following file: