Kodi Documentation  18.0
Kodi is an open source media player and entertainment hub.
Classes | Functions
File
Python » Library - xbmcvfs

Kodi's file class. More...

Classes

class  XBMCAddon::xbmcvfs::File
 

Functions

 XBMCAddon::xbmcvfs::File::read (...)
 

Function: read([bytes])

Read file parts as string. More...

 
 XBMCAddon::xbmcvfs::File::readBytes (...)
 

Function: readBytes(numbytes)

Read bytes from file. More...

 
 XBMCAddon::xbmcvfs::File::write (...)
 

Function: write(buffer)

To write given data in file. More...

 
 XBMCAddon::xbmcvfs::File::size ()
 

Function: size()

Get the file size. More...

 
 XBMCAddon::xbmcvfs::File::seek (...)
 

Function: seek(seekBytes, iWhence)

Seek to position in file. More...

 
 XBMCAddon::xbmcvfs::File::close ()
 

Function: close()

Close opened file. More...

 

Detailed Description

Kodi's file class.

Class: xbmcvfs.File(filepath, [mode])

Parameters
filepathstring Selected file path
mode[opt] string Additional mode options (if no mode is supplied, the default is Open for Read).
Mode Description
w Open for write

Example:

..
f = xbmcvfs.File(file, 'w')
..

Function Documentation

§ close()

XBMCAddon::xbmcvfs::File::close ( )

Function: close()

Close opened file.

Example:

..
f = xbmcvfs.File(file)
f.close()
..

§ read()

XBMCAddon::xbmcvfs::File::read (   ...)

Function: read([bytes])

Read file parts as string.

Parameters
bytes[opt] How many bytes to read - if not set it will read the whole file
Returns
string

Example:

..
f = xbmcvfs.File(file)
b = f.read()
f.close()
..

§ readBytes()

XbmcCommons::Buffer XBMCAddon::xbmcvfs::File::readBytes (   ...)

Function: readBytes(numbytes)

Read bytes from file.

Parameters
numbytesHow many bytes to read [opt]- if not set it will read the whole file
Returns
bytearray

Example:

..
f = xbmcvfs.File(file)
b = f.read()
f.close()
..

§ seek()

XBMCAddon::xbmcvfs::File::seek (   ...)

Function: seek(seekBytes, iWhence)

Seek to position in file.

Parameters
seekBytesposition in the file
iWhencewhere in a file to seek from[0 beginning, 1 current , 2 end position]

Example:

..
f = xbmcvfs.File(file)
result = f.seek(8129, 0)
f.close()
..

§ size()

XBMCAddon::xbmcvfs::File::size ( )

Function: size()

Get the file size.

Returns
The file size

Example:

..
f = xbmcvfs.File(file)
s = f.size()
f.close()
..

§ write()

bool XBMCAddon::xbmcvfs::File::write (   ...)

Function: write(buffer)

To write given data in file.

Parameters
bufferBuffer to write to file
Returns
True on success.

Example:

..
f = xbmcvfs.File(file, 'w')
result = f.write(buffer)
f.close()
..