Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
kodi Namespace Reference

Namespaces

namespace  addon
 
namespace  gui
 
namespace  network
 
namespace  platform
 
namespace  vfs
 

Classes

class  CSettingValue
 

Functions

std::string GetAddonPath (const std::string &append="")
 
std::string GetBaseUserPath (const std::string &append="")
 
std::string GetLibPath ()
 
void Log (const AddonLog loglevel, const char *format,...)
 
bool CheckSettingString (const std::string &settingName, std::string &settingValue)
 
std::string GetSettingString (const std::string &settingName)
 
void SetSettingString (const std::string &settingName, const std::string &settingValue)
 
bool CheckSettingInt (const std::string &settingName, int &settingValue)
 
int GetSettingInt (const std::string &settingName)
 
void SetSettingInt (const std::string &settingName, int settingValue)
 
bool CheckSettingBoolean (const std::string &settingName, bool &settingValue)
 
bool GetSettingBoolean (const std::string &settingName)
 
void SetSettingBoolean (const std::string &settingName, bool settingValue)
 
bool CheckSettingFloat (const std::string &settingName, float &settingValue)
 
float GetSettingFloat (const std::string &settingName)
 
void SetSettingFloat (const std::string &settingName, float settingValue)
 
std::string TranslateAddonStatus (ADDON_STATUS status)
 
voidGetInterface (const std::string &name, const std::string &version)
 Returns a function table to a named interface. More...
 
std::string GetAddonInfo (const std::string &id)
 Returns the value of an addon property as a string. More...
 
bool OpenSettings ()
 Opens this Add-Ons settings dialog. More...
 
std::string GetLocalizedString (uint32_t labelId, const std::string &defaultStr="")
 Returns an addon's localized 'unicode string'. More...
 
bool UnknownToUTF8 (const std::string &stringSrc, std::string &utf8StringDst, bool failOnBadChar=false)
 Translate a string with an unknown encoding to UTF8. More...
 
std::string GetLanguage (LangFormats format=LANG_FMT_ENGLISH_NAME, bool region=false)
 Returns the active language as a string. More...
 
void QueueFormattedNotification (QueueMsg type, const char *format,...)
 Writes the C string pointed by format in the GUI. If format includes format specifiers (subsequences beginning with %), the additional arguments following format are formatted and inserted in the resulting string replacing their respective specifiers. More...
 
void QueueNotification (QueueMsg type, const std::string &header, const std::string &message, const std::string &imageFile="", unsigned int displayTime=5000, bool withSound=true, unsigned int messageTime=1000)
 Queue a notification in the GUI. More...
 
std::string GetMD5 (const std::string &text)
 Get the MD5 digest of the given text. More...
 
std::string GetTempAddonPath (const std::string &append="")
 To get a temporary path for the addon. More...
 
std::string GetRegion (const std::string &id)
 Returns your regions setting as a string for the specified id. More...
 
void GetFreeMem (long &free, long &total, bool asBytes=false)
 Returns the amount of free memory in MByte (or as bytes) as an long integer. More...
 
int GetGlobalIdleTime ()
 Returns the elapsed idle time in seconds as an integer. More...
 
std::string GetCurrentSkinId ()
 
void KodiVersion (kodi_version_t &version)
 Get current Kodi informations and versions, returned data from the following kodi_version_t version; kodi::KodiVersion(version); is e.g.: More...
 

Function Documentation

◆ CheckSettingBoolean()

bool kodi::CheckSettingBoolean ( const std::string &  settingName,
bool &  settingValue 
)
inline

◆ CheckSettingFloat()

bool kodi::CheckSettingFloat ( const std::string &  settingName,
float &  settingValue 
)
inline

◆ CheckSettingInt()

bool kodi::CheckSettingInt ( const std::string &  settingName,
int &  settingValue 
)
inline

◆ CheckSettingString()

bool kodi::CheckSettingString ( const std::string &  settingName,
std::string &  settingValue 
)
inline

◆ GetAddonPath()

std::string kodi::GetAddonPath ( const std::string &  append = "")
inline

◆ GetBaseUserPath()

std::string kodi::GetBaseUserPath ( const std::string &  append = "")
inline

◆ GetLibPath()

std::string kodi::GetLibPath ( )
inline

◆ GetSettingBoolean()

bool kodi::GetSettingBoolean ( const std::string &  settingName)
inline

◆ GetSettingFloat()

float kodi::GetSettingFloat ( const std::string &  settingName)
inline

◆ GetSettingInt()

int kodi::GetSettingInt ( const std::string &  settingName)
inline

◆ GetSettingString()

std::string kodi::GetSettingString ( const std::string &  settingName)
inline

◆ Log()

void kodi::Log ( const AddonLog  loglevel,
const char *  format,
  ... 
)
inline

◆ SetSettingBoolean()

void kodi::SetSettingBoolean ( const std::string &  settingName,
bool  settingValue 
)
inline

◆ SetSettingFloat()

void kodi::SetSettingFloat ( const std::string &  settingName,
float  settingValue 
)
inline

◆ SetSettingInt()

void kodi::SetSettingInt ( const std::string &  settingName,
int  settingValue 
)
inline

◆ SetSettingString()

void kodi::SetSettingString ( const std::string &  settingName,
const std::string &  settingValue 
)
inline

◆ TranslateAddonStatus()

std::string kodi::TranslateAddonStatus ( ADDON_STATUS  status)
inline