Kodi Documentation  18.0
Kodi is an open source media player and entertainment hub.
ModuleXbmc.h File Reference
#include "AddonString.h"
#include "Tuple.h"
#include "utils/LangCodeExpander.h"
#include "swighelper.h"
#include <vector>

Functions

 log (...)
 

Function: xbmc.log(msg[, level])


Write a string to Kodi's log file and the debug window. More...

 
 shutdown ()
 

Function: xbmc.Shutdown()


Shutdown the htpc. More...

 
 restart ()
 

Function: xbmc.restart()


Restart the htpc. More...

 
 executescript (...)
 

Function: xbmc.executescript(script)


Execute a python script. More...

 
 executebuiltin (...)
 

Function: xbmc.executebuiltin(function)


Execute a built in Kodi function. More...

 
 executeJSONRPC (...)
 

Function: xbmc.executeJSONRPC(jsonrpccommand)


Execute an JSONRPC command. More...

 
 sleep (...)
 

Function: xbmc.sleep(time)


Sleeps for 'time' msec. More...

 
 getLocalizedString (...)
 

Function: xbmc.getLocalizedString(id)


Get a localized 'unicode string'. More...

 
 getSkinDir ()
 

Function: xbmc.getSkinDir()


Get the active skin directory. More...

 
 getLanguage (...)
 

Function: xbmc.getLanguage([format], [region])


Get the active language. More...

 
 getIPAddress ()
 

Function: xbmc.getIPAddress()


Get the current ip address. More...

 
 getDVDState ()
 

Function: xbmc.getDVDState()


Returns the dvd state as an integer. More...

 
 getFreeMem ()
 

Function: xbmc.getFreeMem()


Get amount of free memory in MB. More...

 
 getInfoLabel (...)
 

Function: xbmc.getInfoLabel(infotag)


Get a info label More...

 
 getInfoImage (...)
 

Function: xbmc.getInfoImage(infotag)


Get filename including path to the InfoImage's thumbnail. More...

 
 playSFX (...)
 

Function: xbmc.playSFX(filename,[useCached])


Plays a wav file by filename More...

 
 stopSFX ()
 

Function: xbmc.stopSFX()


Stops wav file More...

 
 enableNavSounds (...)
 

Function: xbmc.enableNavSounds(yesNo)


Enables/Disables nav sounds More...

 
 getCondVisibility (...)
 

Function: xbmc.getCondVisibility(condition)


Get visibility conditions More...

 
 getGlobalIdleTime ()
 

Function: xbmc.getGlobalIdleTime()


Get the elapsed idle time in seconds. More...

 
 getCacheThumbName (...)
 

Function: xbmc.getCacheThumbName(path)


Get thumb cache filename. More...

 
 makeLegalFilename (...)
 

Function: xbmc.makeLegalFilename(filename[, fatX])


Returns a legal filename or path as a string. More...

 
 translatePath (...)
 

Function: xbmc.translatePath(path)


Returns the translated path. More...

 
 getCleanMovieTitle (...)
 

Function: xbmc.getCleanMovieTitle(path[, usefoldername])


Get clean movie title and year string if available. More...

 
 validatePath (...)
 

Function: xbmc.validatePath(path)


Returns the validated path. More...

 
 getRegion (...)
 

Function: xbmc.getRegion(id)


Returns your regions setting as a string for the specified id. More...

 
 getSupportedMedia (...)
 

Function: xbmc.getSupportedMedia(media)


Get the supported file types for the specific media. More...

 
 skinHasImage (...)
 

Function: xbmc.skinHasImage(image)


Check skin for presence of Image. More...

 
 startServer (...)
 

Function: xbmc.startServer(typ, bStart, bWait)


Start or stop a server. More...

 
 audioSuspend ()
 

Function: xbmc.audioSuspend()


Suspend Audio engine. More...

 
 audioResume ()
 

Function: xbmc.audioResume()


Resume Audio engine. More...

 
 getUserAgent ()
 

Function: xbmc.getUserAgent()


More...
 
 convertLanguage (...)
 

Function: xbmc.convertLanguage(language, format)


More...