Kodi Docs 20.0
Kodi is an open source media player and entertainment hub.
Static Public Member Functions | Static Public Attributes | List of all members
ADDON::Interface_Base Struct Reference

Global general Add-on to Kodi callback functions. More...

#include <AddonBase.h>

Static Public Member Functions

static bool InitInterface (CAddonDll *addon, AddonGlobalInterface &addonInterface, KODI_HANDLE firstKodiInstance)
 
static void DeInitInterface (AddonGlobalInterface &addonInterface)
 
static void RegisterInterface (ADDON_GET_INTERFACE_FN fn)
 
static bool UpdateSettingInActiveDialog (CAddonDll *addon, const char *id, const std::string &value)
 
static char * get_type_version (void *kodiBase, int type)
 callback functions from add-on to kodi More...
 
static char * get_addon_path (void *kodiBase)
 
static char * get_base_user_path (void *kodiBase)
 
static void addon_log_msg (void *kodiBase, const int addonLogLevel, const char *strMessage)
 
static bool is_setting_using_default (void *kodiBase, const char *id)
 
static bool get_setting_bool (void *kodiBase, const char *id, bool *value)
 
static bool get_setting_int (void *kodiBase, const char *id, int *value)
 
static bool get_setting_float (void *kodiBase, const char *id, float *value)
 
static bool get_setting_string (void *kodiBase, const char *id, char **value)
 
static bool set_setting_bool (void *kodiBase, const char *id, bool value)
 
static bool set_setting_int (void *kodiBase, const char *id, int value)
 
static bool set_setting_float (void *kodiBase, const char *id, float value)
 
static bool set_setting_string (void *kodiBase, const char *id, const char *value)
 
static void free_string (void *kodiBase, char *str)
 
static void free_string_array (void *kodiBase, char **arr, int numElements)
 
static void * get_interface (void *kodiBase, const char *name, const char *version)
 

Static Public Attributes

static std::vector< ADDON_GET_INTERFACE_FN > s_registeredInterfaces
 

Detailed Description

Global general Add-on to Kodi callback functions.

To hold general functions not related to a instance type and usable for every add-on type.

Related add-on header is "./xbmc/addons/kodi-dev-kit/include/kodi/General.h"

Member Function Documentation

◆ addon_log_msg()

void ADDON::Interface_Base::addon_log_msg ( void *  kodiBase,
const int  addonLogLevel,
const char *  strMessage 
)
static

◆ DeInitInterface()

void ADDON::Interface_Base::DeInitInterface ( AddonGlobalInterface &  addonInterface)
static

◆ free_string()

void ADDON::Interface_Base::free_string ( void *  kodiBase,
char *  str 
)
static

◆ free_string_array()

void ADDON::Interface_Base::free_string_array ( void *  kodiBase,
char **  arr,
int  numElements 
)
static

◆ get_addon_path()

char * ADDON::Interface_Base::get_addon_path ( void *  kodiBase)
static

◆ get_base_user_path()

char * ADDON::Interface_Base::get_base_user_path ( void *  kodiBase)
static

◆ get_interface()

void * ADDON::Interface_Base::get_interface ( void *  kodiBase,
const char *  name,
const char *  version 
)
static

◆ get_setting_bool()

bool ADDON::Interface_Base::get_setting_bool ( void *  kodiBase,
const char *  id,
bool *  value 
)
static

◆ get_setting_float()

bool ADDON::Interface_Base::get_setting_float ( void *  kodiBase,
const char *  id,
float *  value 
)
static

◆ get_setting_int()

bool ADDON::Interface_Base::get_setting_int ( void *  kodiBase,
const char *  id,
int *  value 
)
static

◆ get_setting_string()

bool ADDON::Interface_Base::get_setting_string ( void *  kodiBase,
const char *  id,
char **  value 
)
static

◆ get_type_version()

char * ADDON::Interface_Base::get_type_version ( void *  kodiBase,
int  type 
)
static

callback functions from add-on to kodi

Addon to Kodi basic callbacks below.

Note
To add a new function use the "_" style to directly identify an add-on callback function. Everything with CamelCase is only to be used in Kodi.

The parameter kodiBase is used to become the pointer for a CAddonDll class.

The amount of functions here are hold so minimal as possible. Only parts where needed on nearly every add-on (e.g. addon_log_msg) are to add there.

More specific parts like e.g. to open files should be added to a separate part.

◆ InitInterface()

bool ADDON::Interface_Base::InitInterface ( CAddonDll *  addon,
AddonGlobalInterface &  addonInterface,
KODI_HANDLE  firstKodiInstance 
)
static

◆ is_setting_using_default()

bool ADDON::Interface_Base::is_setting_using_default ( void *  kodiBase,
const char *  id 
)
static

◆ RegisterInterface()

void ADDON::Interface_Base::RegisterInterface ( ADDON_GET_INTERFACE_FN  fn)
static

◆ set_setting_bool()

bool ADDON::Interface_Base::set_setting_bool ( void *  kodiBase,
const char *  id,
bool  value 
)
static

◆ set_setting_float()

bool ADDON::Interface_Base::set_setting_float ( void *  kodiBase,
const char *  id,
float  value 
)
static

◆ set_setting_int()

bool ADDON::Interface_Base::set_setting_int ( void *  kodiBase,
const char *  id,
int  value 
)
static

◆ set_setting_string()

bool ADDON::Interface_Base::set_setting_string ( void *  kodiBase,
const char *  id,
const char *  value 
)
static

◆ UpdateSettingInActiveDialog()

bool ADDON::Interface_Base::UpdateSettingInActiveDialog ( CAddonDll *  addon,
const char *  id,
const std::string &  value 
)
static

Member Data Documentation

◆ s_registeredInterfaces

std::vector< ADDON_GET_INTERFACE_FN > ADDON::Interface_Base::s_registeredInterfaces
static
The documentation for this struct was generated from the following files: