kodi-addon-dev-kit/include/kodi/General.h File Reference

#include "AddonBase.h"

Classes
struct	AddonToKodiFuncTable_kodi
struct	kodi_version_t
	For kodi::Version used structure. More...

Namespaces
	kodi

Typedefs
typedef struct AddonToKodiFuncTable_kodi	AddonToKodiFuncTable_kodi
typedef enum QueueMsg	QueueMsg
	For kodi::QueueNotification() used message types. More...
typedef enum LangFormats	LangFormats
	Format codes to get string from them. More...
typedef struct kodi_version_t	kodi_version_t
	For kodi::Version used structure. More...

Enumerations
enum	QueueMsg { QUEUE_INFO, QUEUE_WARNING, QUEUE_ERROR, QUEUE_OWN_STYLE }
	For kodi::QueueNotification() used message types. More...
enum	LangFormats { LANG_FMT_ISO_639_1, LANG_FMT_ISO_639_2, LANG_FMT_ENGLISH_NAME }
	Format codes to get string from them. More...

Functions
std::string	kodi::GetAddonInfo (const std::string &id)
	Returns the value of an addon property as a string. More...
bool	kodi::OpenSettings ()
	Opens this Add-Ons settings dialog. More...
std::string	kodi::GetLocalizedString (uint32_t labelId, const std::string &defaultStr="")
	Returns an addon's localized 'unicode string'. More...
bool	kodi::UnknownToUTF8 (const std::string &stringSrc, std::string &utf8StringDst, bool failOnBadChar=false)
	Translate a string with an unknown encoding to UTF8. More...
std::string	kodi::GetLanguage (LangFormats format=LANG_FMT_ENGLISH_NAME, bool region=false)
	Returns the active language as a string. More...
void	kodi::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	kodi::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	kodi::GetMD5 (const std::string &text)
	Get the MD5 digest of the given text. More...
std::string	kodi::GetTempAddonPath (const std::string &append="")
	To get a temporary path for the addon. More...
std::string	kodi::GetRegion (const std::string &id)
	Returns your regions setting as a string for the specified id. More...
void	kodi::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	kodi::GetGlobalIdleTime ()
	Returns the elapsed idle time in seconds as an integer. More...
std::string	kodi::GetCurrentSkinId ()
	Get the currently used skin identification name from Kodi More...
void	kodi::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.: version.compile_name = Kodi version.major = 18 version.minor = 0 version.revision = 20170706-c6b22fe217-di version.tag = alpha version.tag_revision = 1 . More...

Typedef Documentation

AddonToKodiFuncTable_kodi

typedef struct AddonToKodiFuncTable_kodi AddonToKodiFuncTable_kodi